X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2FGNUmakefile;h=5994526b73e71ae9fcf2d94c0aa09ada0072c0d5;hb=2f996385b21b9d5006c7369c2c496ccbee001e97;hp=ca93cec69bccbc6853f1366245ddd9c1b666dfd4;hpb=4e1b421ace356547dbc0c4d4a3b611b88a0c92fd;p=lilypond.git diff --git a/Documentation/user/GNUmakefile b/Documentation/user/GNUmakefile index ca93cec69b..5994526b73 100644 --- a/Documentation/user/GNUmakefile +++ b/Documentation/user/GNUmakefile @@ -2,29 +2,36 @@ depth=../.. LATEX_FILES =$(call src-wildcard,*.latex) -# todo: add latex. -DVI_FILES = $(TELY_FILES:%.tely=$(outdir)/%.dvi) -EXTRA_DIST_FILES= $(LATEX_FILES) $(IMAGES) +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 + +OUT_PDF_IMAGES=$(IMAGES:%.png=$(outdir)/%.pdf) $(addprefix $(outdir)/,$(PDF_ILLUSTRATIONS)) + +OUT_PNG_IMAGES=$(OUT_PDF_IMAGES:%.pdf=%.png) -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 +HTML_FILES = $(TELY_FILES:%.tely=$(outdir)/%-big-page.html)\ + $(outdir)/lilypond-internals-big-page.html -PS_FILES = $(DVI_FILES:.dvi=.ps) -PDF_FILES = $(DVI_FILES:.dvi=.pdf) - -PS_GZ_FILES= $(addsuffix .gz, $(PS_FILES)) +# todo: add latex. +PDF_FILES = $(TELY_FILES:%.tely=$(outdir)/%.pdf) +# this prevents aux files from being reused for translated docs +TEXI2PDF_FLAGS = --tidy -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 +ifeq ($(out),www) +INFO_IMAGES_DIR = lilypond +endif +STEPMAKE_TEMPLATES=tex texinfo omf documentation OMF_FILES += $(outdir)/lilypond-internals.html.omf LOCALSTEPMAKE_TEMPLATES=lilypond ly @@ -33,17 +40,11 @@ LOCALSTEPMAKE_TEMPLATES=lilypond ly TEXINPUTS=$(top-src-dir)/tex:: export TEXINPUTS -include $(depth)/make/stepmake.make - -dvi: $(DVI_FILES) - -ps: $(PS_FILES) +include $(depth)/make/stepmake.make info: $(INFO_FILES) -pathsettings: - @echo export PATH=$(PATH) - @echo export LILYPONDPREFIX=$(LILYPONDPREFIX) + @echo export LILYPOND_DATADIR=$(LILYPOND_DATADIR) @echo export PYTHONPATH=$(PYTHONPATH) xml: $(outdir)/lilypond/lilypond.xml $(outdir)/lilypond-internals/lilypond-internals.xml @@ -52,13 +53,27 @@ xml: $(outdir)/lilypond/lilypond.xml $(outdir)/lilypond-internals/lilypond-inter 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 +# 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)$(package_infodir) + -$(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 @@ -71,23 +86,27 @@ 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/*png .)" + @echo " (cd $(infodir) && ln -sfT ../doc/lilypond/html/Documentation/user lilypond)" @echo "or add something like that to the postinstall script." @echo -else - -$(INSTALL) -d $(DESTDIR)$(package_infodir) +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 $(package_infodir) && ln -sf $(webdir)/Documentation/user/*png .) -endif + cd $(infodir) && ln -sfT $(webdir)/Documentation/user lilypond +endif # installing directly into standard /usr/... local-uninstall-WWW: - rm -f $(package_infodir)/*.png + rm -f $(infodir)/lilypond -else +else # out!=www # Cancel the default info generation rule that generates images: -$(outdir)/%.info: # $(outdir)/%.texi +$(outdir)/%.info: $(outdir)/%.texi local-install-info: info -$(INSTALL) -d $(DESTDIR)$(package_infodir) @@ -107,9 +126,13 @@ ifneq ($(patsubst %/local,%,$(DESTDIR)$(prefix)),/usr) @echo @echo "and read the extra instructions." @echo -else - -$(INSTALL) -d $(DESTDIR)$(package_infodir) +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 "***************************************************************" @@ -117,24 +140,24 @@ 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 TOP-SRC-DIR local-install-WWW: local-install-info local-uninstall-WWW: local-uninstall-info -default: +default: +local-clean: + rm -f lilypond local-help: extra-local-help 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\ @@ -146,45 +169,22 @@ $(outdir)/lilypond.texi: $(outdir)/lilypond-internals.texi $(outdir)/lilypond.nexi: $(outdir)/lilypond-internals.texi # -# The split user manual +# Split manuals in HTML # -$(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 . ) +$(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) -# -# 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 +# Manuals in one big HTML page # -$(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 $< +$(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) -# -# 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 +$(outdir)/lilypond.xml: $(outdir)/lilypond.texi mkdir -p $(dir $@) $(MAKEINFO) -I$(outdir) --output=$@ --docbook $< @@ -192,67 +192,57 @@ $(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 $(outdir)/lilypond-program.pdf: $(OUT_PDF_IMAGES) $(OUT_PNG_IMAGES) +$(outdir)/lilypond-learning.pdf $(outdir)/music-glossary.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 # Symlinks to refer to external source documents from split and non-split HTML -source-links = $(outdir)/source $(outdir)/lilypond/source $(outdir)/music-glossary/source +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 $(@) - ln -sf ../../../ $(@) - -$(outdir)/music-glossary/source: +$(outdir)/%/source: @rm -f $(@) + mkdir -p $(dir $@) 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 - -info-dir: - $(SHELL) $(buildscript-dir)/install-info-html.sh --dir=$(outdir) lilypond lilypond-internals music-glossary - + $(datafiles) $(PDF_FILES) $(source-links) info $(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 $(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) +$(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) -# 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) - # There used to be a dependency on a dummy target, to force a rebuild # of lilypond-internals every time. however, this triggers @@ -267,19 +257,3 @@ $(outdir)/lilypond-internals.nexi $(outdir)/lilypond-internals.texi: $(LILYPOND_ ## unused $(outdir)/interfaces.itexi: dummy cd $(outdir) && lilypond $(top-src-dir)/ly/generate-interface-doc - -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)/*