depth = ..
+########################
+# Documentation build #
+########################
+
+#############
+### Variables
+
NAME = documentation
LANGS = $(shell $(PYTHON) $(top-src-dir)/python/langdefs.py)
-SUBDIRS = application contributor learning notation snippets\
- bibliography pictures misc po $(LANGS)
+MANUALS_SUBDIRS = usage automated-engraving contributor essay \
+ web learning notation extending
+SUBDIRS = $(MANUALS_SUBDIRS) snippets logo pictures misc po css topdocs \
+ included $(LANGS)
STEPMAKE_TEMPLATES = documentation texinfo tex omf
LOCALSTEPMAKE_TEMPLATES = lilypond ly
### Extra source files
README_TOP_FILES= DEDICATION THANKS
-LATEX_FILES =$(call src-wildcard,*.latex)
-IMAGES=$(call src-wildcard,*.png)
-EPS_ILLUSTRATIONS=context-example.eps
IN_ITELY_FILES = $(call src-wildcard,snippets/*-intro.itely)
SNIPPET_LY_FILES = $(call src-wildcard,snippets/*.ly)
+EXTRA_DIST_FILES = $(call src-wildcard,*.init) search-box.html
-### Extra out files
+### Out files
# Dependencies
GENERATED_ITELY_FILES = $(IN_ITELY_FILES:snippets/%-intro.itely=$(outdir)/%.itely)
-OUT_PDF_IMAGES = $(IMAGES:%.png=$(outdir)/%.pdf)
-OUT_PDF_IMAGES += $(EPS_ILLUSTRATIONS:%.eps=$(outdir)/%.pdf)
-OUT_PNG_IMAGES = $(OUT_PDF_IMAGES:%.pdf=%.png)
-
XREF_MAPS_FILES += $(XREF_MAPS_DIR)/internals.xref-map
OMF_FILES += $(outdir)/internals.html.omf $(outdir)/internals.pdf.omf
# Main manuals
+TEXINFO_MANUALS = internals\
+ $(TELY_FILES:%.tely=%)\
+ $(TEXI_FILES:%.texi=%)
+OUT_TEXINFO_MANUALS = $(TEXINFO_MANUALS:%=$(outdir)/%.texi)
+
+## CHAIN_RULE hack: keep the following line *before* including
+# stepmake.make, so the Internals Reference is built before the
+# Notation Reference, thus providing automatically generated sections
+# of the NR
+TEXI_FILES_FROM_TELY = $(outdir)/internals.texi
+
+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),\
+ $(if $(findstring $(manual), $(TOPDIR_HTML_MANUALS)),,$(manual)))
+
+OUT_HTML_FILES = $(UNSPLITTED_HTML_MANUALS:%=$(outdir)/%.html)\
+ $(SPLITTED_HTML_MANUALS:%=$(outdir)/%-big-page.html)
+DEEP_HTML_FILES = $(NOT_TOPDIR_HTML_MANUALS:%=$(outdir)/%/index.html)
-OUT_MASTER_TEXI_FILES = $(outdir)/internals.texi
-#OUT_TEXI_FILES=$(ITEXI_FILES:%.itexi=$(outdir)/%.texi)\
-# $(ITELY_FILES:%.itely=$(outdir)/%.texi)
-
-HTML_FILES = \
-$(TELY_FILES:%.tely=$(outdir)/%-big-page.html)\
- $(TEXI_FILES:%.texi=$(outdir)/%-big-page.html)\
- $(outdir)/internals-big-page.html
-
-PDF_FILES = \
-$(TELY_FILES:%.tely=$(outdir)/%.pdf)\
- $(TELY_FILES:%.texi=$(outdir)/%.pdf)\
- $(outdir)/internals.pdf
+# 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)
+# Other out files
-HTML_PAGE_NAMES= index translations devel
-OUT_HTML_FILES= $(HTML_PAGE_NAMES:%=$(outdir)/%.html)
-OUT_CSS_FILES= $(CSS_FILES:%.css=$(outdir)/%.css)
+HTML_PAGE_NAMES= translations index
+OUT_HTML_FILES += $(HTML_PAGE_NAMES:%=$(outdir)/%.html)
-MAIN_INFO_DOC = lilypond-notation
-INFO_DOCS = lilypond-application lilypond-changes lilypond-contributor lilypond-internals \
- lilypond-learning lilypond-notation music-glossary
+MAIN_INFO_DOC = lilypond-web
+INFO_DOCS = lilypond-usage lilypond-changes lilypond-contributor lilypond-internals \
+ lilypond-essay lilypond-learning lilypond-notation music-glossary \
+ lilypond-web lilypond-extending
ifeq ($(out),www)
INFO_DOCS += lilypond-snippets
endif
DEST_INFO_IMAGES_SUBDIR = Documentation/
endif
-
include $(depth)/make/stepmake.make
+OUT_TXT_FILES = $(addprefix $(outdir)/, $(addsuffix .txt, $(README_TOP_FILES)))
-default: local-doc
+### Web site idiosyncrases
+$(XREF_MAPS_DIR)/web.xref-map: XREF_MAP_FLAGS += --split=node
-ifeq ($(out),www)
-local-WWW-2: txt-to-html $(OUT_HTML_FILES)
-local-WWW-clean: deep-WWW-clean
+### bad hack for badly-integrated roadmap.
+$(outdir)/ROADMAP:
+ cp $(top-src-dir)/ROADMAP $(outdir)
+$(outdir)/contributor.texi: $(outdir)/ROADMAP
-deep-WWW-clean:
- rm -rf $(outdir)/wiki-dump
-endif
-OUT_TXT_FILES = $(addprefix $(outdir)/, $(addsuffix .txt, $(README_TOP_FILES)))
+###########
+### Targets
-# 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)
-
-$(OUT_HTML_FILES): $(OUT_CSS_FILES)
-
-$(outdir)/%.css: %.css
- ln -f $< $@
+default: local-txt-doc
local-help: extra-local-help
\n\
Translations specific targets (see TRANSLATION for details):\n\
new-lang ISOLANG=LL create and initialize subdirectory \'LL' for language \'LL\n\
+(if \'LL exists, update missing file)\n\
po-update update and replace PO files for documentation with msgmerged versions\n\
check-translation ISOLANG=LL show changes in English docs since last translation update\n\
update-translation ISOLANG=LL call $$$$EDITOR to help updating the translation\n\
\n\
LL refers to the desired locale (most often only the ISO 639 language code).\n"
-#####################################
-# Texinfo
-
info: $(INFO_FILES)
@echo export LILYPOND_DATADIR=$(LILYPOND_DATADIR)
@echo export PYTHONPATH=$(PYTHONPATH)
local-clean:
rm -f $(INFO_IMAGES_DIR)
+### Web targets
+
+ifeq ($(out),www)
+local-WWW-1: $(OUT_TEXINFO_MANUALS) $(PDF_FILES) info
+
+local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(source-links) $(OMF_FILES)
+endif
+
+
+#########
+### Rules
+
+$(outdir)/lilypond-%.info: $(outdir)/%.texi $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep $(outdir)/version.itexi
+ $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$@ $<
-#
-# Split manuals in HTML
-#
-$(outdir)/learning/index.html: $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES)
-$(outdir)/notation/index.html: $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES)
+# 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)
+
+ifeq ($(out),www)
+## Extra images dependencies
+$(OUT_TEXINFO_MANUALS): $(outdir)/pictures
+
+$(outdir)/pictures:
+ $(MAKE) -C pictures WWW-1
+ ln -sf ../pictures/$(outdir) $@
+$(outdir)/web.texi: $(outdir)/examples
-#
-# Manuals in one big HTML page
-#
-$(outdir)/learning-big-page.html: $(OUT_PNG_IMAGES)
-$(outdir)/notation-big-page.html: $(OUT_PNG_IMAGES)
+$(outdir)/examples:
+ $(MAKE) -C web/examples
+ ln -sf ../web/examples/$(outdir) $@
+endif
# Ugh, using '%' twice not possible
$(outdir)/notation/notation.xml: $(outdir)/notation.texi
$(outdir)/learning.texi $(outdir)/notation.texi: $(OUT_PDF_IMAGES)
-$(foreach manual, application contributor learning notation,\
-$(eval $(outdir)/(i).texi: $(call src-wildcard,$(i)/*.ite??)))
-
-$(outdir)/%.png: %.png
- convert -depth 8 -geometry 50x50% $< $@
-
-$(outdir)/%.png: %.eps
- gs -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -q -sOutputFile=$@ -sDEVICE=png16m -dEPSCrop -dNOPAUSE -f $< -c quit
-
-$(outdir)/%.pdf: %.png
- convert -depth 8 $< $@
+$(foreach manual, $(MANUAL_SUBDIRS),\
+$(eval $(outdir)/(manual).texi: $(call src-wildcard,$(manual)/*.ite??)))
-$(outdir)/%.pdf: %.eps
- gs -dAutoRotatePages=/None -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -sOutputFile=$@ -dEPSCrop -c .setpdfwrite -f $<
-### Splitted HTML manuals
-
-DEEP_HTML_FILES =\
- $(outdir)/application/index.html\
- $(outdir)/internals/index.html\
- $(outdir)/learning/index.html\
- $(outdir)/notation/index.html\
- $(outdir)/music-glossary/index.html\
- $(outdir)/snippets/index.html
-
-# Symlinks to refer to external source documents from split and non-split HTML
-source-links = $(outdir)/source $(outdir)/notation/source $(outdir)/music-glossary/source \
- $(outdir)/application/source $(outdir)/learning/source $(outdir)/internals/source \
- $(outdir)/snippets/source
-
$(outdir)/source:
@rm -f $(@)
ln -sf $(depth) $(@)
mkdir -p $(dir $@)
ln -sf $(depth)/.. $(@)
-################################
-### Snippets rules idiosyncrases
+## Snippets rules idiosyncrases
$(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)
-###############
-### Web targets
-
-ifeq ($(out),www)
-local-WWW-1: $(MASTER_TEXI_FILES) $(PDF_FILES) info
-
-local-WWW-2: $(HTML_FILES) $(DEEP_HTML_FILES) $(source-links)
-endif
-
$(outdir)/%.bib: %.bib
ln -f $< $@
-# lilypond.texi deps
+## notation.texi deps
$(top-build-dir)/mf/$(outconfbase)/feta16list.ly:
$(MAKE) -C $(top-src-dir)/mf
$(outdir)/notation.texi: $(outdir)/ly-grammar.txt
-# Rules for the automatically generated documentation
-
+## Rules for the automatically generated documentation
$(outdir)/ly-grammar.txt: $(top-src-dir)/lily/parser.yy
cd $(outdir) && $(BISON) -v $<
$(auxscript-dir)/yyout2grammar.py $(outdir)/parser.output $@
$(outdir)/internals.texi: $(LILYPOND_BINARY)
cd $(outdir) && $(LILYPOND_BINARY) --verbose $(top-src-dir)/ly/generate-documentation
-.SECONDARY:
-
-#####################################
-# Translations maintenance targets #
-#####################################
+###############################################
+# Documentation and translations maintenance #
+###############################################
po-update:
make -C po po-update
endif
ifneq ($(ISOLANG),)
-new-lang:
- @if (( $$(file -b $(ISOLANG)) == directory )) 2>/dev/null; \
- then echo "Error: $(ISOLANG) directory already exists. Exiting." ; \
- exit 3 ; \
- fi
- mkdir -p $(ISOLANG)/user
+new-lang-dir:
+ mkdir -p $(ISOLANG)/$(DIR)
cp fr/GNUmakefile $(ISOLANG)
- cp fr/user/GNUmakefile $(ISOLANG)/user
- sed -i -e 's/ISOLANG *= *fr/ISOLANG = $(ISOLANG)/' $(ISOLANG)/GNUmakefile $(ISOLANG)/user/GNUmakefile
- $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) -o doc.pot --skeleton --gettext ../learning.tely
- mv $(outdir)/*.*tely $(ISOLANG)/user
+ 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
+ $(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\
+ test -e $(ISOLANG)/$$i || mv $(outdir)/$$i $(ISOLANG)/$$i;\
+ done
+ rm -f $(outdir)/$(DIR).tely $(outdir)/$(DIR).texi
+ for i in $$(cd $(outdir) && ls -1 *.*tely *.*texi); do\
+ test -e $(ISOLANG)/$(DIR)/$$i\
+ || test -e $(ISOLANG)/$$i\
+ || mv $(outdir)/$$i $(ISOLANG)/$(DIR)/$$i;\
+ done
+
+new-lang:
+# Also for updating/adding missing files
+ mkdir -p $(ISOLANG)
+ $(foreach i,$(TRANSLATION_DIRS),$(MAKE) new-lang-dir DIR=$(i) &&) :
msgmerge -U po/lilypond-doc.pot $(outdir)/doc.pot
- cp po/lilypond-doc.pot po/$(ISOLANG).po
+ test -e po/$(ISOLANG).po || cp po/lilypond-doc.pot po/$(ISOLANG).po
@echo "*** Please add a language definition for $(ISOLANG) in python/langdefs.py ***"
-CHECKED_FILES = $(ISOLANG)/index.html.in $(shell find $(ISOLANG)/user/ -maxdepth 1 -name '*.*te??') \
- $(shell find $(depth)/input/texidocs/ -name '*.texidoc')
+TRANSLATION_DIRS = web texidocs
+TRANSLATION_FILES = $(shell git ls-files $(ISOLANG) | grep -v GNUmakefile)
-TELY_FILES = $(call src-wildcard,$(ISOLANG)/user/*.tely)
+TELY_FILES = $(call src-wildcard,$(ISOLANG)/*.tely)
skeleton-update:
- $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) --skeleton $(TELY_FILES:$(ISOLANG)/user/%.tely=../user/%.tely)
- $(auxscript-dir)/texi-skeleton-update.py $(ISOLANG)/user $(outdir)
+ mkdir -p $(ISOLANG)
+ $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) --skeleton $(TELY_FILES:$(ISOLANG)/%.tely=../%.tely)
+ $(auxscript-dir)/texi-skeleton-update.py $(ISOLANG) $(outdir)
snippet-update:
- $(auxscript-dir)/update-snippets.py user $(ISOLANG)/user '*.itely'
+ $(auxscript-dir)/update-snippets.py user $(ISOLANG) '*.itely'
-DOCUMENTS_INCLUDES:=-I $(ISOLANG)/user \
--I $(top-build-dir)/Documentation/$(ISOLANG)/user/out-www \
--I $(top-src-dir)/input/lsr \
--I $(top-build-dir)/input/lsr/out-www \
--I user -I $(top-build-dir)/Documentation/user/out-www
+DOCUMENTS_INCLUDES:=-I $(ISOLANG) \
+-I $(top-build-dir)/Documentation/$(ISOLANG)/out-www \
+-I $(top-src-dir)/Documentation/snippets \
+-I $(top-build-dir)/Documentation/out-www \
+-I $(top-build-dir)/Documentation/out
else # ISOLANG is empty
-DOCUMENTS_INCLUDES:=-I user \
--I $(top-build-dir)/Documentation/user/out-www \
--I $(top-src-dir)/input/lsr \
--I $(top-build-dir)/input/lsr/out-www
+DOCUMENTS_INCLUDES:=-I . \
+-I $(top-build-dir)/Documentation/out-www \
+-I $(top-src-dir)/Documentation/snippets \
+-I $(top-build-dir)/Documentation/snippets/out-www \
+-I $(top-build-dir)/Documentation/out
endif # ISOLANG
$(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py
check-translation:
- ISOLANG=$(ISOLANG) $(auxscript-dir)/check_translation.py $(CHECK_TRANSLATION_FLAGS) $(CHECKED_FILES)
+ ISOLANG=$(ISOLANG) $(auxscript-dir)/check_translation.py $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
update-translation:
- ISOLANG=$(ISOLANG) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(CHECKED_FILES)
+ ISOLANG=$(ISOLANG) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
translation-status:
make -C po out=www messages
projects / lilypond.git / blobdiff