Use xmlto; add to 'clean' target.

[exim.git] / doc / doc-docbook / Makefile

diff --git a/doc/doc-docbook/Makefile b/doc/doc-docbook/Makefile
index c2e5593b1d7e57849e79898a35374a7435ae14cf..334e490d5c7147f089191703497c1d540f4f001c 100644 (file)
--- a/doc/doc-docbook/Makefile
+++ b/doc/doc-docbook/Makefile
@@ -1,126 +1,208 @@
-# $Cambridge: exim/doc/doc-docbook/Makefile,v 1.3 2005/11/15 16:10:50 ph10 Exp $
-
-# Make file for Exim documentation from Asciidoc source.
+# Make file for Exim documentation from xfpt source.

 
 notarget:;    @echo "** You must specify a target, in the form x.y, where x is 'filter', 'spec',"
              @echo "** or 'test', and y is 'xml', 'fo', 'ps', 'pdf', 'html', 'txt', or 'info'."
              @echo "** One other possible target is 'exim.8'".
              exit 1
 
 
 notarget:;    @echo "** You must specify a target, in the form x.y, where x is 'filter', 'spec',"
              @echo "** or 'test', and y is 'xml', 'fo', 'ps', 'pdf', 'html', 'txt', or 'info'."
              @echo "** One other possible target is 'exim.8'".
              exit 1
 

+############################# EVERYTHING ###############################
+#
+# Generate all the documentation files...
+#
+## removed info files as I cannot generate them -  spec.info filter.info
+## removed html files as superceded by new website code
+everything:            spec.pdf        spec.ps         spec.txt        spec.epub \
+                               filter.pdf      filter.ps       filter.txt      filter.epub \
+                               exim.8

 
 ############################## MAN PAGE ################################
 
 
 ############################## MAN PAGE ################################
 

-exim.8: spec.xml
+exim.8:       spec.xml x2man

              ./x2man
 
 ########################################################################
 
              ./x2man
 
 ########################################################################
 

+.PHONY: local_params
+local_params:
+       echo .macro version > $@
+       echo $(EXIM_VER)        >> $@
+       echo .endmacro          >> $@
+       echo .macro fulldate    >> $@
+       date "+%d %b %Y"        >> $@
+       echo .endmacro          >> $@
+       echo .macro year        >> $@
+       date "+%Y"              >> $@
+       echo .endmacro          >> $@
+

 
 ############################### FILTER #################################
 
 
 ############################### FILTER #################################
 

-filter.xml:   filter.ascd MyAsciidoc.conf
-             asciidoc -d book -b docbook -f MyAsciidoc.conf filter.ascd
+filter.xml:      local_params filter.xfpt
+                xfpt filter.xfpt
+
+filter-pr.xml:   filter.xml Pre-xml
+                ./Pre-xml -bookinfo <filter.xml >filter-pr.xml
+
+filter-txt.xml:  filter.xml Pre-xml
+                ./Pre-xml -ascii -html -quoteliteral <filter.xml >filter-txt.xml
+
+filter-info.xml: filter.xml Pre-xml
+                ./Pre-xml -ascii -html <filter.xml >filter-info.xml
+
+filter-epub.xml: filter.xml Pre-xml
+                ./Pre-xml -epub <filter.xml >filter-epub.xml
+
+filter.fo:       filter-pr.xml MyStyle-filter-fo.xsl MyStyle-fo.xsl MyStyle.xsl
+                /bin/rm -rf filter.fo filter-pr.fo
+                xmlto -x MyStyle-filter-fo.xsl fo filter-pr.xml
+                /bin/mv -f filter-pr.fo filter.fo
+
+# Do not use pdf2ps from the PDF version; better PS is generated directly.
+
+###
+### PS/PDF generation using fop
+###
+
+fop-filter.ps:   filter.fo
+                fop filter.fo -ps filter-tmp.ps
+                mv filter-tmp.ps filter.ps

 
 

-filter-fo.xml: filter.xml Pre-xml
-             Pre-xml -bookinfo <filter.xml >filter-fo.xml
+# Do not use ps2pdf from the PS version; better PDF is generated directly. It
+# contains cross links etc.

 
 

-filter-html.xml: filter.xml Pre-xml
-             Pre-xml -html <filter.xml >filter-html.xml
+fop-filter.pdf:  filter.fo PageLabelPDF
+                fop filter.fo -pdf filter-tmp.pdf
+                ./PageLabelPDF 2 <filter-tmp.pdf >filter.pdf

 
 

-filter-txt.xml: filter.xml Pre-xml
-             Pre-xml -ascii -html <filter.xml >filter-txt.xml
+###
+### PS/PDF generation using SDoP
+###

 
 

