]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/GNUmakefile
Web: rename web/examples to web/ly-examples
[lilypond.git] / Documentation / GNUmakefile
index c5045faa5f4d5594dd411bc41ceb6205a6dcdc5f..5916e83bf3dc50b051a8e11f0230134459f5a10f 100644 (file)
@@ -9,8 +9,10 @@ depth = ..
 
 NAME = documentation
 LANGS = $(shell $(PYTHON) $(top-src-dir)/python/langdefs.py)
-MANUALS_SUBDIRS = application automated-engraving contributor essay general learning notation
-SUBDIRS = $(MANUALS_SUBDIRS) snippets logo pictures misc po css topdocs $(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
 
@@ -26,13 +28,11 @@ $(outdir)/snippets/index..html: TEXI2HTML_FLAGS += -D short_toc
 ### Extra source files
 
 README_TOP_FILES= DEDICATION THANKS
-LATEX_FILES =$(call src-wildcard,*.latex)
 
 IN_ITELY_FILES = $(call src-wildcard,snippets/*-intro.itely)
 SNIPPET_LY_FILES = $(call src-wildcard,snippets/*.ly)
 
-EXTRA_DIST_FILES = $(call src-wildcard,*.init) $(LATEX_FILES) \
-  search-box.html
+EXTRA_DIST_FILES = $(call src-wildcard,*.init) search-box.ihtml
 
 ### Out files
 
@@ -56,13 +56,16 @@ TEXI_FILES_FROM_TELY = $(outdir)/internals.texi
 
 PDF_FILES = $(TEXINFO_MANUALS:%=$(outdir)/%.pdf)
 
-UNSPLITTED_HTML_MANUALS = changes
+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 = $(SPLITTED_HTML_MANUALS:%=$(outdir)/%/index.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\
@@ -70,12 +73,13 @@ source-links = $(outdir)/source\
 
 # Other out files
 
-HTML_PAGE_NAMES= index translations devel
+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-essay lilypond-learning lilypond-notation music-glossary lilypond
+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
@@ -91,9 +95,14 @@ include $(depth)/make/stepmake.make
 OUT_TXT_FILES = $(addprefix $(outdir)/, $(addsuffix .txt, $(README_TOP_FILES)))
 
 ### Web site idiosyncrases
+$(XREF_MAPS_DIR)/web.xref-map: XREF_MAP_FLAGS += --split=node
+
+
+### bad hack for badly-integrated roadmap.
+$(outdir)/ROADMAP:
+       cp $(top-src-dir)/ROADMAP $(outdir)
+$(outdir)/contributor.texi: $(outdir)/ROADMAP
 
-$(outdir)/general/index.html: TEXI2HTML_INIT = $(WEB_TEXI2HTML_INIT)
-$(outdir)/general/index.html: TEXI2HTML_SPLIT = $(WEB_TEXI2HTML_SPLIT)
 
 ###########
 ### Targets
@@ -111,6 +120,7 @@ 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\
@@ -145,9 +155,6 @@ endif
 $(outdir)/lilypond-%.info: $(outdir)/%.texi $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep $(outdir)/version.itexi
        $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$@ $<
 
-$(outdir)/lilypond.info: $(src-dir)/general.texi $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep $(outdir)/version.itexi
-       $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$@ $<
-
 # 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
@@ -161,11 +168,11 @@ $(outdir)/pictures:
        $(MAKE) -C pictures WWW-1
        ln -sf ../pictures/$(outdir) $@
 
-$(outdir)/general.texi: $(outdir)/examples
+$(outdir)/web.texi: $(outdir)/ly-examples
 
-$(outdir)/examples:
-       $(MAKE) -C general/examples
-       ln -sf ../general/examples/$(outdir) $@
+$(outdir)/ly-examples:
+       $(MAKE) -C web/ly-examples
+       ln -sf ../web/ly-examples/$(outdir) $@
 endif
 
 # Ugh, using '%' twice not possible
@@ -212,7 +219,7 @@ $(outdir)/notation.texi: $(outdir)/ly-grammar.txt
 ## 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 $@
+       $(buildscript-dir)/yyout2grammar $(outdir)/parser.output $@
 
 # There used to be a dependency on a dummy target, to force a rebuild
 # of internals every time.  however, this triggers
@@ -242,78 +249,69 @@ new-lang-dir:
        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)
+       $(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\
            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) &&) :
-       $(foreach i, $(EXTRA_TRANSLATION_FILES), \
-           (test -e $(ISOLANG)/$(i) \
-               || cp fr/$(i) $(ISOLANG)/$(i)) && ) true
        msgmerge -U po/lilypond-doc.pot $(outdir)/doc.pot
        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  ***"
 
-#TRANSLATION_DIRS = $(shell git ls-files $(ISOLANG) | $(PYTHON) $(buildscript-dir)/pytt.py '/[^/]*$$' / | sort -u )
-TRANSLATION_DIRS = application general learning notation texidocs
+TRANSLATION_DIRS = web texidocs
 TRANSLATION_FILES = $(shell git ls-files $(ISOLANG) | grep -v GNUmakefile)
-EXTRA_TRANSLATION_FILES =\
- dedication.itely\
- index.html.in\
- common-macros.itexi\
- macros.itexi\
- translations.html.in\
- translations.template.html.in\
-#
-
 
 TELY_FILES = $(call src-wildcard,$(ISOLANG)/*.tely)
 skeleton-update:
        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)
+       $(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) --skeleton $(TELY_FILES:$(ISOLANG)/%.tely=../%.tely)
+       $(PYTHON) $(auxscript-dir)/texi-skeleton-update.py $(ISOLANG) $(outdir)
 
 snippet-update:
-       $(auxscript-dir)/update-snippets.py user $(ISOLANG) '*.itely'
+       $(PYTHON) $(auxscript-dir)/update-snippets.py user $(ISOLANG) '*.itely'
 
 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-www \
+-I $(top-build-dir)/Documentation/out
 
 else # ISOLANG is empty
 
 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/snippets/out-www \
+-I $(top-build-dir)/Documentation/out
 
 endif # ISOLANG
 
 check-xrefs:
-       $(auxscript-dir)/check_texi_refs.py --batch \
+       $(PYTHON) $(auxscript-dir)/check_texi_refs.py --batch \
        $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py
 
 fix-xrefs:
-       $(auxscript-dir)/check_texi_refs.py --auto-fix \
+       $(PYTHON) $(auxscript-dir)/check_texi_refs.py --auto-fix \
        $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py
 
 check-translation:
-       ISOLANG=$(ISOLANG) $(auxscript-dir)/check_translation.py $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
+       ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
 
 update-translation:
-       ISOLANG=$(ISOLANG) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
+       ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
 
 translation-status:
        make -C po out=www messages
-       $(auxscript-dir)/translations-status.py
+       $(PYTHON) $(auxscript-dir)/translations-status.py
 
 .SECONDARY: