X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2FGNUmakefile;h=dfa4342c9ecffeb17db89991f15369ac5f278e80;hb=70cdb3118765db18800ab76ea62b9c187e9acd52;hp=483f12a34807b08f66aebb86476161b2ee8b45c5;hpb=f81641423b285ca42142d31dcf2f0efd9213936a;p=lilypond.git diff --git a/Documentation/user/GNUmakefile b/Documentation/user/GNUmakefile index 483f12a348..dfa4342c9e 100644 --- a/Documentation/user/GNUmakefile +++ b/Documentation/user/GNUmakefile @@ -1,41 +1,47 @@ depth=../.. -LATEX_FILES =$(wildcard *.latex) +LATEX_FILES =$(call src-wildcard,*.latex) -# todo: add latex. -DVI_FILES = $(addprefix $(outdir)/, $(TELY_FILES:.tely=.dvi)) -EXTRA_DIST_FILES= $(LATEX_FILES) $(IMAGES) -IMAGES=$(wildcard *.png) +EXTRA_DIST_FILES = $(LATEX_FILES) $(IMAGES) $(EPS_ILLUSTRATIONS) +EXTRA_DIST_FILES += README.txt writing-texinfo.txt policy.txt + +IMAGES=$(call src-wildcard,*.png) +EPS_ILLUSTRATIONS=context-example.eps +PDF_ILLUSTRATIONS=context-example.pdf + +OUT_PDF_IMAGES=$(IMAGES:%.png=$(outdir)/%.pdf) $(addprefix $(outdir)/,$(PDF_ILLUSTRATIONS)) -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))\ - $(outdir)/lilypond-internals.html +OUT_PNG_IMAGES=$(OUT_PDF_IMAGES:%.pdf=%.png) -PS_FILES = $(DVI_FILES:.dvi=.ps) -PDF_FILES = $(DVI_FILES:.dvi=.pdf) +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_GZ_FILES= $(addsuffix .gz, $(PS_FILES)) +# todo: add latex. +PDF_FILES = $(TELY_FILES:%.tely=$(outdir)/%.pdf) -INFO_DOCS = lilypond lilypond-internals music-glossary +INFO_DOCS = lilypond lilypond-internals music-glossary lilypond-program lilypond-learning INFO_FILES = $(INFO_DOCS:%=$(outdir)/%.info) STEPMAKE_TEMPLATES=tex texinfo omf documentation - +#TEXI2DVI_FLAGS = -E OMF_FILES += $(outdir)/lilypond-internals.html.omf 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) + @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. @@ -61,20 +67,22 @@ ifneq ($(patsubst %/local,%,$(DESTDIR)$(prefix)),/usr) @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 " (cd $(package_infodir) && ln -sf ../../doc/lilypond/Documentation/user/*png .)" @echo "or add something like that to the postinstall script." @echo -else +else # installing directly into standard /usr/... -$(INSTALL) -d $(DESTDIR)$(package_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 --info-dir=$(infodir) $(outdir)/lilypond.info - (cd $(package_infodir) && ln -sf $(local_package_docdir)/Documentation/user/out-www/*png .) -endif + (cd $(package_infodir) && ln -sf $(webdir)/Documentation/user/*png .) +endif # installing directly into standard /usr/... local-uninstall-WWW: rm -f $(package_infodir)/*.png -else +else # out!=www # Cancel the default info generation rule that generates images: $(outdir)/%.info: # $(outdir)/%.texi @@ -97,9 +105,11 @@ ifneq ($(patsubst %/local,%,$(DESTDIR)$(prefix)),/usr) @echo @echo "and read the extra instructions." @echo -else +else # installing directly into standard /usr/... -$(INSTALL) -d $(DESTDIR)$(package_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 --info-dir=$(infodir) $(outdir)/lilypond.info @echo @echo "***************************************************************" @@ -107,17 +117,16 @@ else @echo @echo " make out=www install-info " @echo -endif +endif # installing into standard /usr/* root# installing into /usr/... - -endif +endif # out!=www # All web targets, except info image symlinks and info docs are -# installed in non-recursing target from TOPDIR +# installed in non-recursing target from TOP-SRC-DIR local-install-WWW: local-install-info local-uninstall-WWW: local-uninstall-info -default: +default: local-help: extra-local-help @@ -138,43 +147,82 @@ $(outdir)/lilypond.nexi: $(outdir)/lilypond-internals.texi # # The split user manual # -$(outdir)/lilypond/index.html: $(outdir)/lilypond.texi +$(outdir)/lilypond/index.html: $(outdir)/lilypond.texi $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES) mkdir -p $(dir $@) - $(MAKEINFO) -I$(outdir) --output=$(outdir)/lilypond --css-include=$(abs-srcdir)/Documentation/texinfo.css --html $< + $(MAKEINFO) -I$(outdir) --output=$(outdir)/lilypond --css-include=$(top-src-dir)/Documentation/texinfo.css --html $< +# we /might/ switch to texi2html if it can be fixed: +# echo "*************************************" +# echo $< +# cd $(outdir) +# texi2html --output=$(outdir)/lilypond --css-include=$(top-src-dir)/Documentation/texinfo.css $< find $(outdir)/lilypond/ -name '*'.png -o -name '*'.ly | xargs rm -f -# symbolic links to save space +# symbolic links to save space (cd $(outdir)/lilypond/ ; ln -sf ../*.png ../*.ly . ) # -# One big page manual +# One big page user manual +# +$(outdir)/lilypond-big-page.html: $(outdir)/lilypond.texi $(OUT_PNG_IMAGES) + $(MAKEINFO) -I$(outdir) --output=$@ --css-include=$(top-src-dir)/Documentation/texinfo.css --html --no-split -D bigpage --no-headers $< + +# +# The split program usage +# +$(outdir)/lilypond-program/index.html: $(outdir)/lilypond-program.texi $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES) + mkdir -p $(dir $@) + $(MAKEINFO) -I$(outdir) --output=$(outdir)/lilypond-program --css-include=$(top-src-dir)/Documentation/texinfo.css --html $< + find $(outdir)/lilypond-program/ -name '*'.png -o -name '*'.ly | xargs rm -f +# symbolic links to save space + (cd $(outdir)/lilypond-program/ ; ln -sf ../*.png ../*.ly . ) + +# +# The Learning Manual +# +$(outdir)/lilypond-learning/index.html: $(outdir)/lilypond-learning.texi $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES) + mkdir -p $(dir $@) + $(MAKEINFO) -I$(outdir) --output=$(outdir)/lilypond-learning --css-include=$(top-src-dir)/Documentation/texinfo.css --html $< + find $(outdir)/lilypond-learning/ -name '*'.png -o -name '*'.ly | xargs rm -f +# symbolic links to save space + (cd $(outdir)/lilypond-learning/ ; ln -sf ../*.png ../*.ly . ) + + +# +# One big page program usage +# +$(outdir)/lilypond-program-big-page.html: $(outdir)/lilypond-program.texi $(OUT_PNG_IMAGES) + $(MAKEINFO) -I$(outdir) --output=$@ --css-include=$(top-src-dir)/Documentation/texinfo.css --html --no-split -D bigpage --no-headers $< + +# +# One big page learning manual # -$(outdir)/lilypond.html: $(outdir)/lilypond.texi - $(MAKEINFO) -I$(outdir) --output=$@ --css-include=$(abs-srcdir)/Documentation/texinfo.css --html --no-split --no-headers $< +$(outdir)/lilypond-learning-big-page.html: $(outdir)/lilypond-learning.texi $(OUT_PNG_IMAGES) + $(MAKEINFO) -I$(outdir) --output=$@ --css-include=$(top-src-dir)/Documentation/texinfo.css --html --no-split -D bigpage --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) --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=$(abs-srcdir)/Documentation/texinfo.css --html --no-split --no-headers $< +$(outdir)/lilypond-internals-big-page.html: $(outdir)/lilypond-internals.texi + $(MAKEINFO) --output=$@ --css-include=$(top-src-dir)/Documentation/texinfo.css --html --no-split -D bigpage --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 $< + $(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 +# symbolic links to save space (cd $(outdir)/music-glossary/ ; ln -sf ../*.png ../*.ly . ) -$(outdir)/lilypond.xml: $(outdir)/lilypond.texi +$(outdir)/lilypond.xml: $(outdir)/lilypond.texi mkdir -p $(dir $@) $(MAKEINFO) -I$(outdir) --output=$@ --docbook $< @@ -182,81 +230,92 @@ $(outdir)/lilypond-internals/lilypond-internals.xml: $(outdir)/lilypond-internal mkdir -p $(dir $@) $(MAKEINFO) --output=$(outdir)/lilypond-internals --docbook $< -$(outdir)/lilypond.dvi: $(OUT_EPS_IMAGES) $(OUT_PNG_IMAGES) +$(outdir)/lilypond.pdf: $(OUT_PDF_IMAGES) $(OUT_PNG_IMAGES) + +$(outdir)/lilypond-program.pdf: $(OUT_PDF_IMAGES) $(OUT_PNG_IMAGES) + +$(outdir)/lilypond-learning.pdf: $(OUT_PDF_IMAGES) $(OUT_PNG_IMAGES) $(outdir)/%.png: %.png - convert -geometry 50x50% $< $@ + convert -depth 8 -geometry 50x50% $< $@ + +$(outdir)/%.png: %.eps + gs -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -q -sOutputFile=$@ -sDEVICE=png16m -dEPSCrop -dNOPAUSE -f $< -c quit + +$(outdir)/%.pdf: %.png + convert -depth 8 $< $@ + +$(outdir)/%.pdf: %.eps + gs -dAutoRotatePages=/None -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -sOutputFile=$@ -dEPSCrop -c .setpdfwrite -f $< -$(outdir)/%.eps: %.png - convert $< $@ DEEP_HTML_FILES =\ $(outdir)/lilypond/index.html\ $(outdir)/lilypond-internals/index.html\ - $(outdir)/music-glossary/index.html + $(outdir)/music-glossary/index.html\ + $(outdir)/lilypond-program/index.html\ + $(outdir)/lilypond-learning/index.html -local-WWW: $(HTML_FILES) $(DEEP_HTML_FILES)\ - $(datafiles) $(PDF_FILES) $(PS_GZ_FILES) info info-dir +# 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 + +$(outdir)/source: + @rm -f $(@) + ln -sf ../../ $(@) + +$(outdir)/lilypond/source: + @rm -f $(@) + mkdir -p $(outdir)/lilypond + ln -sf ../../../ $(@) + +$(outdir)/music-glossary/source: + @rm -f $(@) + mkdir -p $(outdir)/music-glossary + ln -sf ../../../ $(@) -local-WWW-clean: deep-WWW-clean +$(outdir)/lilypond-program/source: + @rm -f $(@) + mkdir -p $(outdir)/lilypond-program + ln -sf ../../../ $(@) -deep-WWW-clean: - rm -rf $(outdir)/lilypond $(outdir)/lilypond-internals +$(outdir)/lilypond-learning/source: + @rm -f $(@) + mkdir -p $(outdir)/lilypond-learning + ln -sf ../../../ $(@) + +local-WWW: $(HTML_FILES) $(DEEP_HTML_FILES)\ + $(datafiles) $(PDF_FILES) $(source-links) info info-dir info-dir: - $(SHELL) $(buildscript-dir)/install-info-html.sh --dir=$(outdir) lilypond lilypond-internals music-glossary + $(SHELL) $(buildscript-dir)/install-info-html.sh --dir=$(outdir) lilypond lilypond-internals music-glossary lilypond-program lilypond-learning $(outdir)/%.bib: %.bib ln -f $< $@ -local-clean: - rm -f fonts.aux fonts.log feta*.tfm feta*.*pk - rm -rf $(outdir)/lilypond $(outdir)/lilypond-internals $(outdir)/music-glossary # lilypond.texi deps -$(builddir)/mf/$(outconfbase)/feta16list.ly: - $(MAKE) -C $(topdir)/mf +$(top-build-dir)/mf/$(outconfbase)/feta16list.ly: + $(MAKE) -C $(top-src-dir)/mf -$(outdir)/lilypond.texi: $(ITELY_FILES) $(ITEXI_FILES) +$(outdir)/lilypond.texi: $(ITELY_FILES) $(ITEXI_FILES) $(outdir)/lilypond.nexi: $(ITELY_FILES) $(ITEXI_FILES) -# Rules for the automatically generated documentation -# When cross-compiling, we don't have lilypond, so we fake -ifneq ($(CROSS),yes) +# Prevent building music-glossary.texi from default target +$(outdir)/music-glossary.nexi: +# 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: $(builddir)/lily/$(outconfbase)/lilypond - cd $(outdir) && $(builddir)/lily/$(outconfbase)/lilypond --verbose $(abs-srcdir)/ly/generate-documentation +$(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 ## unused $(outdir)/interfaces.itexi: dummy - cd $(outdir) && $(builddir)/lily/$(outconfbase)/lilypond $(abs-srcdir)/ly/generate-interface-doc - -else - -$(outdir)/lilypond-internals.nexi $(outdir)/lilypond-internals.texi: - touch $@ - touch $(outdir)/$(*F).nexi - -$(outdir)/interfaces.itexi: - 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 eps.trans.ps ps log png tex; do \ - rm -f $(outdir)/lily-$$i*$$j; \ - done; \ - done - -rm -f $(outdir)/* + cd $(outdir) && lilypond $(top-src-dir)/ly/generate-interface-doc