-filter.fo:    filter-fo.xml MyStyle-filter-fo.xsl MyStyle-fo.xsl MyStyle.xsl
-             /bin/rm -rf filter.fo filter-fo.fo
-             xmlto -x MyStyle-filter-fo.xsl fo filter-fo.xml
-             /bin/mv -f filter-fo.fo filter.fo
+sdop-filter.ps:  filter-pr.xml
+                sdop -o filter.ps filter-pr.xml

 
 

-filter.ps:    filter.fo
-             fop filter.fo -ps filter-tmp.ps
-             mv filter-tmp.ps filter.ps
+sdop-filter.pdf: filter.ps
+                ps2pdf filter.ps filter.pdf

 
 

-#filter.pdf:   filter.fo
-#             fop filter.fo -pdf filter-tmp.pdf
-#             mv filter-tmp.pdf filter.pdf
+###
+### PS/PDF default setting
+###

 
 

-filter.pdf:   filter.ps
-             ps2pdf filter.ps filter.pdf
+filter.ps:  sdop-filter.ps

 
 

-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
+filter.pdf: sdop-filter.pdf

 
 

-filter.txt:   filter-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl MyStyle.xsl
+###
+###
+
+filter.txt:   filter-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \
+                MyStyle.xsl

              /bin/rm -rf filter-txt.html
              xmlto -x MyStyle-txt-html.xsl html-nochunks filter-txt.xml
              /bin/rm -rf filter-txt.html
              xmlto -x MyStyle-txt-html.xsl html-nochunks filter-txt.xml

-             w3m -dump filter-txt.html >filter.txt
+             w3m -dump filter-txt.html | ./Tidytxt >filter.txt
+             ./SanityTestText filter.txt

 
 # I have not found a way of making docbook2texi write its output anywhere
 # other than the file name that it makes up. The --to-stdout option does not
 # work.
 
 
 # I have not found a way of making docbook2texi write its output anywhere
 # other than the file name that it makes up. The --to-stdout option does not
 # work.
 

-filter.info:  filter-txt.xml
-             docbook2texi filter-txt.xml
+filter.info:  filter-info.xml
+             docbook2texi filter-info.xml

              perl -ne 's/conceptindex/cindex/;s/optionindex/findex/;print;' \
              perl -ne 's/conceptindex/cindex/;s/optionindex/findex/;print;' \

-               <exim_filtering.texi | Tidytxt >filter.texinfo
+               <exim_filtering.texi | ./Tidytxt >filter.texinfo

              /bin/rm -rf exim_filtering.texi
              makeinfo -o filter.info filter.texinfo
 
              /bin/rm -rf exim_filtering.texi
              makeinfo -o filter.info filter.texinfo
 

+filter.epub:   filter-epub.xml
+       xmlto epub filter-epub.xml
+       mv filter-epub.epub filter.epub
+

 ########################################################################
 
 
 ################################ SPEC ##################################
 
 ########################################################################
 
 
 ################################ SPEC ##################################
 

-spec.xml:     spec.ascd MyAsciidoc.conf
-             asciidoc -d book -b docbook -f MyAsciidoc.conf spec.ascd
+spec.xml:      local_params spec.xfpt
+              xfpt spec.xfpt
+
+spec-pr.xml:   spec.xml Pre-xml
+              ./Pre-xml -optbreak <spec.xml >spec-pr.xml
+
+spec-txt.xml:  spec.xml Pre-xml
+              ./Pre-xml -ascii -html -noindex -quoteliteral \
+                <spec.xml >spec-txt.xml
+
+spec-info.xml: spec.xml Pre-xml
+              ./Pre-xml -ascii -html -noindex <spec.xml >spec-info.xml

 
 

-spec-fo.xml:  spec.xml Pre-xml
-             Pre-xml <spec.xml >spec-fo.xml
+spec-epub.xml: spec.xml Pre-xml
+                ./Pre-xml -epub <spec.xml >spec-epub.xml

 
 

-spec-html.xml: spec.xml Pre-xml
-             Pre-xml -abstract -html -oneindex <spec.xml >spec-html.xml
+spec.fo:       spec-pr.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl \
+               MyTitleStyle.xsl
+              /bin/rm -rf spec.fo spec-pr.fo
+              xmlto -x MyStyle-spec-fo.xsl fo spec-pr.xml
+              /bin/mv -f spec-pr.fo spec.fo

 
 

-spec-txt.xml: spec.xml Pre-xml
-             Pre-xml -abstract -ascii -html -noindex <spec.xml >spec-txt.xml
+###
+### PS/PDF generation using fop
+###

 
 

