tvl-depot/doc/manual/local.mk

114 lines
3.8 KiB
Makefile
Raw Normal View History

2014-02-01 11:30:21 +01: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\' \
--param contrib.inline.enabled 0
MANUAL_SRCS := $(wildcard $(d)/*.xml)
# 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)/docbook.rng -
@touch $@
2014-02-01 12:23:14 +01:00
clean-files += $(d)/manual.xmli $(d)/version.txt $(d)/manual.is-valid
2014-02-01 11:30:21 +01:00
2014-02-01 15:18:48 +01:00
dist-files += $(d)/manual.xmli $(d)/version.txt $(d)/manual.is-valid
2014-02-01 14:28:31 +01:00
2014-02-01 11:30:21 +01: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-pull.1 \
nix-prefetch-url.1 nix-channel.1 \
nix-install-package.1 nix-hash.1 nix-copy-closure.1 \
nix.conf.5 nix-daemon.8, \
$(d)/$(n))
$(man-pages): $(d)/manual.xmli $(d)/manual.is-valid
$(trace-gen) $(XSLTPROC) --stringparam profile.condition manpage \
$(docbookxsl)/profiling/profile.xsl $< 2> /dev/null | \
(cd doc/manual && $(XSLTPROC) $(docbookxsl)/manpages/docbook.xsl -)
2014-02-01 12:23:14 +01:00
clean-files += $(d)/*.1 $(d)/*.5 $(d)/*.8
2014-02-01 11:30:21 +01:00
dist-files += $(man-pages)
2014-02-01 15:18:48 +01:00
2014-02-01 11:30:21 +01: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 12:36:58 +02:00
$(XSLTPROC) --output $@ $(docbookxsl)/xhtml/docbook.xsl -
2014-02-01 11:30:21 +01: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 11:30:21 +01:00
$(eval $(call install-symlink, manual.html, $(docdir)/manual/index.html))
all: $(d)/manual.html
2014-02-01 12:23:14 +01:00
clean-files += $(d)/manual.html
2014-02-01 11:30:21 +01:00
2014-02-01 14:28:31 +01:00
dist-files += $(d)/manual.html
2014-02-01 11:30:21 +01: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 14:15:37 +01:00
$(dblatex) -o $(notdir $@) $(dblatex_opts) -; \
2014-02-01 11:30:21 +01:00
else \
echo "Please install dblatex and rerun configure."; \
exit 1; \
fi
2014-02-01 12:23:14 +01:00
clean-files += $(d)/manual.pdf
2014-02-01 14:28:31 +01:00
2014-03-12 14:15:37 +01:00
# Generate the release notes.
NEWS_OPTS = \
--stringparam generate.toc "article nop" \
--stringparam section.autolabel.max.depth 0 \
--stringparam header.rule 0
$(d)/release-notes.html: $(d)/release-notes.xml
$(trace-gen) $(XSLTPROC) --xinclude --output $@ $(NEWS_OPTS) \
2014-07-03 12:36:58 +02:00
$(docbookxsl)/xhtml/docbook.xsl $<
2014-03-12 14:15:37 +01:00
NEWS: $(d)/release-notes.xml
$(trace-gen) $(XSLTPROC) --xinclude doc/manual/quote-literals.xsl $< | \
$(XSLTPROC) --output $@.tmp.html $(NEWS_OPTS) \
2014-07-03 12:36:58 +02:00
$(docbookxsl)/xhtml/docbook.xsl - && \
2014-03-12 14:15:37 +01:00
LANG=en_US.UTF-8 $(w3m) -dump $@.tmp.html > $@.tmp && \
sed -e 's/●/*/g' -e 's/○/-/g' -e 's/━/-/g' < $@.tmp > NEWS && \
rm $@.tmp $@.tmp.html
dist-files += NEWS $(d)/release-notes.html
clean-files += NEWS $(d)/release-notes.html
all: $(d)/release-notes.html NEWS
$(foreach file, $(d)/release-notes.html, $(eval $(call install-data-in, $(file), $(docdir)/manual)))