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 &os;.
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:
&prompt.root; make JADETEX=yes install
ou
&prompt.root; 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;.
Ferramentas Obrigatórias
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.
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.
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.
Ferramentas Opcionais
Você não precisa ter qualquer uma das
ferramentas a seguir instaladas. Entretanto, você
poderá achar mais fácil trabalhar com a
documentação se elas estiverem disponíveis,
elas também oferecem uma maior flexibilidade em
relação aos formatos nos quais os documentos podem
ser gerados.
Software
JadeTeX e
teTeX
(print/jadetex e
print/teTeX)
O Jade e o
teTeX são usados para
converter DocBook para os formatos DVI, Postscript, e
PDF. As macros do JadeTeX
são necessárias para estas
conversões.
Se você não pretende converter seus
documentos para um destes formatos (i.e., HTML, texto
puro, e RTF são o suficiente) então
não será preciso instalar o
JadeTeX e
teTeX. Isto pode resultar em
uma boa economia de tempo e espaço em disco,
já que o teTeX
possui tamanho de aproximadamente 30MB.
Se você decidir instalar o
JadeTeX e
teTeX então
será preciso configurar o
teTeX depois do
JadeTeX ter sido
instalado. O arquivo
print/jadetex/pkg-message
contém instruções detalhadas
sobre o que é preciso ser feito.
Emacs ou
XEmacs
(editors/emacs ou
editors/xemacs)
Ambos editores incluem um modo especial para a
edição de documentos com uma linguagem de
marcas que siga um SGML DTD. Esse modo inclui comandos
para reduzir o volume total de digitação a
ser feita, o que ajuda a reduzir a possibilidade de
erros.
Você não precisa utilizá-los,
qualquer editor pode ser usado para editar documentos
escritos com linguagem de marcas. Entretanto,
se optar por usá-los você poderá
constatar que eles tornam seu trabalho
mais eficiente.
Se alguém tiver sugestões sobre algum outro
software que seja útil para a
manipulação de documentos SGML, por favor
informe a &a.doceng;, desta forma ele poderá ser
adicionado a esta lista.