NAME = documentation
LANGS = $(shell $(PYTHON) $(top-src-dir)/python/langdefs.py)
-MANUALS_SUBDIRS = usage automated-engraving contributor essay \
- web learning notation extending
-SUBDIRS = $(MANUALS_SUBDIRS) snippets logo pictures misc po css topdocs \
- included $(LANGS)
+SUBDIRS = logo pictures misc po css topdocs \
+ ly-examples $(LANGS)
STEPMAKE_TEMPLATES = documentation texinfo tex omf
LOCALSTEPMAKE_TEMPLATES = lilypond ly
-I $(outdir) \
-I $(top-build-dir)/Documentation/$(outconfbase)
$(outdir)/snippets-big-page.html: TEXI2HTML_FLAGS += -D short_toc
-$(outdir)/snippets/index..html: TEXI2HTML_FLAGS += -D short_toc
+$(outdir)/snippets/index.html: TEXI2HTML_FLAGS += -D short_toc
### Extra source files
-README_TOP_FILES= DEDICATION THANKS
+README_TOP_FILES= DEDICATION
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_SNIPPET_LY_FILES = $(SNIPPET_LY_FILES:%.ly=out/%.ly)
### Out files
PDF_FILES = $(TEXINFO_MANUALS:%=$(outdir)/%.pdf)
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),\
+UNSPLIT_HTML_MANUALS =
+SPLIT_HTML_MANUALS = $(foreach manual, $(TEXINFO_MANUALS),\
+ $(if $(findstring $(manual), $(UNSPLIT_HTML_MANUALS)),,$(manual)))
+NOT_TOPDIR_HTML_MANUALS = $(foreach manual, $(SPLIT_HTML_MANUALS),\
$(if $(findstring $(manual), $(TOPDIR_HTML_MANUALS)),,$(manual)))
-OUT_HTML_FILES = $(UNSPLITTED_HTML_MANUALS:%=$(outdir)/%.html)\
- $(SPLITTED_HTML_MANUALS:%=$(outdir)/%-big-page.html)
+OUT_HTML_FILES = $(UNSPLIT_HTML_MANUALS:%=$(outdir)/%.html)\
+ $(SPLIT_HTML_MANUALS:%=$(outdir)/%-big-page.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\
- $(foreach manual, $(SPLITTED_HTML_MANUALS), $(outdir)/$(manual)/source)
+ $(foreach manual, $(SPLIT_HTML_MANUALS), $(outdir)/$(manual)/source)
# Other out files
ifeq ($(out),www)
INFO_IMAGES_DIR = lilypond
-DEST_INFO_IMAGES_SUBDIR = Documentation/
+DEST_INFO_IMAGES_SUBDIR = Documentation
endif
include $(depth)/make/stepmake.make
+DOCUMENTATION_INCLUDES += -I $(outdir) \
+ -I $(top-build-dir)/Documentation/snippets/out \
+ -I $(top-src-dir)/Documentation/included \
+ -I $(top-src-dir)/Documentation/pictures \
+ -I $(top-src-dir)/Documentation \
+ -I $(top-src-dir)/input/regression
+
OUT_TXT_FILES = $(addprefix $(outdir)/, $(addsuffix .txt, $(README_TOP_FILES)))
-### Web site idiosyncrases
+
+### Web site idiosyncrasies
$(XREF_MAPS_DIR)/web.xref-map: XREF_MAP_FLAGS += --split=node
+### AJAX scripts
+JS_FILES = $(call src-wildcard,*.js)
+PHP_FILES = $(call src-wildcard,*.php)
+
+OUT_JS_FILES = $(JS_FILES:%.js=$(outdir)/%.js)
+OUT_PHP_FILES = $(PHP_FILES:%.php=$(outdir)/%.php)
+
+
### bad hack for badly-integrated roadmap.
$(outdir)/ROADMAP:
$(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 \
+$(outdir)/colorado.itexi:
+ BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \
+ -s $(top-src-dir)/Documentation/lily-bib \
+ -o $(outdir)/colorado.itexi \
+ -q \
$(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 \
+
+$(outdir)/computer-notation.itexi:
+ BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \
+ -s $(top-src-dir)/Documentation/lily-bib \
+ -o $(outdir)/computer-notation.itexi \
+ -q \
$(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 \
+
+$(outdir)/engravingbib.itexi:
+ BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \
+ -s $(top-src-dir)/Documentation/lily-bib \
+ -o $(outdir)/engravingbib.itexi \
+ -q \
$(src-dir)/essay/engravingbib.bib
- $(buildscript-dir)/html-to-texi \
- < $(outdir)/engravingbib.html > $(outdir)/engravingbib.itexi
-$(outdir)/essay.texi: $(outdir)/engravingbib.itexi
+$(outdir)/essay.texi: \
+ $(outdir)/colorado.itexi \
+ $(outdir)/computer-notation.itexi \
+ $(outdir)/engravingbib.itexi
###########
@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
info: $(INFO_FILES)
- @echo export LILYPOND_DATADIR=$(LILYPOND_DATADIR)
- @echo export PYTHONPATH=$(PYTHONPATH)
xml: $(outdir)/notation/notation.xml $(outdir)/internals/internals.xml
ifeq ($(out),www)
local-WWW-1: $(OUT_TEXINFO_MANUALS) $(PDF_FILES) info
+ifeq ($(AJAX_SEARCH),1)
+local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(OUT_JS_FILES) $(OUT_PHP_FILES) $(source-links) $(OMF_FILES)
+else
local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(source-links) $(OMF_FILES)
endif
+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=$@ $<
+$(outdir)/lilypond-%.info: $(outdir)/%.texi $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep $(outdir)/version.itexi $(outdir)/weblinks.itexi | $(OUT_TEXINFO_MANUALS)
+ $(buildscript-dir)/run-and-check "$(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$@ $<" "$*.makeinfo.log"
-# 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)
+txt-to-html: $(OUT_TXT_FILES) $(OUT_TXT_FILES:%.txt=%.html)
+
+$(OUT_TXT_FILES): $(outdir)/%.txt: $(top-src-dir)/%
+ cp -f $< $@
+
+$(OUT_TXT_FILES:%.txt=%.html): $(outdir)/%.html: $(outdir)/%.txt
+ $(buildscript-dir)/text2html $<
+
+# Explicitly list the dependencies on generated content
+$(outdir)/web.texi: $(outdir)/we-wrote.itexi $(outdir)/others-did.itexi $(outdir)/weblinks.itexi $(outdir)/version.itexi
ifeq ($(out),www)
## Extra images dependencies
$(OUT_TEXINFO_MANUALS): $(outdir)/pictures
$(outdir)/pictures:
- $(MAKE) -C pictures WWW-1
+ $(MAKE) -C pictures out=www WWW-1
ln -sf ../pictures/$(outdir) $@
-$(outdir)/web.texi: $(outdir)/ly-examples
+$(outdir)/web.texi: $(outdir)/css $(outdir)/ly-examples
+
+$(outdir)/css:
+ $(MAKE) -C css out=www WWW-1
+ ln -sf ../css/$(outdir) $@
$(outdir)/ly-examples:
- $(MAKE) -C web/ly-examples
- ln -sf ../web/ly-examples/$(outdir) $@
+ $(MAKE) -C ly-examples out=www WWW-1
+ ln -sf ../ly-examples/$(outdir) $@
endif
+
# Ugh, using '%' twice not possible
$(outdir)/notation/notation.xml: $(outdir)/notation.texi
mkdir -p $(dir $@)
- $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<
+ $(buildscript-dir)/run-and-check "$(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<" "$*.makeinfoxml.log"
$(outdir)/internals/internals.xml: $(outdir)/internals.texi
mkdir -p $(dir $@)
- $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<
+ $(buildscript-dir)/run-and-check "$(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<" "$*.makeinfoxml.log"
$(outdir)/learning.texi $(outdir)/notation.texi: $(OUT_PDF_IMAGES)
-$(foreach manual, $(MANUAL_SUBDIRS),\
-$(eval $(outdir)/(manual).texi: $(call src-wildcard,$(manual)/*.ite??)))
-
-
-
$(outdir)/source:
@rm -f $(@)
ln -sf $(depth) $(@)
ln -sf $(depth)/.. $(@)
-## Snippets rules idiosyncrases
+## Snippets rules idiosyncrasies
$(outdir)/%.itely: snippets/%-intro.itely snippets/%.snippet-list
xargs $(LYS_TO_TELY) -f doctitle,texidoc,verbatim --name=$@ --template=$< < $(filter %.snippet-list, $^)
-$(outdir)/snippets.texi: $(GENERATED_ITELY_FILES) $(SNIPPET_LY_FILES)
+$(TEXI_FILES_FROM_TELY): $(GENERATED_ITELY_FILES) $(OUT_SNIPPET_LY_FILES)
+
+$(OUT_SNIPPET_LY_FILES): out/ly-snippets.dep
+
+out/ly-snippets.dep: $(SNIPPET_LY_FILES)
+ mkdir -p snippets/out
+ $(buildscript-dir)/makesnippets $(src-dir)/snippets snippets/out $(src-dir)
+ mkdir -p out
+ touch $@
$(outdir)/%.bib: %.bib
ln -f $< $@
+$(outdir)/%.js: %.js
+ ln -f $< $@
+
+$(outdir)/%.php: %.php
+ ln -f $< $@
+
## notation.texi deps
$(top-build-dir)/mf/$(outconfbase)/feta16list.ly:
$(MAKE) -C $(top-src-dir)/mf
-$(outdir)/notation.texi: $(outdir)/ly-grammar.txt
+$(outdir)/contributor.texi: $(outdir)/ly-grammar.txt
## Rules for the automatically generated documentation
$(outdir)/ly-grammar.txt: $(top-src-dir)/lily/parser.yy
# of internals every time. however, this triggers
# compilation during install, which is a bad thing (tm).
-$(outdir)/internals.texi: $(LILYPOND_BINARY)
- cd $(outdir) && $(LILYPOND_BINARY) --verbose $(top-src-dir)/ly/generate-documentation
-
+$(outdir)/internals.texi: $(LILYPOND_BINARY) $(INIT_LY_SOURCES) $(SCHEME_SOURCES)
+ cd $(outdir) && $(buildscript-dir)/run-and-check "$(LILYPOND_BINARY) --verbose $(top-src-dir)/ly/generate-documentation" "generate-documentation.log"
###############################################
# Documentation and translations maintenance #
ifneq ($(ISOLANG),)
new-lang-dir:
mkdir -p $(ISOLANG)/$(DIR)
- cp fr/GNUmakefile $(ISOLANG)
- 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\
new-lang:
# Also for updating/adding missing files
- mkdir -p $(ISOLANG)
+ mkdir -p $(ISOLANG)/included
+ if test -z "`ls $(ISOLANG)/included`"; then touch $(ISOLANG)/included/.gitignore; fi
+ cp fr/GNUmakefile $(ISOLANG)
+ sed -i -e 's/ISOLANG *= *fr/ISOLANG = $(ISOLANG)/' $(ISOLANG)/GNUmakefile
$(foreach i,$(TRANSLATION_DIRS),$(MAKE) new-lang-dir DIR=$(i) &&) :
msgmerge -U po/lilypond-doc.pot $(outdir)/doc.pot
test -e po/$(ISOLANG).po || cp po/lilypond-doc.pot po/$(ISOLANG).po
TELY_FILES = $(call src-wildcard,$(ISOLANG)/*.tely)
skeleton-update:
+ @echo "$@ has been discontinued"
+ @echo "simply copy .texi, .itexi files you want to translate"
+ exit 2
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)
update-translation:
ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
+# what's it gonna be, boy...tranlationS-/translation-
translation-status:
- @echo Target temporarily disabled
-
-.SECONDARY:
+ PYTHONPATH=$(top-src-dir)/python:$(top-src-dir)/python/auxiliar $(PYTHON) $(top-src-dir)/scripts/auxiliar/translations-status.py
projects / lilypond.git / blobdiff