]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/GNUmakefile
Build: end directories in their bare names and avoid some double slashes in logs.
[lilypond.git] / Documentation / GNUmakefile
index 133f09854a03b0c6d62fa0684a8fb521e9a808c0..d4246294e5d7d2d3ab2c45602bee8cd9ca339324 100644 (file)
@@ -9,7 +9,7 @@ depth = ..
 
 NAME = documentation
 LANGS = $(shell $(PYTHON) $(top-src-dir)/python/langdefs.py)
-MANUALS_SUBDIRS = usage automated-engraving contributor essay \
+MANUALS_SUBDIRS = usage contributor essay \
   web learning notation extending
 SUBDIRS = $(MANUALS_SUBDIRS) snippets logo pictures misc po css topdocs \
   included $(LANGS)
@@ -32,7 +32,7 @@ README_TOP_FILES= DEDICATION THANKS
 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_DIST_FILES = $(call src-wildcard,*.init)
 
 ### Out files
 
@@ -56,7 +56,7 @@ TEXI_FILES_FROM_TELY = $(outdir)/internals.texi
 
 PDF_FILES = $(TEXINFO_MANUALS:%=$(outdir)/%.pdf)
 
-TOPDIR_HTML_MANUALS = 
+TOPDIR_HTML_MANUALS =
 UNSPLITTED_HTML_MANUALS =
 SPLITTED_HTML_MANUALS = $(foreach manual, $(TEXINFO_MANUALS),\
  $(if $(findstring $(manual), $(UNSPLITTED_HTML_MANUALS)),,$(manual)))
@@ -73,39 +73,36 @@ source-links = $(outdir)/source\
 
 # Other out files
 
-HTML_PAGE_NAMES= translations index
-OUT_HTML_FILES += $(HTML_PAGE_NAMES:%=$(outdir)/%.html)
-
 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 
+INFO_DOCS += lilypond-snippets
 endif
 INFO_FILES = $(INFO_DOCS:%=$(outdir)/%.info)
 
 ifeq ($(out),www)
 INFO_IMAGES_DIR = lilypond
-DEST_INFO_IMAGES_SUBDIR = Documentation/
+DEST_INFO_IMAGES_SUBDIR = Documentation
 endif
 
 include $(depth)/make/stepmake.make
 
 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
 
