From owner-svn-doc-all@FreeBSD.ORG Sun May 20 04:02:22 2012 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id 56BDF106564A; Sun, 20 May 2012 04:02:22 +0000 (UTC) (envelope-from wblock@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:4f8:fff6::2c]) by mx1.freebsd.org (Postfix) with ESMTP id 043928FC08; Sun, 20 May 2012 04:02:21 +0000 (UTC) Received: from svn.freebsd.org (localhost [127.0.0.1]) by svn.freebsd.org (8.14.4/8.14.4) with ESMTP id q4K42Ldh065315; Sun, 20 May 2012 04:02:21 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.4/8.14.4/Submit) id q4K42LPB065313; Sun, 20 May 2012 04:02:21 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201205200402.q4K42LPB065313@svn.freebsd.org> From: Warren Block Date: Sun, 20 May 2012 04:02:21 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Cc: Subject: svn commit: r38847 - head/en_US.ISO8859-1/books/fdp-primer/examples X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 20 May 2012 04:02:22 -0000 Author: wblock Date: Sun May 20 04:02:21 2012 New Revision: 38847 URL: http://svn.freebsd.org/changeset/doc/38847 Log: Whitespace-only fixes, mostly wrapping long lines. Translators, please ignore. Modified: head/en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml Modified: head/en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml Sun May 20 03:49:06 2012 (r38846) +++ head/en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml Sun May 20 04:02:21 2012 (r38847) @@ -33,24 +33,25 @@ Examples - This appendix contains example SGML 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. - - 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 SGML - source for this and other documents, available in the - svn doc repository, or - available online starting at + This appendix contains example SGML 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. + + 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 SGML 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 stock stylesheets - distributed by Norm Walsh, rather than any customizations made to those - stylesheets by the FreeBSD Documentation Project. This makes them more - useful as generic DocBook examples. + To avoid confusion, these examples use the standard DocBook + 4.1 DTD rather than the FreeBSD extension. They also use the + stock stylesheets distributed by Norm Walsh, rather than any + customizations made to those stylesheets by the FreeBSD + Documentation Project. This makes them more useful as generic + DocBook examples. DocBook <sgmltag>book</sgmltag> @@ -152,20 +153,21 @@ 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. + 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. Using Jade Converting DocBook to HTML (One Large File) - + &prompt.user; jade -V nochunks \ -c /usr/local/share/sgml/docbook/dsssl/modular/catalog \ -c /usr/local/share/sgml/docbook/catalog \ @@ -175,41 +177,48 @@ - Specifies the nochunks parameter to the - stylesheets, forcing all output to be written to - the standard output (using Norm Walsh's stylesheets). + 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 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. + 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 HTML DTD. + 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 HTML DTD. - Specifies the file that Jade should process, and redirects - output to the specified .html file. + Specifies the file that + Jade should process, and + redirects output to the specified + .html file. - Converting DocBook to HTML (Several Small Files) - + Converting DocBook to HTML (Several Small + Files) + &prompt.user; jade \ -c /usr/local/share/sgml/docbook/dsssl/modular/catalog \ -c /usr/local/share/sgml/docbook/catalog \ @@ -219,42 +228,48 @@ - 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 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. + 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 HTML DTD. + 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 HTML 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 document. + 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 + document. - This example may still only generate one HTML file, depending on - the structure of the document you are processing, and the - stylesheet's rules for splitting output. + This example may still only generate one HTML 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 SGML file must be converted to a &tex; file. + The source SGML file must be converted to a &tex; + file. &prompt.user; jade -V tex-backend \ -c /usr/local/share/sgml/docbook/dsssl/modular/catalog \ @@ -268,51 +283,56 @@ 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 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. + Jade will use when processing + the document. - Instructs Jade to convert the output to &tex;. + Instructs Jade to convert + the output to &tex;. - The generated .tex file must now be run - through tex, specifying the + 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 - 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. + 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. + 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 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. @@ -327,17 +347,18 @@ jade command line (). - When the .tex file has been generated you - run pdfTeX. However, use the &pdfjadetex macro package - instead. + When the .tex file has been + generated you 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. + file.pdf, + which does not need to be processed any further.