-# Documentation/tex/Makefile
-
depth=../..
-
-LATEX_FILES =$(wildcard *.latex)
-
+LATEX_FILES =$(call src-wildcard,*.latex)
# todo: add latex.
-DVI_FILES = $(addprefix $(outdir)/, $(TELY_FILES:.tely=.dvi))
+DVI_FILES = $(TELY_FILES:%.tely=$(outdir)/%.dvi)
-EXTRA_DIST_FILES= $(LATEX_FILES) $(wildcard *.itexi *.itely)
+EXTRA_DIST_FILES= $(LATEX_FILES) $(IMAGES)
+IMAGES=$(call src-wildcard,*.png)
-HTML_FILES = $(addprefix $(outdir)/, $(TELY_FILES:.tely=.html))
+OUT_EPS_IMAGES=$(IMAGES:%.png=$(outdir)/%.eps)
+OUT_PNG_IMAGES=$(IMAGES:%=$(outdir)/%)
+OUT_TEXI_FILES=$(ITEXI_FILES:%.itexi=$(outdir)/%.texi)\
+ $(ITELY_FILES:%.itely=$(outdir)/%.texi)
+HTML_FILES = $(TELY_FILES:%.tely=$(outdir)/%.html)\
+ $(outdir)/lilypond-internals.html
-PS_FILES = $(DVI_FILES:.dvi=.ps) $(OUTDOC_FILES:.doc=.ps) $(OUTTEX_FILES:.tex=.ps)
+PS_FILES = $(DVI_FILES:.dvi=.ps)
+PDF_FILES = $(DVI_FILES:.dvi=.pdf)
PS_GZ_FILES= $(addsuffix .gz, $(PS_FILES))
-INFO_FILES = $(addprefix $(outdir)/, lilypond.info lilypond-internals.info)
+INFO_DOCS = lilypond lilypond-internals music-glossary
+INFO_FILES = $(INFO_DOCS:%=$(outdir)/%.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
+
+TEXINPUTS=$(top-src-dir)/tex::
+export TEXINPUTS
+
+include $(depth)/make/stepmake.make
dvi: $(DVI_FILES)
ps: $(PS_FILES)
+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.
-$(outdir)/%.info: $(outdir)/%.texi
+pathsettings:
+ @echo export PATH=$(PATH)
+ @echo export LILYPONDPREFIX=$(LILYPONDPREFIX)
+ @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.
+# Viewawble with a recent Emacs, doing: M-x info out-www/lilypond.info
+
+# Cancel the special, non-image info generation rule that skips images:
+$(outdir)/%.info: $(outdir)/%.nexi
+
+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) $(outdir)/lilypond.info"
+ @echo
+ @echo "For images in the INFO docs to work, do: "
+ @echo
+ @echo " (cd $(package_infodir) && ln -sf ../../doc/lilypond/Documentation/user/*png .)"
+ @echo "or add something like that to the postinstall script."
+ @echo
+else
+ -$(INSTALL) -d $(DESTDIR)$(package_infodir)
+ -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond.info
+ install-info --info-dir=$(infodir) $(outdir)/lilypond.info
+ (cd $(package_infodir) && ln -sf $(webdir)/Documentation/user/*png .)
+endif
-default:
+local-uninstall-WWW:
+ rm -f $(package_infodir)/*.png
-# 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)
+else
+# Cancel the default info generation rule that generates images:
+$(outdir)/%.info: # $(outdir)/%.texi
+
+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
+ -$(INSTALL) -d $(DESTDIR)$(package_infodir)
+ -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond.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
-# The new pretest version of makeinfo, 4.0a splits html files into their own
-# directory. Available from
-# ftp://texinfo.org/texinfo/pretests/texinfo-4.0a.tar.gz
-SPLITTING_MAKEINFO = $(shell makeinfo --version | egrep '4.0((.jcn[2,3])|a)')
+endif
-# Generic rule using % twice not possible?
-# $(outdir)/%/%.html: $(outdir)/%.texi
-$(outdir)/lilypond/lilypond.html: $(outdir)/lilypond.texi
- -$(MAKEINFO) --force --output=$@ --html $<
- -cp -f $(outdir)/*.png $(outdir)/lilypond
- -cp -f $(outdir)/lilypond/index.html $@
- $(deep-footify) $(shell find $(outdir)/$(*F)/*.html)
+# 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
-$(outdir)/lilypond-internals/lilypond-internals.html: $(outdir)/lilypond-internals.texi
- -$(MAKEINFO) --force --output=$@ --html $<
- -cp -f $(outdir)/*.png $(outdir)/lilypond-internals
- -cp -f $(outdir)/lilypond-internals/index.html $@
- $(deep-footify) $(shell find $(outdir)/$(*F)/*.html)
+default:
-ifneq ($(SPLITTING_MAKEINFO),)
-DEEP_HTML_FILES = $(outdir)/lilypond/lilypond.html $(outdir)/lilypond-internals/lilypond-internals.html
+local-help: extra-local-help
-else
+extra-local-help:
+ @echo -e "\
+ dvi update dvi documents\n\
+ info update info pages\n\
+ ps update PostScript documents\n\
+ xml update Docbook xml documentation\n\
+"
-DEEP_HTML_FILES = $(outdir)/lilypond.html $(outdir)/lilypond-internals.html
+# Generic rule using % twice not possible?
+# $(outdir)/%/%.html: $(outdir)/%.texi
+$(outdir)/lilypond.texi: $(outdir)/lilypond-internals.texi
+$(outdir)/lilypond.nexi: $(outdir)/lilypond-internals.texi
+
+#
+# The split user manual
+#
+$(outdir)/lilypond/index.html: $(outdir)/lilypond.texi $(OUT_PNG_IMAGES)
+ mkdir -p $(dir $@)
+ $(MAKEINFO) -I$(outdir) --output=$(outdir)/lilypond --css-include=$(top-src-dir)/Documentation/texinfo.css --html $<
+ find $(outdir)/lilypond/ -name '*'.png -o -name '*'.ly | xargs rm -f
+# symbolic links to save space
+ (cd $(outdir)/lilypond/ ; ln -sf ../*.png ../*.ly . )
+
+#
+# One big page manual
+#
+$(outdir)/lilypond.html: $(outdir)/lilypond.texi
+ $(MAKEINFO) -I$(outdir) --output=$@ --css-include=$(top-src-dir)/Documentation/texinfo.css --html --no-split --no-headers $<
+
+#
+# The split internals reference
+#
+$(outdir)/lilypond-internals/index.html: $(outdir)/lilypond-internals.texi
+ mkdir -p $(dir $@)
+ $(MAKEINFO) --output=$(outdir)/lilypond-internals --css-include=$(top-src-dir)/Documentation/texinfo.css --html $<
+
+#
+# One big page internals reference
+#
+$(outdir)/lilypond-internals.html: $(outdir)/lilypond-internals.texi
+ $(MAKEINFO) --output=$@ --css-include=$(top-src-dir)/Documentation/texinfo.css --html --no-split --no-headers $<
+
+#
+# The split glossary
+#
+$(outdir)/music-glossary/index.html: $(outdir)/music-glossary.texi
+ mkdir -p $(dir $@)
+ $(MAKEINFO) --output=$(outdir)/music-glossary --css-include=$(top-src-dir)/Documentation/texinfo.css --html $<
+ find $(outdir)/music-glossary/ -name '*'.png -o -name '*'.ly | xargs rm -f
+# symbolic links to save space
+ (cd $(outdir)/music-glossary/ ; ln -sf ../*.png ../*.ly . )
+
+$(outdir)/lilypond.xml: $(outdir)/lilypond.texi
+ mkdir -p $(dir $@)
+ $(MAKEINFO) -I$(outdir) --output=$@ --docbook $<
+
+$(outdir)/lilypond-internals/lilypond-internals.xml: $(outdir)/lilypond-internals.texi
+ mkdir -p $(dir $@)
+ $(MAKEINFO) --output=$(outdir)/lilypond-internals --docbook $<
+
+$(outdir)/lilypond.dvi: $(OUT_EPS_IMAGES) $(OUT_PNG_IMAGES)
+
+$(outdir)/%.png: %.png
+ convert -geometry 50x50% $< $@
+
+$(outdir)/%.eps: %.png
+ convert $< $@
+
+DEEP_HTML_FILES =\
+ $(outdir)/lilypond/index.html\
+ $(outdir)/lilypond-internals/index.html\
+ $(outdir)/music-glossary/index.html
+
+# 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)/source:
+ @rm -f $(@)
+ ln -sf ../../ $(@)
+
+$(outdir)/lilypond/source:
+ @rm -f $(@)
+ ln -sf ../../../ $(@)
+
+$(outdir)/music-glossary/source:
+ @rm -f $(@)
+ ln -sf ../../../ $(@)
+
+local-WWW: $(HTML_FILES) $(DEEP_HTML_FILES)\
+ $(datafiles) $(PDF_FILES) $(source-links) info info-dir
+
+local-WWW-clean: deep-WWW-clean
+
+deep-WWW-clean:
+ rm -rf $(outdir)/lilypond $(outdir)/lilypond-internals
-local-WWW: deep-symlinks
+info-dir:
+ $(SHELL) $(buildscript-dir)/install-info-html.sh --dir=$(outdir) lilypond lilypond-internals music-glossary
+$(outdir)/%.bib: %.bib
+ ln -f $< $@
-# Links referred to by Documentation index
-LILYPOND_LINKS=Reference-Manual.html Features.html Ly2dvi.html Midi2ly.html
+local-clean:
+ rm -f fonts.aux fonts.log feta*.tfm feta*.*pk
+ rm -rf $(outdir)/lilypond $(outdir)/lilypond-internals $(outdir)/music-glossary
-deep-symlinks:
- cd $(outdir) && rm -f lilypond && ln -s . lilypond
- cd $(outdir) && rm -f lilypond-internals && ln -s . lilypond-internals
- cd $(outdir) && $(foreach i, $(LILYPOND_LINKS),\
- rm -f $(i) && ln -s $(i) lilypond.html &&) true
-endif
+# lilypond.texi deps
+$(top-build-dir)/mf/$(outconfbase)/feta16list.ly:
+ $(MAKE) -C $(top-src-dir)/mf
+$(outdir)/lilypond.texi: $(ITELY_FILES) $(ITEXI_FILES)
+$(outdir)/lilypond.nexi: $(ITELY_FILES) $(ITEXI_FILES)
-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
+# Prevent building music-glossary.texi from default target
+$(outdir)/music-glossary.nexi:
-# $(PYTHON) $(step-bindir)/ls-latex.py --title 'User documentation' \
-# $(DOC_FILES) $(TEX_FILES) $(TELY_FILES) \
-# | sed "s!$(outdir)/!!g" > $(outdir)/index.html
+# Rules for the automatically generated documentation
+# When cross-compiling, we don't have lilypond, so we fake
+ifneq ($(CROSS),yes)
+# 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)/%.bib: %.bib
- ln -f $< $@
-# we want footers even if website builds (or is built) partly
- $(MAKE) footify
+$(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
-localclean:
- rm -f fonts.aux fonts.log feta*.tfm feta*.*pk
- rm -rf $(outdir)/lilypond $(outdir)/lilypond-internals
-backdoc-WWW: $(outdir)/lilypond-internals/lilypond-internals.html
- $(SHELL) $(buildscript-dir)/install-info-html.sh --dir=$(outdir) lilypond lilypond-internals
+## unused
+$(outdir)/interfaces.itexi: dummy
+ cd $(outdir) && lilypond $(top-src-dir)/ly/generate-interface-doc
-#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
- -ln $(outdir)/lilypond-internals.texi $(outdir)/lilypond-internals.nexi
else
+
$(outdir)/lilypond-internals.nexi $(outdir)/lilypond-internals.texi:
touch $@
touch $(outdir)/$(*F).nexi
+
+$(outdir)/programming-interface.texi:
+ cp dummy-interfaces.itexi $@
endif
+local-clean: local-delete
+
+local-delete:
+ find $(outdir)/ -name 'lily-[0-9]*' | xargs rm -f
+ -rm -f $(outdir)/*
projects / lilypond.git / blobdiff