diff --git a/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml b/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml index ee6b7e139e..00a21be9c4 100644 --- a/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml +++ b/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml @@ -1,368 +1,361 @@ Examples - This appendix contains example XML files and command lines - you can use to convert them from one output format to another. If - you have successfully installed the Documentation Project tools - then you should be able to use these examples directly. + This appendix contains example XML files and the commands + to convert them from one output format to another. After + installing the Documentation Project tools (see ), + these examples can be used directly. These examples are not exhaustive—they do not contain - all the elements you might want to use, particularly in your - document's front matter. For more examples of DocBook markup you - should examine the XML source for this and other documents, + all the elements that might be desirable to use, particularly in a + document's front matter. For more examples of DocBook markup, + examine the XML source for this and other documents available in the svn doc repository, or available online starting at . To avoid confusion, these examples use the standard DocBook - 4.1 DTD rather than the FreeBSD extension. They also use the + 4.1 DTD 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 FreeBSD + customizations made to those stylesheets by the &os; Documentation Project. This makes them more useful as generic DocBook examples. DocBook <sgmltag>book</sgmltag> DocBook <sgmltag>book</sgmltag> - + <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> - - - An Example Book +book lang='en' + bookinfo + titleAn Example Booktitle - - Your first name - Your surname - -
foo@example.com
- - + author + firstnameYour first namefirstname + surnameYour surnamesurname + affiliation + addressemailfoo@example.comemailaddress + affiliation + author - - 2000 - Copyright string here - + copyright + year2000year + holderCopyright string hereholder + copyright - - If your book has an abstract then it should go here. - - + abstract + paraIf your book has an abstract then it should go here.para + abstract + bookinfo - - Preface + preface + titlePrefacetitle - Your book may have a preface, in which case it should be placed - here. - + paraYour book may have a preface, in which case it should be placed + here.para + preface - - My First Chapter + chapter + titleMy First Chaptertitle - This is the first chapter in my book. + paraThis is the first chapter in my book.para - - My First Section + sect1 + titleMy First Sectiontitle - This is the first section in my book. - - -]]> + paraThis is the first section in my book.para + sect1 + chapter +book DocBook <sgmltag>article</sgmltag> DocBook <sgmltag>article</sgmltag> - + <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> -
- - An Example Article +article lang='en' + articleinfo + titleAn Example Articletitle - - Your first name - Your surname - -
foo@example.com
- - + author + firstnameYour first namefirstname + surnameYour surnamesurname + affiliation + addressemailfoo@example.comemailaddress + affiliation + author - - 2000 - Copyright string here - + copyright + year2000year + holderCopyright string hereholder + copyright - - If your article has an abstract then it should go here. - - + abstract + paraIf your article has an abstract then it should go here.para + abstract + articleinfo - - My First Section + sect1 + titleMy First Sectiontitle - This is the first section in my article. + paraThis is the first section in my article.para - - My First Sub-Section + sect2 + titleMy First Sub-Sectiontitle - This is the first sub-section in my article. - - -
]]> + paraThis is the first sub-section in my article.para + sect2 + sect1 +article Producing Formatted Output - This section assumes that you have installed the software - listed in the textproc/docproj port, either by - hand, or by using the port. Further, it is assumed that your - software is installed in subdirectories under - /usr/local/, and the directory where - binaries have been installed is in your PATH. - Adjust the paths as necessary for your system. + Before using this examples, install the required tools as shown in . - Using Jade + Using <application>Jade</application> - Converting DocBook to HTML (One Large File) + Converting DocBook to <acronym>XHTML</acronym> (One Large File) &prompt.user; jade -V nochunks \ -c /usr/local/share/xml/docbook/dsssl/modular/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 \ -t sgml file.xml > file.html Specifies the nochunks parameter to the stylesheets, forcing all output to be written to the standard output (using Norm Walsh's stylesheets). Specifies the catalogs that Jade will need to process. Three catalogs are required. The first is a catalog - that contains information about the DSSSL stylesheets. - The second contains information about the DocBook DTD. + that contains information about the DSSSL stylesheets. + The second contains information about the DocBook DTD. The third contains information specific to Jade. - Specifies the full path to the DSSSL stylesheet that + Specifies the full path to the DSSSL stylesheet that Jade will use when processing the document. Instructs Jade to perform - a transformation from one DTD to + a transformation from one DTD to another. In this case, the input is being transformed - from the DocBook DTD to the HTML DTD. + from the DocBook DTD to the XHTML DTD. Specifies the file that Jade should process, and redirects output to the specified .html file. - Converting DocBook to HTML (Several Small + <title>Converting DocBook to <acronym>XHTML</acronym> (Several Small Files) &prompt.user; jade \ -c /usr/local/share/xml/docbook/dsssl/modular/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 \ -t sgml file.xml Specifies the catalogs that Jade will need to process. Three catalogs are required. The first is a catalog - that contains information about the DSSSL stylesheets. - The second contains information about the DocBook DTD. - The third contains information specific to Jade. + that contains information about the DSSSL stylesheets. + The second contains information about the DocBook DTD. + The third contains information specific to Jade. - Specifies the full path to the DSSSL stylesheet that + Specifies the full path to the DSSSL stylesheet that Jade will use when processing the document. Instructs Jade to perform - a transformation from one DTD to + a transformation from one DTD to another. In this case, the input is being transformed - from the DocBook DTD to the HTML DTD. + from the DocBook DTD to the XHTML DTD. Specifies the file that Jade should process. The - stylesheets determine how the individual HTML files will - be named, and the name of the root file - (i.e., the one that contains the start of the + stylesheets determine how the individual XHTML files will + be named, and the name of the root file, + the one that contains the start of the document. - This example may still only generate one HTML file, + This example may still only generate one XHTML file, depending on the structure of the document you are processing, and the stylesheet's rules for splitting output. - Converting DocBook to Postscript + Converting DocBook to &postscript; - The source XML file must be converted to a &tex; + The source XML file must be converted to a &tex; file. &prompt.user; jade -V tex-backend \ -c /usr/local/share/xml/docbook/dsssl/modular/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 \ -t tex file.xml Customizes the stylesheets to use various options specific to producing output for &tex;. Specifies the catalogs that Jade will need to process. Three catalogs are required. The first is a catalog - that contains information about the DSSSL stylesheets. - The second contains information about the DocBook DTD. - The third contains information specific to Jade. + that contains information about the DSSSL stylesheets. + The second contains information about the DocBook DTD. + The third contains information specific to Jade. - Specifies the full path to the DSSSL stylesheet that + Specifies the full path to the DSSSL stylesheet that Jade will use when processing the document. Instructs Jade to convert the output to &tex;. The generated .tex file must now be run through tex, specifying the &jadetex macro package. &prompt.user; tex "&jadetex" file.tex - You have to run tex at + tex commands must be run at least 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. Do not be alarmed if you see warning messages such as LaTeX Warning: Reference `136' on page 5 undefined on input line 728. at this point. The second run reprocesses the document now that certain pieces of information are known (such as the document's page length). This allows index entries and other cross-references to be fixed up. The third pass performs any final cleanup necessary. The output from this stage will be file.dvi. Finally, run dvips to convert the - .dvi file to Postscript. + .dvi file to &postscript;. &prompt.user; dvips -o file.ps file.dvi - Converting DocBook to PDF + Converting DocBook to <acronym>PDF</acronym> - The first part of this process is identical to that when - converting DocBook to Postscript, using the same + The first part of this process is identical to that of + converting DocBook to &postscript;, using the same jade command line (). - When the .tex file has been - generated you run pdfTeX. + After the .tex file has been + generated, run pdfTeX. However, use the &pdfjadetex macro package instead. &prompt.user; pdftex "&pdfjadetex" file.tex Again, run this command three times. This will generate file.pdf, which does not need to be processed any further.