From owner-svn-doc-head@FreeBSD.ORG Tue Jul 23 01:35:21 2013 Return-Path: Delivered-To: svn-doc-head@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by hub.freebsd.org (Postfix) with ESMTP id 0F600C63; Tue, 23 Jul 2013 01:35:21 +0000 (UTC) (envelope-from wblock@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.freebsd.org (Postfix) with ESMTPS id E41902E66; Tue, 23 Jul 2013 01:35:20 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id r6N1ZKw9001899; Tue, 23 Jul 2013 01:35:20 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.7/8.14.5/Submit) id r6N1ZKNc001898; Tue, 23 Jul 2013 01:35:20 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201307230135.r6N1ZKNc001898@svn.freebsd.org> From: Warren Block Date: Tue, 23 Jul 2013 01:35:20 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42393 - head/en_US.ISO8859-1/books/fdp-primer/examples X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 23 Jul 2013 01:35:21 -0000 Author: wblock Date: Tue Jul 23 01:35:20 2013 New Revision: 42393 URL: http://svnweb.freebsd.org/changeset/doc/42393 Log: First pass through the examples appendix, updating, simplifying, and changing CDATA sections to sgmltag. Modified: head/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml Tue Jul 23 00:45:09 2013 (r42392) +++ head/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml Tue Jul 23 01:35:20 2013 (r42393) @@ -34,23 +34,23 @@ 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. @@ -60,50 +60,50 @@ 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 - - - Your first name - Your surname - -
foo@example.com
- - - - - 2000 - Copyright string here - - - - If your book has an abstract then it should go here. - - - - - Preface - - Your book may have a preface, in which case it should be placed - here. - - - - My First Chapter - - This is the first chapter in my book. - - - My First Section - - This is the first section in my book. - - -]]> +book lang='en' + bookinfo + titleAn Example Booktitle + + author + firstnameYour first namefirstname + surnameYour surnamesurname + affiliation + addressemailfoo@example.comemailaddress + affiliation + author + + copyright + year2000year + holderCopyright string hereholder + copyright + + abstract + paraIf your book has an abstract then it should go here.para + abstract + bookinfo + + preface + titlePrefacetitle + + paraYour book may have a preface, in which case it should be placed + here.para + preface + + chapter + titleMy First Chaptertitle + + paraThis is the first chapter in my book.para + + sect1 + titleMy First Sectiontitle + + paraThis is the first section in my book.para + sect1 + chapter +book @@ -113,63 +113,56 @@ 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 - - - Your first name - Your surname - -
foo@example.com
- - - - - 2000 - Copyright string here - - - - If your article has an abstract then it should go here. - - - - - My First Section - - This is the first section in my article. - - - My First Sub-Section - - This is the first sub-section in my article. - - -
]]> +article lang='en' + articleinfo + titleAn Example Articletitle + + author + firstnameYour first namefirstname + surnameYour surnamesurname + affiliation + addressemailfoo@example.comemailaddress + affiliation + author + + copyright + year2000year + holderCopyright string hereholder + copyright + + abstract + paraIf your article has an abstract then it should go here.para + abstract + articleinfo + + sect1 + titleMy First Sectiontitle + + paraThis is the first section in my article.para + + sect2 + titleMy First Sub-Sectiontitle + + 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 \ @@ -190,23 +183,23 @@ 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. @@ -219,7 +212,7 @@ - Converting DocBook to HTML (Several Small + <title>Converting DocBook to <acronym>XHTML</acronym> (Several Small Files) &prompt.user; jade \ @@ -234,44 +227,44 @@ 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 \ @@ -291,13 +284,13 @@ 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. @@ -314,7 +307,7 @@ &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 @@ -337,21 +330,21 @@ 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.