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

# Capítulo 2 Ferramentas

O FDP utiliza diferentes ferramentas como auxílio no gerenciamento da documentação do FreeBSD, e na conversão para diferentes formatos, e assim por diante. Você irá precisar utilizar estas ferramentas se for trabalhar com a documentação do FreeBSD.

Todas estas ferramentas estão disponíveis como `Ports` e `Packages` do FreeBSD, simplificando enormemente o seu trabalho para instalá-las.

Você precisará instalar estas ferramentas antes de trabalhar com qualquer exemplo dos próximos capítulos. O uso real destas ferramentas será abordado nos próximos capítulos.

> Se possível use o `textproc/docproj`: Você pode economizar bastante tempo se instalar o `port` `textproc/docproj`. Este é 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 irá baixar e instalar automaticamente todos os pacotes listados como necessários neste 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. O TeX é um pacote grande, e ele somente será necessário se você quiser gerar documentos nos formatos 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 do TeX) quando o `port` for instalado. Conforme necessário, faça:

>     # make JADETEX=yes install

> ou

>     # make JADETEX=no install

> Alternativamente você pode instalar o `textproc/docproj-jadetex` ou o `textproc/docproj-nojadetex`. Estes `ports` secundários irão definir a variável `JADETEX` para você, consequentemente eles irão instalar o mesmo conjunto de aplicativos na sua máquina. Observe que você poderá produzir apenas documentos em HTML e ASCII se você não instalar o JadeTeX. Para produzir documentos em PostScript e PDF você irá precisar do TeX.

# 2.1 Ferramentas Obrigatórias

## 2.1.1 Software

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

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 estão armazenadas como arquivos EPS. Estas imagens precisam ser convertidas para o formato PNG antes de serem exibidas em um navegador `web`.

## 2.1.2 Entidades e DTDs

Estes são os conjuntos de DTDs e de entidades usados pelo FDP. Eles precisam estar instalados para que você possa trabalhar 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

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

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

  As `Modular DocBook Stylesheets` são usadas na conversão da documentação escrita em DocBook para outros formatos, tais como HTML ou RTF.

Anterior | Principal | Próxima
Início Rápido |  | Ferramentas Opcionais

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