Esta seção contém informações específicas sobre documentos gerenciados pelo FDP.
O Handbook está escrito em DocBook XML usando DTD extendido do DocBook FreeBSD.
O Handbook está organizado como um DocBook book
. O livro é dividido em part
s, cada uma contendo vários chapter
s. Os chapter
s são subdivididos em seções (sect1
) e subseções (sect2
, sect3
) e assim por diante.
Existem vários arquivos e diretórios dentro do diretório handbook
.
A organização do Handbook pode ser alterada ao longo do tempo, e este documento pode estar defasado quanto ao detalhamento das mudanças organizacionais do mesmo. Envie perguntas sobre a organização do Handbook na lista de discussão do projeto FreeBSD.
O Makefile
define algumas variáveis que afetam como o fonte XML é convertido em diversos formatos e lista os vários arquivos fontes que compõem o Handbook. Em seguida, ele inclui o doc.project.mk
padrão, para inserir o restante do código que manipula a conversão de documentos de um formato para outro.
Este é o principal arquivo do Handbook. Ele contém a declaração DOCTYPE, bem como os elementos que descrevem a estrutura do Handbook.
book.xml
utiliza entidades de parâmetro para carregar os arquivos com a extensão .ent
. Esses arquivos (descritos posteriormente) e então definem as entidades gerais que são utilizadas no restante do Handbook.
Cada capítulo do Handbook é armazenado em um arquivo chamado chapter.xml
em um diretório separado dos outros capítulos. Cada diretório é nomeado após o valor do atributo id
no elemento chapter
.
Por exemplo, se um dos arquivos de capítulo contiver:
<chapter id="kernelconfig">
...</chapter>
Então ele será chamado de chapter.xml
no diretório kernelconfig
. Em geral, todo o conteúdo do capítulo está neste único arquivo.
Quando a versão XHTML do Handbook for gerada, produzirá o kernelconfig.html
. Isso é por causa do valor id
e não está relacionado ao nome do diretório.
Nas versões anteriores do Handbook, os arquivos eram armazenados no mesmo diretório que book.xml
e nomeados após o valor do atributo id
no elemento chapter
. Agora, é possível incluir imagens em cada capítulo. Imagens para cada capítulo do Handbook são armazenadas em share/images/books/handbook
. As imagens devem ser colocadas no mesmo diretório que os fontes XML para cada capítulo. As colisões de Namespace são inevitáveis e é mais fácil trabalhar com vários diretórios que contenham alguns arquivos, do que trabalhar com um único diretório que contenham muitos arquivos.
Com uma breve analise pode-se constatar que existem diversos diretórios com arquivos individuais chapter.xml
, incluindo basics/chapter.xml
, introduction/chapter.xml
, e printing/chapter.xml
.
Não nomeie capítulos ou diretórios com a ordenação do Handbook. Essa ordenação pode mudar conforme o conteúdo do Handbook é reorganizado. A reorganização deve ser realizada sem renomear arquivos, a menos que capítulos inteiros sejam promovidos ou rebaixados dentro da hierarquia.
Os arquivos chapter.xml
não são arquivos completos de documentos XML que podem ser compilados individualmente. Eles só podem ser compilados como partes de todo o Handbook.
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>.