FreeBSD Handbook/Apêndices/G: Padrões Adotados

FreeBSD Handbook
Anterior	Apêndice G - Padrões Adotados

---

Introdução

Este livro é uma tradução livre da documentação oficial do Projeto FreeBSD. Ao realizar a tradução foram adotados vários padrões para garantir a coerência geral do texto num ambiente colaborativo como o WikiLivros, bem como a qualidade do trabalho. Este apêndice deve ser usado como referência pelos possíveis colaboradores.

Padrões de Codificação

Padrões gerais que se referem a como codificar as páginas para a obtenção de determinado resultado visual. Estes padrões tendem a ser originados na padronização docbook do Projeto de Documentação do FreeBSD, adaptados às possibilidades do Wiki. Em outros casos são apenas boas práticas para conformidade geral do documento ou também razões técnicas, como é o caso do padrão para acentuação.

Exemplos de Tela

A melhor maneira é usando a própria captura da tela.

Uma alternativa é usar uma pré-definição/template desenvolvido e usado no capítulo 2, como por exemplo, em "2.9 - Efetivando a Instalação".

Como fazer:

 {{UserConfReq|texto=Last Chance!  Are you SURE you want to continue the installation?
 <br><br>If you're running this on a disk with data you wish to save then WE STRONGLY ENCOURAGE YOU 
 TO MAKE PROPER BACKUPS before proceeding!<br><br>We can take no responsibility for lost disk 
 contents!}}

Como aparece:

Como última e pior alternativa usamos a notação do wiki que se faz com dois espaços no início da linha. Exemplo:

 Last Chance: Are you SURE you want continue the installation?
 
 If you're running this on a disk with data you wish to save then WE
 STRONGLY ENCOURAGE YOU TO MAKE PROPER BACKUPS before proceeding!
 
 We can take no responsibility for lost disk contents!

Asteriscos

Usados com número auxiliar no caso de exemplos mais complexos. Vide uso na Seção 11.6

Como fazer:

 <span style="color: red; font-weight: bold">*1</span>

Como aparece: *1

Nomes de Arquivos

Como fazer:

 {{FBSDHB_FILENAME|arquivo=/etc/crontab}}

Como se fazia (substituir quando possível):

 <tt class="FILENAME">/etc/crontab</tt>

Como aparece: Predefinição:FBSDHB FILENAME

Primeira Aparição de Termo Técnico

É preferível usar o tag <i> do que a notação do wiki, pois assim podemos incluir o item na classe correspondente, o que facilitará conversão futura para docbook. Exemplo:

Como fazer:

 <i class="FIRSTTERM">partições estendidas</i>

Como aparece: partições estendidas

Quadro "Aviso:"

Como fazer:

 {{FBSD_HB_AVISO|aviso=texto da nota.}}

Como aparece:

Quadro de Exemplo

Como fazer:

 <div class="EXAMPLE" style="background: #fefde6; border: 1px solid #f1bb16;
   margin: 1em 0;padding: 0.2em 2em;width: 90%;">
 ====Exemplo X.x- XXX====
 </div>

Como aparece:

Exemplo X.x- XXX

Quadro "Importante:"

Como fazer:

 {{FBSD_HB_IMPORTANTE|importante=texto importante.}}

Como aparece:

Quadro "Nota:"

Como fazer:

 {{FBSD_HB_NOTA|nota=texto da nota.}}

Como aparece:

Nomes de Dispositivos (devices)

Devem ser representados com a predefinição a seguir, onde usamos "ad0" como dispositivo para exemplificar:

Como fazer:

 {{FBSD_HB_DEVICENAME|nome=ad0}}

Como aparece: Predefinição:FBSD HB DEVICENAME

Comandos do Sistema

Devem ser representados com a predefinição a seguir, onde usamos o comando "cron" para exemplificar:

Como fazer:

 {{FBSD_HB_COMMAND"|comando=cron}}

Como aparece: Predefinição:FBSD HB COMMAND"

Palavras Estrangeiras

Use o itálico normal com a sintaxe do próprio wiki.

Como fazer:

 ''kernel''

Como aparece: kernel

Marcas Registradas e Afins

Além do símbolo correspondente à marca registrada ou trademark é usado também o tag <span>, o que facilitará converter de wiki para docbook no futuro. Exemplos:

TradeMark:

Como fazer:

 <span class="TRADEMARK">i386</span>&#8482;

Como aparece: i386™

Marca Registrada:

Como fazer:

 <span class="TRADEMARK">HomeConnect</span>&reg;

Como aparece: HomeConnect®

Texto de "Contribuição de"

Para os textos que indicam de quem foi a contribuição para o capítulo ou item, usar apenas itálico.

Padrões de Escrita

Padrões gerais que se referem à maneira de escrever os textos.

Capitulares em Títulos Compostos

Para o caso de títulos compostos, a regra a ser utilizada é correspondente àquela definida no Acordo Ortográfico de 1943, a qual difere da adotada no Brasil pela ABNT. Desta forma, capitulam-se todas as iniciais com exceção de artigos, preposições, conjunções e advérbios (os quais se escrevem em minúsculas). Este é o mesmo padrão adotado na Wikipedia numa decisão obtida após votação em Votações/Regra para títulos). Portanto:

• Exemplo 1:
  • Forma correta: A Liberdade É Azul
  • Forma incorreta: A liberdade é azul
  • Forma incorreta: A Liberdade é Azul
• Exemplo 2:
  • Forma correta: Ensaio sobre a Cegueira
  • Forma incorreta: Ensaio sobre a cegueira
  • Forma incorreta: Ensaio Sobre A Cegueira

---

Anterior	Índice
Glossário da Tradução	Topo

Última edição desta página: 01/02/2011 (20110201162048)