os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Whitespace-only fixes. Translators, please ignore.

Browse source
This commit is contained in:
Warren Block 2013-07-23 01:41:37 +00:00
parent 7460a702d2
commit b000255d60
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=42394
1 changed files with 62 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

109
en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml
View file

@ -34,23 +34,24 @@
<appendix id="examples">
<title>Examples</title>
<para>This appendix contains example <acronym>XML</acronym> files and the commands
to convert them from one output format to another. After
installing the Documentation Project tools (see <xref linkend="tools-required"/>),
these examples can be used directly.</para>
<para>This appendix contains example <acronym>XML</acronym> files
and the commands to convert them from one output format to
another. After installing the Documentation Project tools (see
<xref linkend="tools-required"/>), these examples can be used
directly.</para>
<para>These examples are not exhaustive&mdash;they do not contain
all the elements that might be desirable to use, particularly in a
document's front matter. For more examples of DocBook markup,
examine the <acronym>XML</acronym> source for this and other documents
available in the <application>svn</application>
examine the <acronym>XML</acronym> source for this and other
documents available in the <application>svn</application>
<literal>doc</literal> repository, or available online starting at
<ulink url="http://svnweb.FreeBSD.org/doc/"></ulink>.</para>
<para>To avoid confusion, these examples use the standard DocBook
4.1 <acronym>DTD</acronym> rather than the &os; extension. They also use the
stock stylesheets distributed by Norm Walsh, rather than any
customizations made to those stylesheets by the &os;
4.1 <acronym>DTD</acronym> rather than the &os; extension. They
also use the stock stylesheets distributed by Norm Walsh, rather
than any customizations made to those stylesheets by the &os;
Documentation Project. This makes them more useful as generic
DocBook examples.</para>
@ -156,13 +157,15 @@
<sect1 id="examples-formatted">
<title>Producing Formatted Output</title>
<para>Before using this examples, install the required tools as shown in <xref linkend="tools-required"/>.</para>
<para>Before using this examples, install the required tools as
shown in <xref linkend="tools-required"/>.</para>
<sect2>
<title>Using <application>Jade</application></title>
<example>
<title>Converting DocBook to <acronym>XHTML</acronym> (One Large File)</title>
<title>Converting DocBook to <acronym>XHTML</acronym> (One
Large File)</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"/>
@ -183,23 +186,27 @@
<para>Specifies the catalogs that
<application>Jade</application> will need to process.
Three catalogs are required. The first is a catalog
that contains information about the <acronym>DSSSL</acronym> stylesheets.
The second contains information about the DocBook <acronym>DTD</acronym>.
The third contains information specific to
<application>Jade</application>.</para>
that contains information about the
<acronym>DSSSL</acronym> stylesheets. The second
contains information about the DocBook
<acronym>DTD</acronym>. The third contains information
specific to <application>Jade</application>.</para>
</callout>
<callout arearefs="examples-co-jade-1-dsssl">
<para>Specifies the full path to the <acronym>DSSSL</acronym> stylesheet that
<para>Specifies the full path to the
<acronym>DSSSL</acronym> stylesheet that
<application>Jade</application> will use when processing
the document.</para>
</callout>
<callout arearefs="examples-co-jade-1-transform">
<para>Instructs <application>Jade</application> to perform
a <emphasis>transformation</emphasis> from one <acronym>DTD</acronym> to
another. In this case, the input is being transformed
from the DocBook <acronym>DTD</acronym> to the <acronym>XHTML</acronym> <acronym>DTD</acronym>.</para>
a <emphasis>transformation</emphasis> from one
<acronym>DTD</acronym> to another. In this case, the
input is being transformed from the DocBook
<acronym>DTD</acronym> to the <acronym>XHTML</acronym>
<acronym>DTD</acronym>.</para>
</callout>
<callout arearefs="examples-co-jade-1-filename">
@ -212,8 +219,8 @@
</example>
<example>
<title>Converting DocBook to <acronym>XHTML</acronym> (Several Small
Files)</title>
<title>Converting DocBook to <acronym>XHTML</acronym> (Several
Small Files)</title>
<screen>&prompt.user; <userinput>jade \
-c /usr/local/share/xml/docbook/dsssl/modular/catalog \ <co id="examples-co-jade-2-catalog"/>
@ -227,45 +234,50 @@
<para>Specifies the catalogs that
<application>Jade</application> will need to process.
Three catalogs are required. The first is a catalog
that contains information about the <acronym>DSSSL</acronym> stylesheets.
The second contains information about the DocBook <acronym>DTD</acronym>.
The third contains information specific to <application>Jade</application>.</para>
that contains information about the
<acronym>DSSSL</acronym> stylesheets. The second
contains information about the DocBook
<acronym>DTD</acronym>. The third contains information
specific to <application>Jade</application>.</para>
</callout>
<callout arearefs="examples-co-jade-2-dsssl">
<para>Specifies the full path to the <acronym>DSSSL</acronym> stylesheet that
<para>Specifies the full path to the
<acronym>DSSSL</acronym> stylesheet that
<application>Jade</application> will use when processing
the document.</para>
</callout>
<callout arearefs="examples-co-jade-2-transform">
<para>Instructs <application>Jade</application> to perform
a <emphasis>transformation</emphasis> from one <acronym>DTD</acronym> to
another. In this case, the input is being transformed
from the DocBook <acronym>DTD</acronym> to the <acronym>XHTML</acronym> <acronym>DTD</acronym>.</para>
a <emphasis>transformation</emphasis> from one
<acronym>DTD</acronym> to another. In this case, the
input is being transformed from the DocBook
<acronym>DTD</acronym> to the <acronym>XHTML</acronym>
<acronym>DTD</acronym>.</para>
</callout>
<callout arearefs="examples-co-jade-2-filename">
<para>Specifies the file that
<application>Jade</application> should process. The
stylesheets determine how the individual <acronym>XHTML</acronym> files will
be named, and the name of the <quote>root</quote> file,
the one that contains the start of the
document.</para>
stylesheets determine how the individual
<acronym>XHTML</acronym> files will be named, and the
name of the <quote>root</quote> file, the one that
contains the start of the document.</para>
</callout>
</calloutlist>
<para>This example may still only generate one <acronym>XHTML</acronym> file,
depending on the structure of the document you are
processing, and the stylesheet's rules for splitting
output.</para>
<para>This example may still only generate one
<acronym>XHTML</acronym> file, depending on the structure of
the document you are processing, and the stylesheet's rules
for splitting output.</para>
</example>
<example id="examples-docbook-postscript">
<title>Converting DocBook to &postscript;</title>
<para>The source <acronym>XML</acronym> file must be converted to a &tex;
file.</para>
<para>The source <acronym>XML</acronym> file must be converted
to a &tex; file.</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"/>
@ -284,13 +296,16 @@
<para>Specifies the catalogs that
<application>Jade</application> will need to process.
Three catalogs are required. The first is a catalog
that contains information about the <acronym>DSSSL</acronym> stylesheets.
The second contains information about the DocBook <acronym>DTD</acronym>.
The third contains information specific to <application>Jade</application>.</para>
that contains information about the
<acronym>DSSSL</acronym> stylesheets. The second
contains information about the DocBook
<acronym>DTD</acronym>. The third contains information
specific to <application>Jade</application>.</para>
</callout>
<callout arearefs="examples-co-jade-3-dsssl">
<para>Specifies the full path to the <acronym>DSSSL</acronym> stylesheet that
<para>Specifies the full path to the
<acronym>DSSSL</acronym> stylesheet that
<application>Jade</application> will use when processing
the document.</para>
</callout>
@ -307,11 +322,11 @@
<screen>&prompt.user; <userinput>tex "&amp;jadetex" <replaceable>file</replaceable>.tex</userinput></screen>
<para><command>tex</command> commands must be run <emphasis>at
least</emphasis> three times. The first run processes the
document, and determines areas of the document which are
referenced from other parts of the document, for use in
indexing, and so on.</para>
<para><command>tex</command> commands must be run
<emphasis>at least</emphasis> three times. The first run
processes the document, and determines areas of the document
which are referenced from other parts of the document, for
use in indexing, and so on.</para>
<para>Do not be alarmed if you see warning messages such as
<errorname>LaTeX Warning: Reference `136' on page 5