1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved.
Redistribution and use in source (SGML DocBook) and 'compiled' forms
(SGML, HTML, PDF, PostScript, RTF and so forth) with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code (SGML DocBook) must retain the above
copyright notice, this list of conditions and the following
disclaimer as the first lines of this file unmodified.
2. Redistributions in compiled form (transformed to other DTDs,
converted to PDF, PostScript, RTF and other formats) must reproduce
the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials
provided with the distribution.
THIS DOCUMENTATION IS PROVIDED BY NIK CLAYTON "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL NIK CLAYTON BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
The FreeBSD Documentation Project
The FreeBSD Brazilian Portuguese Documentation Project
$FreeBSD$
Original revision: r38826
-->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="tools">
<title>Ferramentas</title>
<para>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;.</para>
<para>Todas estas ferramentas estão disponíveis como
<literal>Ports</literal> e <literal>Packages</literal> do FreeBSD,
simplificando enormemente o seu trabalho para
instalá-las.</para>
<para>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.</para>
<tip>
<title>Se possível use o <package>
textproc/docproj</package></title>
<para>Você pode economizar bastante tempo se instalar o
<literal>port</literal> <package>textproc/docproj</package>. Este é um
<emphasis>meta-port</emphasis> que por si só não
contém nenhum programa. Ao invés disto, ele
depende que já estejam instalados corretamente
vários outros <literal>ports</literal>. O processo de
instalação <emphasis>irá</emphasis>
baixar e instalar automaticamente todos os pacotes
listados como necessários neste capítulo.</para>
<para>Um dos pacotes que você pode precisar é o
conjunto de macros <application>JadeTeX</application>. 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>
<para>Para economizar seu tempo e espaço em disco
você deve especificar se quer, ou não, a
instalação do <application>JadeTeX</application>
(e por consequência do &tex;) quando o
<literal>port</literal> for instalado. Conforme
necessário, faça:</para>
<screen>&prompt.root;<userinput> make JADETEX=yes install</userinput></screen>
<para>ou</para>
<screen>&prompt.root;<userinput> make JADETEX=no install</userinput></screen>
<para>Alternativamente você pode instalar o
<package>textproc/docproj-jadetex</package> ou o
<package>textproc/docproj-nojadetex</package>.
Estes <literal>ports</literal> secundários irão
definir a variável <varname>JADETEX</varname> 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
<application>JadeTeX</application>. Para produzir documentos
em PostScript e PDF você irá precisar do &tex;.
</para>
</tip>
<sect1 xml:id="tools-mandatory">
<title>Ferramentas Obrigatórias</title>
<sect2>
<title>Software</title>
<para>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
<package>textproc/docproj</package>.</para>
<variablelist>
<varlistentry>
<term><application>Jade</application>
(<package>textproc/jade</package>)</term>
<listitem>
<para>Uma implementação DSSSL. Utilizado
para a conversão de documentos escritos com
linguagem de marcas para outros formatos, incluindo
HTML e &tex;.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><application>Tidy</application>
(<package>www/tidy</package>)</term>
<listitem>
<para>Um HTML <foreignphrase><quote>pretty printer</quote>
</foreignphrase>, utilizado para reformatar alguns dos
HTMLs gerados automaticamente ficando mais
fácil de entendê-los.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><application>Links</application>
(<package>www/links</package>)</term>
<listitem>
<para>Um navegador WWW em modo texto que também
converte arquivos HTML para texto puro.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><application>peps</application>
(<package>graphics/peps</package>)</term>
<listitem>
<para>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
<literal>web</literal>.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2>
<title>Entidades e DTDs</title>
<para>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.</para>
<variablelist>
<varlistentry>
<term>HTML DTD
(<package>textproc/html</package>)</term>
<listitem>
<para>HTML é a linguagem de marcas escolhida para a
<literal>World Wide Web</literal>, e é usada no
<literal>web site</literal> do FreeBSD.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>DocBook DTD
(<package>textproc/docbook</package>)
</term>
<listitem>
<para>DocBook é uma linguagem de marcas projetada
para documentação técnica. Toda a
documentação do FreeBSD está
escrita em DocBook.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ISO 8879 entities
(<package>textproc/iso8879</package>)
</term>
<listitem>
<para>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.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2>
<title>Stylesheets</title>
<para>As <literal>Stylesheets</literal> são usadas na
conversão e formatação de documentos
para serem apresentados na tela, impressos, e assim por
diante.</para>
<variablelist>
<varlistentry>
<term>Modular DocBook Stylesheets
(<package>textproc/dsssl-docbook-modular
</package>)</term>
<listitem>
<para>As <literal>Modular DocBook Stylesheets</literal>
são usadas na conversão da
documentação escrita em DocBook para
outros formatos, tais como HTML ou RTF.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
<sect1 xml:id="tools-optional">
<title>Ferramentas Opcionais</title>
<para>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.</para>
<sect2>
<title>Software</title>
<variablelist>
<varlistentry>
<term><application>JadeTeX</application> e
<application>teTeX</application>
(<package>print/jadetex</package> e
<package>print/teTeX</package>)</term>
<listitem>
<para>O <application>Jade</application> e o
<application>teTeX</application> são usados para
converter DocBook para os formatos DVI, Postscript, e
PDF. As macros do <application>JadeTeX</application>
são necessárias para estas
conversões.</para>
<para>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
<application>JadeTeX</application> e
<application>teTeX</application>. Isto pode resultar em
uma boa economia de tempo e espaço em disco,
já que o <application>teTeX</application>
possui tamanho de aproximadamente 30MB.</para>
<important>
<para>Se você decidir instalar o
<application>JadeTeX</application> e
<application>teTeX</application> então
será preciso configurar o
<application>teTeX</application> depois do
<application>JadeTeX</application> ter sido
instalado. O arquivo
<filename>print/jadetex/pkg-message</filename>
contém instruções detalhadas
sobre o que é preciso ser feito.</para>
</important>
</listitem>
</varlistentry>
<varlistentry>
<term><application>Emacs</application> ou
<application>XEmacs</application>
(<package>editors/emacs</package> ou
<package>editors/xemacs</package>)</term>
<listitem>
<para>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.</para>
<para>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.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Se alguém tiver sugestões sobre algum outro
<literal>software</literal> 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.</para>
</sect2>
</sect1>
</chapter>
|