diff options
Diffstat (limited to 'doc/src/sgml/docguide.sgml')
| -rw-r--r-- | doc/src/sgml/docguide.sgml | 104 |
1 files changed, 78 insertions, 26 deletions
diff --git a/doc/src/sgml/docguide.sgml b/doc/src/sgml/docguide.sgml index 7b2bf52934..734ea73519 100644 --- a/doc/src/sgml/docguide.sgml +++ b/doc/src/sgml/docguide.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.36 2001/11/21 05:53:41 thomas Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.37 2001/12/08 03:24:22 thomas Exp $ --> <appendix id="docguide"> <title>Documentation</title> @@ -682,7 +682,7 @@ gmake man <para> The hardcopy Postscript documentation is generated by converting the <acronym>SGML</acronym> source code to <acronym>RTF</acronym>, then - importing into <productname>ApplixWare-4.4.1</productname>. + importing into <productname>ApplixWare</productname>. After a little cleanup (see the following section) the output is <quote>printed</quote> to a postscript file. </para> @@ -735,28 +735,35 @@ gmake man <step performance="required"> <para> Repair the RTF file to correctly specify all - styles, in particular the default style. The field can be added - using <application>vi</application> or the following small - <application>sed</application> procedure: + styles, in particular the default style. If the document + contains <sgmltag>REFENTRY</sgmltag> sections, one must also + replace formatting hints which tie a + <emphasis>preceeding</emphasis> paragraph to the current + paragraph, and instead tie the current paragraph to the + following one. A utility, <application>fixrtf</application> is + available in + <filename>doc/src/sgml</filename> to accomplish these repairs: + + <programlisting> +% cd doc/src/sgml +% fixrtf tutorial.rtf + </programlisting> - <programlisting> -#!/bin/sh -# fixrtf.sh -# Utility to repair slight damage in RTF files generated by jade -# Thomas Lockhart <lockhart@alumni.caltech.edu> -# -for i in $* ; do - mv $i $i.orig - cat $i.orig | sed 's#\\stylesheet#\\stylesheet{\\s0 Normal;}#' > $i -done - -exit - </programlisting> + or + + <programlisting> +% cd doc/src/sgml +% fixrtf --refentry reference.rtf + </programlisting> + </para> - where the script is adding <literal>{\s0 Normal;}</literal> as + <para> + The script adds <literal>{\s0 Normal;}</literal> as the zero-th style in the document. According to ApplixWare, the RTF standard would prohibit adding an implicit zero-th style, - though M$Word happens to handle this case. + though M$Word happens to handle this case. For repairing + <sgmltag>REFENTRY</sgmltag> sections, the script replaces + <literal>\keepn</literal> tags with <literal>\keep</literal>. </para> </step> @@ -822,10 +829,10 @@ exit <literal>TOC-Heading 1</literal> </entry> <entry> - <literal>0.6</literal> + <literal>0.4</literal> </entry> <entry> - <literal>0.6</literal> + <literal>0.4</literal> </entry> </row> @@ -834,10 +841,10 @@ exit <literal>TOC-Heading 2</literal> </entry> <entry> - <literal>1.0</literal> + <literal>0.8</literal> </entry> <entry> - <literal>1.0</literal> + <literal>0.8</literal> </entry> </row> @@ -846,10 +853,10 @@ exit <literal>TOC-Heading 3</literal> </entry> <entry> - <literal>1.4</literal> + <literal>1.2</literal> </entry> <entry> - <literal>1.4</literal> + <literal>1.2</literal> </entry> </row> </tbody> @@ -905,6 +912,8 @@ exit </para> </step> +<!-- +Later stylesheets seem to not need this adjustment - thomas 2001-11-29 <step performance="required"> <para> If a bibliography is present, remove the <firstterm>short @@ -914,6 +923,49 @@ exit information immediately following. </para> </step> +--> + + <step performance="optional"> + <para> + Delete the index section from the document if it is empty. + </para> + </step> + + <step performance="required"> + <para> + Regenerate and adjust the table of contents. + </para> + + <substeps> + <step> + <para> + Select the ToC field. + </para> + </step> + + <step> + <para> + Select + <literal>Tools->Book Building->Create Table of + Contents</literal>. + </para> + </step> + + <step> + <para> + Unbind the ToC by selecting + <literal>Tools->Field Editing->Unprotect</literal>. + </para> + </step> + + <step> + <para> + Delete the first line in the ToC, which is an entry for the + ToC itself. + </para> + </step> + </substeps> + </step> <step performance="required"> <para> |