X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2FGNUmakefile;h=d2a4eb2f58345f5ccb5c9cf1bb0eb6750079a998;hb=abf0f7e73103716d60c235fa61d938754d9f3a06;hp=792b09b27780ea8d7b076a346959eb1120a585e1;hpb=a83a8b6e15a5cbbd94f0e6a7157457da0475c6d3;p=lilypond.git diff --git a/Documentation/GNUmakefile b/Documentation/GNUmakefile index 792b09b277..d2a4eb2f58 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 learning notation -SUBDIRS = $(MANUALS_SUBDIRS) snippets bibliography pictures misc po $(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,22 +28,17 @@ $(outdir)/snippets/index..html: TEXI2HTML_FLAGS += -D short_toc ### Extra source files README_TOP_FILES= DEDICATION THANKS -LATEX_FILES =$(call src-wildcard,*.latex) -IMAGES=$(call src-wildcard,*.png) -EPS_ILLUSTRATIONS=context-example.eps 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) -OUT_PDF_IMAGES = $(IMAGES:%.png=$(outdir)/%.pdf) -OUT_PDF_IMAGES += $(EPS_ILLUSTRATIONS:%.eps=$(outdir)/%.pdf) -OUT_PNG_IMAGES = $(OUT_PDF_IMAGES:%.pdf=%.png) - XREF_MAPS_FILES += $(XREF_MAPS_DIR)/internals.xref-map OMF_FILES += $(outdir)/internals.html.omf $(outdir)/internals.pdf.omf @@ -49,6 +46,7 @@ OMF_FILES += $(outdir)/internals.html.omf $(outdir)/internals.pdf.omf 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 @@ -58,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\ @@ -72,15 +73,12 @@ source-links = $(outdir)/source\ # Other out files -HTML_PAGE_NAMES= index translations devel -OUT_HTML_FILES += $(HTML_PAGE_NAMES:%=$(outdir)/%.html) -OUT_CSS_FILES = $(CSS_FILES:%.css=$(outdir)/%.css) - -MAIN_INFO_DOC = lilypond-notation -INFO_DOCS = lilypond-application lilypond-changes lilypond-contributor lilypond-internals \ - lilypond-learning lilypond-notation music-glossary +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) @@ -93,30 +91,68 @@ 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-doc +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) @@ -131,7 +167,7 @@ local-clean: ### Web targets ifeq ($(out),www) -local-WWW-1: $(TEXINFO_MANUALS:%=$(outdir)/%.texi) $(PDF_FILES) info +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 @@ -140,20 +176,28 @@ 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)/%.css: %.css - ln -f $< $@ +$(outdir)/pictures: + $(MAKE) -C pictures WWW-1 + ln -sf ../pictures/$(outdir) $@ -## Extra images dependencies -$(outdir)/learning/index.html: $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES) -$(outdir)/notation/index.html: $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES) -$(outdir)/learning-big-page.html: $(OUT_PNG_IMAGES) -$(outdir)/notation-big-page.html: $(OUT_PNG_IMAGES) +$(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 @@ -169,17 +213,6 @@ $(outdir)/learning.texi $(outdir)/notation.texi: $(OUT_PDF_IMAGES) $(foreach manual, $(MANUAL_SUBDIRS),\ $(eval $(outdir)/(manual).texi: $(call src-wildcard,$(manual)/*.ite??))) -$(outdir)/%.png: %.png - convert -depth 8 -geometry 50x50% $< $@ - -$(outdir)/%.png: %.eps - gs -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -q -sOutputFile=$@ -sDEVICE=png16m -dEPSCrop -dNOPAUSE -f $< -c quit - -$(outdir)/%.pdf: %.png - convert -depth 8 $< $@ - -$(outdir)/%.pdf: %.eps - gs -dAutoRotatePages=/None -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -sOutputFile=$@ -dEPSCrop -c .setpdfwrite -f $< $(outdir)/source: @@ -210,7 +243,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 @@ -234,63 +267,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) +TEXI_LANGUTIL_FLAGS += --skeleton 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) $(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) $(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 + @echo Target temporarily disabled .SECONDARY: