Capítulo 6. Estruturando documentos sob doc/

Índice
6.1. O nível superior, doc/
6.2. Os diretórios de idioma.codificação
6.3. Informação específica do documento

A árvore doc/ é organizada de uma forma particular, e os documentos que compõe o Primer do Projeto de Documentação do FreeBSD devem ser por isso organizados de forma particular. O objetivo é tornar simples a adição de nova documentação à árvore, e:

  1. facilitar a automatização da converção de documentos para outros formatos

  2. promover consistência entre diferentes formas de organizar a documentação, facilitar a troca entre diferentes documentos XXX

  3. facilitar a decisão de onde na árvore nova documentação deveria ser colocada

Além disso, a árvore de documentação tem de acomodar documentação que pode estar em muitas diferentes língua e muitas diferentes codificações. É importante que a estrutura da árvore de documentação não force nenhum padrão particular ou preferência cultural.

6.1. O nível superior, doc/

Existem dois tipos de diretórios sob doc/, cada um com nomes de diretórios e significados muito específicos.

Diretório: share/

Significado: Contém arquivos que não são específicos as várias traduções e codificações da documentaçõo. Contém subdiretórios para maior categorizar a informação. Por exemplo, os arquivos que compõe a infraestrutura de make(1) encontram-se em share/mk, enquanto os arquivos adicionais para suporte SGML (como FreeBSD DocBook DTD extendido) encontram-se em share/sgml.

Diretório: idioma.codificação/

Significado: Existe um diretório para cada tradução e codificação da documentação, por ex. en_US.ISO8859-1/ e zh_TW.Big5/. Os nomes são longos, mas ao especificar completamente a língua e codificação prevenimos qualquer futura dor de cabeça caso um time de tradução queira prover a documentação na mesma língua mas em mais de uma codificação. Isto também nos insola completamente de quaisquer problemas que possam ser causados por uma mudança para Unicode.

Este, e outros documentos, podem ser obtidos em ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/.

Para perguntas sobre FreeBSD, leia a documentação antes de contatar <questions@FreeBSD.org>.
Para perguntas sobre esta documentação, envie e-mail para <doc@FreeBSD.org>.