]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/GNUmakefile
Doc getting an I rehearsal mark, and fix "notime" entry in lily-book.
[lilypond.git] / Documentation / user / GNUmakefile
index 675608ff48417de375a2244f8cff799eb8432ec5..e8b8d0dbe5b53b2b13ec0c32bbe182b23a2eed16 100644 (file)
@@ -3,15 +3,17 @@ depth=../..
 LATEX_FILES =$(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) $(IMAGES)
 IMAGES=$(wildcard *.png)
 
-OUT_EPS_IMAGES=$(addprefix $(outdir)/,$(IMAGES:.png=.eps))
-OUT_PNG_IMAGES=$(addprefix $(outdir)/,$(IMAGES))
-OUT_ITEXI_FILES=$(addprefix $(outdir)/,$(ITELY_FILES:.itely=.itexi) 
-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)
 PDF_FILES = $(DVI_FILES:.dvi=.pdf)
@@ -27,6 +29,10 @@ OMF_FILES += $(outdir)/lilypond-internals.html.omf
 
 LOCALSTEPMAKE_TEMPLATES=lilypond ly
 
+
+TEXINPUTS=$(topdir)/tex::
+export TEXINPUTS
+
 include $(depth)/make/stepmake.make 
 
 dvi: $(DVI_FILES)
@@ -35,6 +41,11 @@ ps: $(PS_FILES)
 
 info: $(INFO_FILES)
 
+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.
@@ -43,31 +54,72 @@ 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
 
-#info: $(INFO_FILES)
-
 # Cancel the special, non-image info generation rule that skips images:
 $(outdir)/%.info: $(outdir)/%.nexi
 
