X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2FGNUmakefile;h=790b0460479ce4a976d511a7a1d91228fc4ce460;hb=d9fcd3db46970a4afbc4e073abb2156ecc865981;hp=dbf4805d50c3dd3b45b38566e0c5028a2517b270;hpb=ecbaf861c4f0358c98dd3949029af21c97d5b1ed;p=lilypond.git

diff --git a/Documentation/GNUmakefile b/Documentation/GNUmakefile
index dbf4805d50..872166ad93 100644
--- a/Documentation/GNUmakefile
+++ b/Documentation/GNUmakefile
@@ -1,72 +1,313 @@
 depth = ..
 
+########################
+#  Documentation build #
+########################
+
+#############
+### Variables
+
 NAME = documentation
-LANGS = $(shell $(PYTHON) $(buildscript-dir)/langdefs.py)
-SUBDIRS=user bibliography pictures topdocs misc po $(LANGS)
-STEPMAKE_TEMPLATES=documentation texinfo tex
-LOCALSTEPMAKE_TEMPLATES=lilypond ly
-LILYPOND_BOOK_FLAGS=--extra-options '-e "(ly:set-option (quote internal-type-checking) \#t)"'
-README_TOP_FILES= DEDICATION THANKS 
-EXTRA_DIST_FILES= texinfo.css TRANSLATION
+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
 
-include $(depth)/make/stepmake.make
+### 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) search-box.ihtml
+
+### Out files
+
+# Dependencies
+GENERATED_ITELY_FILES = $(IN_ITELY_FILES:snippets/%-intro.itely=$(outdir)/%.itely)
 
-default: local-doc
+XREF_MAPS_FILES += $(XREF_MAPS_DIR)/internals.xref-map
+OMF_FILES += $(outdir)/internals.html.omf $(outdir)/internals.pdf.omf
 
-local-WWW: txt-to-html $(outdir)/index.html $(outdir)/devel.html
+# Main manuals
+TEXINFO_MANUALS = internals\
+ $(TELY_FILES:%.tely=%)\
+ $(TEXI_FILES:%.texi=%)
+OUT_TEXINFO_MANUALS = $(TEXINFO_MANUALS:%=$(outdir)/%.texi)
 
-local-WWW-clean: deep-WWW-clean
+## 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
 
-deep-WWW-clean:
-	rm -rf $(outdir)/wiki-dump
+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
+
+
+###########
+### Targets
+
+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"
+
+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
+	$(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:
-	@if (( $$(file -b $(ISOLANG)) == directory )) 2>/dev/null; \
-	then echo "Error: $(ISOLANG) directory already exists. Exiting." ; \
-	exit 3 ; \
-	fi
-	mkdir -p $(ISOLANG)/user
+new-lang-dir:
+	mkdir -p $(ISOLANG)/$(DIR)
 	cp fr/GNUmakefile $(ISOLANG)
-	cp fr/user/GNUmakefile $(ISOLANG)/user
-	sed -i -e 's/ISOLANG *= *fr/ISOLANG = $(ISOLANG)/' $(ISOLANG)/GNUmakefile $(ISOLANG)/user/GNUmakefile
-	$(PYTHON) $(buildscript-dir)/texi-langutils.py -d $(outdir) -b "UNTRANSLATED NODE: IGNORE ME" -l $(ISOLANG) -o doc.pot --skeleton --gettext ../user/lilypond-learning.tely
-	mv $(outdir)/*.*tely $(ISOLANG)/user
+	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
-	cp po/lilypond-doc.pot po/$(ISOLANG).po
-	@echo "***  Please add a language definition for $(ISOLANG) in buildscripts/langdefs.py  ***"
+	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  ***"
 
-CHECKED_FILES = $(ISOLANG)/index.html.in $(shell find $(ISOLANG)/user/ -maxdepth 1 -name '*.*te??')
+TRANSLATION_DIRS = web texidocs
+TRANSLATION_FILES = $(shell git ls-files $(ISOLANG) | grep -v GNUmakefile)
 
-TELY_FILES = $(call src-wildcard,$(ISOLANG)/user/*.tely)
+TELY_FILES = $(call src-wildcard,$(ISOLANG)/*.tely)
 skeleton-update:
-	$(PYTHON) $(buildscript-dir)/texi-langutils.py -d $(outdir) -b "UNTRANSLATED NODE: IGNORE ME" -l $(ISOLANG) --skeleton $(TELY_FILES:$(ISOLANG)/user/%.tely=../user/%.tely)
-	$(PYTHON) $(buildscript-dir)/texi-skeleton-update.py $(ISOLANG)/user $(outdir)
+	mkdir -p $(ISOLANG)
+	$(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) --skeleton $(TELY_FILES:$(ISOLANG)/%.tely=../%.tely)
+	$(PYTHON) $(auxscript-dir)/texi-skeleton-update.py $(ISOLANG) $(outdir)
 
 snippet-update:
-	$(PYTHON) $(buildscript-dir)/update-snippets.py user $(ISOLANG)/user '*.itely'
+	$(PYTHON) $(auxscript-dir)/update-snippets.py user $(ISOLANG) '*.itely'
 
-endif
+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:
-	$(PYTHON) $(buildscript-dir)/check_translation.py $(buildscript-dir) $(CHECKED_FILES)
+	ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
 
 update-translation:
-	$(PYTHON) $(buildscript-dir)/check_translation.py --update $(buildscript-dir) $(CHECKED_FILES)
+	ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
 
 translation-status:
-	make -C po out=www messages
-	$(PYTHON) $(buildscript-dir)/translations-status.py $(buildscript-dir) po/out-www
+	@echo Target temporarily disabled
+
+.SECONDARY: