-# Documentation/tex/Makefile
-
depth=../..
+LATEX_FILES =$(call src-wildcard,*.latex)
-LATEX_FILES =$(wildcard *.latex)
+EXTRA_DIST_FILES = $(LATEX_FILES) $(IMAGES) $(EPS_ILLUSTRATIONS)
+EXTRA_DIST_FILES += README.txt writing-texinfo.txt policy.txt writing-sections.txt
+IMAGES=$(call src-wildcard,*.png)
+EPS_ILLUSTRATIONS=context-example.eps
+PDF_ILLUSTRATIONS=context-example.pdf
-# todo: add latex.
-DVI_FILES = $(addprefix $(outdir)/, $(TELY_FILES:.tely=.dvi))
+OUT_PDF_IMAGES=$(IMAGES:%.png=$(outdir)/%.pdf) $(addprefix $(outdir)/,$(PDF_ILLUSTRATIONS))
-EXTRA_DIST_FILES= $(LATEX_FILES) $(wildcard *.itexi *.itely)
+OUT_PNG_IMAGES=$(OUT_PDF_IMAGES:%.pdf=%.png)
-HTML_FILES = $(addprefix $(outdir)/, $(TELY_FILES:.tely=.html))
+OUT_TEXI_FILES=$(ITEXI_FILES:%.itexi=$(outdir)/%.texi)\
+ $(ITELY_FILES:%.itely=$(outdir)/%.texi)
+HTML_FILES = $(TELY_FILES:%.tely=$(outdir)/%-big-page.html)\
+ $(outdir)/lilypond-internals-big-page.html
-PS_FILES = $(DVI_FILES:.dvi=.ps) $(OUTDOC_FILES:.doc=.ps) $(OUTTEX_FILES:.tex=.ps)
+# todo: add latex.
+PDF_FILES = $(TELY_FILES:%.tely=$(outdir)/%.pdf)
+# this prevents aux files from being reused for translated docs
+TEXI2PDF_FLAGS = --tidy
-PS_GZ_FILES= $(addsuffix .gz, $(PS_FILES))
+INFO_DOCS = lilypond lilypond-internals music-glossary lilypond-program lilypond-learning
+INFO_FILES = $(INFO_DOCS:%=$(outdir)/%.info)
+
+ifeq ($(out),www)
+INFO_IMAGES_DIR = lilypond
+endif
-INFO_FILES = $(addprefix $(outdir)/, lilypond.info lilypond-internals.info)
+STEPMAKE_TEMPLATES=tex texinfo omf documentation
+OMF_FILES += $(outdir)/lilypond-internals.html.omf
-STEPMAKE_TEMPLATES=tex texinfo documentation
LOCALSTEPMAKE_TEMPLATES=lilypond ly
-include $(depth)/make/stepmake.make
-dvi: $(DVI_FILES)
+TEXINPUTS=$(top-src-dir)/tex::
+export TEXINPUTS
-ps: $(PS_FILES)
+include $(depth)/make/stepmake.make
+info: $(INFO_FILES)
-# Cancel default info generation rule. We want to generate info from
-# `.nexi', making sure we don't run LilyPond for inline pictures, when
-# generating info.
+ @echo export LILYPOND_DATADIR=$(LILYPOND_DATADIR)
+ @echo export PYTHONPATH=$(PYTHONPATH)
+
+xml: $(outdir)/lilypond/lilypond.xml $(outdir)/lilypond-internals/lilypond-internals.xml
+
+# There are two modes for info: with and without images.
+ifeq ($(out),www)
+
+# This builds all .info targets with images, in out-www.
+# Viewable with a recent Emacs, doing: C-u C-h i out-www/lilypond.info
+
+# Cancel the special, non-image info generation rule that skips images:
+$(outdir)/%.info: $(outdir)/%.nexi
+
+# "makeinfo --info" MUST be able to read PNGs from CWD for info images
+# to work, hence lilypond/ -> $(outdir)/ symlink.
+# $(outdir)/lilypond/*.png symlinks are only needed to view
+# out-www/*.info with Emacs -- HTML docs no longer need these
+# symlinks, see replace_symlinks_urls in
+# buildscripts/add_html_footer.py.
+$(outdir)/%.info: lilypond
+lilypond: $(OUT_PNG_IMAGES)
+ rm -f lilypond
+ ln -s $(outdir) lilypond
+ mkdir -p $(outdir)/lilypond
+ find $(outdir)/lilypond/ -name '*'.png | xargs rm -f
+ (cd $(outdir)/lilypond/ ; ln -sf ../*.png . )
+
+local-install-info: info
+ -$(INSTALL) -d $(DESTDIR)$(infodir)
+ifneq ($(patsubst %/local,%,$(DESTDIR)$(prefix)),/usr)
+## Can not have absolute symlinks because some binary packages build schemes
+## install files in nonstandard root. Best we can do is to notify the
+## builder or packager.
+ @echo
+ @echo "***************************************************************"
+ @echo "Please add or update the LilyPond direntries, do"
+ @echo
+ @echo " install-info --info-dir=$(infodir) $(outdir)/lilypond.info"
+ @echo
+ @echo "For images in the INFO docs to work, do: "
+ @echo
+ @echo " (cd $(infodir) && ln -sfT ../doc/lilypond/html/Documentation/user lilypond)"
+ @echo "or add something like that to the postinstall script."
+ @echo
+else # installing directly into standard /usr/...
+ -$(INSTALL) -d $(DESTDIR)$(infodir)
+ -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond.info
+ -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond-program.info
+ -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond-learning.info
+ -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond-internals.info
+ -install-info --remove --info-dir=$(infodir) $(outdir)/music-glossary.info
+ install-info --info-dir=$(infodir) $(outdir)/lilypond.info
+ cd $(infodir) && ln -sfT $(webdir)/Documentation/user lilypond
+endif # installing directly into standard /usr/...
+
+local-uninstall-WWW:
+ rm -f $(infodir)/lilypond
+
+else # out!=www
+
+# Cancel the default info generation rule that generates images:
$(outdir)/%.info: $(outdir)/%.texi
-default:
+local-install-info: info
+ -$(INSTALL) -d $(DESTDIR)$(package_infodir)
+ifneq ($(patsubst %/local,%,$(DESTDIR)$(prefix)),/usr)
+## Can not have absolute symlinks because some binary packages build schemes
+## install files in nonstandard root. Best we can do is to notify the
+## builder or packager.
+ @echo
+ @echo "***************************************************************"
+ @echo "Please add or update the LilyPond direntries, do"
+ @echo
+ @echo " install-info --info-dir=$(infodir) out/lilypond.info"
+ @echo
+ @echo "For images in the INFO docs to work, do"
+ @echo
+ @echo " make out=www install-info "
+ @echo
+ @echo "and read the extra instructions."
+ @echo
+else # installing directly into standard /usr/...
+ -$(INSTALL) -d $(DESTDIR)$(infodir)
+ -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond.info
+ -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond-program.info
+ -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond-learning.info
+ -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond-internals.info
+ -install-info --remove --info-dir=$(infodir) $(outdir)/music-glossary.info
+ install-info --info-dir=$(infodir) $(outdir)/lilypond.info
+ @echo
+ @echo "***************************************************************"
+ @echo "For images in the INFO docs to work, do"
+ @echo
+ @echo " make out=www install-info "
+ @echo
+endif # installing into standard /usr/* root# installing into /usr/...
+
+endif # out!=www
+
+# All web targets, except info image symlinks and info docs are
+# installed in non-recursing target from TOP-SRC-DIR
+local-install-WWW: local-install-info
+local-uninstall-WWW: local-uninstall-info
+
+default:
+
+local-clean:
+ rm -f lilypond
+
+local-help: extra-local-help
+
+extra-local-help:
+ @echo -e "\
+ info update info pages\n\
+ ps update PostScript documents\n\
+ xml update Docbook xml documentation\n\
+"
-# Info is now built by default via texinfo-rules.
-# We must build them by default, otherwise they get built during make install
-info: $(INFO_FILES)
+# Generic rule using % twice not possible?
+# $(outdir)/%/%.html: $(outdir)/%.texi
+$(outdir)/lilypond.texi: $(outdir)/lilypond-internals.texi
+$(outdir)/lilypond.nexi: $(outdir)/lilypond-internals.texi
+#
+# Split manuals in HTML
+#
+$(outdir)/lilypond/index.html: $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES)
+$(outdir)/lilypond-program/index.html: $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES)
+$(outdir)/lilypond-learning/index.html: $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES)
+$(outdir)/music-glossary/index.html: $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES)
-# The next version of makeinfo should split html files into their own
-# directory. For now available only as patches from
-# http://appel.lilypond.org/software
-SPLITTING_MAKEINFO = $(shell makeinfo --version | grep '4.0.jcn[2,3]')
+#
+# Manuals in one big HTML page
+#
+$(outdir)/lilypond-big-page.html: $(OUT_PNG_IMAGES)
+$(outdir)/lilypond-program-big-page.html: $(OUT_PNG_IMAGES)
+$(outdir)/lilypond-learning-big-page.html: $(OUT_PNG_IMAGES)
-# Generic rule using % twice not possible?
-# $(outdir)/%/%.html: $(outdir)/%.texi
-$(outdir)/lilypond/lilypond.html: $(outdir)/lilypond.texi
- -$(MAKEINFO) --force --output=$@ --html $<
- -mv -f $(outdir)/*.png $(outdir)/lilypond
- $(deep-footify) $(sort $(wildcard $(outdir)/$(*F)/*.html))
+$(outdir)/lilypond.xml: $(outdir)/lilypond.texi
+ mkdir -p $(dir $@)
+ $(MAKEINFO) -I$(outdir) --output=$@ --docbook $<
-$(outdir)/lilypond-internals/lilypond-internals.html: $(outdir)/lilypond-internals.texi
- -$(MAKEINFO) --force --output=$@ --html $<
- -mv -f $(outdir)/*.png $(outdir)/lilypond-internals
- $(deep-footify) $(sort $(wildcard $(outdir)/$(*F)/*.html))
+$(outdir)/lilypond-internals/lilypond-internals.xml: $(outdir)/lilypond-internals.texi
+ mkdir -p $(dir $@)
+ $(MAKEINFO) --output=$(outdir)/lilypond-internals --docbook $<
-$(outdir)/features/features.html: $(outdir)/features.texi
- -$(MAKEINFO) --force --output=$@ --html $<
- -mv -f $(outdir)/*.png $(outdir)/features
- $(deep-footify) $(sort $(wildcard $(outdir)/$(*F)/*.html))
+$(outdir)/lilypond.pdf $(outdir)/lilypond-program.pdf: $(OUT_PDF_IMAGES) $(OUT_PNG_IMAGES)
+$(outdir)/lilypond-learning.pdf $(outdir)/music-glossary.pdf: $(OUT_PDF_IMAGES) $(OUT_PNG_IMAGES)
-ifneq ($(SPLITTING_MAKEINFO),)
+$(outdir)/%.png: %.png
+ convert -depth 8 -geometry 50x50% $< $@
-DEEP_HTML_FILES = $(outdir)/lilypond/lilypond.html $(outdir)/lilypond-internals/lilypond-internals.html $(outdir)/features/features.html
+$(outdir)/%.png: %.eps
+ gs -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -q -sOutputFile=$@ -sDEVICE=png16m -dEPSCrop -dNOPAUSE -f $< -c quit
-else
+$(outdir)/%.pdf: %.png
+ convert -depth 8 $< $@
-DEEP_HTML_FILES = $(outdir)/lilypond.html $(outdir)/lilypond-internals.html
+$(outdir)/%.pdf: %.eps
+ gs -dAutoRotatePages=/None -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -sOutputFile=$@ -dEPSCrop -c .setpdfwrite -f $<
-endif
+DEEP_HTML_FILES =\
+ $(outdir)/lilypond/index.html\
+ $(outdir)/lilypond-internals/index.html\
+ $(outdir)/music-glossary/index.html\
+ $(outdir)/lilypond-program/index.html\
+ $(outdir)/lilypond-learning/index.html
-local-WWW: $(HTML_FILES) $(datafiles) $(PS_GZ_FILES) $(DEEP_HTML_FILES)
- $(SHELL) $(buildscript-dir)/install-info-html.sh --dir=$(outdir) lilypond lilypond-internals
- $(MAKE) footify
- $(MAKE) deep-footify
+# Symlinks to refer to external source documents from split and non-split HTML
+source-links = $(outdir)/source $(outdir)/lilypond/source $(outdir)/music-glossary/source $(outdir)/lilypond-program/source $(outdir)/lilypond-learning/source
-# $(PYTHON) $(step-bindir)/ls-latex.py --title 'User documentation' \
-# $(DOC_FILES) $(TEX_FILES) $(TELY_FILES) \
-# | sed "s!$(outdir)/!!g" > $(outdir)/index.html
+$(outdir)/source:
+ @rm -f $(@)
+ ln -sf ../../ $(@)
+$(outdir)/%/source:
+ @rm -f $(@)
+ mkdir -p $(dir $@)
+ ln -sf ../../../ $(@)
+local-WWW: $(HTML_FILES) $(DEEP_HTML_FILES)\
+ $(datafiles) $(PDF_FILES) $(source-links) info
$(outdir)/%.bib: %.bib
ln -f $< $@
-# we want footers even if website builds (or is built) partly
- $(MAKE) footify
-localclean:
- rm -f fonts.aux fonts.log feta*.tfm feta*.*pk
-backdoc-WWW: $(outdir)/lilypond-internals/lilypond-internals.html
- $(SHELL) $(buildscript-dir)/install-info-html.sh --dir=$(outdir) lilypond lilypond-internals
+# lilypond.texi deps
+$(top-build-dir)/mf/$(outconfbase)/feta16list.ly:
+ $(MAKE) -C $(top-src-dir)/mf
+
+$(outdir)/lilypond.texi $(outdir)/lilypond-program.texi $(outdir)/lilypond-learning.texi: $(ITELY_FILES) $(ITEXI_FILES)
+$(outdir)/lilypond.nexi $(outdir)/lilypond-program.nexi $(outdir)/lilypond-learning.nexi: $(ITELY_FILES) $(ITEXI_FILES)
+
-#ugh. lily/OUT/lilypond hardcoded.
-# when cross-compiling, we don't have lilypond
-ifneq ($(CROSS),yes)
-$(outdir)/lilypond-internals.nexi $(outdir)/lilypond-internals.texi:
- cd $(outdir) && ../$(depth)/$(builddir)/lily/out/lilypond ../$(src-depth)/ly/generate-documentation
+# Rules for the automatically generated documentation
+
+# There used to be a dependency on a dummy target, to force a rebuild
+# of lilypond-internals every time. however, this triggers
+# compilation during install, which is a bad thing (tm).
+
+$(outdir)/lilypond-internals.nexi $(outdir)/lilypond-internals.texi: $(LILYPOND_BINARY)
+ cd $(outdir) && $(LILYPOND_BINARY) --verbose $(top-src-dir)/ly/generate-documentation
+ rm -f $(outdir)/lilypond-internals.nexi
-ln $(outdir)/lilypond-internals.texi $(outdir)/lilypond-internals.nexi
-else
-$(outdir)/lilypond-internals.nexi $(outdir)/lilypond-internals.texi:
- touch $@
- touch $(outdir)/$(*F).nexi
-endif
+
+## unused
+$(outdir)/interfaces.itexi: dummy
+ cd $(outdir) && lilypond $(top-src-dir)/ly/generate-interface-doc
projects / lilypond.git / blobdiff