-local-install-info: install-info info
+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 "***************************************************************"
+       @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/out-www/*png .)"
        @echo "or add something like that to the postinstall script."
-       @echo "***"
+       @echo
 else
-       (cd $(package_infodir) && ln -sf $(local_package_docdir)/Documentation/user/out-www/*png .)
+       -$(INSTALL) -d $(DESTDIR)$(package_infodir)
+       -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond.info
+       install-info --info-dir=$(infodir) $(outdir)/lilypond.info
+       (cd $(lilypond_infodir) && ln -sf $(webdir)/Documentation/user/out-www/*png .)
 endif
 
 local-uninstall-WWW:
        rm -f $(package_infodir)/*.png
+
+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
-    # Cancel the default info generation rule that generates images:
-    $(outdir)/%.info: # $(outdir)/%.texi
+       -$(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
+
+
 endif
 
 # All web targets, except info image symlinks and info docs are
@@ -93,32 +145,53 @@ extra-local-help:
 $(outdir)/lilypond.texi: $(outdir)/lilypond-internals.texi
 $(outdir)/lilypond.nexi: $(outdir)/lilypond-internals.texi
 
-
-$(outdir)/lilypond/lilypond.html: $(outdir)/lilypond.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=$(abs-srcdir)/Documentation/texinfo.css --html $<
-       $(MAKEINFO) -I$(outdir) --output=$@ --css-include=$(abs-srcdir)/Documentation/texinfo.css --html --no-split --no-headers $<
-       perl -i~ -pe 's!../lilypond-internals!lilypond-internals/!g' $(outdir)/lilypond.html
-       rm -f $(outdir)/lilypond/*.png $(outdir)/lilypond/*.ly
+       find $(outdir)/lilypond/ -name '*'.png -o -name '*'.ly | xargs rm -f
 # symbolic links to save space 
        (cd $(outdir)/lilypond/ ; ln -sf ../*.png ../*.ly . )
 
-$(outdir)/lilypond-internals/lilypond-internals.html: $(outdir)/lilypond-internals.texi
+#
+# One big page manual
+#
+$(outdir)/lilypond.html: $(outdir)/lilypond.texi
+       $(MAKEINFO) -I$(outdir) --output=$@ --css-include=$(abs-srcdir)/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=$(abs-srcdir)/Documentation/texinfo.css --html $<
-       $(MAKEINFO) -I$(outdir) --output=$@ --css-include=$(abs-srcdir)/Documentation/texinfo.css --html --no-split --no-headers $<
 
-$(outdir)/lilypond/lilypond.xml: $(outdir)/lilypond.texi 
+#
+# One big page internals reference
+#
+$(outdir)/lilypond-internals.html: $(outdir)/lilypond-internals.texi
+       $(MAKEINFO) --output=$@ --css-include=$(abs-srcdir)/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=$(abs-srcdir)/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 $<
-       perl -i~ -pe 's!../lilypond-internals!lilypond-internals/!g' $(outdir)/lilypond.xml
 
 $(outdir)/lilypond-internals/lilypond-internals.xml: $(outdir)/lilypond-internals.texi
        mkdir -p $(dir $@)
        $(MAKEINFO) --output=$(outdir)/lilypond-internals --docbook $<
 
-ifeq ($(SPLITTING_MAKEINFO),yes)
-
 $(outdir)/lilypond.dvi: $(OUT_EPS_IMAGES) $(OUT_PNG_IMAGES)
 
 $(outdir)/%.png: %.png
@@ -127,24 +200,28 @@ $(outdir)/%.png: %.png
 $(outdir)/%.eps: %.png
        convert $< $@
 
-DEEP_HTML_FILES = $(outdir)/lilypond/lilypond.html $(outdir)/lilypond-internals/lilypond-internals.html
-
-else
-
-# Links referred to by Documentation index
-LILYPOND_LINKS=Reference-Manual.html Tutorial.html Ly2dvi.html Midi2ly.html
+DEEP_HTML_FILES =\
+ $(outdir)/lilypond/index.html\
+ $(outdir)/lilypond-internals/index.html\
+ $(outdir)/music-glossary/index.html
 
-local-WWW: outimages deep-symlinks
+# Symlinks to refer to external source documents from split and non-split HTML
+source-links = $(outdir)/source $(outdir)/lilypond/source $(outdir)/music-glossary/source
 
-deep-symlinks:
-       mkdir -p $(outdir)/lilypond
-       cd $(outdir)/lilypond && $(foreach i, $(LILYPOND_LINKS),\
-               rm -f $(i) && ln -s lilypond.html $(i) &&) true
+$(outdir)/source:
+       @rm -f $(@)
+       ln -sf ../../../ $(@)
 
-endif
+$(outdir)/lilypond/source:
+       @rm -f $(@)
+       ln -sf ../../../../ $(@)
 
+$(outdir)/music-glossary/source:
+       @rm -f $(@)
+       ln -sf ../../../../ $(@)
 
-local-WWW: $(HTML_FILES) $(datafiles) $(PDF_FILES) $(PS_GZ_FILES) $(DEEP_HTML_FILES) info info-dir
+local-WWW: $(HTML_FILES) $(DEEP_HTML_FILES)\
+ $(datafiles) $(PDF_FILES) $(source-links) info info-dir
 
 local-WWW-clean: deep-WWW-clean
 
@@ -152,7 +229,7 @@ deep-WWW-clean:
        rm -rf $(outdir)/lilypond $(outdir)/lilypond-internals
 
 info-dir:
-       $(SHELL) $(buildscript-dir)/install-info-html.sh --dir=$(outdir) lilypond lilypond-internals
+       $(SHELL) $(buildscript-dir)/install-info-html.sh --dir=$(outdir) lilypond lilypond-internals music-glossary
 
 
 $(outdir)/%.bib: %.bib
@@ -160,7 +237,7 @@ $(outdir)/%.bib: %.bib
 
 local-clean:
        rm -f fonts.aux fonts.log feta*.tfm feta*.*pk 
-       rm -rf $(outdir)/lilypond $(outdir)/lilypond-internals
+       rm -rf $(outdir)/lilypond $(outdir)/lilypond-internals $(outdir)/music-glossary
 
 # lilypond.texi deps
 $(builddir)/mf/$(outconfbase)/feta16list.ly:
@@ -169,6 +246,9 @@ $(builddir)/mf/$(outconfbase)/feta16list.ly:
 $(outdir)/lilypond.texi: $(ITELY_FILES) $(ITEXI_FILES) 
 $(outdir)/lilypond.nexi: $(ITELY_FILES) $(ITEXI_FILES)
 
+# Prevent building music-glossary.texi from default target
+$(outdir)/music-glossary.nexi:
+
 # Rules for the automatically generated documentation
 # When cross-compiling, we don't have lilypond, so we fake
 ifneq ($(CROSS),yes)
@@ -194,16 +274,15 @@ $(outdir)/lilypond-internals.nexi $(outdir)/lilypond-internals.texi:
        touch $@
        touch $(outdir)/$(*F).nexi
 
-$(outdir)/interfaces.itexi:
+$(outdir)/programming-interface.texi:
        cp dummy-interfaces.itexi $@
 endif
 
-
 local-clean: local-delete
 
 local-delete:
        -for i in $$(seq 0 9); do \
-               for j in dvi eps eps.bbox eps.trans log png tex; do \
+               for j in dvi eps eps.bbox eps.trans eps.trans.ps ps log png tex; do \
                        rm -f $(outdir)/lily-$$i*$$j; \
                done; \
        done