X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2FGNUmakefile;h=9592e548c513145fb4adc656e0b8fe436fddc1d7;hb=2cb02ca327fbbde256ae6712d1e968b9da5d492e;hp=f62631f4d57b61e08fc06f50932b7427dbd1560f;hpb=cb01be4028886109ecc4772234452965ce7dfb66;p=lilypond.git diff --git a/Documentation/GNUmakefile b/Documentation/GNUmakefile index f62631f4d5..9592e548c5 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 automated-engraving 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) ### Out files @@ -55,13 +56,16 @@ TEXI_FILES_FROM_TELY = $(outdir)/internals.texi 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,14 +73,12 @@ source-links = $(outdir)/source\ # Other out files -HTML_PAGE_NAMES= index translations devel -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 +INFO_DOCS += lilypond-snippets endif INFO_FILES = $(INFO_DOCS:%=$(outdir)/%.info) @@ -90,9 +92,14 @@ 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 -$(outdir)/general/index.html: TEXI2HTML_INIT = $(WEB_TEXI2HTML_INIT) -$(outdir)/general/index.html: TEXI2HTML_SPLIT = $(WEB_TEXI2HTML_SPLIT) ########### ### Targets @@ -102,22 +109,30 @@ 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\ - 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 " 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) @@ -141,10 +156,7 @@ 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: $(src-dir)/general.texi $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep $(outdir)/version.itexi +$(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 @@ -160,13 +172,11 @@ $(outdir)/pictures: $(MAKE) -C pictures WWW-1 ln -sf ../pictures/$(outdir) $@ -$(outdir)/general.texi: $(outdir)/examples +$(outdir)/web.texi: $(outdir)/ly-examples -$(outdir)/examples: - $(MAKE) -C general/examples -# FIXME: who is replacing src="examples --> src="../examples" ? -# [ugh, why do most scripts not even say they run anymore?] - ln -sf general/examples $@ +$(outdir)/ly-examples: + $(MAKE) -C web/ly-examples + ln -sf ../web/ly-examples/$(outdir) $@ endif # Ugh, using '%' twice not possible @@ -213,7 +223,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 @@ -243,78 +253,69 @@ new-lang-dir: 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 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) &&) : - $(foreach i, $(EXTRA_TRANSLATION_FILES), \ - (test -e $(ISOLANG)/$(i) \ - || cp fr/$(i) $(ISOLANG)/$(i)) && ) true 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 = $(shell git ls-files $(ISOLANG) | $(PYTHON) $(buildscript-dir)/pytt.py '/[^/]*$$' / | sort -u ) -TRANSLATION_DIRS = application general learning notation texidocs +TRANSLATION_DIRS = web texidocs TRANSLATION_FILES = $(shell git ls-files $(ISOLANG) | grep -v GNUmakefile) -EXTRA_TRANSLATION_FILES =\ - dedication.itely\ - index.html.in\ - common-macros.itexi\ - macros.itexi\ - translations.html.in\ - translations.template.html.in\ -# - +TEXI_LANGUTIL_FLAGS += --skeleton TELY_FILES = $(call src-wildcard,$(ISOLANG)/*.tely) skeleton-update: 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) translation-status: - make -C po out=www messages - $(auxscript-dir)/translations-status.py + @echo Target temporarily disabled .SECONDARY: