git://git.exim.org / exim.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Generate ePub files of documentation.
[exim.git] / doc / doc-docbook / Makefile
diff --git a/doc/doc-docbook/Makefile b/doc/doc-docbook/Makefile
index 8e485ab2d18d5517a888651698c21336b11cda0a..a741585dc0f1ce0b145b3cbe774e4eb676660c2d 100644 (file)
--- a/doc/doc-docbook/Makefile
+++ b/doc/doc-docbook/Makefile
@@ -1,5 +1,3 @@
-# $Cambridge: exim/doc/doc-docbook/Makefile,v 1.11 2007/08/29 13:37:28 ph10 Exp $
-
 # 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',"
 # 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',"
@@ -7,6 +5,17 @@ notarget:;    @echo "** You must specify a target, in the form x.y, where x is '
              @echo "** One other possible target is 'exim.8'".
              exit 1
 
              @echo "** One other possible target is 'exim.8'".
              exit 1
 
+EPUB_DOCBOOK= /usr/local/share/xsl/docbook/epub/docbook.xsl
+
+############################# 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 ################################
 
@@ -15,24 +24,36 @@ exim.8:       spec.xml 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.xfpt
+filter.xml:      local_params filter.xfpt
                 xfpt filter.xfpt
 
 filter-pr.xml:   filter.xml Pre-xml
                 ./Pre-xml -bookinfo <filter.xml >filter-pr.xml
 
                 xfpt filter.xfpt
 
 filter-pr.xml:   filter.xml Pre-xml
                 ./Pre-xml -bookinfo <filter.xml >filter-pr.xml
 
-filter-html.xml: filter.xml Pre-xml
-                ./Pre-xml -html <filter.xml >filter-html.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-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
 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
@@ -76,18 +97,12 @@ filter.pdf: sdop-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
-
 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
              w3m -dump filter-txt.html | ./Tidytxt >filter.txt
 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
              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
 
 # 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
@@ -96,25 +111,29 @@ filter.txt:   filter-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \
 filter.info:  filter-info.xml
              docbook2texi filter-info.xml
              perl -ne 's/conceptindex/cindex/;s/optionindex/findex/;print;' \
 filter.info:  filter-info.xml
              docbook2texi filter-info.xml
              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
+       rm -rf book-filter
+       mkdir book-filter
+       xsltproc -o book-filter/ $(EPUB_DOCBOOK) filter-epub.xml
+       echo "application/epub+zip" > book-filter/mimetype
+       ( cd book-filter; zip -XqD ../filter.epub mimetype )
+       ( cd book-filter; zip -Xr9D ../filter.epub META-INF OEBPS )
+
 ########################################################################
 
 
 ################################ SPEC ##################################
 
 ########################################################################
 
 
 ################################ SPEC ##################################
 
-spec.xml:      spec.xfpt
+spec.xml:      local_params spec.xfpt
               xfpt spec.xfpt
 
 spec-pr.xml:   spec.xml Pre-xml
               ./Pre-xml -optbreak <spec.xml >spec-pr.xml
 
               xfpt spec.xfpt
 
 spec-pr.xml:   spec.xml Pre-xml
               ./Pre-xml -optbreak <spec.xml >spec-pr.xml
 
-spec-html.xml: spec.xml Pre-xml
-              ./Pre-xml -html -oneindex \
-                <spec.xml >spec-html.xml
-
 spec-txt.xml:  spec.xml Pre-xml
               ./Pre-xml -ascii -html -noindex -quoteliteral \
                 <spec.xml >spec-txt.xml
 spec-txt.xml:  spec.xml Pre-xml
               ./Pre-xml -ascii -html -noindex -quoteliteral \
                 <spec.xml >spec-txt.xml
@@ -122,6 +141,9 @@ spec-txt.xml:  spec.xml Pre-xml
 spec-info.xml: spec.xml Pre-xml
               ./Pre-xml -ascii -html -noindex <spec.xml >spec-info.xml
 
 spec-info.xml: spec.xml Pre-xml
               ./Pre-xml -ascii -html -noindex <spec.xml >spec-info.xml
 
+spec-epub.xml: spec.xml Pre-xml
+                ./Pre-xml -epub <spec.xml >spec-epub.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
 spec.fo:       spec-pr.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl \
                MyTitleStyle.xsl
               /bin/rm -rf spec.fo spec-pr.fo
@@ -167,17 +189,12 @@ spec.pdf: sdop-spec.pdf
 ###
 ###
 
 ###
 ###
 
-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.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
              w3m -dump spec-txt.html | ./Tidytxt >spec.txt
 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
              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
 
 # 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
@@ -189,6 +206,14 @@ spec.info:    spec-info.xml
              /bin/rm -rf the_exim_mta.texi
              makeinfo -o spec.info --no-split spec.texinfo
 
              /bin/rm -rf the_exim_mta.texi
              makeinfo -o spec.info --no-split spec.texinfo
 
+spec.epub:   spec-epub.xml
+       rm -rf book-spec
+       mkdir book-spec
+       xsltproc -o book-spec/ $(EPUB_DOCBOOK) spec-epub.xml
+       echo "application/epub+zip" > book-spec/mimetype
+       ( cd book-spec; zip -XqD ../spec.epub mimetype )
+       ( cd book-spec; zip -Xr9D ../spec.epub META-INF OEBPS )
+
 ########################################################################
 
 
 ########################################################################
 
 
@@ -257,12 +282,6 @@ test.pdf: sdop-test.pdf
 ###
 
 
 ###
 
 
-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.txt:     test-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \
                 MyStyle.xsl
              /bin/rm -rf test-txt.html
 test.txt:     test-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \
                 MyStyle.xsl
              /bin/rm -rf test-txt.html
@@ -282,12 +301,26 @@ test.info:    test-info.xml
 ########################################################################
 
 
 ########################################################################
 
 
+############################## 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 \
              *.info* *.texinfo *.texi
 
 ########################################################################
              filter*.txt spec*.txt test*.txt \
              *.info* *.texinfo *.texi
 
 ########################################################################
+# vim: set ts=4 :
Master Exim source repository