Capítulo 5. O Processo de Compilação da Documentação

Índice
5.1. Renderizando DocBook
5.2. O Conjunto de Ferramentas de Compilação da Documentação do FreeBSD
5.3. Noções Básicas de Makefiles no Repositório de Documentação
5.4. Includes do Make do Projeto de Documentação do FreeBSD

Este capítulo aborda a organização do processo de compilação da documentação e como o make(1) é utilizado para isso.

5.1. Renderizando DocBook

Diferentes tipos de saída podem ser produzidos a partir de um único arquivo fonte DocBook. O tipo de saída desejado é definido com a variável FORMATS. Uma lista de formatos de saída conhecidos é armazenada em KNOWN_FORMATS:

% cd ~/doc/en_US.ISO8859-1/books/handbook
% make -V KNOWN_FORMATS
Tabela 5.1. Formatos de Saída Comuns
Valor FORMATSTipo de ArquivoDescrição
htmlHTML, arquivo únicoUm único book.html ou article.html.
html-splitHTML, vários arquivosVários arquivos HTML, um para cada capítulo ou seção, para uso em um site comum.
pdfPDFPortable Document Format

O formato de saída padrão pode variar de acordo com o documento, mas geralmente é html-split. Outros formatos são escolhidos definindo FORMATS para um valor específico. Múltiplos formatos de saída podem ser criados de uma só vez definindo FORMATS para uma lista de formatos.

Exemplo 5.1. Compilar um Arquivo Único HTML
% cd ~/doc/en_US.ISO8859-1/books/handbook
% make FORMATS=html

Exemplo 5.2. Compilar HTML-Split e PDF
% cd ~/doc/en_US.ISO8859-1/books/handbook
% make FORMATS="html-split pdf"

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