]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/GNUmakefile
Docs: Add AJAX search field to the docs
[lilypond.git] / Documentation / GNUmakefile
1 depth = ..
2
3 ########################
4 #  Documentation build #
5 ########################
6
7 #############
8 ### Variables
9
10 NAME = documentation
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 $(LANGS)
16 STEPMAKE_TEMPLATES = documentation texinfo tex omf
17 LOCALSTEPMAKE_TEMPLATES = lilypond ly
18
19 ### Extra flags
20
21 LILYPOND_BOOK_FLAGS = --extra-options '-e "(ly:set-option (quote internal-type-checking) \#t)"'
22 TEXI2PDF_FLAGS = \
23   -I $(outdir) \
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
27
28 ### Extra source files
29
30 README_TOP_FILES= DEDICATION THANKS
31
32 IN_ITELY_FILES = $(call src-wildcard,snippets/*-intro.itely)
33 SNIPPET_LY_FILES = $(call src-wildcard,snippets/*.ly)
34
35 EXTRA_DIST_FILES = $(call src-wildcard,*.init)
36
37 ### Out files
38
39 # Dependencies
40 GENERATED_ITELY_FILES = $(IN_ITELY_FILES:snippets/%-intro.itely=$(outdir)/%.itely)
41
42 XREF_MAPS_FILES += $(XREF_MAPS_DIR)/internals.xref-map
43 OMF_FILES += $(outdir)/internals.html.omf $(outdir)/internals.pdf.omf
44
45 # Main manuals
46 TEXINFO_MANUALS = internals\
47  $(TELY_FILES:%.tely=%)\
48  $(TEXI_FILES:%.texi=%)
49 OUT_TEXINFO_MANUALS = $(TEXINFO_MANUALS:%=$(outdir)/%.texi)
50
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
54 # of the NR
55 TEXI_FILES_FROM_TELY = $(outdir)/internals.texi
56
57 PDF_FILES = $(TEXINFO_MANUALS:%=$(outdir)/%.pdf)
58
59 TOPDIR_HTML_MANUALS =
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)))
65
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)
69
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)
73
74 # Other out files
75
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
80 ifeq ($(out),www)
81 INFO_DOCS += lilypond-snippets
82 endif
83 INFO_FILES = $(INFO_DOCS:%=$(outdir)/%.info)
84
85 ifeq ($(out),www)
86 INFO_IMAGES_DIR = lilypond
87 DEST_INFO_IMAGES_SUBDIR = Documentation/
88 endif
89
90 include $(depth)/make/stepmake.make
91
92 OUT_TXT_FILES = $(addprefix $(outdir)/, $(addsuffix .txt, $(README_TOP_FILES)))
93
94
95 ### Web site idiosyncrases
96 $(XREF_MAPS_DIR)/web.xref-map: XREF_MAP_FLAGS += --split=node
97
98 ### AJAX scripts
99 JS_FILES = $(call src-wildcard,*.js)
100 PHP_FILES = $(call src-wildcard,*.php)
101 EXTRA_DIST_FILES += $(JS_FILES)
102
103 OUT_JS_FILES = $(JS_FILES:%.js=$(outdir)/%.js)
104 OUT_PHP_FILES = $(PHP_FILES:%.php=$(outdir)/%.php)
105
106
107
108 ### bad hack for badly-integrated roadmap.
109 $(outdir)/ROADMAP:
110         cp $(top-src-dir)/ROADMAP $(outdir)
111 $(outdir)/contributor.texi: $(outdir)/ROADMAP
112
113 ### bad hack for badly-integrated bibliography
114 $(outdir)/engravingbib.itexi:
115         BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2html \
116                 -o $(outdir)/colorado.html \
117                 $(src-dir)/essay/colorado.bib
118         $(buildscript-dir)/html-to-texi \
119                 < $(outdir)/colorado.html > $(outdir)/colorado.itexi
120         BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2html \
121                 -o $(outdir)/computer-notation.html \
122                 $(src-dir)/essay/computer-notation.bib
123         $(buildscript-dir)/html-to-texi \
124                 < $(outdir)/computer-notation.html > $(outdir)/computer-notation.itexi
125         BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2html \
126                 -o $(outdir)/engravingbib.html \
127                 $(src-dir)/essay/engravingbib.bib
128         $(buildscript-dir)/html-to-texi \
129                 < $(outdir)/engravingbib.html > $(outdir)/engravingbib.itexi
130
131 $(outdir)/essay.texi: $(outdir)/engravingbib.itexi
132
133
134 ###########
135 ### Targets
136
137 default: local-txt-doc
138
139 local-help: extra-local-help
140
141 extra-local-help:
142         @echo "  check-xrefs [ISOLANG=LL] validate Texinfo cross-references"
143         @echo "  fix-xrefs [ISOLANG=LL]   interactively fix Texinfo cross-references"
144         @echo "                             (use with caution)"
145         @echo "  info                     update info pages"
146         @echo "  xml                      update Docbook xml documentation"
147         @echo
148         @echo "Translations specific targets (see TRANSLATION for details):"
149         @echo "  new-lang ISOLANG=LL           create and initialize"
150         @echo "                                  subdirectory \'LL' for language \'LL"
151         @echo "                                  (if \'LL exists, update missing file)"
152         @echo "  po-update                     update and replace PO files for"
153         @echo "                                  documentation with msgmerged versions"
154         @echo "  check-translation ISOLANG=LL  show changes in English docs since"
155         @echo "                                  last translation update"
156         @echo "  update-translation ISOLANG=LL call $$$$EDITOR to help updating"
157         @echo "                                  the translation"
158         @echo "  snippet-update ISOLANG=LL     update ly snippets in Texinfo translation"
159         @echo "                                  according to docs in English"
160         @echo "                                  (use with caution)"
161         @echo
162         @echo "  LL refers to the desired locale"
163         @echo "    (most often only the ISO 639 language code)."
164         @echo
165
166 info: $(INFO_FILES)
167         @echo export LILYPOND_DATADIR=$(LILYPOND_DATADIR)
168         @echo export PYTHONPATH=$(PYTHONPATH)
169
170 xml: $(outdir)/notation/notation.xml $(outdir)/internals/internals.xml
171
172
173 local-clean:
174         rm -f $(INFO_IMAGES_DIR)
175
176 ### Web targets
177
178 ifeq ($(out),www)
179 local-WWW-1: $(OUT_TEXINFO_MANUALS) $(PDF_FILES) info
180
181 local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(OUT_JS_FILES) $(OUT_PHP_FILES) $(source-links) $(OMF_FILES)
182 endif
183
184
185 #########
186 ### Rules
187
188 $(outdir)/lilypond-%.info: $(outdir)/%.texi $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep $(outdir)/version.itexi $(outdir)/weblinks.itexi
189         $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$@ $<
190
191 # cd $(outdir) rule gets bit hairy for --srcdir configure builds
192 txt-to-html:
193         $(foreach a, $(README_TOP_FILES), cp $(top-src-dir)/$(a) $(outdir)/$(a).txt && ) true
194         $(PYTHON) $(step-bindir)/text2html.py $(OUT_TXT_FILES)
195
196 ifeq ($(out),www)
197 ## Extra images dependencies
198 $(OUT_TEXINFO_MANUALS): $(outdir)/pictures
199
200 $(outdir)/pictures:
201         $(MAKE) -C pictures WWW-1
202         ln -sf ../pictures/$(outdir) $@
203
204 $(outdir)/web.texi: $(outdir)/ly-examples
205
206 $(outdir)/ly-examples:
207         $(MAKE) -C web/ly-examples
208         ln -sf ../web/ly-examples/$(outdir) $@
209 endif
210
211 # Ugh, using '%' twice not possible
212 $(outdir)/notation/notation.xml: $(outdir)/notation.texi
213         mkdir -p $(dir $@)
214         $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<
215
216 $(outdir)/internals/internals.xml: $(outdir)/internals.texi
217         mkdir -p $(dir $@)
218         $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<
219
220 $(outdir)/learning.texi $(outdir)/notation.texi: $(OUT_PDF_IMAGES)
221
222 $(foreach manual, $(MANUAL_SUBDIRS),\
223 $(eval $(outdir)/(manual).texi: $(call src-wildcard,$(manual)/*.ite??)))
224
225
226
227 $(outdir)/source:
228         @rm -f $(@)
229         ln -sf $(depth) $(@)
230
231 $(outdir)/%/source:
232         @rm -f $(@)
233         mkdir -p $(dir $@)
234         ln -sf $(depth)/.. $(@)
235
236
237 ## Snippets rules idiosyncrases
238 $(outdir)/%.itely: snippets/%-intro.itely snippets/%.snippet-list
239         xargs $(LYS_TO_TELY) -f doctitle,texidoc,verbatim --name=$@ --template=$< < $(filter %.snippet-list, $^)
240
241 $(outdir)/snippets.texi: $(GENERATED_ITELY_FILES) $(SNIPPET_LY_FILES)
242
243 $(outdir)/%.bib: %.bib
244         ln -f $< $@
245
246 $(outdir)/%.js: %.js
247         ln -f $< $@
248
249 $(outdir)/%.php: %.php
250         ln -f $< $@
251
252 ## notation.texi deps
253 $(top-build-dir)/mf/$(outconfbase)/feta16list.ly:
254         $(MAKE) -C $(top-src-dir)/mf
255
256 $(outdir)/notation.texi: $(outdir)/ly-grammar.txt
257
258 ## Rules for the automatically generated documentation
259 $(outdir)/ly-grammar.txt: $(top-src-dir)/lily/parser.yy
260         cd $(outdir) && $(BISON) -v $<
261         $(buildscript-dir)/yyout2grammar $(outdir)/parser.output $@
262
263 # There used to be a dependency on a dummy target, to force a rebuild
264 # of internals every time.  however, this triggers
265 # compilation during install, which is a bad thing (tm).
266
267 $(outdir)/internals.texi: $(LILYPOND_BINARY)
268         cd $(outdir) && $(LILYPOND_BINARY) --verbose $(top-src-dir)/ly/generate-documentation
269
270
271 ###############################################
272 #  Documentation and translations maintenance #
273 ###############################################
274 po-update:
275         make -C po po-update
276
277 all-translations-update: po-update translation-status
278         $(foreach lang, $(LANGS), make ISOLANG=$(lang) skeleton-update snippet-update &&) true
279
280 ifneq ($(NO_COLOR),)
281 CHECK_TRANSLATION_FLAGS = --no-color
282 endif
283
284 ifneq ($(ISOLANG),)
285 new-lang-dir:
286         mkdir -p $(ISOLANG)/$(DIR)
287         cp fr/GNUmakefile $(ISOLANG)
288         cp fr/$(DIR)/GNUmakefile $(ISOLANG)/$(DIR)
289         sed -i -e 's/ISOLANG *= *fr/ISOLANG = $(ISOLANG)/' $(ISOLANG)/GNUmakefile $(ISOLANG)/$(DIR)/GNUmakefile
290         rm -f $(outdir)/*.*tely $(outdir)/*.*texi
291         $(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) -o doc.pot --skeleton --gettext $$(cd $(ISOLANG) && ls -1 ../$(DIR).tely ../$(DIR).texi)
292         for i in $$(cd $(outdir) && ls -1 $(DIR).tely $(DIR).texi); do\
293             test -e $(ISOLANG)/$$i || mv $(outdir)/$$i $(ISOLANG)/$$i;\
294         done
295         rm -f $(outdir)/$(DIR).tely $(outdir)/$(DIR).texi
296         for i in $$(cd $(outdir) && ls -1 *.*tely *.*texi); do\
297             test -e $(ISOLANG)/$(DIR)/$$i\
298                 || test -e $(ISOLANG)/$$i\
299                 || mv $(outdir)/$$i $(ISOLANG)/$(DIR)/$$i;\
300         done
301
302 new-lang:
303 # Also for updating/adding missing files
304         mkdir -p $(ISOLANG)
305         $(foreach i,$(TRANSLATION_DIRS),$(MAKE) new-lang-dir DIR=$(i) &&) :
306         msgmerge -U po/lilypond-doc.pot $(outdir)/doc.pot
307         test -e po/$(ISOLANG).po || cp po/lilypond-doc.pot po/$(ISOLANG).po
308         @echo "***  Please add a language definition for $(ISOLANG) in python/langdefs.py  ***"
309
310 TRANSLATION_DIRS = web texidocs
311 TRANSLATION_FILES = $(shell git ls-files $(ISOLANG) | grep -v GNUmakefile)
312 TEXI_LANGUTIL_FLAGS += --skeleton
313
314 TELY_FILES = $(call src-wildcard,$(ISOLANG)/*.tely)
315 skeleton-update:
316         @echo "$@ has been discontinued"
317         @echo "simply copy .texi, .itexi files you want to translate"
318         exit 2
319         mkdir -p $(ISOLANG)
320         $(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) $(TEXI_LANGUTIL_FLAGS) $(TELY_FILES:$(ISOLANG)/%.tely=../%.tely)
321         $(PYTHON) $(auxscript-dir)/texi-skeleton-update.py $(ISOLANG) $(outdir)
322
323 snippet-update:
324         $(PYTHON) $(auxscript-dir)/update-snippets.py user $(ISOLANG) '*.itely'
325
326 DOCUMENTS_INCLUDES:=-I $(ISOLANG) \
327 -I $(top-build-dir)/Documentation/$(ISOLANG)/out-www \
328 -I $(top-src-dir)/Documentation/snippets \
329 -I $(top-build-dir)/Documentation/out-www \
330 -I $(top-build-dir)/Documentation/out
331
332 else # ISOLANG is empty
333
334 DOCUMENTS_INCLUDES:=-I . \
335 -I $(top-build-dir)/Documentation/out-www \
336 -I $(top-src-dir)/Documentation/snippets \
337 -I $(top-build-dir)/Documentation/snippets/out-www \
338 -I $(top-build-dir)/Documentation/out
339
340 endif # ISOLANG
341
342 check-xrefs:
343         $(PYTHON) $(auxscript-dir)/check_texi_refs.py --batch \
344         $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py
345
346 fix-xrefs:
347         $(PYTHON) $(auxscript-dir)/check_texi_refs.py --auto-fix \
348         $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py
349
350 check-translation:
351         ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
352
353 update-translation:
354         ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
355
356 # what's it gonna be, boy...tranlationS-/translation-
357 translation-status:
358         PYTHONPATH=$(top-src-dir)/python:$(top-src-dir)/python/auxiliar $(PYTHON) $(top-src-dir)/scripts/auxiliar/translations-status.py
359
360 .SECONDARY: