From e391092606ad7310cd22b97a24365e7e1dfd5489 Mon Sep 17 00:00:00 2001 From: Warren Block Date: Wed, 25 Jun 2014 14:19:46 +0000 Subject: [PATCH] Remove obsolete example build instructions. Update book and article examples for DocBook 5 and FreeBSD DTD. Note to translators: there are content whitespace changes in the example programlistings that should be included in translations. --- .../books/fdp-primer/examples/appendix.xml | 282 ++---------------- 1 file changed, 33 insertions(+), 249 deletions(-) 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 973c3b1348..250b14134a 100644 --- a/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml +++ b/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml @@ -33,45 +33,40 @@ Examples - 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 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 + documents available in the Subversion doc repository, or available online starting at http://svnweb.FreeBSD.org/doc/. - To avoid confusion, these examples use the standard DocBook - 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 &os; - Documentation Project. This makes them more useful as generic - DocBook examples. - DocBook <tag>book</tag> DocBook <tag>book</tag> - <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + <!DOCTYPE book PUBLIC "-//FreeBSD//DTD DocBook XML V5.0-Based Extension//EN" + "http://www.FreeBSD.org/XML/share/xml/freebsd50.dtd"> -book lang='en' - bookinfo +book xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" + xml:lang="en" + + info titleAn Example Booktitle author - firstnameYour first namefirstname - surnameYour surnamesurname + personname + firstnameYour first namefirstname + surnameYour surnamesurname + personname + affiliation - addressemailfoo@example.comemailaddress + address + emailfoo@example.comemail + address affiliation author @@ -83,7 +78,7 @@ abstract paraIf your book has an abstract then it should go here.para abstract - bookinfo + info preface titlePrefacetitle @@ -113,18 +108,26 @@ DocBook <tag>article</tag> - <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + <!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook XML V5.0-Based Extension//EN" + "http://www.FreeBSD.org/XML/share/xml/freebsd50.dtd"> -article lang='en' - articleinfo +article xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" + xml:lang="en" + + info titleAn Example Articletitle author - firstnameYour first namefirstname - surnameYour surnamesurname + personname + firstnameYour first namefirstname + surnameYour surnamesurname + personname + affiliation - addressemailfoo@example.comemailaddress + address + emailfoo@example.comemail + address affiliation author @@ -136,7 +139,7 @@ abstract paraIf your article has an abstract then it should go here.para abstract - articleinfo + info sect1 titleMy First Sectiontitle @@ -152,223 +155,4 @@ article - - - Producing Formatted Output - - Before using these examples, install the required tools as - shown in . - - - Using <application>Jade</application> - - - 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. The third contains information - specific to Jade. - - - - 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 another. In this case, the - input is being transformed 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 <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. - - - - 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 another. In this case, the - input is being transformed from the DocBook - DTD to the XHTML - DTD. - - - - Specifies the file that - Jade should process. 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 - XHTML file, depending on the structure of - the document you are processing, and the stylesheet's rules - for splitting output. - - - - Converting DocBook to &postscript; - - 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. - - - - 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 - - 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;. - - &prompt.user; dvips -o file.ps file.dvi - - - - Converting DocBook to <acronym>PDF</acronym> - - The first part of this process is identical to that of - converting DocBook to &postscript;, using the same - jade command line (). - - 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. - - -