recoll/src/doc/user/Makefile
2019-04-13 12:38:17 +02:00

81 lines
2.8 KiB
Makefile

# Wherever docbook.xsl and chunk.xsl live.
# NOTE: THIS IS HARDCODED inside custom.xsl (for changing the output
# charset), which needs to change if the stylesheet location changes.
# Necessity of custom.xsl:
# http://www.sagehill.net/docbookxsl/OutputEncoding.html
# Fbsd
#XSLDIR="/usr/local/share/xsl/docbook/"
# Mac
#XSLDIR="/opt/local/share/xsl/docbook-xsl/"
#Linux
XSLDIR="/usr/share/xml/docbook/stylesheet/docbook-xsl/"
# Options common to the single-file and chunked versions
commonoptions=--stringparam section.autolabel 1 \
--stringparam section.autolabel.max.depth 2 \
--stringparam section.label.includes.component.label 1 \
--stringparam toc.max.depth 3 \
--stringparam autotoc.label.in.hyperlink 0 \
--stringparam abstract.notitle.enabled 1 \
--stringparam html.stylesheet docbook-xsl.css \
--stringparam generate.toc "book toc,title,figure,table,example,equation"
# index.html chunk format target replaced by nicer webhelp (needs separate
# make) in webhelp/ subdir
all: usermanual.html webh usermanual.pdf
webh:
make -C webhelp
usermanual.html: usermanual.xml recoll.conf.xml
xsltproc --xinclude ${commonoptions} \
-o tmpfile.html custom.xsl $<
-tidy -indent tmpfile.html > usermanual.html
rm -f tmpfile.html
index.html: usermanual.xml recoll.conf.xml
xsltproc ${commonoptions} \
--stringparam use.id.as.filename 1 \
--stringparam root.filename index \
"${XSLDIR}/html/chunk.xsl" $<
usermanual.pdf: usermanual.xml recoll.conf.xml
dblatex --xslt-opts="--xinclude" -tpdf $<
UTILBUILDS=/home/dockes/tmp/builds/medocutils/
recoll-conf-xml:
$(UTILBUILDS)/confxml --docbook \
--idprefix=RCL.INSTALL.CONFIG.RECOLLCONF \
../../sampleconf/recoll.conf > recoll.conf.xml
# Generating a restructured text version, for uploading to readthedocs.
# Does not really work, the internal links are botched. pandoc
# generates something like:
# `configuration <#RCL.INDEXING.CONFIG>`__
# when it should be:
# :ref:`RCL.INDEXING.CONFIG`
# Also with the second form, the link text is the section heading (can't be
# chosen), which is not nice. Else, the change could probably be done by a
# script.
# Also could not get readthedocs to generate the left pane TOC? could
# probably be fixed...
#usermanual-rst: recoll-conf-xml
# tail -n +2 recoll.conf.xml > rcl-conf-tail.xml
# sed -e '/xi:include/r rcl-conf-tail.xml' \
# < usermanual.xml > full-man.xml
# sed -i -e '/xi:include/d' -e '/<?xml version="1.0"?>/d' full-man.xml
# pandoc -s -f docbook -t rst full-man.xml > \
# ../../../docs/index.rst
# rm -f rcl-conf-tail.xml full-man.xml
# not needed with pandoc 2.x -@echo fix termmatch and execute
clean:
rm -f RCL.*.html usermanual.pdf usermanual.html index.html \
tmpfile.html rcl-conf-tail.xml full-man.xml