-ifeq ($(out),www)
-website: $(outdir)/web.texi $(XREF_MAPS_DIR)/web.xref-map $(outdir)/version.itexi $(outdir)/pictures/
-       mkdir -p $(outdir)/website/
-       $(TEXI2HTML) $(TEXI2HTML_SPLIT) $(TEXI2HTML_FLAGS) -D web_version \
-               --output=$(outdir)/website/ $(outdir)/web.texi
-       cp $(top-src-dir)/Documentation/css/*.css $(outdir)/website/
-       cd $(outdir)/website && ln -sf ../../pictures/$(outdir) pictures
-       cd $(outdir)/website && ln -sf ../../web/examples/$(outdir) examples
-endif
+### AJAX scripts
+JS_FILES = $(call src-wildcard,*.js)
+PHP_FILES = $(call src-wildcard,*.php)
+EXTRA_DIST_FILES += $(JS_FILES) $(PHP_FILES)
+
+OUT_JS_FILES = $(JS_FILES:%.js=$(outdir)/%.js)
+OUT_PHP_FILES = $(PHP_FILES:%.php=$(outdir)/%.php)
+
 
 
 ### bad hack for badly-integrated roadmap.
@@ -113,6 +110,39 @@ $(outdir)/ROADMAP:
        cp $(top-src-dir)/ROADMAP $(outdir)
 $(outdir)/contributor.texi: $(outdir)/ROADMAP
 
+### bad hack for badly-integrated bibliography
+$(outdir)/colorado.itexi:
+       BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \
+               -o $(outdir)/colorado.itexi \
+               $(src-dir)/essay/colorado.bib
+
+$(outdir)/computer-notation.itexi:
+       BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \
+               -o $(outdir)/computer-notation.itexi \
+               $(src-dir)/essay/computer-notation.bib
+
+$(outdir)/engravingbib.itexi:
+       BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \
+               -o $(outdir)/engravingbib.itexi \
+               $(src-dir)/essay/engravingbib.bib
+
+$(outdir)/essay.texi: \
+  $(outdir)/colorado.itexi \
+  $(outdir)/computer-notation.itexi \
+  $(outdir)/engravingbib.itexi
+
+$(outdir)/others-did.itexi:
+       BSTINPUTS=$(src-dir)/web/ $(buildscript-dir)/bib2texi \
+               -s web \
+               -o $(outdir)/others-did.itexi \
+               $(src-dir)/web/others-did.bib
+
+$(outdir)/we-wrote.itexi:
+       BSTINPUTS=$(src-dir)/web/ $(buildscript-dir)/bib2texi \
+               -s web \
+               -o $(outdir)/we-wrote.itexi \
+               $(src-dir)/web/we-wrote.bib
+
 
 ###########
 ### Targets
@@ -122,23 +152,29 @@ default: local-txt-doc
 local-help: extra-local-help
 
 extra-local-help:
-       @echo -e "\
-  check-xrefs [ISOLANG=LL] validate Texinfo cross-references\n\
-  fix-xrefs [ISOLANG=LL]   interactively fix Texinfo cross-references (use with caution)\n\
-  info        update info pages\n\
-  xml        update Docbook xml documentation\n\
-\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\
-  skeleton-update ISOLANG=LL     update Texinfo skeleton files\n\
-  snippet-update ISOLANG=LL      update ly snippets in Texinfo translation according to\n\
-                              docs in English (use with caution)\n\
-\n\
-LL refers to the desired locale (most often only the ISO 639 language code).\n"
+       @echo "  check-xrefs [ISOLANG=LL] validate Texinfo cross-references"
+       @echo "  fix-xrefs [ISOLANG=LL]   interactively fix Texinfo cross-references"
+       @echo "                             (use with caution)"
+       @echo "  info                     update info pages"
+       @echo "  xml                      update Docbook xml documentation"
+       @echo
+       @echo "Translations specific targets (see TRANSLATION for details):"
+       @echo "  new-lang ISOLANG=LL           create and initialize"
+       @echo "                                  subdirectory \'LL' for language \'LL"
+       @echo "                                  (if \'LL exists, update missing file)"
+       @echo "  po-update                     update and replace PO files for"
+       @echo "                                  documentation with msgmerged versions"
+       @echo "  check-translation ISOLANG=LL  show changes in English docs since"
+       @echo "                                  last translation update"
+       @echo "  update-translation ISOLANG=LL call $$$$EDITOR to help updating"
+       @echo "                                  the translation"
+       @echo "  snippet-update ISOLANG=LL     update ly snippets in Texinfo translation"
+       @echo "                                  according to docs in English"
+       @echo "                                  (use with caution)"
+       @echo
+       @echo "  LL refers to the desired locale"
+       @echo "    (most often only the ISO 639 language code)."
+       @echo
 
 info: $(INFO_FILES)
        @echo export LILYPOND_DATADIR=$(LILYPOND_DATADIR)
@@ -155,14 +191,19 @@ local-clean:
 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)/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=$@ $<
 
 # cd $(outdir) rule gets bit hairy for --srcdir configure builds
@@ -178,13 +219,19 @@ $(outdir)/pictures:
        $(MAKE) -C pictures WWW-1
        ln -sf ../pictures/$(outdir) $@
 
-$(outdir)/web.texi: $(outdir)/examples
+$(outdir)/ly-examples:
+       $(MAKE) -C web/ly-examples
+       ln -sf ../web/ly-examples/$(outdir) $@
+endif
 
-$(outdir)/examples:
-       $(MAKE) -C web/examples
-       ln -sf ../web/examples/$(outdir) $@
+ifeq ($(out),www)
+$(outdir)/web.texi: $(outdir)/ly-examples $(outdir)/we-wrote.itexi $(outdir)/others-did.itexi
+else
+# duplicate (without ly-examples)
+$(outdir)/web.texi: $(outdir)/we-wrote.itexi $(outdir)/others-did.itexi
 endif
 
+
 # Ugh, using '%' twice not possible
 $(outdir)/notation/notation.xml: $(outdir)/notation.texi
        mkdir -p $(dir $@)
@@ -211,7 +258,7 @@ $(outdir)/%/source:
        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, $^)
 
@@ -220,6 +267,12 @@ $(outdir)/snippets.texi: $(GENERATED_ITELY_FILES) $(SNIPPET_LY_FILES)
 $(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
@@ -229,7 +282,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
@@ -259,7 +312,7 @@ 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
@@ -280,15 +333,19 @@ new-lang:
 
 TRANSLATION_DIRS = web texidocs
 TRANSLATION_FILES = $(shell git ls-files $(ISOLANG) | grep -v GNUmakefile)
+TEXI_LANGUTIL_FLAGS += --skeleton
 
 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)
-       $(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) $(TEXI_LANGUTIL_FLAGS) $(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 \
@@ -307,21 +364,21 @@ DOCUMENTS_INCLUDES:=-I . \
 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)
 
+# what's it gonna be, boy...tranlationS-/translation-
 translation-status:
-       make -C po out=www messages
-       $(auxscript-dir)/translations-status.py
+       PYTHONPATH=$(top-src-dir)/python:$(top-src-dir)/python/auxiliar $(PYTHON) $(top-src-dir)/scripts/auxiliar/translations-status.py
 
 .SECONDARY: