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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- Copyright (c) 2000 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: r38847
-->
<appendix id="examples">
<title>Exemplos</title>
<para>Este apêndice contém arquivos SGML de exemplo
e linhas de comando que você pode utilizar para
convertê-los de um formato para outro. Se você
instalou com sucesso as ferramentas do Projeto de
Documentação, então você será
capaz de utilizar estes exemplos imediatamente.</para>
<para>Estes exemplos não são exaustivos — eles
não contêm todos os elementos que você pode
utilizar, particularmente para a capa do seu documento. Para
maiores exemplos de marcação DocBook você
deve examinar o código SGML deste e de outros documentos,
disponíveis no repositório <literal>doc</literal>
do <application>svn</application>, ou disponíveis online
no endereço
<ulink url="http://svnweb.FreeBSD.org/doc/"></ulink>.
</para>
<para>Para evitar confusão, estes exemplos utilizam a
especificação DocBook 4.1 DTD sem nenhuma
extensão particular adicionada pelo FreeBSD. Eles
também utilizam as folhas de estilo padrões
distribuídas pelo Norm Walsh, sem nenhuma
customização feita nas mesmas pelo Projeto de
Documentação do FreeBSD. Isto os torna mais
úteis como exemplos genéricos de
marcação DocBook.</para>
<sect1 id="examples-docbook-book">
<title>DockBook <sgmltag>book</sgmltag></title>
<example>
<title>DocBook <sgmltag>book</sgmltag></title>
<programlisting><![CDATA[<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<book>
<bookinfo>
<title>Um exemplo de Livro</title>
<author>
<firstname>Seu nome</firstname>
<surname>Seu sobrenome</surname>
<affiliation>
<address><email>seuemail@example.com</email></address>
</affiliation>
</author>
<copyright>
<year>2000</year>
<holder>Texto de Copyright</holder>
</copyright>
<abstract>
<para>Se seu livro possui um sumário ele deve ser colocado aqui.</para>
</abstract>
</bookinfo>
<preface>
<title>Prefácio</title>
<para>Seu livro pode ter um prefácio, se este for o caso, ele deve
ser colocado aqui.</para>
</preface>
<chapter>
<title>Meu primeiro capítulo</title>
<para>Este é o primeiro capítulo do meu livro.</para>
<sect1>
<title>Minha primeira seção</title>
<para>Esta é a primeira seção do meu livro.</para>
</sect1>
</chapter>
</book>]]></programlisting>
</example>
</sect1>
<sect1 id="examples-docbook-article">
<title>DocBook <sgmltag>article</sgmltag></title>
<example>
<title>DocBook <sgmltag>article</sgmltag></title>
<programlisting><![CDATA[<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<article>
<articleinfo>
<title>Um exemplo de Artigo</title>
<author>
<firstname>Seu nome</firstname>
<surname>Seu sobrenome</surname>
<affiliation>
<address><email>seuemail@example.com</email></address>
</affiliation>
</author>
<copyright>
<year>2000</year>
<holder>Texto de Copyright</holder>
</copyright>
<abstract>
<para>Se o seu artigo possuir um sumário ele deve ser colocado aqui.</para>
</abstract>
</articleinfo>
<sect1>
<title>Minha primeira seção</title>
<para>Esta é a primeira seção do meu artigo.</para>
<sect2>
<title>Minha primeira subseção</title>
<para>Esta é a primeira subseção do meu artigo.</para>
</sect2>
</sect1>
</article>]]></programlisting>
</example>
</sect1>
<sect1 id="examples-formatted">
<title>Produzindo saídas formatadas</title>
<para>Esta seção assume que você já
instalou os softwares listados no port <filename
role="package">textproc/docproj</filename>, seja via meta-port
ou manualmente. Além disso, ela também assume
que os seus softwares estão instalados em
subdiretórios sob o <filename>/usr/local/</filename>,
e que os diretórios nos quais os binários foram
instalados, estão mapeados no seu <envar>PATH</envar>.
Ajuste os paths conforme a necessidade do seu sistema.</para>
<sect2>
<title>Usando o Jade</title>
<example>
<title>Convertendo de DocBook para HTML (em um único
grande arquivo)</title>
<screen>&prompt.user; <userinput>jade -V nochunks \ <co id="examples-co-jade-1-nochunks"/>
-c /usr/local/share/xml/docbook/dsssl/modular/catalog \ <co id="examples-co-jade-1-catalog"/>
-c /usr/local/share/xml/docbook/catalog \
-c /usr/local/share/xml/jade/catalog \
-d /usr/local/share/xml/docbook/dsssl/modular/html/docbook.dsl \<co id="examples-co-jade-1-dsssl"/>
-t sgml <co id="examples-co-jade-1-transform"/> <replaceable>file</replaceable>.xml > <replaceable>file</replaceable>.html <co id="examples-co-jade-1-filename"/></userinput></screen>
<calloutlist>
<callout arearefs="examples-co-jade-1-nochunks">
<para>Especifique o parâmetro <literal>nochunks
</literal> para as folhas de estilo, forçando
que todos os outputs sejam escritos para a saída
padrão (<abbrev>STDOUT</abbrev>) (utilizando as
folhas de estilo do Norm Walsh).</para>
</callout>
<callout arearefs="examples-co-jade-1-catalog">
<para>Especifique os catálogos que o
<application>Jade</application> terá que
processar. Três catálogos são
requeridos. O primeiro é o catálogo
que contém as informações sobre
as folhas de estilo DSSSL. O segundo contém
informações sobre o DTD DockBook. E
o terceiro contém informações
específicas para o
<application>Jade</application>.</para>
</callout>
<callout arearefs="examples-co-jade-1-dsssl">
<para>Especifique o caminho completo das folhas de estilo
DSSSL as quais o <application>Jade</application>
irá utilizar quando estiver processando o
documento.</para>
</callout>
<callout arearefs="examples-co-jade-1-transform">
<para>Instrua o <application>Jade</application> para
realizar uma <emphasis>transformação
</emphasis> de uma DTD para outra. Neste caso, a
entrada será transformada de um DTD DocBook
para um DTD HTML.</para> </callout>
<callout arearefs="examples-co-jade-1-filename">
<para>Especifique o arquivo que o
<application>Jade</application> deve processar, e
redirecione a saída para o arquivo
<filename>.html</filename> desejado.</para>
</callout>
</calloutlist>
</example>
<example>
<title>Convertendo de DocBook para HTML (vários
arquivos pequenos)</title>
<screen>&prompt.user; <userinput>jade \
-c /usr/local/share/xml/docbook/dsssl/modular/catalog \ <co id="examples-co-jade-2-catalog"/>
-c /usr/local/share/xml/docbook/catalog \
-c /usr/local/share/xml/jade/catalog \
-d /usr/local/share/xml/docbook/dsssl/modular/html/docbook.dsl \<co id="examples-co-jade-2-dsssl"/>
-t sgml <co id="examples-co-jade-2-transform"/> <replaceable>file</replaceable>.xml <co id="examples-co-jade-2-filename"/></userinput></screen>
<calloutlist>
<callout arearefs="examples-co-jade-2-catalog">
<para>Especifique os catálogos os quais o
<application>Jade</application> terá que
processar. Três catálogos são
requeridos. O primeiro é o catálogo
o qual contém as informações
sobre as folhas de estilo DSSSL. O segundo
contém informações sobre o DTD
DocBook. O terceiro contém
informações específicas para
o <application>Jade</application>.</para>
</callout>
<callout arearefs="examples-co-jade-2-dsssl">
<para>Especifique o caminho completo da folha de estilo
DSSSL a qual o <application>Jade</application>
irá utilizar quando estiver processando o
documento.</para>
</callout>
<callout arearefs="examples-co-jade-2-transform">
<para>Instrua o <application>Jade</application> para
realizar a <emphasis>transformação
</emphasis> de uma DTD para outra. Neste caso, a
entrada será transformada de um DTD DocBook
para um DTD HTML.</para>
</callout>
<callout arearefs="examples-co-jade-2-filename">
<para>Especifique o arquivo que o
<application>Jade</application> deve processar. A
folha de estilo determina como os arquivos HTML
individuais serão nomeados, inclusive o nome
do arquivo <quote>raiz</quote> (é o arquivo
que contém o inicio do documento).</para>
</callout>
</calloutlist>
<para>Este exemplo pode continuar gerando apenas um
único arquivo HTML, dependerá da estrutura
do documento que você estiver processando e das
regras da folha de estilo selecionada, para divisão
do output.</para>
</example>
<example id="examples-docbook-postscript">
<title>Convertendo de DocBook para Postscript</title>
<para>O arquivo fonte SGML precisa ser convertido para um
arquivo &tex;.</para>
<screen>&prompt.user; <userinput>jade -V tex-backend \ <co id="examples-co-jade-3-tex-backend"/>
-c /usr/local/share/xml/docbook/dsssl/modular/catalog \ <co id="examples-co-jade-3-catalog"/>
-c /usr/local/share/xml/docbook/catalog \
-c /usr/local/share/xml/jade/catalog \
-d /usr/local/share/xml/docbook/dsssl/modular/print/docbook.dsl \<co id="examples-co-jade-3-dsssl"/>
-t tex <co id="examples-co-jade-3-tex"/> <replaceable>file</replaceable>.xml</userinput></screen>
<calloutlist>
<callout arearefs="examples-co-jade-3-tex-backend">
<para>Customize as folhas de estilo para utilizar as
várias opções existentes,
específicas para a produção
de saídas &tex;.</para>
</callout>
<callout arearefs="examples-co-jade-3-catalog">
<para>Especifique os catálogos os quais o
<application>Jade</application> terá que
processar. Três catálogos são
requeridos. O primeiro é o catálogo o
qual contém as informações sobre
as folhas de estilo DSSSL. O segundo contém
informações sobre o DTD DocBook. O
terceiro contém informações
específicas para o Jade.</para>
</callout>
<callout arearefs="examples-co-jade-3-dsssl">
<para>Especifique o caminho completo da folha de estilo
DSSSL a qual o <application>Jade</application>
irá utilizar quando estiver processando o
documento.</para>
</callout>
<callout arearefs="examples-co-jade-3-tex">
<para>Instrua o <application>Jade</application> para
converter o output para &tex;.</para>
</callout>
</calloutlist>
<para>O arquivo <filename>.tex</filename> gerado, deve ser
agora processado pelo <command>tex</command>, especificando
o pacote de macros <literal>&jadetex</literal>.</para>
<screen>&prompt.user; <userinput>tex "&jadetex" <replaceable>file</replaceable>.tex</userinput></screen>
<para>Você tem que executar o <command>tex</command>
<emphasis>pelo menos</emphasis> três vezes. A
primeira execução irá processar o
documento, e determinar as áreas do documento que
são referenciadas a partir de outras partes do
documento, para uso na indexação, etc.</para>
<para>Não fique alarmado se você visualizar
mensagens de alertas tais como <errorname>LaTeX Warning:
Reference `136' on page 5 undefined on input
line 728.</errorname> neste momento.</para>
<para>A segunda execução reprocessa o documento
agora que certas peças de informação
são conhecidas (tais como o número de
páginas do documento). Isto permite indexar as
entradas e estabelecer as outras referências
cruzadas.</para>
<para>A terceira execução irá realizar
a limpeza final necessária no arquivo</para>
<para>O output deste estágio será um
<filename><replaceable>arquivo</replaceable>.dvi</filename>.
</para>
<para>Finalmente, execute o <command>dvips</command> para
converter o arquivo <filename>.dvi</filename> para o
formato Postscript.</para>
<screen>&prompt.user; <userinput>dvips -o <replaceable>file</replaceable>.ps <replaceable>file.dvi</replaceable></userinput></screen>
</example>
<example>
<title>Convertendo de DocBook para PDF</title>
<para>A primeira parte deste processo é idêntica ao
realizado quando se converte de DocBook para Postscript,
utilizando a mesma linha de comando para o
<command>jade</command>
(<xref linkend="examples-docbook-postscript"/>).</para>
<para>Quando o arquivo <filename>.tex</filename> já
tiver sido gerado, você deve executar o
<application>pdfTeX</application> utilizando o pacote de
macros <literal>&pdfjadetex</literal>.</para>
<screen>&prompt.user; <userinput>pdftex "&pdfjadetex" <replaceable>file</replaceable>.tex</userinput></screen>
<para>De novo, execute este comando três vezes.</para>
<para>Ele irá gerar um <filename><replaceable>arquivo
</replaceable>.pdf</filename>, o qual não necessita
de nenhum processamento adicional.</para>
</example>
</sect2>
</sect1>
</appendix>
|