Primer do Projeto de Documentação do FreeBSD para novos colaboradores
Anterior |  | Próxima

# Capítulo 6 Estruturando Documentos Sob `doc/`

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 conversão de documentos para outros formatos.

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

3. Facilitar a decisão de onde na árvore uma 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ínguas 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 promover uma melhor categorização da informação. Por exemplo, os arquivos que compõem a infraestrutura de make(1) encontram-se em `share/mk`, enquanto os arquivos adicionais para suporte SGML (como as extensões do FreeBSD ao DocBook DTD) encontram-se em `share/xml`.

Diretório: ``idioma`.`codificação`/`

Significado: Existe um diretório para cada tradução e codificação da documentação, por exemplo `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 isola completamente de quaisquer problemas que possam ser causados por uma mudança para Unicode.

Anterior | Principal | Próxima
CSS |  | Os Diretórios de ``idioma`.`codificação``

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>.