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 -o $(outdir)/colorado.itexi \
117 $(src-dir)/essay/colorado.bib
119 $(outdir)/computer-notation.itexi:
120 BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \
121 -o $(outdir)/computer-notation.itexi \
122 $(src-dir)/essay/computer-notation.bib
124 $(outdir)/engravingbib.itexi:
125 BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \
126 -o $(outdir)/engravingbib.itexi \
127 $(src-dir)/essay/engravingbib.bib
129 $(outdir)/essay.texi: \
130 $(outdir)/colorado.itexi \
131 $(outdir)/computer-notation.itexi \
132 $(outdir)/engravingbib.itexi
138 default: local-txt-doc
140 local-help: extra-local-help
143 @echo " check-xrefs [ISOLANG=LL] validate Texinfo cross-references"
144 @echo " fix-xrefs [ISOLANG=LL] interactively fix Texinfo cross-references"
145 @echo " (use with caution)"
146 @echo " info update info pages"
147 @echo " xml update Docbook xml documentation"
149 @echo "Translations specific targets (see TRANSLATION for details):"
150 @echo " new-lang ISOLANG=LL create and initialize"
151 @echo " subdirectory \'LL' for language \'LL"
152 @echo " (if \'LL exists, update missing file)"
153 @echo " po-update update and replace PO files for"
154 @echo " documentation with msgmerged versions"
155 @echo " check-translation ISOLANG=LL show changes in English docs since"
156 @echo " last translation update"
157 @echo " update-translation ISOLANG=LL call $$$$EDITOR to help updating"
158 @echo " the translation"
159 @echo " snippet-update ISOLANG=LL update ly snippets in Texinfo translation"
160 @echo " according to docs in English"
161 @echo " (use with caution)"
163 @echo " LL refers to the desired locale"
164 @echo " (most often only the ISO 639 language code)."
168 @echo export LILYPOND_DATADIR=$(LILYPOND_DATADIR)
169 @echo export PYTHONPATH=$(PYTHONPATH)
171 xml: $(outdir)/notation/notation.xml $(outdir)/internals/internals.xml
175 rm -f $(INFO_IMAGES_DIR)
180 local-WWW-1: $(OUT_TEXINFO_MANUALS) $(PDF_FILES) info
182 ifeq ($(AJAX_SEARCH),1)
183 local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(OUT_JS_FILES) $(OUT_PHP_FILES) $(source-links) $(OMF_FILES)
185 local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(source-links) $(OMF_FILES)
194 $(outdir)/lilypond-%.info: $(outdir)/%.texi $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep $(outdir)/version.itexi $(outdir)/weblinks.itexi
195 $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$@ $<
197 # cd $(outdir) rule gets bit hairy for --srcdir configure builds
199 $(foreach a, $(README_TOP_FILES), cp $(top-src-dir)/$(a) $(outdir)/$(a).txt && ) true
200 $(PYTHON) $(step-bindir)/text2html.py $(OUT_TXT_FILES)
203 ## Extra images dependencies
204 $(OUT_TEXINFO_MANUALS): $(outdir)/pictures
207 $(MAKE) -C pictures WWW-1
208 ln -sf ../pictures/$(outdir) $@
210 $(outdir)/web.texi: $(outdir)/ly-examples
212 $(outdir)/ly-examples:
213 $(MAKE) -C web/ly-examples
214 ln -sf ../web/ly-examples/$(outdir) $@
217 # Ugh, using '%' twice not possible
218 $(outdir)/notation/notation.xml: $(outdir)/notation.texi
220 $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<
222 $(outdir)/internals/internals.xml: $(outdir)/internals.texi
224 $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<
226 $(outdir)/learning.texi $(outdir)/notation.texi: $(OUT_PDF_IMAGES)
228 $(foreach manual, $(MANUAL_SUBDIRS),\
229 $(eval $(outdir)/(manual).texi: $(call src-wildcard,$(manual)/*.ite??)))
240 ln -sf $(depth)/.. $(@)
243 ## Snippets rules idiosyncrasies
244 $(outdir)/%.itely: snippets/%-intro.itely snippets/%.snippet-list
245 xargs $(LYS_TO_TELY) -f doctitle,texidoc,verbatim --name=$@ --template=$< < $(filter %.snippet-list, $^)
247 $(outdir)/snippets.texi: $(GENERATED_ITELY_FILES) $(SNIPPET_LY_FILES)
249 $(outdir)/%.bib: %.bib
255 $(outdir)/%.php: %.php
258 ## notation.texi deps
259 $(top-build-dir)/mf/$(outconfbase)/feta16list.ly:
260 $(MAKE) -C $(top-src-dir)/mf
262 $(outdir)/notation.texi: $(outdir)/ly-grammar.txt
264 ## Rules for the automatically generated documentation
265 $(outdir)/ly-grammar.txt: $(top-src-dir)/lily/parser.yy
266 cd $(outdir) && $(BISON) -v $<
267 $(buildscript-dir)/yyout2grammar $(outdir)/parser.output $@
269 # There used to be a dependency on a dummy target, to force a rebuild
270 # of internals every time. however, this triggers
271 # compilation during install, which is a bad thing (tm).
273 $(outdir)/internals.texi: $(LILYPOND_BINARY)
274 cd $(outdir) && $(LILYPOND_BINARY) --verbose $(top-src-dir)/ly/generate-documentation
277 ###############################################
278 # Documentation and translations maintenance #
279 ###############################################
283 all-translations-update: po-update translation-status
284 $(foreach lang, $(LANGS), make ISOLANG=$(lang) skeleton-update snippet-update &&) true
287 CHECK_TRANSLATION_FLAGS = --no-color
292 mkdir -p $(ISOLANG)/$(DIR)
293 cp fr/GNUmakefile $(ISOLANG)
294 cp fr/$(DIR)/GNUmakefile $(ISOLANG)/$(DIR)
295 sed -i -e 's/ISOLANG *= *fr/ISOLANG = $(ISOLANG)/' $(ISOLANG)/GNUmakefile $(ISOLANG)/$(DIR)/GNUmakefile
296 rm -f $(outdir)/*.*tely $(outdir)/*.*texi
297 $(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) -o doc.pot --skeleton --gettext $$(cd $(ISOLANG) && ls -1 ../$(DIR).tely ../$(DIR).texi)
298 for i in $$(cd $(outdir) && ls -1 $(DIR).tely $(DIR).texi); do\
299 test -e $(ISOLANG)/$$i || mv $(outdir)/$$i $(ISOLANG)/$$i;\
301 rm -f $(outdir)/$(DIR).tely $(outdir)/$(DIR).texi
302 for i in $$(cd $(outdir) && ls -1 *.*tely *.*texi); do\
303 test -e $(ISOLANG)/$(DIR)/$$i\
304 || test -e $(ISOLANG)/$$i\
305 || mv $(outdir)/$$i $(ISOLANG)/$(DIR)/$$i;\
309 # Also for updating/adding missing files
311 $(foreach i,$(TRANSLATION_DIRS),$(MAKE) new-lang-dir DIR=$(i) &&) :
312 msgmerge -U po/lilypond-doc.pot $(outdir)/doc.pot
313 test -e po/$(ISOLANG).po || cp po/lilypond-doc.pot po/$(ISOLANG).po
314 @echo "*** Please add a language definition for $(ISOLANG) in python/langdefs.py ***"
316 TRANSLATION_DIRS = web texidocs
317 TRANSLATION_FILES = $(shell git ls-files $(ISOLANG) | grep -v GNUmakefile)
318 TEXI_LANGUTIL_FLAGS += --skeleton
320 TELY_FILES = $(call src-wildcard,$(ISOLANG)/*.tely)
322 @echo "$@ has been discontinued"
323 @echo "simply copy .texi, .itexi files you want to translate"
326 $(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) $(TEXI_LANGUTIL_FLAGS) $(TELY_FILES:$(ISOLANG)/%.tely=../%.tely)
327 $(PYTHON) $(auxscript-dir)/texi-skeleton-update.py $(ISOLANG) $(outdir)
330 $(PYTHON) $(auxscript-dir)/update-snippets.py user $(ISOLANG) '*.itely'
332 DOCUMENTS_INCLUDES:=-I $(ISOLANG) \
333 -I $(top-build-dir)/Documentation/$(ISOLANG)/out-www \
334 -I $(top-src-dir)/Documentation/snippets \
335 -I $(top-build-dir)/Documentation/out-www \
336 -I $(top-build-dir)/Documentation/out
338 else # ISOLANG is empty
340 DOCUMENTS_INCLUDES:=-I . \
341 -I $(top-build-dir)/Documentation/out-www \
342 -I $(top-src-dir)/Documentation/snippets \
343 -I $(top-build-dir)/Documentation/snippets/out-www \
344 -I $(top-build-dir)/Documentation/out
349 $(PYTHON) $(auxscript-dir)/check_texi_refs.py --batch \
350 $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py
353 $(PYTHON) $(auxscript-dir)/check_texi_refs.py --auto-fix \
354 $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py
357 ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
360 ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
362 # what's it gonna be, boy...tranlationS-/translation-
364 PYTHONPATH=$(top-src-dir)/python:$(top-src-dir)/python/auxiliar $(PYTHON) $(top-src-dir)/scripts/auxiliar/translations-status.py