-spec.fo:      spec-fo.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl MyTitleStyle.xsl
-             /bin/rm -rf spec.fo spec-fo.fo
-             xmlto -x MyStyle-spec-fo.xsl fo spec-fo.xml
-             /bin/mv -f spec-fo.fo spec.fo
+# Do not use pdf2ps from the PDF version; better PS is generated directly.

 
 

-spec.ps:      spec.fo
+fop-spec.ps:  spec.fo

              FOP_OPTS=-Xmx512m fop spec.fo -ps spec-tmp.ps
              mv spec-tmp.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-tmp.pdf
-#             mv spec-tmp.pdf spec.pdf
+# Do not use ps2pdf from the PS version; better PDF is generated directly. It
+# contains cross links etc. We post-process it to add page label information
+# so that the page identifiers shown by acroread are the correct page numbers.
+
+fop-spec.pdf: spec.fo PageLabelPDF
+             FOP_OPTS=-Xmx512m fop spec.fo -pdf spec-tmp.pdf
+             ./PageLabelPDF 12 <spec-tmp.pdf >spec.pdf
+
+###
+### PS/PDF generation using SDoP
+###
+
+sdop-spec.ps:  spec-pr.xml
+              sdop -o spec.ps spec-pr.xml
+
+sdop-spec.pdf: spec.ps
+              ps2pdf spec.ps spec.pdf
+
+###
+### PS/PDF default setting
+###

 
 

-spec.pdf:     spec.ps
-             ps2pdf spec.ps spec.pdf
+spec.ps:  sdop-spec.ps

 
 

-spec.html:    spec-html.xml TidyHTML-spec MyStyle-chunk-html.xsl MyStyle-html.xsl MyStyle.xsl
-             /bin/rm -rf spec.html
-             xmlto -x MyStyle-chunk-html.xsl -o spec.html html spec-html.xml
-             ./TidyHTML-spec
+spec.pdf: sdop-spec.pdf

 
 

-spec.txt:     spec-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl MyStyle.xsl
+###
+###
+
+spec.txt:     spec-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \
+                MyStyle.xsl

              /bin/rm -rf spec-txt.html
              xmlto -x MyStyle-txt-html.xsl html-nochunks spec-txt.xml
              /bin/rm -rf spec-txt.html
              xmlto -x MyStyle-txt-html.xsl html-nochunks spec-txt.xml

-             w3m -dump spec-txt.html | Tidytxt >spec.txt
+             w3m -dump spec-txt.html | ./Tidytxt >spec.txt
+             ./SanityTestText spec.txt

 
 # I have not found a way of making docbook2texi write its output anywhere
 # other than the file name that it makes up. The --to-stdout option does not
 # work.
 
 
 # I have not found a way of making docbook2texi write its output anywhere
 # other than the file name that it makes up. The --to-stdout option does not
 # work.
 

-spec.info:    spec-txt.xml
-             docbook2texi spec-txt.xml
-             perl -ne 's/conceptindex/cindex/;s/optionindex/findex/;print;' \
-               <the_exim_mta.texi >spec.texinfo
+spec.info:    spec-info.xml
+             docbook2texi spec-info.xml
+             ./TidyInfo <the_exim_mta.texi >spec.texinfo

              /bin/rm -rf the_exim_mta.texi
              /bin/rm -rf the_exim_mta.texi

-             makeinfo -o spec.info spec.texinfo
+             makeinfo -o spec.info --no-split spec.texinfo
+
+spec.epub:   spec-epub.xml
+       xmlto epub spec-epub.xml
+       mv spec-epub.epub spec.epub

 
 ########################################################################
 
 
 ########################################################################
 


@@ -129,40 +211,69 @@ spec.info:    spec-txt.xml
 
 # These targets (similar to the above)  are for running little tests.
 
 
 # These targets (similar to the above)  are for running little tests.
 

-test.xml:     test.ascd MyAsciidoc.conf
-             asciidoc -d book -b docbook -f MyAsciidoc.conf test.ascd
+test.xml:     test.xfpt
+             xfpt test.xfpt

 
 

-test-fo.xml:  test.xml Pre-xml
-             ./Pre-xml <test.xml >test-fo.xml
+test-pr.xml:  test.xml Pre-xml
+             ./Pre-xml <test.xml >test-pr.xml

 
 test-html.xml: test.xml Pre-xml
 
 test-html.xml: test.xml Pre-xml

-             ./Pre-xml -abstract -html -oneindex <test.xml >test-html.xml
+             ./Pre-xml -html -oneindex <test.xml >test-html.xml

 
 test-txt.xml: test.xml Pre-xml
 
 test-txt.xml: test.xml Pre-xml

