]> git.donarmstrong.com Git - lilypond.git/commitdiff
Add Contributors' Guide stub and clean up makefiles
authorJohn Mandereau <john.mandereau@gmail.com>
Fri, 9 Jan 2009 19:32:27 +0000 (20:32 +0100)
committerJohn Mandereau <john.mandereau@gmail.com>
Fri, 9 Jan 2009 19:32:27 +0000 (20:32 +0100)
* add Contributors' Guide stub in new directory Documentation/devel/;

* move Documentation/devel.html.in to Documentation/devel/index.html.in
to avoid clashing directory and file names on lilypond.org;

* cleanup topdocs and Texinfo makefiles;

* fix links accordingly;

* fix 'make dist'.

17 files changed:
Documentation/GNUmakefile
Documentation/de/index.html.in
Documentation/devel.html.in [deleted file]
Documentation/devel/GNUmakefile [new file with mode: 0644]
Documentation/devel/contrib-guide.texi [new file with mode: 0644]
Documentation/devel/index.html.in [new file with mode: 0644]
Documentation/es/index.html.in
Documentation/fr/index.html.in
Documentation/index.html.in
Documentation/topdocs/GNUmakefile
GNUmakefile.in
scripts/build/www_post.py
stepmake/stepmake/texinfo-rules.make
stepmake/stepmake/texinfo-targets.make
stepmake/stepmake/texinfo-vars.make
stepmake/stepmake/topdocs-vars.make
tex/GNUmakefile

index 790b0460479ce4a976d511a7a1d91228fc4ce460..747a8e304e612ed38698c5f6758b4d9b56767c97 100644 (file)
@@ -2,7 +2,7 @@ depth = ..
 
 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)"'
@@ -11,7 +11,7 @@ EXTRA_DIST_FILES= TRANSLATION
 
 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)
 
index ee95ddede8bb1131aec23002de4680b16ed022e1..5d9bae5359a378cfc1ef787f7c127d5fef1412f9 100644 (file)
@@ -100,7 +100,7 @@ als <a class="title" href="user/lilypond-snippets.pdf">PDF</a>)
         <tr>
           <td valign="baseline" class="left-column">
        <ul>
-            <li><a class="title"  href="devel.html">Resourcen f&uuml;r Entwickler</a>
+            <li><a class="title"  href="devel/index.html">Resourcen f&uuml;r Entwickler</a>
             <br>(Dokumentation f&uuml;r Entwickler und Mitwirkende.)</li>
        </ul>
     </td><td class="right-column">
diff --git a/Documentation/devel.html.in b/Documentation/devel.html.in
deleted file mode 100644 (file)
index 703a3d7..0000000
+++ /dev/null
@@ -1,84 +0,0 @@
-<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>
diff --git a/Documentation/devel/GNUmakefile b/Documentation/devel/GNUmakefile
new file mode 100644 (file)
index 0000000..5c10ebe
--- /dev/null
@@ -0,0 +1,21 @@
+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)
diff --git a/Documentation/devel/contrib-guide.texi b/Documentation/devel/contrib-guide.texi
new file mode 100644 (file)
index 0000000..6e8ec88
--- /dev/null
@@ -0,0 +1,16 @@
+\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
diff --git a/Documentation/devel/index.html.in b/Documentation/devel/index.html.in
new file mode 100644 (file)
index 0000000..3cc188d
--- /dev/null
@@ -0,0 +1,97 @@
+<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>
index d5721ba5f4ca4528f4883ca0276bf7bfa34c4265..5c987014e9eea984d75d7caf8624fa17a922d575 100644 (file)
@@ -93,7 +93,7 @@
           <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>
index f01889be69699dffd5c701204df83a71afed8892..da2d55073ce878abf2df2cdda57e1875c17d45c8 100644 (file)
@@ -91,7 +91,7 @@ au format <a class="title" href="user/lilypond-snippets.pdf">PDF</a>)
         <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>&mdash; documentation pour les développeurs et contributeurs</li>
        </ul>
     </td><td class="right-column">
index 99ec9d8e0e30022c9cc6198e0c4f60b0f054f5d6..9836f53491bef264d5b55e10e7538ab75c5e44ec 100644 (file)
@@ -98,7 +98,7 @@ in <a class="title" href="user/lilypond-snippets.pdf">PDF</a>)
         <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">
index 537f761b0a8f847f578e16c0a8f99f12d664dad1..0f81c76f1136828424e8c93a5732f65cbe85a2be 100644 (file)
@@ -11,10 +11,6 @@ OUTTXT_FILES= $(outdir)/NEWS.txt
 
 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:
-
index f6389fbe3f7a0b4aae02d30ec1b7afc911c6e41a..36ade426bdd469360634b07d0dc50b8a3336abf8 100644 (file)
@@ -22,7 +22,7 @@ TOPDOC_FILES = AUTHORS INSTALL README NEWS
 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
@@ -88,6 +88,7 @@ WEB_TARGETS = offline
 
 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
index 29f80cf09fa2bb208995e7c5094974782c6ee566..21ce380ce342a5447790a0adadfc7c74117223a9 100644 (file)
@@ -35,9 +35,13 @@ static_files = {
     }
 
 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)
@@ -46,7 +50,9 @@ sys.stderr.write ("Mirrorring...\n")
 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)')
 
index 05627f18dab6eb598cd0fab9c76fc546fc93ac54..a49c86a87f4f65d150eea9b0d400e55a64c4b5ec 100644 (file)
@@ -64,16 +64,17 @@ $(outdir)/%.ps.gz.omf: %.texi
 $(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'> $@
@@ -81,4 +82,5 @@ $(outdir)/version.%: $(top-src-dir)/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
index 492e1f636621a137c5687a030bf25664a5fac420..6754b77f5fe389bacd8ad48f64406e54e2c58dc4 100644 (file)
@@ -4,7 +4,7 @@ default: $(INFO_FILES)
 
 local-WWW-1: $(XREF_MAPS_FILES)
 
-local-doc: $(OUTTXT_FILES)
+local-doc:  $(OUTTXT_FILES)
 
 check-info: texinfo-all-menus-update
 
index ca567b686806f6dd3560f1ed888b05e657396b4f..d3d237843cbf80f58e5144693dab43703510dbdc 100644 (file)
@@ -10,7 +10,7 @@ GENERATE_OMF = $(buildscript-dir)/texi2omf --format $(1) --location $(webdir)/$(
 
 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
@@ -25,6 +25,8 @@ TEXI2HTML_FLAGS += $(DOCUMENTATION_INCLUDES) --I=$(XREF_MAPS_DIR)
 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
index 73adc870461bfd43cf3b0209dbe59ec18e41b2f7..89786ea768fd73945f137fc9a2a2290fbf4f04b9 100644 (file)
@@ -1,2 +1,3 @@
 TO_TOP_FILES=$(addprefix $(outdir)/, $(addsuffix .txt, $(README_TOP_FILES)))
 
+DOCUMENTATION_INCLUDES = -I $(top-src-dir)/Documentation/user
index 9f275d7041dafd07eff9077712c43975dc4f382b..64e2653bd9d227b0095c7f36e67df576d22317d9 100644 (file)
@@ -1,7 +1,7 @@
 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