depth = .. ######################## # Documentation build # ######################## ############# ### Variables NAME = documentation LANGS = $(shell $(PYTHON) $(top-src-dir)/python/langdefs.py) MANUALS_SUBDIRS = usage automated-engraving contributor essay \ web learning notation extending SUBDIRS = $(MANUALS_SUBDIRS) snippets logo pictures misc po css topdocs \ included $(LANGS) STEPMAKE_TEMPLATES = documentation texinfo tex omf LOCALSTEPMAKE_TEMPLATES = lilypond ly ### Extra flags LILYPOND_BOOK_FLAGS = --extra-options '-e "(ly:set-option (quote internal-type-checking) \#t)"' TEXI2PDF_FLAGS = \ -I $(outdir) \ -I $(top-build-dir)/Documentation/$(outconfbase) $(outdir)/snippets-big-page.html: TEXI2HTML_FLAGS += -D short_toc $(outdir)/snippets/index..html: TEXI2HTML_FLAGS += -D short_toc ### Extra source files README_TOP_FILES= DEDICATION THANKS IN_ITELY_FILES = $(call src-wildcard,snippets/*-intro.itely) SNIPPET_LY_FILES = $(call src-wildcard,snippets/*.ly) EXTRA_DIST_FILES = $(call src-wildcard,*.init) ### Out files # Dependencies GENERATED_ITELY_FILES = $(IN_ITELY_FILES:snippets/%-intro.itely=$(outdir)/%.itely) XREF_MAPS_FILES += $(XREF_MAPS_DIR)/internals.xref-map OMF_FILES += $(outdir)/internals.html.omf $(outdir)/internals.pdf.omf # Main manuals TEXINFO_MANUALS = internals\ $(TELY_FILES:%.tely=%)\ $(TEXI_FILES:%.texi=%) OUT_TEXINFO_MANUALS = $(TEXINFO_MANUALS:%=$(outdir)/%.texi) ## CHAIN_RULE hack: keep the following line *before* including # stepmake.make, so the Internals Reference is built before the # Notation Reference, thus providing automatically generated sections # of the NR TEXI_FILES_FROM_TELY = $(outdir)/internals.texi PDF_FILES = $(TEXINFO_MANUALS:%=$(outdir)/%.pdf) TOPDIR_HTML_MANUALS = UNSPLITTED_HTML_MANUALS = SPLITTED_HTML_MANUALS = $(foreach manual, $(TEXINFO_MANUALS),\ $(if $(findstring $(manual), $(UNSPLITTED_HTML_MANUALS)),,$(manual))) NOT_TOPDIR_HTML_MANUALS = $(foreach manual, $(SPLITTED_HTML_MANUALS),\ $(if $(findstring $(manual), $(TOPDIR_HTML_MANUALS)),,$(manual))) OUT_HTML_FILES = $(UNSPLITTED_HTML_MANUALS:%=$(outdir)/%.html)\ $(SPLITTED_HTML_MANUALS:%=$(outdir)/%-big-page.html) DEEP_HTML_FILES = $(NOT_TOPDIR_HTML_MANUALS:%=$(outdir)/%/index.html) # Symlinks to refer to external source documents from split and non-split HTML source-links = $(outdir)/source\ $(foreach manual, $(SPLITTED_HTML_MANUALS), $(outdir)/$(manual)/source) # Other out files MAIN_INFO_DOC = lilypond-web INFO_DOCS = lilypond-usage lilypond-changes lilypond-contributor lilypond-internals \ lilypond-essay lilypond-learning lilypond-notation music-glossary \ lilypond-web lilypond-extending ifeq ($(out),www) INFO_DOCS += lilypond-snippets endif INFO_FILES = $(INFO_DOCS:%=$(outdir)/%.info) ifeq ($(out),www) INFO_IMAGES_DIR = lilypond DEST_INFO_IMAGES_SUBDIR = Documentation/ endif include $(depth)/make/stepmake.make OUT_TXT_FILES = $(addprefix $(outdir)/, $(addsuffix .txt, $(README_TOP_FILES))) ### Web site idiosyncrases $(XREF_MAPS_DIR)/web.xref-map: XREF_MAP_FLAGS += --split=node ### bad hack for badly-integrated roadmap. $(outdir)/ROADMAP: cp $(top-src-dir)/ROADMAP $(outdir) $(outdir)/contributor.texi: $(outdir)/ROADMAP ### bad hack for badly-integrated bibliography $(outdir)/engravingbib.itexi: BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2html \ -o $(outdir)/colorado.html \ $(src-dir)/essay/colorado.bib $(buildscript-dir)/html-to-texi \ < $(outdir)/colorado.html > $(outdir)/colorado.itexi BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2html \ -o $(outdir)/computer-notation.html \ $(src-dir)/essay/computer-notation.bib $(buildscript-dir)/html-to-texi \ < $(outdir)/computer-notation.html > $(outdir)/computer-notation.itexi BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2html \ -o $(outdir)/engravingbib.html \ $(src-dir)/essay/engravingbib.bib $(buildscript-dir)/html-to-texi \ < $(outdir)/engravingbib.html > $(outdir)/engravingbib.itexi $(outdir)/essay.texi: $(outdir)/engravingbib.itexi ########### ### Targets default: local-txt-doc local-help: extra-local-help extra-local-help: @echo " check-xrefs [ISOLANG=LL] validate Texinfo cross-references" @echo " fix-xrefs [ISOLANG=LL] interactively fix Texinfo cross-references" @echo " (use with caution)" @echo " info update info pages" @echo " xml update Docbook xml documentation" @echo @echo "Translations specific targets (see TRANSLATION for details):" @echo " new-lang ISOLANG=LL create and initialize" @echo " subdirectory \'LL' for language \'LL" @echo " (if \'LL exists, update missing file)" @echo " po-update update and replace PO files for" @echo " documentation with msgmerged versions" @echo " check-translation ISOLANG=LL show changes in English docs since" @echo " last translation update" @echo " update-translation ISOLANG=LL call $$$$EDITOR to help updating" @echo " the translation" @echo " skeleton-update ISOLANG=LL update Texinfo skeleton files" @echo " snippet-update ISOLANG=LL update ly snippets in Texinfo translation" @echo " according to docs in English" @echo " (use with caution)" @echo @echo " LL refers to the desired locale" @echo " (most often only the ISO 639 language code)." @echo info: $(INFO_FILES) @echo export LILYPOND_DATADIR=$(LILYPOND_DATADIR) @echo export PYTHONPATH=$(PYTHONPATH) xml: $(outdir)/notation/notation.xml $(outdir)/internals/internals.xml local-clean: rm -f $(INFO_IMAGES_DIR) ### Web targets ifeq ($(out),www) local-WWW-1: $(OUT_TEXINFO_MANUALS) $(PDF_FILES) info local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(source-links) $(OMF_FILES) endif ######### ### Rules $(outdir)/lilypond-%.info: $(outdir)/%.texi $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep $(outdir)/version.itexi $(outdir)/weblinks.itexi $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$@ $< # cd $(outdir) rule gets bit hairy for --srcdir configure builds txt-to-html: $(foreach a, $(README_TOP_FILES), cp $(top-src-dir)/$(a) $(outdir)/$(a).txt && ) true $(PYTHON) $(step-bindir)/text2html.py $(OUT_TXT_FILES) ifeq ($(out),www) ## Extra images dependencies $(OUT_TEXINFO_MANUALS): $(outdir)/pictures $(outdir)/pictures: $(MAKE) -C pictures WWW-1 ln -sf ../pictures/$(outdir) $@ $(outdir)/web.texi: $(outdir)/ly-examples $(outdir)/ly-examples: $(MAKE) -C web/ly-examples ln -sf ../web/ly-examples/$(outdir) $@ endif # Ugh, using '%' twice not possible $(outdir)/notation/notation.xml: $(outdir)/notation.texi mkdir -p $(dir $@) $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $< $(outdir)/internals/internals.xml: $(outdir)/internals.texi mkdir -p $(dir $@) $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $< $(outdir)/learning.texi $(outdir)/notation.texi: $(OUT_PDF_IMAGES) $(foreach manual, $(MANUAL_SUBDIRS),\ $(eval $(outdir)/(manual).texi: $(call src-wildcard,$(manual)/*.ite??))) $(outdir)/source: @rm -f $(@) ln -sf $(depth) $(@) $(outdir)/%/source: @rm -f $(@) mkdir -p $(dir $@) ln -sf $(depth)/.. $(@) ## Snippets rules idiosyncrases $(outdir)/%.itely: snippets/%-intro.itely snippets/%.snippet-list xargs $(LYS_TO_TELY) -f doctitle,texidoc,verbatim --name=$@ --template=$< < $(filter %.snippet-list, $^) $(outdir)/snippets.texi: $(GENERATED_ITELY_FILES) $(SNIPPET_LY_FILES) $(outdir)/%.bib: %.bib ln -f $< $@ ## notation.texi deps $(top-build-dir)/mf/$(outconfbase)/feta16list.ly: $(MAKE) -C $(top-src-dir)/mf $(outdir)/notation.texi: $(outdir)/ly-grammar.txt ## Rules for the automatically generated documentation $(outdir)/ly-grammar.txt: $(top-src-dir)/lily/parser.yy cd $(outdir) && $(BISON) -v $< $(buildscript-dir)/yyout2grammar $(outdir)/parser.output $@ # There used to be a dependency on a dummy target, to force a rebuild # of internals every time. however, this triggers # compilation during install, which is a bad thing (tm). $(outdir)/internals.texi: $(LILYPOND_BINARY) cd $(outdir) && $(LILYPOND_BINARY) --verbose $(top-src-dir)/ly/generate-documentation ############################################### # Documentation and translations maintenance # ############################################### po-update: make -C po po-update all-translations-update: po-update translation-status $(foreach lang, $(LANGS), make ISOLANG=$(lang) skeleton-update snippet-update &&) true ifneq ($(NO_COLOR),) CHECK_TRANSLATION_FLAGS = --no-color endif ifneq ($(ISOLANG),) new-lang-dir: mkdir -p $(ISOLANG)/$(DIR) cp fr/GNUmakefile $(ISOLANG) cp fr/$(DIR)/GNUmakefile $(ISOLANG)/$(DIR) sed -i -e 's/ISOLANG *= *fr/ISOLANG = $(ISOLANG)/' $(ISOLANG)/GNUmakefile $(ISOLANG)/$(DIR)/GNUmakefile rm -f $(outdir)/*.*tely $(outdir)/*.*texi $(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) -o doc.pot --skeleton --gettext $$(cd $(ISOLANG) && ls -1 ../$(DIR).tely ../$(DIR).texi) for i in $$(cd $(outdir) && ls -1 $(DIR).tely $(DIR).texi); do\ test -e $(ISOLANG)/$$i || mv $(outdir)/$$i $(ISOLANG)/$$i;\ done rm -f $(outdir)/$(DIR).tely $(outdir)/$(DIR).texi for i in $$(cd $(outdir) && ls -1 *.*tely *.*texi); do\ test -e $(ISOLANG)/$(DIR)/$$i\ || test -e $(ISOLANG)/$$i\ || mv $(outdir)/$$i $(ISOLANG)/$(DIR)/$$i;\ done new-lang: # Also for updating/adding missing files mkdir -p $(ISOLANG) $(foreach i,$(TRANSLATION_DIRS),$(MAKE) new-lang-dir DIR=$(i) &&) : msgmerge -U po/lilypond-doc.pot $(outdir)/doc.pot test -e po/$(ISOLANG).po || cp po/lilypond-doc.pot po/$(ISOLANG).po @echo "*** Please add a language definition for $(ISOLANG) in python/langdefs.py ***" TRANSLATION_DIRS = web texidocs TRANSLATION_FILES = $(shell git ls-files $(ISOLANG) | grep -v GNUmakefile) TEXI_LANGUTIL_FLAGS += --skeleton TELY_FILES = $(call src-wildcard,$(ISOLANG)/*.tely) skeleton-update: mkdir -p $(ISOLANG) $(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) $(TEXI_LANGUTIL_FLAGS) $(TELY_FILES:$(ISOLANG)/%.tely=../%.tely) $(PYTHON) $(auxscript-dir)/texi-skeleton-update.py $(ISOLANG) $(outdir) snippet-update: $(PYTHON) $(auxscript-dir)/update-snippets.py user $(ISOLANG) '*.itely' DOCUMENTS_INCLUDES:=-I $(ISOLANG) \ -I $(top-build-dir)/Documentation/$(ISOLANG)/out-www \ -I $(top-src-dir)/Documentation/snippets \ -I $(top-build-dir)/Documentation/out-www \ -I $(top-build-dir)/Documentation/out else # ISOLANG is empty DOCUMENTS_INCLUDES:=-I . \ -I $(top-build-dir)/Documentation/out-www \ -I $(top-src-dir)/Documentation/snippets \ -I $(top-build-dir)/Documentation/snippets/out-www \ -I $(top-build-dir)/Documentation/out endif # ISOLANG check-xrefs: $(PYTHON) $(auxscript-dir)/check_texi_refs.py --batch \ $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py fix-xrefs: $(PYTHON) $(auxscript-dir)/check_texi_refs.py --auto-fix \ $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py check-translation: ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES) update-translation: ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES) translation-status: @echo Target temporarily disabled .SECONDARY: