X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;ds=sidebyside;f=Documentation%2FGNUmakefile;h=88700e15315add0ff9ba11203562a444deefc821;hb=99b434910b500fd6eab261c65ac1fe4db4b44732;hp=7b9c52fc8da63d6d180f04d5e7a12a25d2c6c088;hpb=b94b32c5a3b047fa98e7784532df1aab88015025;p=lilypond.git diff --git a/Documentation/GNUmakefile b/Documentation/GNUmakefile index 7b9c52fc8d..88700e1531 100644 --- a/Documentation/GNUmakefile +++ b/Documentation/GNUmakefile @@ -9,8 +9,10 @@ depth = .. NAME = documentation LANGS = $(shell $(PYTHON) $(top-src-dir)/python/langdefs.py) -MANUALS_SUBDIRS = application contributor essay general learning notation -SUBDIRS = $(MANUALS_SUBDIRS) snippets logo pictures misc po css $(LANGS) +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 @@ -26,12 +28,11 @@ $(outdir)/snippets/index..html: TEXI2HTML_FLAGS += -D short_toc ### Extra source files README_TOP_FILES= DEDICATION THANKS -LATEX_FILES =$(call src-wildcard,*.latex) IN_ITELY_FILES = $(call src-wildcard,snippets/*-intro.itely) SNIPPET_LY_FILES = $(call src-wildcard,snippets/*.ly) -EXTRA_DIST_FILES = $(call src-wildcard,*.init) $(LATEX_FILES) +EXTRA_DIST_FILES = $(call src-wildcard,*.init) search-box.html ### Out files @@ -53,15 +54,18 @@ OUT_TEXINFO_MANUALS = $(TEXINFO_MANUALS:%=$(outdir)/%.texi) # of the NR TEXI_FILES_FROM_TELY = $(outdir)/internals.texi -PDF_FILES = $(subst $(outdir)/general.pdf,,$(TEXINFO_MANUALS:%=$(outdir)/%.pdf)) +PDF_FILES = $(TEXINFO_MANUALS:%=$(outdir)/%.pdf) -UNSPLITTED_HTML_MANUALS = changes +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 = $(SPLITTED_HTML_MANUALS:%=$(outdir)/%/index.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\ @@ -69,12 +73,13 @@ source-links = $(outdir)/source\ # Other out files -HTML_PAGE_NAMES= index translations devel +HTML_PAGE_NAMES= translations index OUT_HTML_FILES += $(HTML_PAGE_NAMES:%=$(outdir)/%.html) -MAIN_INFO_DOC = lilypond-notation -INFO_DOCS = lilypond-application lilypond-changes lilypond-contributor lilypond-internals \ - lilypond-essay lilypond-learning lilypond-notation music-glossary lilypond +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 @@ -90,12 +95,14 @@ include $(depth)/make/stepmake.make OUT_TXT_FILES = $(addprefix $(outdir)/, $(addsuffix .txt, $(README_TOP_FILES))) ### Web site idiosyncrases -## No big page -OUT_HTML_FILES := $(subst $(outdir)/general-big-page.html,,$(OUT_HTML_FILES)) +$(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 -## Different init file and CSS -$(outdir)/general/index.html: \ - TEXI2HTML_INIT = --init-file=$(top-src-dir)/Documentation/web-texi2html.init ########### ### Targets @@ -113,6 +120,7 @@ extra-local-help: \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\ @@ -144,6 +152,9 @@ 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 @@ -156,6 +167,12 @@ $(OUT_TEXINFO_MANUALS): $(outdir)/pictures $(outdir)/pictures: $(MAKE) -C pictures WWW-1 ln -sf ../pictures/$(outdir) $@ + +$(outdir)/web.texi: $(outdir)/examples + +$(outdir)/examples: + $(MAKE) -C web/examples + ln -sf ../web/examples/$(outdir) $@ endif # Ugh, using '%' twice not possible @@ -202,7 +219,7 @@ $(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 @@ -226,63 +243,75 @@ 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)/learning +new-lang-dir: + mkdir -p $(ISOLANG)/$(DIR) cp fr/GNUmakefile $(ISOLANG) - cp fr/learning/GNUmakefile $(ISOLANG)/learning - sed -i -e 's/ISOLANG *= *fr/ISOLANG = $(ISOLANG)/' $(ISOLANG)/GNUmakefile $(ISOLANG)/learning/GNUmakefile - $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) -o doc.pot --skeleton --gettext ../learning.tely - mv $(outdir)/*.*tely $(ISOLANG)/learning + 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 + 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 $(foreach i,learning notation application, \ - $(shell find $(ISOLANG)/$(manual) -name '*.*te??' -not -wholename '*out-www*')) \ - $(shell find $(ISOLANG)/texidocs/ -name '*.texidoc') +TRANSLATION_DIRS = web texidocs +TRANSLATION_FILES = $(shell git ls-files $(ISOLANG) | grep -v GNUmakefile) TELY_FILES = $(call src-wildcard,$(ISOLANG)/*.tely) skeleton-update: - $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) --skeleton $(TELY_FILES:$(ISOLANG)/%.tely=../%.tely) - $(auxscript-dir)/texi-skeleton-update.py $(ISOLANG) $(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: - $(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) $(CHECKED_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) $(CHECKED_FILES) + ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES) translation-status: make -C po out=www messages - $(auxscript-dir)/translations-status.py + $(PYTHON) $(auxscript-dir)/translations-status.py .SECONDARY: