Capítulo 4. Estrutura de Diretórios da Documentação

Índice
4.1. O Nível Superior, doc/
4.2. Os Diretórios lang.encoding/
4.3. Informação Específica de Documentação

Arquivos e diretórios no repositório doc/ seguem uma estrutura destinada a:

  1. Facilitar a conversão do documento para outros formatos.

  2. Promover a consistência entre as diferentes organizações de documentação, e assim facilitar a alternância entre diferentes documentos.

  3. Facilitar a decisão de onde a nova documentação deve ser colocada.

Além disso, o repositório de documentação deve acomodar documentos em vários idiomas e codificações diferentes. É importante que a estrutura do repositório de documentação não imponha quaisquer padrões particulares ou preferências culturais.

4.1. O Nível Superior, doc/

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

DiretórioUso
shareContém arquivos que não são específicos das várias traduções e codificações da documentação. Contém subdiretórios para categorizar ainda mais as informações. Por exemplo, os arquivos que fazem parte da infra-estrutura make(1) estão em share/mk, enquanto o suporte adicional a arquivos XML (como o DTBook estendido do FreeBSD DTD) estão em share/xml.
lang.encodingExiste um diretório para cada tradução e codificação disponível da documentação, por exemplo, en_US.ISO8859-1/ e zh_TW.UTF-8/. Os nomes são longos, mas ao especificar totalmente o idioma e a codificação, evitamos dores de cabeça futuras quando uma equipe de tradução desejar fornecer documentação no mesmo idioma, mas em mais de uma codificação. Isso também evita problemas que podem ser causados ​​por uma futura mudança para Unicode.

All FreeBSD documents are available for download at https://download.freebsd.org/ftp/doc/

Questions that are not answered by the documentation may be sent to <freebsd-questions@FreeBSD.org>.
Send questions about this document to <freebsd-doc@FreeBSD.org>.