Capítulo 2. Ferramentas

Índice
2.1. Ferramentas Obrigatórias
2.2. Ferramentas Opcionais

O FDP usa diferentes ferramentas para auxiliar no gerenciamento da documentação do FreeBSD, e na conversão para diferentes formatos, e assim por diante. Você próprio precisará usar essas ferramentas se for trabalhar com a documentação.

Todas essas ferramentas estão disponíveis como Ports e Packages do FreeBSD, simplificando enormemente o trabalho a ser feito para instalá-las.

Você precisará instalar essas ferramentas antes de trabalhar com qualquer exemplo dos próximos capítulos. O uso real dessas ferramentas será coberto em capítulos posteriores.

Use textproc/docproj se possível: Você pode economizar bastante tempo se instalar o port textproc/docproj. Esse é um meta-port que por si só não contém nenhum programa. Ao invés disto, ele depende que já estejam instalados corretamente vários outros ports. O processo de instalação deverá automaticamente baixar e instalar todos os pacotes necessários listados nesse capítulo.

Um dos pacotes que você pode precisar é o conjunto de macros JadeTeX. No entanto, esse conjunto de macros requer que o Tex esteja instalado. Tex é um pacote grande, e ele somente será necessário se você quiser gerar saídas em formato Postscript ou PDF.

Para economizar seu tempo e espaço em disco você deve especificar se quer, ou não, a instalação do JadeTeX (e por consequência o TeX) quando o port for instalado. Conforme necessário, faça:

#
        make JADETEX=yes install
ou
# make JADETEX=no
          install

Observe que você poderá produzir apenas documentos em HTML e ASCII se você instalar as ferramentas utilizando JADETEX=no. Para produzir documentos em PostScript e PDF você irá precisar do TeX.

2.1. Ferramentas Obrigatórias

2.1.1. Software

Esses programas são necessários para você trabalhar com a documentação do FreeBSD, e permitirão a converterção da mesma para os formatos HTML, texto puro e RTF. Eles estão todos incluídos em textproc/docproj.

SP (textproc/sp)

Um conjunto de aplicações, incluindo um parser SGML de validação, e um normalizador SGML.

Jade (textproc/jade)

Uma implementação DSSSL. Utilizado para a conversão de documentos escritos com linguagem de marcas para outros formatos, incluindo HTML e TeX.

Tidy (www/tidy)

Um HTML 'pretty printer', utilizado para reformatar alguns dos HTMLs gerados automaticamente ficando mais fácil de entendê-los.

Links (www/links)

Um navegador WWW em modo texto que também converte arquivos HTML para texto puro.

peps (graphics/peps)

Parte da documentação inclui imagens, algumas delas sendo armazenadas como arquivos EPS. Essas imagens devem ser convertidas para PNG antes de algum navegador web apresentá-las.

2.1.2. Entidades e DTDs

Esses são os conjuntos de DTDs e entidade usados pelo FDP. Eles precisam estar instalados antes que você trabalhe com qualquer parte da documentação.

HTML DTD (textproc/html)

HTML é a linguagem de marcas escolhida para a World Wide Web, e é usada no web site do FreeBSD.

DocBook DTD (textproc/docbook)

DocBook é uma linguagem de marcas projetada para documentação técnica. Toda a documentação do FreeBSD está escrita em DocBook.

ISO 8879 entities (textproc/iso8879)

19 dos conjuntos de entidade de caracter ISO 8879:1986 utilizados por muitos DTDs. Inclui símbolos matemáticos nomeados, caracteres do conjunto de caracter 'Latin' (acentos, diacríticos e assim por diante), e símbolos Gregos.

2.1.3. Stylesheets

Stylesheets são usadas na conversão e formatação de documentos a serem apresentados na tela, impressos, e assim por diante.

Modular DocBook Stylesheets (textproc/dsssl-docbook-modular)

Modular DocBook Stylesheets são usados na conversão da documentação escrita com DocBook para outros formatos, tais como HTML ou RTF.

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