From 068aaea8b5ac80809a1b860f63c625b3ea389ded Mon Sep 17 00:00:00 2001 From: Philip Hazel Date: Thu, 10 Nov 2005 12:30:13 +0000 Subject: [PATCH] First pass update for 4.60 documentation. --- doc/doc-docbook/AdMarkup.txt | 12 +- doc/doc-docbook/HowItWorks.txt | 9 +- doc/doc-docbook/Makefile | 34 +- doc/doc-docbook/MyAsciidoc.conf | 13 +- doc/doc-docbook/MyStyle-fo.xsl | 9 +- doc/doc-docbook/MyStyle-html.xsl | 55 +- doc/doc-docbook/MyStyle.xsl | 4 +- doc/doc-docbook/Pre-xml | 35 +- doc/doc-docbook/TidyHTML-filter | 18 +- doc/doc-docbook/TidyHTML-spec | 48 +- doc/doc-docbook/filter.ascd | 77 +- doc/doc-docbook/spec.ascd | 4113 ++++++++++++++++++++++-------- doc/doc-txt/OptionLists.txt | 5 +- 13 files changed, 3207 insertions(+), 1225 deletions(-) diff --git a/doc/doc-docbook/AdMarkup.txt b/doc/doc-docbook/AdMarkup.txt index 40942a629..4267f5544 100644 --- a/doc/doc-docbook/AdMarkup.txt +++ b/doc/doc-docbook/AdMarkup.txt @@ -1,4 +1,4 @@ -$Cambridge: exim/doc/doc-docbook/AdMarkup.txt,v 1.1 2005/06/16 10:32:31 ph10 Exp $ +$Cambridge: exim/doc/doc-docbook/AdMarkup.txt,v 1.2 2005/11/10 12:30:13 ph10 Exp $ Asciidoc markup used in the Exim documentation ---------------------------------------------- @@ -130,6 +130,8 @@ example: This is an AsciiDoc comment block. /// +You can also include one-line comments by starting the line with //. + URL REFERENCES @@ -185,7 +187,8 @@ asterisk or if any lines in the block end in a backslash (as is quite often the case in Exim configuration examples), you have to use a "listing block" or a "literal block" instead of a "literal paragraph". Otherwise an initial asterisk makes AsciiDoc think this is a list item, and a terminating backslash causes -lines to be concatenated. +lines to be concatenated. Also, a blank line in the block generates two output +items, so that case should also be avoided. Another time when you have to use an explicit block is when a display forms part of a list item. This is because you have to indent such displays more than @@ -404,8 +407,9 @@ insert [revisionflag="changed"] This should precede any index settings at the start of the paragraph. If you -want to do this for a display, you must use the "&&&" block described above, -because that's the only type that I have set up to support it. +want to do this for a display, you must use the "...." or "&&&" blocks +described above, because that's the only types that I have set up to support +it. FUDGES diff --git a/doc/doc-docbook/HowItWorks.txt b/doc/doc-docbook/HowItWorks.txt index 9be1466e2..849190986 100644 --- a/doc/doc-docbook/HowItWorks.txt +++ b/doc/doc-docbook/HowItWorks.txt @@ -1,4 +1,4 @@ -$Cambridge: exim/doc/doc-docbook/HowItWorks.txt,v 1.1 2005/06/16 10:32:31 ph10 Exp $ +$Cambridge: exim/doc/doc-docbook/HowItWorks.txt,v 1.2 2005/11/10 12:30:13 ph10 Exp $ CREATING THE EXIM DOCUMENTATION @@ -366,6 +366,13 @@ The index.html file as built by xmlto contains the whole table of contents in a single line, which makes is hard to debug by hand. Since I was postprocessing it anyway, I arranged to insert newlines after every '>' character. +The TidyHTML-spec script also processes every HTML file, to tidy up some of the +untidy features therein. It turns

into

and a matching