-             ./Pre-xml -abstract -ascii -html -noindex <test.xml >test-txt.xml
+             ./Pre-xml -ascii -html -noindex -quoteinfo \
+               <test.xml >test-txt.xml
+
+test-info.xml: test.xml Pre-xml
+             ./Pre-xml -ascii -html -noindex <test.xml >test-info.xml
+
+test.fo:      test-pr.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl \
+                MyTitleStyle.xsl
+             /bin/rm -rf test.fo test-pr.fo
+             xmlto -x MyStyle-spec-fo.xsl fo test-pr.xml
+             /bin/mv -f test-pr.fo test.fo

 
 

-test.fo:      test-fo.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl MyTitleStyle.xsl
-             /bin/rm -rf test.fo test-fo.fo
-             xmlto -x MyStyle-spec-fo.xsl fo test-fo.xml
-             /bin/mv -f test-fo.fo test.fo
+###
+### PS/PDF generation using fop
+###

 
 

-test.ps:      test.fo
+# Do not use pdf2ps from the PDF version; better PS is generated directly.
+
+fop-test.ps:  test.fo

              fop test.fo -ps test-tmp.ps
              mv test-tmp.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-tmp.pdf
-#             mv test-tmp.pdf test.pdf
+# Do not use ps2pdf from the PS version; better PDF is generated directly. It
+# contains cross links etc.
+
+fop-test.pdf: test.fo
+             fop test.fo -pdf test-tmp.pdf
+             mv test-tmp.pdf test.pdf
+
+###
+### PS/PDF generation using SDoP
+###
+
+sdop-test.ps:  test-pr.xml
+              sdop -o test.ps test-pr.xml
+
+sdop-test.pdf: test.ps
+              ps2pdf test.ps test.pdf

 
 

-test.pdf:     test.ps
-             ps2pdf test.ps test.pdf
+###
+### PS/PDF default setting
+###

 
 

-test.html:    test-html.xml MyStyle-nochunk-html.xsl MyStyle-html.xsl MyStyle.xsl
-             /bin/rm -rf test.html test-html.html
-             xmlto -x MyStyle-nochunk-html.xsl html-nochunks test-html.xml
-             /bin/mv -f test-html.html test.html
+test.ps:  sdop-test.ps

 
 

-test.txt:     test-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl MyStyle.xsl
+test.pdf: sdop-test.pdf
+
+###
+###
+
+
+test.txt:     test-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \
+                MyStyle.xsl

              /bin/rm -rf test-txt.html
              xmlto -x MyStyle-txt-html.xsl html-nochunks test-txt.xml
              w3m -dump test-txt.html | Tidytxt >test.txt
              /bin/rm -rf test-txt.html
              xmlto -x MyStyle-txt-html.xsl html-nochunks test-txt.xml
              w3m -dump test-txt.html | Tidytxt >test.txt


@@ -171,22 +282,36 @@ test.txt:     test-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl MyStyle
 # other than the file name that it makes up. The --to-stdout option does not
 # work.
 
 # other than the file name that it makes up. The --to-stdout option does not
 # work.
 

-test.info:    test-txt.xml
-             docbook2texi test-txt.xml
-             perl -ne 's/conceptindex/cindex/;s/optionindex/findex/;print;' \
-               <short_title.texi >test.texinfo
+test.info:    test-info.xml
+             docbook2texi test-info.xml
+             ./TidyInfo <short_title.texi >test.texinfo

              /bin/rm -rf short_title.texi
              makeinfo -o test.info test.texinfo
 
 ########################################################################
 
 
              /bin/rm -rf short_title.texi
              makeinfo -o test.info test.texinfo
 
 ########################################################################
 
 

+############################## OS FIXUP ################################
+
+# Yes, we've advanced so far in text processing that we now have to
+# hardcode in complete paths and so become dependent upon exactly where
+# files were installed for xsl:import.  Which of course varies by OS.
+
+os-fixup:
+       ./OS-Fixups
+
+########################################################################
+
+

 ################################ CLEAN #################################
 
 clean:; /bin/rm -rf exim.8 \
              filter*.xml spec*.xml test*.xml \
 ################################ CLEAN #################################
 
 clean:; /bin/rm -rf exim.8 \
              filter*.xml spec*.xml test*.xml \

-             *.fo *.html *.pdf *.ps \
+             *.fo *.pdf *.ps \
+             filter*.html spec*.html test*.html \

              filter*.txt spec*.txt test*.txt \
              filter*.txt spec*.txt test*.txt \

-             *.info* *.texinfo *.texi
+             *.info* *.texinfo *.texi \
+             *.epub

 
 ########################################################################
 
 ########################################################################

+# vim: set ts=4 :