3 ########################
4 # Documentation build #
5 ########################
11 LANGS = $(shell $(PYTHON) $(top-src-dir)/python/langdefs.py)
12 MANUALS_SUBDIRS = usage contributor essay \
13 web learning notation extending
14 SUBDIRS = $(MANUALS_SUBDIRS) snippets logo pictures misc po css topdocs \
15 included ly-examples $(LANGS)
16 STEPMAKE_TEMPLATES = documentation texinfo tex omf
17 LOCALSTEPMAKE_TEMPLATES = lilypond ly
21 LILYPOND_BOOK_FLAGS = --extra-options '-e "(ly:set-option (quote internal-type-checking) \#t)"'
24 -I $(top-build-dir)/Documentation/$(outconfbase)
25 $(outdir)/snippets-big-page.html: TEXI2HTML_FLAGS += -D short_toc
26 $(outdir)/snippets/index.html: TEXI2HTML_FLAGS += -D short_toc
28 ### Extra source files
30 README_TOP_FILES= DEDICATION THANKS
32 IN_ITELY_FILES = $(call src-wildcard,snippets/*-intro.itely)
33 SNIPPET_LY_FILES = $(call src-wildcard,snippets/*.ly)
35 EXTRA_DIST_FILES = $(call src-wildcard,*.init) $(call src-wildcard,*.bst)
40 GENERATED_ITELY_FILES = $(IN_ITELY_FILES:snippets/%-intro.itely=$(outdir)/%.itely)
42 XREF_MAPS_FILES += $(XREF_MAPS_DIR)/internals.xref-map
43 OMF_FILES += $(outdir)/internals.html.omf $(outdir)/internals.pdf.omf
46 TEXINFO_MANUALS = internals\
47 $(TELY_FILES:%.tely=%)\
48 $(TEXI_FILES:%.texi=%)
49 OUT_TEXINFO_MANUALS = $(TEXINFO_MANUALS:%=$(outdir)/%.texi)
51 ## CHAIN_RULE hack: keep the following line *before* including
52 # stepmake.make, so the Internals Reference is built before the
53 # Notation Reference, thus providing automatically generated sections
55 TEXI_FILES_FROM_TELY = $(outdir)/internals.texi
57 PDF_FILES = $(TEXINFO_MANUALS:%=$(outdir)/%.pdf)
60 UNSPLIT_HTML_MANUALS =
61 SPLIT_HTML_MANUALS = $(foreach manual, $(TEXINFO_MANUALS),\
62 $(if $(findstring $(manual), $(UNSPLIT_HTML_MANUALS)),,$(manual)))
63 NOT_TOPDIR_HTML_MANUALS = $(foreach manual, $(SPLIT_HTML_MANUALS),\
64 $(if $(findstring $(manual), $(TOPDIR_HTML_MANUALS)),,$(manual)))
66 OUT_HTML_FILES = $(UNSPLIT_HTML_MANUALS:%=$(outdir)/%.html)\
67 $(SPLIT_HTML_MANUALS:%=$(outdir)/%-big-page.html)
68 DEEP_HTML_FILES = $(NOT_TOPDIR_HTML_MANUALS:%=$(outdir)/%/index.html)
70 # Symlinks to refer to external source documents from split and non-split HTML
71 source-links = $(outdir)/source\
72 $(foreach manual, $(SPLIT_HTML_MANUALS), $(outdir)/$(manual)/source)
76 MAIN_INFO_DOC = lilypond-web
77 INFO_DOCS = lilypond-usage lilypond-changes lilypond-contributor lilypond-internals \
78 lilypond-essay lilypond-learning lilypond-notation music-glossary \
79 lilypond-web lilypond-extending
81 INFO_DOCS += lilypond-snippets
83 INFO_FILES = $(INFO_DOCS:%=$(outdir)/%.info)
86 INFO_IMAGES_DIR = lilypond
87 DEST_INFO_IMAGES_SUBDIR = Documentation
90 include $(depth)/make/stepmake.make
92 OUT_TXT_FILES = $(addprefix $(outdir)/, $(addsuffix .txt, $(README_TOP_FILES)))
95 ### Web site idiosyncrasies
96 $(XREF_MAPS_DIR)/web.xref-map: XREF_MAP_FLAGS += --split=node
99 JS_FILES = $(call src-wildcard,*.js)
100 PHP_FILES = $(call src-wildcard,*.php)
101 EXTRA_DIST_FILES += $(JS_FILES) $(PHP_FILES)
103 OUT_JS_FILES = $(JS_FILES:%.js=$(outdir)/%.js)
104 OUT_PHP_FILES = $(PHP_FILES:%.php=$(outdir)/%.php)
108 ### bad hack for badly-integrated roadmap.
110 cp $(top-src-dir)/ROADMAP $(outdir)
111 $(outdir)/contributor.texi: $(outdir)/ROADMAP
113 ### bad hack for badly-integrated bibliography
114 $(outdir)/colorado.itexi:
115 BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \
116 -s $(top-src-dir)/Documentation/lily-bib \
117 -o $(outdir)/colorado.itexi \
118 $(src-dir)/essay/colorado.bib
120 $(outdir)/computer-notation.itexi:
121 BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \
122 -s $(top-src-dir)/Documentation/lily-bib \
123 -o $(outdir)/computer-notation.itexi \
124 $(src-dir)/essay/computer-notation.bib
126 $(outdir)/engravingbib.itexi:
127 BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \
128 -s $(top-src-dir)/Documentation/lily-bib \
129 -o $(outdir)/engravingbib.itexi \
130 $(src-dir)/essay/engravingbib.bib
132 $(outdir)/essay.texi: \
133 $(outdir)/colorado.itexi \
134 $(outdir)/computer-notation.itexi \
135 $(outdir)/engravingbib.itexi
141 default: local-txt-doc
143 local-help: extra-local-help
146 @echo " check-xrefs [ISOLANG=LL] validate Texinfo cross-references"
147 @echo " fix-xrefs [ISOLANG=LL] interactively fix Texinfo cross-references"
148 @echo " (use with caution)"
149 @echo " info update info pages"
150 @echo " xml update Docbook xml documentation"
152 @echo "Translations specific targets (see TRANSLATION for details):"
153 @echo " new-lang ISOLANG=LL create and initialize"
154 @echo " subdirectory \'LL' for language \'LL"
155 @echo " (if \'LL exists, update missing file)"
156 @echo " po-update update and replace PO files for"
157 @echo " documentation with msgmerged versions"
158 @echo " check-translation ISOLANG=LL show changes in English docs since"
159 @echo " last translation update"
160 @echo " update-translation ISOLANG=LL call $$$$EDITOR to help updating"
161 @echo " the translation"
162 @echo " snippet-update ISOLANG=LL update ly snippets in Texinfo translation"
163 @echo " according to docs in English"
164 @echo " (use with caution)"
166 @echo " LL refers to the desired locale"
167 @echo " (most often only the ISO 639 language code)."
171 @echo export LILYPOND_DATADIR=$(LILYPOND_DATADIR)
172 @echo export PYTHONPATH=$(PYTHONPATH)
174 xml: $(outdir)/notation/notation.xml $(outdir)/internals/internals.xml
178 rm -f $(INFO_IMAGES_DIR)
183 local-WWW-1: $(OUT_TEXINFO_MANUALS) $(PDF_FILES) info
185 ifeq ($(AJAX_SEARCH),1)
186 local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(OUT_JS_FILES) $(OUT_PHP_FILES) $(source-links) $(OMF_FILES)
188 local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(source-links) $(OMF_FILES)
197 $(outdir)/lilypond-%.info: $(outdir)/%.texi $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep $(outdir)/version.itexi $(outdir)/weblinks.itexi
198 $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$@ $<
200 txt-to-html: $(OUT_TXT_FILES) $(OUT_TXT_FILES:%.txt=%.html)
202 $(OUT_TXT_FILES): $(outdir)/%.txt: $(top-src-dir)/%
205 $(OUT_TXT_FILES:%.txt=%.html): $(outdir)/%.html: $(outdir)/%.txt
206 $(PYTHON) $(step-bindir)/text2html.py $<
208 # Explicitly list the dependencies on generated content
209 $(outdir)/web.texi: $(outdir)/we-wrote.itexi $(outdir)/others-did.itexi $(outdir)/weblinks.itexi
212 ## Extra images dependencies
213 $(OUT_TEXINFO_MANUALS): $(outdir)/pictures
216 $(MAKE) -C pictures WWW-1
217 ln -sf ../pictures/$(outdir) $@
219 $(outdir)/web.texi: $(outdir)/css $(outdir)/ly-examples
223 ln -sf ../css/$(outdir) $@
225 $(outdir)/ly-examples:
226 $(MAKE) -C ly-examples
227 ln -sf ../ly-examples/$(outdir) $@
231 # Ugh, using '%' twice not possible
232 $(outdir)/notation/notation.xml: $(outdir)/notation.texi
234 $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<
236 $(outdir)/internals/internals.xml: $(outdir)/internals.texi
238 $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<
240 $(outdir)/learning.texi $(outdir)/notation.texi: $(OUT_PDF_IMAGES)
249 ln -sf $(depth)/.. $(@)
252 ## Snippets rules idiosyncrasies
253 $(outdir)/%.itely: snippets/%-intro.itely snippets/%.snippet-list
254 xargs $(LYS_TO_TELY) -f doctitle,texidoc,verbatim --name=$@ --template=$< < $(filter %.snippet-list, $^)
256 $(outdir)/snippets.texi: $(GENERATED_ITELY_FILES) $(SNIPPET_LY_FILES)
258 $(outdir)/%.bib: %.bib
264 $(outdir)/%.php: %.php
267 ## notation.texi deps
268 $(top-build-dir)/mf/$(outconfbase)/feta16list.ly:
269 $(MAKE) -C $(top-src-dir)/mf
271 $(outdir)/notation.texi: $(outdir)/ly-grammar.txt
273 ## Rules for the automatically generated documentation
274 $(outdir)/ly-grammar.txt: $(top-src-dir)/lily/parser.yy
275 cd $(outdir) && $(BISON) -v $<
276 $(buildscript-dir)/yyout2grammar $(outdir)/parser.output $@
278 # There used to be a dependency on a dummy target, to force a rebuild
279 # of internals every time. however, this triggers
280 # compilation during install, which is a bad thing (tm).
282 $(outdir)/internals.texi: $(LILYPOND_BINARY)
283 cd $(outdir) && $(LILYPOND_BINARY) --verbose $(top-src-dir)/ly/generate-documentation
286 ###############################################
287 # Documentation and translations maintenance #
288 ###############################################
292 all-translations-update: po-update translation-status
293 $(foreach lang, $(LANGS), make ISOLANG=$(lang) skeleton-update snippet-update &&) true
296 CHECK_TRANSLATION_FLAGS = --no-color
301 mkdir -p $(ISOLANG)/$(DIR)
302 cp fr/GNUmakefile $(ISOLANG)
303 cp fr/$(DIR)/GNUmakefile $(ISOLANG)/$(DIR)
304 sed -i -e 's/ISOLANG *= *fr/ISOLANG = $(ISOLANG)/' $(ISOLANG)/GNUmakefile $(ISOLANG)/$(DIR)/GNUmakefile
305 rm -f $(outdir)/*.*tely $(outdir)/*.*texi
306 $(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) -o doc.pot --skeleton --gettext $$(cd $(ISOLANG) && ls -1 ../$(DIR).tely ../$(DIR).texi)
307 for i in $$(cd $(outdir) && ls -1 $(DIR).tely $(DIR).texi); do\
308 test -e $(ISOLANG)/$$i || mv $(outdir)/$$i $(ISOLANG)/$$i;\
310 rm -f $(outdir)/$(DIR).tely $(outdir)/$(DIR).texi
311 for i in $$(cd $(outdir) && ls -1 *.*tely *.*texi); do\
312 test -e $(ISOLANG)/$(DIR)/$$i\
313 || test -e $(ISOLANG)/$$i\
314 || mv $(outdir)/$$i $(ISOLANG)/$(DIR)/$$i;\
318 # Also for updating/adding missing files
320 $(foreach i,$(TRANSLATION_DIRS),$(MAKE) new-lang-dir DIR=$(i) &&) :
321 msgmerge -U po/lilypond-doc.pot $(outdir)/doc.pot
322 test -e po/$(ISOLANG).po || cp po/lilypond-doc.pot po/$(ISOLANG).po
323 @echo "*** Please add a language definition for $(ISOLANG) in python/langdefs.py ***"
325 TRANSLATION_DIRS = web texidocs
326 TRANSLATION_FILES = $(shell git ls-files $(ISOLANG) | grep -v GNUmakefile)
327 TEXI_LANGUTIL_FLAGS += --skeleton
329 TELY_FILES = $(call src-wildcard,$(ISOLANG)/*.tely)
331 @echo "$@ has been discontinued"
332 @echo "simply copy .texi, .itexi files you want to translate"
335 $(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) $(TEXI_LANGUTIL_FLAGS) $(TELY_FILES:$(ISOLANG)/%.tely=../%.tely)
336 $(PYTHON) $(auxscript-dir)/texi-skeleton-update.py $(ISOLANG) $(outdir)
339 $(PYTHON) $(auxscript-dir)/update-snippets.py user $(ISOLANG) '*.itely'
341 DOCUMENTS_INCLUDES:=-I $(ISOLANG) \
342 -I $(top-build-dir)/Documentation/$(ISOLANG)/out-www \
343 -I $(top-src-dir)/Documentation/snippets \
344 -I $(top-build-dir)/Documentation/out-www \
345 -I $(top-build-dir)/Documentation/out
347 else # ISOLANG is empty
349 DOCUMENTS_INCLUDES:=-I . \
350 -I $(top-build-dir)/Documentation/out-www \
351 -I $(top-src-dir)/Documentation/snippets \
352 -I $(top-build-dir)/Documentation/snippets/out-www \
353 -I $(top-build-dir)/Documentation/out
358 $(PYTHON) $(auxscript-dir)/check_texi_refs.py --batch \
359 $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py
362 $(PYTHON) $(auxscript-dir)/check_texi_refs.py --auto-fix \
363 $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py
366 ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
369 ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
371 # what's it gonna be, boy...tranlationS-/translation-
373 PYTHONPATH=$(top-src-dir)/python:$(top-src-dir)/python/auxiliar $(PYTHON) $(top-src-dir)/scripts/auxiliar/translations-status.py