lix/doc/manual/local.mk

93 lines
3.2 KiB
Makefile
Raw Normal View History

2014-02-01 10:30:21 +00:00
XSLTPROC = $(xsltproc) --nonet $(xmlflags) \
--param section.autolabel 1 \
--param section.label.includes.component.label 1 \
--param html.stylesheet \'style.css\' \
--param xref.with.number.and.title 1 \
--param toc.section.depth 3 \
--param admon.style \'\' \
--param callout.graphics.extension \'.gif\' \
2014-09-16 13:37:38 +00:00
--param contrib.inline.enabled 0 \
2014-12-14 00:22:57 +00:00
--stringparam generate.toc "book toc" \
--param keep.relative.image.uris 0
2014-02-01 10:30:21 +00:00
2014-12-11 09:44:02 +00:00
docbookxsl = http://docbook.sourceforge.net/release/xsl-ns/1.78.1
docbookrng = http://docbook.org/xml/5.0/rng/docbook.rng
2014-09-16 12:14:09 +00:00
MANUAL_SRCS := $(call rwildcard, $(d), *.xml)
2014-02-01 10:30:21 +00:00
# Do XInclude processing / RelaxNG validation
$(d)/manual.xmli: $(d)/manual.xml $(MANUAL_SRCS) $(d)/version.txt
$(trace-gen) $(xmllint) --nonet --xinclude $< -o $@.tmp
@mv $@.tmp $@
$(d)/version.txt:
$(trace-gen) echo -n $(PACKAGE_VERSION) > $@
# Note: RelaxNG validation requires xmllint >= 2.7.4.
$(d)/manual.is-valid: $(d)/manual.xmli
$(trace-gen) $(XSLTPROC) --novalid --stringparam profile.condition manual \
$(docbookxsl)/profiling/profile.xsl $< 2> /dev/null | \
$(xmllint) --nonet --noout --relaxng $(docbookrng) -
2014-02-01 10:30:21 +00:00
@touch $@
2014-02-01 11:23:14 +00:00
clean-files += $(d)/manual.xmli $(d)/version.txt $(d)/manual.is-valid
2014-02-01 10:30:21 +00:00
2014-02-01 14:18:48 +00:00
dist-files += $(d)/manual.xmli $(d)/version.txt $(d)/manual.is-valid
2014-02-01 13:28:31 +00:00
2014-02-01 10:30:21 +00:00
# Generate man pages.
man-pages := $(foreach n, \
nix-env.1 nix-build.1 nix-shell.1 nix-store.1 nix-instantiate.1 \
nix-collect-garbage.1 nix-push.1 \
nix-prefetch-url.1 nix-channel.1 \
2014-02-01 10:30:21 +00:00
nix-install-package.1 nix-hash.1 nix-copy-closure.1 \
nix.conf.5 nix-daemon.8, \
$(d)/$(n))
2014-09-16 13:29:55 +00:00
$(firstword $(man-pages)): $(d)/manual.xmli $(d)/manual.is-valid
$(trace-gen) $(XSLTPROC) --novalid --stringparam profile.condition manpage \
2014-02-01 10:30:21 +00:00
$(docbookxsl)/profiling/profile.xsl $< 2> /dev/null | \
(cd doc/manual && $(XSLTPROC) $(docbookxsl)/manpages/docbook.xsl -)
2014-09-16 13:29:55 +00:00
$(wordlist 2, $(words $(man-pages)), $(man-pages)): $(firstword $(man-pages))
2014-02-01 11:23:14 +00:00
clean-files += $(d)/*.1 $(d)/*.5 $(d)/*.8
2014-02-01 10:30:21 +00:00
dist-files += $(man-pages)
2014-02-01 14:18:48 +00:00
2014-02-01 10:30:21 +00:00
# Generate the HTML manual.
$(d)/manual.html: $(d)/manual.xml $(MANUAL_SRCS) $(d)/manual.is-valid
$(trace-gen) $(XSLTPROC) --xinclude --stringparam profile.condition manual \
$(docbookxsl)/profiling/profile.xsl $< | \
2014-07-03 10:36:58 +00:00
$(XSLTPROC) --output $@ $(docbookxsl)/xhtml/docbook.xsl -
2014-02-01 10:30:21 +00:00
$(foreach file, $(d)/manual.html $(d)/style.css, $(eval $(call install-data-in, $(file), $(docdir)/manual)))
$(foreach file, $(wildcard $(d)/figures/*.png), $(eval $(call install-data-in, $(file), $(docdir)/manual/figures)))
$(foreach file, $(wildcard $(d)/images/callouts/*.gif), $(eval $(call install-data-in, $(file), $(docdir)/manual/images/callouts)))
2014-02-01 10:30:21 +00:00
$(eval $(call install-symlink, manual.html, $(docdir)/manual/index.html))
all: $(d)/manual.html
2014-02-01 11:23:14 +00:00
clean-files += $(d)/manual.html
2014-02-01 10:30:21 +00:00
2014-02-01 13:28:31 +00:00
dist-files += $(d)/manual.html
2014-02-01 10:30:21 +00:00
# Generate the PDF manual.
$(d)/manual.pdf: $(d)/manual.xml $(MANUAL_SRCS) $(d)/manual.is-valid
$(trace-gen) if test "$(dblatex)" != ""; then \
cd doc/manual && $(XSLTPROC) --xinclude --stringparam profile.condition manual \
$(docbookxsl)/profiling/profile.xsl manual.xml | \
2014-03-12 13:15:37 +00:00
$(dblatex) -o $(notdir $@) $(dblatex_opts) -; \
2014-02-01 10:30:21 +00:00
else \
echo "Please install dblatex and rerun configure."; \
exit 1; \
fi
2014-02-01 11:23:14 +00:00
clean-files += $(d)/manual.pdf