X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2FGNUmakefile;h=fff37aa6adf70d879fb97065ac3c5ab88d063a65;hb=6c323bc1bb27a79f687f5f3f3ed6b105aad24caa;hp=2dcf751ce46959410b9113b12609f588274c64e3;hpb=fc41dbd0b6048fea62fa7251134fac350a59276f;p=lilypond.git diff --git a/Documentation/GNUmakefile b/Documentation/GNUmakefile index 2dcf751ce4..fff37aa6ad 100644 --- a/Documentation/GNUmakefile +++ b/Documentation/GNUmakefile @@ -9,10 +9,8 @@ depth = .. 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) +SUBDIRS = logo pictures misc po css topdocs \ + ly-examples $(LANGS) STEPMAKE_TEMPLATES = documentation texinfo tex omf LOCALSTEPMAKE_TEMPLATES = lilypond ly @@ -23,7 +21,7 @@ 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 +$(outdir)/snippets/index.html: TEXI2HTML_FLAGS += -D short_toc ### Extra source files @@ -31,8 +29,7 @@ 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) search-box.html +OUT_SNIPPET_LY_FILES = $(SNIPPET_LY_FILES:%.ly=out/%.ly) ### Out files @@ -56,51 +53,83 @@ 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),\ +TOPDIR_HTML_MANUALS = +UNSPLIT_HTML_MANUALS = +SPLIT_HTML_MANUALS = $(foreach manual, $(TEXINFO_MANUALS),\ + $(if $(findstring $(manual), $(UNSPLIT_HTML_MANUALS)),,$(manual))) +NOT_TOPDIR_HTML_MANUALS = $(foreach manual, $(SPLIT_HTML_MANUALS),\ $(if $(findstring $(manual), $(TOPDIR_HTML_MANUALS)),,$(manual))) -OUT_HTML_FILES = $(UNSPLITTED_HTML_MANUALS:%=$(outdir)/%.html)\ - $(SPLITTED_HTML_MANUALS:%=$(outdir)/%-big-page.html) +OUT_HTML_FILES = $(UNSPLIT_HTML_MANUALS:%=$(outdir)/%.html)\ + $(SPLIT_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) + $(foreach manual, $(SPLIT_HTML_MANUALS), $(outdir)/$(manual)/source) # Other out files -HTML_PAGE_NAMES= translations index -OUT_HTML_FILES += $(HTML_PAGE_NAMES:%=$(outdir)/%.html) - -MAIN_INFO_DOC = lilypond-notation +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 +INFO_DOCS += lilypond-snippets endif INFO_FILES = $(INFO_DOCS:%=$(outdir)/%.info) ifeq ($(out),www) INFO_IMAGES_DIR = lilypond -DEST_INFO_IMAGES_SUBDIR = Documentation/ +DEST_INFO_IMAGES_SUBDIR = Documentation endif include $(depth)/make/stepmake.make OUT_TXT_FILES = $(addprefix $(outdir)/, $(addsuffix .txt, $(README_TOP_FILES))) -### Web site idiosyncrases -$(outdir)/web/index.html: TEXI2HTML_INIT = $(WEB_TEXI2HTML_INIT) -$(outdir)/web/index.html: TEXI2HTML_SPLIT = $(WEB_TEXI2HTML_SPLIT) +### Web site idiosyncrasies +$(XREF_MAPS_DIR)/web.xref-map: XREF_MAP_FLAGS += --split=node + +### AJAX scripts +JS_FILES = $(call src-wildcard,*.js) +PHP_FILES = $(call src-wildcard,*.php) + +OUT_JS_FILES = $(JS_FILES:%.js=$(outdir)/%.js) +OUT_PHP_FILES = $(PHP_FILES:%.php=$(outdir)/%.php) + + + +### 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)/colorado.itexi: + BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \ + -s $(top-src-dir)/Documentation/lily-bib \ + -o $(outdir)/colorado.itexi \ + $(src-dir)/essay/colorado.bib + +$(outdir)/computer-notation.itexi: + BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \ + -s $(top-src-dir)/Documentation/lily-bib \ + -o $(outdir)/computer-notation.itexi \ + $(src-dir)/essay/computer-notation.bib + +$(outdir)/engravingbib.itexi: + BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \ + -s $(top-src-dir)/Documentation/lily-bib \ + -o $(outdir)/engravingbib.itexi \ + $(src-dir)/essay/engravingbib.bib + +$(outdir)/essay.texi: \ + $(outdir)/colorado.itexi \ + $(outdir)/computer-notation.itexi \ + $(outdir)/engravingbib.itexi -#$(outdir)/web/index.html: -# $(TEXI2HTML) $(TEXI2HTML_SPLIT) $(TEXI2HTML_FLAGS) --output $(outdir)/ $(outdir)/web.texi ########### ### Targets @@ -110,23 +139,29 @@ default: local-txt-doc local-help: extra-local-help extra-local-help: - @echo -e "\ - check-xrefs [ISOLANG=LL] validate Texinfo cross-references\n\ - fix-xrefs [ISOLANG=LL] interactively fix Texinfo cross-references (use with caution)\n\ - info update info pages\n\ - xml update Docbook xml documentation\n\ -\n\ -Translations specific targets (see TRANSLATION for details):\n\ - new-lang ISOLANG=LL create and initialize subdirectory \'LL' for language \'LL\n\ -(if \'LL exists, update missing file)\n\ - po-update update and replace PO files for documentation with msgmerged versions\n\ - check-translation ISOLANG=LL show changes in English docs since last translation update\n\ - update-translation ISOLANG=LL call $$$$EDITOR to help updating the translation\n\ - skeleton-update ISOLANG=LL update Texinfo skeleton files\n\ - snippet-update ISOLANG=LL update ly snippets in Texinfo translation according to\n\ - docs in English (use with caution)\n\ -\n\ -LL refers to the desired locale (most often only the ISO 639 language code).\n" + @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 " 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) @@ -143,20 +178,31 @@ local-clean: ifeq ($(out),www) local-WWW-1: $(OUT_TEXINFO_MANUALS) $(PDF_FILES) info +ifeq ($(AJAX_SEARCH),1) +local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(OUT_JS_FILES) $(OUT_PHP_FILES) $(source-links) $(OMF_FILES) +else local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(source-links) $(OMF_FILES) endif +endif + ######### ### Rules -$(outdir)/lilypond-%.info: $(outdir)/%.texi $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep $(outdir)/version.itexi - $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$@ $< +$(outdir)/lilypond-%.info: $(outdir)/%.texi $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep $(outdir)/version.itexi $(outdir)/weblinks.itexi | $(OUT_TEXINFO_MANUALS) + $(buildscript-dir)/run-and-check "$(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$@ $<" "$*.makeinfo.log" + +txt-to-html: $(OUT_TXT_FILES) $(OUT_TXT_FILES:%.txt=%.html) + +$(OUT_TXT_FILES): $(outdir)/%.txt: $(top-src-dir)/% + cp -f $< $@ + +$(OUT_TXT_FILES:%.txt=%.html): $(outdir)/%.html: $(outdir)/%.txt + $(buildscript-dir)/text2html $< -# 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) +# Explicitly list the dependencies on generated content +$(outdir)/web.texi: $(outdir)/we-wrote.itexi $(outdir)/others-did.itexi $(outdir)/weblinks.itexi ifeq ($(out),www) ## Extra images dependencies @@ -166,29 +212,29 @@ $(outdir)/pictures: $(MAKE) -C pictures WWW-1 ln -sf ../pictures/$(outdir) $@ -$(outdir)/web.texi: $(outdir)/examples +$(outdir)/web.texi: $(outdir)/css $(outdir)/ly-examples -$(outdir)/examples: - $(MAKE) -C web/examples - ln -sf ../web/examples/$(outdir) $@ +$(outdir)/css: + $(MAKE) -C css + ln -sf ../css/$(outdir) $@ + +$(outdir)/ly-examples: + $(MAKE) -C ly-examples + ln -sf ../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 $< + $(buildscript-dir)/run-and-check "$(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<" "$*.makeinfoxml.log" $(outdir)/internals/internals.xml: $(outdir)/internals.texi mkdir -p $(dir $@) - $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $< + $(buildscript-dir)/run-and-check "$(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<" "$*.makeinfoxml.log" $(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) $(@) @@ -199,15 +245,29 @@ $(outdir)/%/source: ln -sf $(depth)/.. $(@) -## Snippets rules idiosyncrases +## Snippets rules idiosyncrasies $(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) +$(TEXI_FILES_FROM_TELY): $(GENERATED_ITELY_FILES) $(OUT_SNIPPET_LY_FILES) + +$(OUT_SNIPPET_LY_FILES): out/ly-snippets.dep + +out/ly-snippets.dep: $(SNIPPET_LY_FILES) + mkdir -p snippets/out + $(buildscript-dir)/makesnippets $(src-dir)/snippets snippets/out $(src-dir) + mkdir -p out + touch $@ $(outdir)/%.bib: %.bib ln -f $< $@ +$(outdir)/%.js: %.js + ln -f $< $@ + +$(outdir)/%.php: %.php + ln -f $< $@ + ## notation.texi deps $(top-build-dir)/mf/$(outconfbase)/feta16list.ly: $(MAKE) -C $(top-src-dir)/mf @@ -217,15 +277,14 @@ $(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 $< - $(auxscript-dir)/yyout2grammar.py $(outdir)/parser.output $@ + $(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 - + cd $(outdir) && $(buildscript-dir)/run-and-check "$(LILYPOND_BINARY) --verbose $(top-src-dir)/ly/generate-documentation" "generate-documentation.log" ############################################### # Documentation and translations maintenance # @@ -243,11 +302,8 @@ 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 - $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) -o doc.pot --skeleton --gettext $$(cd $(ISOLANG) && ls -1 ../$(DIR).tely ../$(DIR).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 @@ -261,6 +317,8 @@ new-lang-dir: new-lang: # Also for updating/adding missing files mkdir -p $(ISOLANG) + cp fr/GNUmakefile $(ISOLANG) + sed -i -e 's/ISOLANG *= *fr/ISOLANG = $(ISOLANG)/' $(ISOLANG)/GNUmakefile $(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 @@ -268,46 +326,50 @@ new-lang: 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: + @echo "$@ has been discontinued" + @echo "simply copy .texi, .itexi files you want to translate" + exit 2 mkdir -p $(ISOLANG) - $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) --skeleton $(TELY_FILES:$(ISOLANG)/%.tely=../%.tely) - $(auxscript-dir)/texi-skeleton-update.py $(ISOLANG) $(outdir) + $(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: - $(auxscript-dir)/update-snippets.py user $(ISOLANG) '*.itely' + $(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-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/snippets/out-www \ +-I $(top-build-dir)/Documentation/out endif # ISOLANG check-xrefs: - $(auxscript-dir)/check_texi_refs.py --batch \ + $(PYTHON) $(auxscript-dir)/check_texi_refs.py --batch \ $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py fix-xrefs: - $(auxscript-dir)/check_texi_refs.py --auto-fix \ + $(PYTHON) $(auxscript-dir)/check_texi_refs.py --auto-fix \ $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py check-translation: - ISOLANG=$(ISOLANG) $(auxscript-dir)/check_translation.py $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES) + ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES) update-translation: - ISOLANG=$(ISOLANG) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES) + ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES) +# what's it gonna be, boy...tranlationS-/translation- translation-status: - make -C po out=www messages - $(auxscript-dir)/translations-status.py - -.SECONDARY: + PYTHONPATH=$(top-src-dir)/python:$(top-src-dir)/python/auxiliar $(PYTHON) $(top-src-dir)/scripts/auxiliar/translations-status.py