into
to get rid of +unwanted vertical white space in literallayout blocks. Before each occurrence +of it inserts   so that the table's cell is a little bit wider than +the text itself. + The TidyHTML-spec script also takes the opportunity to postprocess the spec.html/ix01.html file, which contains the document index. Again, the index is generated as one single line, so it splits it up. Then it creates a list of diff --git a/doc/doc-docbook/Makefile b/doc/doc-docbook/Makefile index 802f74085..60bf5ff9c 100644 --- a/doc/doc-docbook/Makefile +++ b/doc/doc-docbook/Makefile @@ -1,4 +1,4 @@ -# $Cambridge: exim/doc/doc-docbook/Makefile,v 1.1 2005/06/16 10:32:31 ph10 Exp $ +# $Cambridge: exim/doc/doc-docbook/Makefile,v 1.2 2005/11/10 12:30:13 ph10 Exp $ # Make file for Exim documentation from Asciidoc source. @@ -25,10 +25,10 @@ filter-fo.xml: filter.xml Pre-xml Pre-xml -bookinfo filter-fo.xml filter-html.xml: filter.xml Pre-xml - Pre-xml filter-html.xml + Pre-xml -html filter-html.xml filter-txt.xml: filter.xml Pre-xml - Pre-xml -ascii filter-txt.xml + Pre-xml -ascii -html filter-txt.xml filter.fo: filter-fo.xml MyStyle-filter-fo.xsl MyStyle-fo.xsl MyStyle.xsl /bin/rm -rf filter.fo filter-fo.fo @@ -36,16 +36,18 @@ filter.fo: filter-fo.xml MyStyle-filter-fo.xsl MyStyle-fo.xsl MyStyle.xsl /bin/mv -f filter-fo.fo filter.fo filter.ps: filter.fo - fop filter.fo -ps filter.ps + fop filter.fo -ps filter-tmp.ps + mv filter-tmp.ps filter.ps filter.pdf: filter.fo - fop filter.fo -pdf filter.pdf + fop filter.fo -pdf filter-tmp.pdf + mv filter-tmp.pdf filter.pdf filter.html: filter-html.xml TidyHTML-filter MyStyle-nochunk-html.xsl MyStyle-html.xsl MyStyle.xsl /bin/rm -rf filter.html filter-html.html xmlto -x MyStyle-nochunk-html.xsl html-nochunks filter-html.xml /bin/mv -f filter-html.html filter.html - ./TidyHTML-filter + ./TidyHTML-filter filter.txt: filter-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl MyStyle.xsl /bin/rm -rf filter-txt.html @@ -75,10 +77,10 @@ spec-fo.xml: spec.xml Pre-xml Pre-xml spec-fo.xml spec-html.xml: spec.xml Pre-xml - Pre-xml -abstract -oneindex spec-html.xml + Pre-xml -abstract -html -oneindex spec-html.xml spec-txt.xml: spec.xml Pre-xml - Pre-xml -abstract -ascii -noindex spec-txt.xml + Pre-xml -abstract -ascii -html -noindex spec-txt.xml spec.fo: spec-fo.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl MyTitleStyle.xsl /bin/rm -rf spec.fo spec-fo.fo @@ -86,10 +88,12 @@ spec.fo: spec-fo.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl MyTitle /bin/mv -f spec-fo.fo spec.fo spec.ps: spec.fo - FOP_OPTS=-Xmx512m fop spec.fo -ps spec.ps + FOP_OPTS=-Xmx512m fop spec.fo -ps spec-tmp.ps + mv spec-tmp.ps spec.ps spec.pdf: spec.fo - FOP_OPTS=-Xmx512m fop spec.fo -pdf spec.pdf + FOP_OPTS=-Xmx512m fop spec.fo -pdf spec-tmp.pdf + mv spec-tmp.pdf spec.pdf spec.html: spec-html.xml TidyHTML-spec MyStyle-chunk-html.xsl MyStyle-html.xsl MyStyle.xsl /bin/rm -rf spec.html @@ -126,10 +130,10 @@ test-fo.xml: test.xml Pre-xml ./Pre-xml test-fo.xml test-html.xml: test.xml Pre-xml - ./Pre-xml -abstract -oneindex test-html.xml + ./Pre-xml -abstract -html -oneindex test-html.xml test-txt.xml: test.xml Pre-xml - ./Pre-xml -abstract -ascii -noindex test-txt.xml + ./Pre-xml -abstract -ascii -html -noindex test-txt.xml test.fo: test-fo.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl MyTitleStyle.xsl /bin/rm -rf test.fo test-fo.fo @@ -137,10 +141,12 @@ test.fo: test-fo.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl MyTitle /bin/mv -f test-fo.fo test.fo test.ps: test.fo - fop test.fo -ps test.ps + fop test.fo -ps test-tmp.ps + mv test-tmp.ps test.ps test.pdf: test.fo - fop test.fo -pdf test.pdf + fop test.fo -pdf test-tmp.pdf + mv test-tmp.pdf test.pdf test.html: test-html.xml MyStyle-nochunk-html.xsl MyStyle-html.xsl MyStyle.xsl /bin/rm -rf test.html test-html.html diff --git a/doc/doc-docbook/MyAsciidoc.conf b/doc/doc-docbook/MyAsciidoc.conf index 4b09e5a6a..316e1676f 100644 --- a/doc/doc-docbook/MyAsciidoc.conf +++ b/doc/doc-docbook/MyAsciidoc.conf @@ -1,4 +1,4 @@ -# $Cambridge: exim/doc/doc-docbook/MyAsciidoc.conf,v 1.1 2005/06/16 10:32:31 ph10 Exp $ +# $Cambridge: exim/doc/doc-docbook/MyAsciidoc.conf,v 1.2 2005/11/10 12:30:13 ph10 Exp $ # Asciidoc configuration customization for creating the DocBook XML sources # of the Exim specification and the filter document. @@ -112,10 +112,17 @@ presubs=specialcharacters,quotes,replacements,macros,callouts # The template for my non-monospaced literal layout block [literallayoutblock] - +| + +# Replace the template for normal literal blocks so as to support the +# revisionflag feature. + +[literalblock] +{title} + | - +{title#} # Paragraph substitution - use rather than diff --git a/doc/doc-docbook/MyStyle-fo.xsl b/doc/doc-docbook/MyStyle-fo.xsl index bd0dd314c..3eb6c4595 100644 --- a/doc/doc-docbook/MyStyle-fo.xsl +++ b/doc/doc-docbook/MyStyle-fo.xsl @@ -1,4 +1,4 @@ - + - - - - - @@ -148,8 +143,6 @@ http://www.sagehill.net/docbookxsl/PrintHeaders.html - - + @@ -8,22 +8,6 @@ specific to HTML output. --> - - - - #F0F0E0 - 100% - 2 - 0 - - - - - - + + + + diff --git a/doc/doc-docbook/MyStyle.xsl b/doc/doc-docbook/MyStyle.xsl index a3e05cccb..78f1cdfe1 100644 --- a/doc/doc-docbook/MyStyle.xsl +++ b/doc/doc-docbook/MyStyle.xsl @@ -1,4 +1,4 @@ - + @@ -12,7 +12,7 @@ have happen in all forms of output. It is imported by all the drivers. --> -0pt +0pt