NAME = documentation
LANGS = $(shell $(PYTHON) $(top-src-dir)/python/langdefs.py)
-SUBDIRS=user bibliography pictures topdocs misc po $(LANGS)
+SUBDIRS=devel user bibliography pictures topdocs misc po $(LANGS)
STEPMAKE_TEMPLATES=documentation texinfo tex
LOCALSTEPMAKE_TEMPLATES=lilypond ly
LILYPOND_BOOK_FLAGS=--extra-options '-e "(ly:set-option (quote internal-type-checking) \#t)"'
include $(depth)/make/stepmake.make
-HTML_PAGE_NAMES= index devel translations
+HTML_PAGE_NAMES= index translations
OUT_HTML_FILES= $(HTML_PAGE_NAMES:%=$(outdir)/%.html)
OUT_CSS_FILES= $(CSS_FILES:%.css=$(outdir)/%.css)
<tr>
<td valign="baseline" class="left-column">
<ul>
- <li><a class="title" href="devel.html">Resourcen für Entwickler</a>
+ <li><a class="title" href="devel/index.html">Resourcen für Entwickler</a>
<br>(Dokumentation für Entwickler und Mitwirkende.)</li>
</ul>
</td><td class="right-column">
+++ /dev/null
-<html>
-<!--
- Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
-
- When revising a translation, copy the HEAD committish of the
- version that you are working on. See TRANSLATION for details.
-!-->
- <head>
- <title>LilyPond @TOPLEVEL_VERSION@ Developers Resources</title>
- <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
- <meta name="aesop" content="links">
- <meta name="description"
- content="Top-level index to developers documentation for
- LilyPond @TOPLEVEL_VERSION@">
- </head>
-
- <body>
-
- <div class="header">
- <h1>LilyPond developers resources</h1>
- </div>
-
- <div class="subheader">
- <p>
- <strong>Version @TOPLEVEL_VERSION@</strong>
- <br>
- <strong>@DATE@</strong>
- </p>
- </div>
-
- <table id="navigation">
- <tbody>
- <tr>
- <td class="left-column">
- <ul>
- <li><a class="title"
- href="../input/regression/collated-files.html">Regression
- tests</a> (~ 5 Mb, in <a class="title"
- href="../input/regression/collated-files.pdf">PDF</a>)
- <br>(general tests)</li>
- <li><a class="title"
- href="../input/regression/musicxml/collated-files.html">MusicXML regression
- tests</a> (in <a class="title"
- href="../input/regression/musicxml/collated-files.pdf">PDF</a>)
- <br>(musicxml2ly tests)</li>
- </ul></td>
- <td class="right-column">
- <ul>
- <li><a class="title" href="http://lilypond.org/test">Regression tests results</a>
- <br>(for comparison between releases)</li>
- <li><a class="title" href="bibliography/index.html">Bibliography</a>
- <br>(on background information)</li>
- </ul></td>
- </tr>
- <tr>
- <td valign="baseline" class="left-column">
- <ul>
- <li><a class="title" href="http://lilypond.org/web/devel">lilypond.org development page</a>
- <br>(for all contributors)</li>
- <li><a class="title" href="http://git.sv.gnu.org/gitweb/?p=lilypond.git">lilypond.git repository</a>
- <br>(official sources)</li>
- <li><a class="title" href="http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=blob_plain;f=README;hb=gub">GUB Readme</a>
- <br>(about Grand Unified Binaries packages)</li>
- </ul>
- </td><td class="right-column">
- <ul>
- <li><a class="title" href="http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=blob_plain;f=Documentation%2Fuser%2FREADME.txt;hb=master">Documentation Readme</a>
- <br>(for documentation editors)</li>
- <li><a class="title" href="http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=blob_plain;f=README;hb=web">lilypond.org Readme</a>
-and <a class="title" href="http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=blob_plain;f=TRANSLATION;hb=web">Translation</a>
-<br>(how to translate and build lilypond.org website)</li>
- <li>
- <a class="title" href="http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=blob_plain;f=Documentation%2FTRANSLATION;hb=lilypond%2Ftranslation">Documentation translation</a>
- <br>(how to translate documentation)</li>
- </ul>
- </td>
- </tr>
- </tbody>
-</table>
-
-<p><a href="index.html">Go back</a> to the Documentation index.</a></p>
-
-</body>
-</html>
--- /dev/null
+depth = ../..
+
+STEPMAKE_TEMPLATES = documentation tex texinfo topdocs
+LOCALSTEPMAKE_TEMPLATES = ly
+
+include $(depth)/make/stepmake.make
+
+HTML_PAGE_NAMES = index
+OUT_HTML_FILES = $(HTML_PAGE_NAMES:%=$(outdir)/%.html)
+
+
+MASTER_TEXI_FILES = contrib-guide.texi
+PDF_FILES = $(MASTER_TEXI_FILES:%.texi=$(outdir)/%.pdf)
+HTML_FILES = $(MASTER_TEXI_FILES:%.texi=$(outdir)/%/index.html) \
+ $(MASTER_TEXI_FILES:%.texi=$(outdir)/%-big-page.html)
+
+default: local-doc
+
+local-WWW-1: $(PDF_FILES)
+
+local-WWW-2: $(HTML_FILES) $(OUT_HTML_FILES)
--- /dev/null
+\input texinfo @c -*- coding: utf-8; mode: texinfo; -*-
+@setfilename contrib-guide.info
+@settitle LilyPond Contributors' Guide
+
+@include macros.itexi
+
+@documentencoding utf-8
+@documentlanguage en
+
+@finalout
+
+@node Top
+@top LilyPond Contributors' Guide
+
+
+@bye
--- /dev/null
+<html>
+<!--
+ Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
+
+ When revising a translation, copy the HEAD committish of the
+ version that you are working on. See TRANSLATION for details.
+!-->
+ <head>
+ <title>LilyPond @TOPLEVEL_VERSION@ Developers Resources</title>
+ <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
+ <meta name="aesop" content="links">
+ <meta name="description"
+ content="Top-level index to developers documentation for
+ LilyPond @TOPLEVEL_VERSION@">
+ </head>
+
+ <body>
+
+ <div class="header">
+ <h1>LilyPond developers resources</h1>
+ </div>
+
+ <div class="subheader">
+ <p>
+ <strong>Version @TOPLEVEL_VERSION@</strong>
+ <br>
+ <strong>@DATE@</strong>
+ </p>
+ </div>
+
+ <table align="center">
+ <tr>
+ <td>
+ <br>
+ <a class="title" href="contrib-guide/index.html">Contributors'
+ Guide</a>
+ (in <a class="title" href="contrib-guide-big-page.html">one
+ big page</a>, in <a class="title" href="contrib-guide.pdf">PDF</a>)
+ <br>(how to participate in development)
+ </td>
+ <tr>
+ </table>
+
+ <table id="navigation">
+ <tbody>
+ <tr>
+ <td class="left-column">
+ <ul>
+ <li><a class="title"
+ href="../../input/regression/collated-files.html">Regression
+ tests</a> (~ 5 Mb, in <a class="title"
+ href="../../input/regression/collated-files.pdf">PDF</a>)
+ <br>(general tests)</li>
+ <li><a class="title"
+ href="../../input/regression/musicxml/collated-files.html">MusicXML regression
+ tests</a> (in <a class="title"
+ href="../../input/regression/musicxml/collated-files.pdf">PDF</a>)
+ <br>(musicxml2ly tests)</li>
+ </ul></td>
+ <td class="right-column">
+ <ul>
+ <li><a class="title" href="http://lilypond.org/test">Regression tests results</a>
+ <br>(for comparison between releases)</li>
+ <li><a class="title" href="../bibliography/index.html">Bibliography</a>
+ <br>(on background information)</li>
+ </ul></td>
+ </tr>
+ <tr>
+ <td valign="baseline" class="left-column">
+ <ul>
+ <li><a class="title" href="http://lilypond.org/web/devel">lilypond.org development page</a>
+ <br>(for all contributors)</li>
+ <li><a class="title" href="http://git.sv.gnu.org/gitweb/?p=lilypond.git">lilypond.git repository</a>
+ <br>(official sources)</li>
+ <li><a class="title" href="http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=blob_plain;f=README;hb=gub">GUB Readme</a>
+ <br>(about Grand Unified Binaries packages)</li>
+ </ul>
+ </td><td class="right-column">
+ <ul>
+ <li><a class="title" href="http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=blob_plain;f=Documentation%2Fuser%2FREADME.txt;hb=master">Documentation Readme</a>
+ <br>(for documentation editors)</li>
+ <li><a class="title" href="http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=blob_plain;f=README;hb=web">lilypond.org Readme</a>
+and <a class="title" href="http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=blob_plain;f=TRANSLATION;hb=web">Translation</a>
+<br>(how to translate and build lilypond.org website)</li>
+ <li>
+ <a class="title" href="http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=blob_plain;f=Documentation%2FTRANSLATION;hb=lilypond%2Ftranslation">Documentation translation</a>
+ <br>(how to translate documentation)</li>
+ </ul>
+ </td>
+ </tr>
+ </tbody>
+</table>
+
+<p><a href="../index.html">Go back</a> to the Documentation index.</a></p>
+
+</body>
+</html>
<td valign="baseline" class="left-column">
<ul>
<li>
- <a class="title" href="devel.html">Recursos para desarrolladores</a><br>
+ <a class="title" href="devel/index.html">Recursos para desarrolladores</a><br>
(documentos de interés para desarrolladores y colaboradores)</li>
</ul>
</td>
<tr>
<td valign="baseline" class="left-column">
<ul>
- <li><a class="title" href="devel.html">Ressources de développement</a>
+ <li><a class="title" href="devel/index.html">Ressources de développement</a>
<br>— documentation pour les développeurs et contributeurs</li>
</ul>
</td><td class="right-column">
<tr>
<td valign="baseline" class="left-column">
<ul>
- <li><a class="title" href="devel.html">Developers resources</a>
+ <li><a class="title" href="devel/index.html">Developers resources</a>
<br>(documentation for developers and contributors)</li>
</ul>
</td><td class="right-column">
include $(depth)/make/stepmake.make
-MAKEINFO_FLAGS += -I $(top-src-dir)/Documentation/user
-TEXI2HTML_FLAGS += -I $(top-src-dir)/Documentation/user
-
local-WWW-1: $(OUT_TEXI_FILES)
.SECONDARY:
-
TOPDOC_TXT_FILES = $(addprefix $(top-build-dir)/Documentation/topdocs/$(outdir)/,$(addsuffix .txt,$(TOPDOC_FILES)))
IN_FILES := $(call src-wildcard,*.in)
-EXTRA_DIST_FILES = VERSION .gitignore SConstruct lilypond-texi2html.init \
+EXTRA_DIST_FILES = VERSION .gitignore lilypond-texi2html.init \
$(README_FILES) $(SCRIPTS) $(IN_FILES)
INSTALLATION_DIR=$(local_lilypond_datadir)
INSTALLATION_FILES=$(config_make) VERSION
WWW-post:
# need UTF8 setting in case this is hosted on a website.
+ $(MAKE) -C scripts/build out=
echo -e 'AddDefaultCharset utf-8\nAddCharset utf-8 .html\nAddCharset utf-8 .en\nAddCharset utf-8 .nl\nAddCharset utf-8 .txt\n' > $(top-build-dir)/.htaccess
$(buildscript-dir)/mutopia-index -o $(outdir)/examples.html input/
find $(outdir) -name '*-root' | xargs rm -rf
}
for l in langdefs.LANGUAGES:
- static_files[os.path.join ('Documentation', 'user', outdir, l.file_name ('index', '.html'))] = \
- '<META HTTP-EQUIV="refresh" content="0;URL=../' + l.file_name ('index', '.html') + \
- '">\n<html><body>Redirecting to the documentation index...</body></html>\n'
+ static_files[os.path.join (
+ 'Documentation',
+ 'user',
+ outdir,
+ l.file_name ('index', '.html'))] = \
+ '<META HTTP-EQUIV="refresh" content="0;URL=../' + l.file_name ('index', '.html') + \
+ '">\n<html><body>Redirecting to the documentation index...</body></html>\n'
for f, contents in static_files.items ():
open (f, 'w').write (contents)
dirs, symlinks, files = mirrortree.walk_tree (
tree_roots = doc_dirs,
process_dirs = outdir,
- exclude_dirs = '(^|/)(' + r'|po|out|out-test|.*?[.]t2d|\w*?-root)(/|$)|Documentation/(' + '|'.join ([l.code for l in langdefs.LANGUAGES]) + ')',
+ exclude_dirs = '(^|/)((' + \
+ r'po|out|out-test|out-cov|.*?[.]t2d|\w*?-root)|^Documentation/(' + \
+ '|'.join ([l.code for l in langdefs.LANGUAGES]) + '))(/|$)',
find_files = r'.*?\.(?:midi|html|pdf|png|txt|i?ly|signature|css)$|VERSION',
exclude_files = r'lily-[0-9a-f]+.*\.(pdf|txt)')
$(outdir)/%.pdf: $(outdir)/%.texi $(outdir)/version.itexi
cd $(outdir); texi2pdf $(TEXI2PDF_FLAGS) --batch $(TEXINFO_PAPERSIZE_OPTION) $(<F)
+
+MAKEINFO_TXT_COMMAND =
+
$(outdir)/%.txt: $(outdir)/%.texi $(outdir)/version.itexi
$(MAKEINFO) -I$(src-dir) -I$(outdir) --no-split --no-headers --output $@ $<
-$(outdir)/%.texi: %.texi
- rm -f $@
- cp $< $@
-
$(XREF_MAPS_DIR)/%.xref-map: $(outdir)/%.texi
$(buildscript-dir)/extract_texi_filenames -o $(XREF_MAPS_DIR) $<
+$(outdir)/%.texi: %.texi
+ cp -f $< $@
$(outdir)/version.%: $(top-src-dir)/VERSION
echo '@macro version'> $@
echo '@end macro'>> $@
.SECONDARY: $(outdir)/version.itexi $(outdir)/version.texi \
- $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep
+ $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep \
+ $(outdir)/*.texi
local-WWW-1: $(XREF_MAPS_FILES)
-local-doc: $(OUTTXT_FILES)
+local-doc: $(OUTTXT_FILES)
check-info: texinfo-all-menus-update
TEXINFO_PAPERSIZE_OPTION= $(if $(findstring $(PAPERSIZE),a4),,-t @afourpaper)
-MAKEINFO_FLAGS = --enable-encoding
+MAKEINFO_FLAGS += --enable-encoding $(DOCUMENTATION_INCLUDES)
MAKEINFO = LANG= $(MAKEINFO_PROGRAM) $(MAKEINFO_FLAGS)
# texi2html xref map files
TEXI2HTML_INIT = --init-file=$(top-src-dir)/lilypond-texi2html.init
TEXI2HTML = $(TEXI2HTML_PROGRAM) $(TEXI2HTML_FLAGS) $(TEXI2HTML_LANG)
+TEXI2PDF_FLAGS += $(DOCUMENTATION_INCLUDES)
+
ifdef QUIET_BUILD
TEXI2PDF_FLAGS += -q
endif
TO_TOP_FILES=$(addprefix $(outdir)/, $(addsuffix .txt, $(README_TOP_FILES)))
+DOCUMENTATION_INCLUDES = -I $(top-src-dir)/Documentation/user
depth = ..
TEXINFO_FILES = texinfo.tex $(call src-wildcard,txi-*.tex)
-TEX_FILES = $(filter-out $TEXINFO_FILES,$(call src-wildcard,*.tex))
+TEX_FILES = $(filter-out $(TEXINFO_FILES),$(call src-wildcard,*.tex))
EXTRA_DIST_FILES = $(TEX_FILES) $(TEXINFO_FILES)
STEPMAKE_TEMPLATES = install install-out