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

Origem: Wikilivros, livros abertos por um mundo aberto.

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.

Acentuação Gráfica

É desejável que os acentos sejam codificados sem amarração de charset (ex: á = á) - abra essa página para editar e veja como são os acentos. Isso garantirá que a página vai abrir com os acentos corretos em qualquer computador.

Exemplos de Tela

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!

Notas e Afins

Para "Nota:", "Aviso:" e "Importante:" usamos o tag <blockquote> incluindo-o na classe correspondente para facilitar futura conversão para docbook. O Título "Nota:", "Aviso:" e "Importante:" deve ser colocado em negrito, o que pode ser feito com a marcação do próprio wiki.

Exemplo de "Nota"

<blockquote class="NOTE">
'''Nota:''' bla bla bla...

Aviso

<blockquote class="WARNING">
'''Aviso:''' bla bla bla...

Importante

<blockquote class="IMPORTANT">
'''Importante:''' bla bla bla...

Naturalmente o trecho da nota, aviso ou importante deve ser fechado com o tag </blockquote>

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

Representação de Teclas

Comandos do Sistema

Palavras Estrangeiras

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®

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: 24/5/2007 (20070524020611)