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 \
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)
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 UNSPLITTED_HTML_MANUALS =
61 SPLITTED_HTML_MANUALS = $(foreach manual, $(TEXINFO_MANUALS),\
62 $(if $(findstring $(manual), $(UNSPLITTED_HTML_MANUALS)),,$(manual)))
63 NOT_TOPDIR_HTML_MANUALS = $(foreach manual, $(SPLITTED_HTML_MANUALS),\
64 $(if $(findstring $(manual), $(TOPDIR_HTML_MANUALS)),,$(manual)))
66 OUT_HTML_FILES = $(UNSPLITTED_HTML_MANUALS:%=$(outdir)/%.html)\
67 $(SPLITTED_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, $(SPLITTED_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
137 $(outdir)/others-did.itexi:
138 BSTINPUTS=$(src-dir)/web/ $(buildscript-dir)/bib2texi \
139 -s $(top-src-dir)/Documentation/lily-bib \
140 -o $(outdir)/others-did.itexi \
141 $(src-dir)/web/others-did.bib
143 $(outdir)/we-wrote.itexi:
144 BSTINPUTS=$(src-dir)/web/ $(buildscript-dir)/bib2texi \
145 -s $(top-src-dir)/Documentation/lily-bib \
146 -o $(outdir)/we-wrote.itexi \
147 $(src-dir)/web/we-wrote.bib
153 default: local-txt-doc
155 local-help: extra-local-help
158 @echo " check-xrefs [ISOLANG=LL] validate Texinfo cross-references"
159 @echo " fix-xrefs [ISOLANG=LL] interactively fix Texinfo cross-references"
160 @echo " (use with caution)"
161 @echo " info update info pages"
162 @echo " xml update Docbook xml documentation"
164 @echo "Translations specific targets (see TRANSLATION for details):"
165 @echo " new-lang ISOLANG=LL create and initialize"
166 @echo " subdirectory \'LL' for language \'LL"
167 @echo " (if \'LL exists, update missing file)"
168 @echo " po-update update and replace PO files for"
169 @echo " documentation with msgmerged versions"
170 @echo " check-translation ISOLANG=LL show changes in English docs since"
171 @echo " last translation update"
172 @echo " update-translation ISOLANG=LL call $$$$EDITOR to help updating"
173 @echo " the translation"
174 @echo " snippet-update ISOLANG=LL update ly snippets in Texinfo translation"
175 @echo " according to docs in English"
176 @echo " (use with caution)"
178 @echo " LL refers to the desired locale"
179 @echo " (most often only the ISO 639 language code)."
183 @echo export LILYPOND_DATADIR=$(LILYPOND_DATADIR)
184 @echo export PYTHONPATH=$(PYTHONPATH)
186 xml: $(outdir)/notation/notation.xml $(outdir)/internals/internals.xml
190 rm -f $(INFO_IMAGES_DIR)
195 local-WWW-1: $(OUT_TEXINFO_MANUALS) $(PDF_FILES) info
197 ifeq ($(AJAX_SEARCH),1)
198 local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(OUT_JS_FILES) $(OUT_PHP_FILES) $(source-links) $(OMF_FILES)
200 local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(source-links) $(OMF_FILES)
209 $(outdir)/lilypond-%.info: $(outdir)/%.texi $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep $(outdir)/version.itexi $(outdir)/weblinks.itexi
210 $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$@ $<
212 # cd $(outdir) rule gets bit hairy for --srcdir configure builds
214 $(foreach a, $(README_TOP_FILES), cp $(top-src-dir)/$(a) $(outdir)/$(a).txt && ) true
215 $(PYTHON) $(step-bindir)/text2html.py $(OUT_TXT_FILES)
218 ## Extra images dependencies
219 $(OUT_TEXINFO_MANUALS): $(outdir)/pictures
222 $(MAKE) -C pictures WWW-1
223 ln -sf ../pictures/$(outdir) $@
225 $(outdir)/ly-examples:
226 $(MAKE) -C web/ly-examples
227 ln -sf ../web/ly-examples/$(outdir) $@
231 $(outdir)/web.texi: $(outdir)/ly-examples $(outdir)/we-wrote.itexi $(outdir)/others-did.itexi
233 # duplicate (without ly-examples)
234 $(outdir)/web.texi: $(outdir)/we-wrote.itexi $(outdir)/others-did.itexi
238 # Ugh, using '%' twice not possible
239 $(outdir)/notation/notation.xml: $(outdir)/notation.texi
241 $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<
243 $(outdir)/internals/internals.xml: $(outdir)/internals.texi
245 $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<
247 $(outdir)/learning.texi $(outdir)/notation.texi: $(OUT_PDF_IMAGES)
249 $(foreach manual, $(MANUAL_SUBDIRS),\
250 $(eval $(outdir)/(manual).texi: $(call src-wildcard,$(manual)/*.ite??)))
261 ln -sf $(depth)/.. $(@)
264 ## Snippets rules idiosyncrasies
265 $(outdir)/%.itely: snippets/%-intro.itely snippets/%.snippet-list
266 xargs $(LYS_TO_TELY) -f doctitle,texidoc,verbatim --name=$@ --template=$< < $(filter %.snippet-list, $^)
268 $(outdir)/snippets.texi: $(GENERATED_ITELY_FILES) $(SNIPPET_LY_FILES)
270 $(outdir)/%.bib: %.bib
276 $(outdir)/%.php: %.php
279 ## notation.texi deps
280 $(top-build-dir)/mf/$(outconfbase)/feta16list.ly:
281 $(MAKE) -C $(top-src-dir)/mf
283 $(outdir)/notation.texi: $(outdir)/ly-grammar.txt
285 ## Rules for the automatically generated documentation
286 $(outdir)/ly-grammar.txt: $(top-src-dir)/lily/parser.yy
287 cd $(outdir) && $(BISON) -v $<
288 $(buildscript-dir)/yyout2grammar $(outdir)/parser.output $@
290 # There used to be a dependency on a dummy target, to force a rebuild
291 # of internals every time. however, this triggers
292 # compilation during install, which is a bad thing (tm).
294 $(outdir)/internals.texi: $(LILYPOND_BINARY)
295 cd $(outdir) && $(LILYPOND_BINARY) --verbose $(top-src-dir)/ly/generate-documentation
298 ###############################################
299 # Documentation and translations maintenance #
300 ###############################################
304 all-translations-update: po-update translation-status
305 $(foreach lang, $(LANGS), make ISOLANG=$(lang) skeleton-update snippet-update &&) true
308 CHECK_TRANSLATION_FLAGS = --no-color
313 mkdir -p $(ISOLANG)/$(DIR)
314 cp fr/GNUmakefile $(ISOLANG)
315 cp fr/$(DIR)/GNUmakefile $(ISOLANG)/$(DIR)
316 sed -i -e 's/ISOLANG *= *fr/ISOLANG = $(ISOLANG)/' $(ISOLANG)/GNUmakefile $(ISOLANG)/$(DIR)/GNUmakefile
317 rm -f $(outdir)/*.*tely $(outdir)/*.*texi
318 $(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) -o doc.pot --skeleton --gettext $$(cd $(ISOLANG) && ls -1 ../$(DIR).tely ../$(DIR).texi)
319 for i in $$(cd $(outdir) && ls -1 $(DIR).tely $(DIR).texi); do\
320 test -e $(ISOLANG)/$$i || mv $(outdir)/$$i $(ISOLANG)/$$i;\
322 rm -f $(outdir)/$(DIR).tely $(outdir)/$(DIR).texi
323 for i in $$(cd $(outdir) && ls -1 *.*tely *.*texi); do\
324 test -e $(ISOLANG)/$(DIR)/$$i\
325 || test -e $(ISOLANG)/$$i\
326 || mv $(outdir)/$$i $(ISOLANG)/$(DIR)/$$i;\
330 # Also for updating/adding missing files
332 $(foreach i,$(TRANSLATION_DIRS),$(MAKE) new-lang-dir DIR=$(i) &&) :
333 msgmerge -U po/lilypond-doc.pot $(outdir)/doc.pot
334 test -e po/$(ISOLANG).po || cp po/lilypond-doc.pot po/$(ISOLANG).po
335 @echo "*** Please add a language definition for $(ISOLANG) in python/langdefs.py ***"
337 TRANSLATION_DIRS = web texidocs
338 TRANSLATION_FILES = $(shell git ls-files $(ISOLANG) | grep -v GNUmakefile)
339 TEXI_LANGUTIL_FLAGS += --skeleton
341 TELY_FILES = $(call src-wildcard,$(ISOLANG)/*.tely)
343 @echo "$@ has been discontinued"
344 @echo "simply copy .texi, .itexi files you want to translate"
347 $(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) $(TEXI_LANGUTIL_FLAGS) $(TELY_FILES:$(ISOLANG)/%.tely=../%.tely)
348 $(PYTHON) $(auxscript-dir)/texi-skeleton-update.py $(ISOLANG) $(outdir)
351 $(PYTHON) $(auxscript-dir)/update-snippets.py user $(ISOLANG) '*.itely'
353 DOCUMENTS_INCLUDES:=-I $(ISOLANG) \
354 -I $(top-build-dir)/Documentation/$(ISOLANG)/out-www \
355 -I $(top-src-dir)/Documentation/snippets \
356 -I $(top-build-dir)/Documentation/out-www \
357 -I $(top-build-dir)/Documentation/out
359 else # ISOLANG is empty
361 DOCUMENTS_INCLUDES:=-I . \
362 -I $(top-build-dir)/Documentation/out-www \
363 -I $(top-src-dir)/Documentation/snippets \
364 -I $(top-build-dir)/Documentation/snippets/out-www \
365 -I $(top-build-dir)/Documentation/out
370 $(PYTHON) $(auxscript-dir)/check_texi_refs.py --batch \
371 $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py
374 $(PYTHON) $(auxscript-dir)/check_texi_refs.py --auto-fix \
375 $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py
378 ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
381 ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
383 # what's it gonna be, boy...tranlationS-/translation-
385 PYTHONPATH=$(top-src-dir)/python:$(top-src-dir)/python/auxiliar $(PYTHON) $(top-src-dir)/scripts/auxiliar/translations-status.py