aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/Makefile
diff options
context:
space:
mode:
authorUlf Lamping <ulf.lamping@web.de>2004-07-19 16:59:49 +0000
committerUlf Lamping <ulf.lamping@web.de>2004-07-19 16:59:49 +0000
commit556f1245e46dd68dcf322f5dff30dc24f7702032 (patch)
treed8575d2d367ff820eeba9c472403373d1a74d767 /docbook/Makefile
parent5d366ee1e28624622011633a041fcbacc16dcb12 (diff)
The first draft of an updated "Ethereal User's Guide" redesigned and updated to the current released Ethereal version 0.10.5.
As generation of output files is a bit tricky, please have a look at the Readme.txt file for instructions. Please send comments and improvements. svn path=/trunk/; revision=11433
Diffstat (limited to 'docbook/Makefile')
-rw-r--r--docbook/Makefile99
1 files changed, 99 insertions, 0 deletions
diff --git a/docbook/Makefile b/docbook/Makefile
new file mode 100644
index 0000000000..489e949e03
--- /dev/null
+++ b/docbook/Makefile
@@ -0,0 +1,99 @@
+#
+# Make the "Ethereal User's Guide" in several formats.
+# See the Readme.txt file for instructions.
+#
+
+# if you need to change this, don't forget to change it in catalog.xml too
+DOCBOOKXSL="/usr/share/docbook-xsl"
+
+# formatting objects processor
+# (comment this out, if you don't want pdf or don't have fop installed)
+FOP="fop-0.20.5/fop.bat"
+#FOP="fop-0.20.5/fop.sh"
+
+# html help compiler (Win32 only)
+# (comment this out, if you don't want chm or don't have hhc installed)
+HHC="/cygdrive/c/Program Files/HTML Help Workshop/hhc.exe"
+
+############### YOU SHOULDN'T HAVE TO EDIT ANYTHING BELOW THIS LINE! ################
+
+# the XSL processor
+XSLTPROC="xsltproc"
+
+# the XML validator (from the xsltproc package)
+XMLLINT="xmllint"
+
+# as eug_chm will stop with an error, make sure it's the last in this dependency list
+all: eug_validate eug_pdf_a4 eug_html eug_html_chunked eug_chm
+
+clean:
+ rm -f *.html
+ rm -f htmlhelp.*
+ rm -f *.hhc
+ rm -f *.fo
+ rm -f *.pdf
+ rm -f *.chm
+
+images:
+ cp $(DOCBOOKXSL)/images/note.png ./graphics
+ cp $(DOCBOOKXSL)/images/tip.png ./graphics
+ cp $(DOCBOOKXSL)/images/warning.png ./graphics
+
+# validate the content
+eug_validate:
+ @ echo --- VALIDATING XML ---
+ $(XMLLINT) --valid --noout user-guide.xml
+
+# create html single page file
+eug_html:
+ @ echo --- HTML SINGLE PAGE ---
+ mkdir -p eug_html
+ mkdir -p eug_html/graphics
+ mkdir -p eug_html/graphics/toolbar
+ cp ./graphics/*.* eug_html/graphics
+ cp ./graphics/toolbar/*.* eug_html/graphics/toolbar
+ $(XSLTPROC) --nonet $(DOCBOOKXSL)/html/docbook.xsl user-guide.xml > eug_html/user-guide.html
+
+# create html chunked page files
+eug_html_chunked: images
+ @ echo --- HTML CHUNKED ---
+ mkdir -p eug_html_chunked
+ mkdir -p eug_html_chunked/graphics
+ mkdir -p eug_html_chunked/graphics/toolbar
+ cp ./graphics/*.* eug_html_chunked/graphics
+ cp ./graphics/toolbar/*.* eug_html_chunked/graphics/toolbar
+ $(XSLTPROC) --stringparam base.dir eug_html_chunked/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --nonet $(DOCBOOKXSL)/html/chunk.xsl user-guide.xml
+
+# create pdf file (through XSL-FO), portrait pages on US letter paper (the default)
+# you will get lot's of errors, but that's ok
+eug_pdf_us: images
+ifdef FOP
+ @ echo --- PDF US PAPER ---
+ $(XSLTPROC) --nonet custom_layer_pdf.xsl $(DOCBOOKXSL)/fo/docbook.xsl user-guide.xml > user-guide.fo
+ $(FOP) user-guide.fo user-guide.pdf
+endif
+
+# create pdf file (through XSL-FO), portrait pages on A4 paper
+# you will get lot's of errors, but that's ok
+eug_pdf_a4: images
+ifdef FOP
+ @ echo --- PDF A4 PAPER ---
+ $(XSLTPROC) --stringparam paper.type A4 --nonet custom_layer_pdf.xsl user-guide.xml > user-guide.fo
+ $(FOP) user-guide.fo user-guide.pdf
+endif
+
+# create MS html help file (through html chunked pages)
+eug_chm: images
+ifdef HHC
+ @ echo --- MICROSOFT HTML HELP ---
+ mkdir -p eug_chm
+ mkdir -p eug_chm/graphics
+ mkdir -p eug_chm/graphics/toolbar
+ cp ./graphics/*.* eug_chm/graphics
+ cp ./graphics/toolbar/*.* eug_chm/graphics/toolbar
+ $(XSLTPROC) --stringparam base.dir eug_chm/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --nonet $(DOCBOOKXSL)/htmlhelp/htmlhelp.xsl user-guide.xml
+ -$(HHC) htmlhelp.hhp
+ mv htmlhelp.chm user-guide.chm
+ rm -r htmlhelp.hhp
+ rm -r toc.hhc
+endif