]> git.donarmstrong.com Git - lilypond.git/commitdiff
Doc: CG: discuss useful scripts.
authorGraham Percival <graham@percival-music.ca>
Tue, 24 Aug 2010 20:35:52 +0000 (21:35 +0100)
committerGraham Percival <graham@percival-music.ca>
Wed, 25 Aug 2010 14:41:34 +0000 (15:41 +0100)
node-menuify.py for the docs, and .bib stuff for the website.

Documentation/contributor/doc-work.itexi
Documentation/contributor/website-work.itexi

index cab96b90a405ed5831f84a8a5c5d666637c4c38c..abd8c1654ffcbe378a062dc7d037cbbde3bb5dd2 100644 (file)
@@ -1353,34 +1353,29 @@ scripts/auxiliar/cg-section.sh doc-work
 Like @code{doc-section.sh}, @code{cg-section.sh} may need to be customized
 for your installation.
 
-@subheading Stripping whitespace
+@subheading Stripping whitespace and generating menus
 
-@c TODO: should this be documented elsewhere?  It's useful for
-@c more than just docs.
-To remove extra whitespace from the ends of lines, run
+@warning{This script assumes that the file conforms to our doc
+policy; a few files still need work in this regard.}
+
+To automatically regenerate @code{@@menu} portions and strip
+whitespace, use:
 
 @example
-scripts/auxiliar/strip-whitespace.py Documentation/FILENAME
+scripts/auxiliar/node-menuify.py @var{FILENAME}
 @end example
 
 
-@subheading Sectioning commands
-
-@warning{These commands add whitespace.}
+@subheading Stripping whitespace only
 
-The emacs @code{M-x texinfo-all-menus-update} command will
-regenerate @@menu blocks.  This can also be run with this
-command-line script:
+@c TODO: should this be documented elsewhere?  It's useful for
+@c more than just docs.
+To remove extra whitespace from the ends of lines, run
 
 @example
-#!/bin/sh
-emacs $1 -batch -f texinfo-all-menus-update -f save-buffer
+scripts/auxiliar/strip-whitespace.py Documentation/FILENAME
 @end example
 
-@noindent
-(save the above as something like @command{texinfo-menus.sh}, make
-it executable, then run @command{texinfo-menus.sh foo.itely})
-
 
 @subheading Updating doc with @command{convert-ly}
 
index 4d71c32e97e2400b18f00b751c7797f186517889..ba1ddcb0392afa7e60c403680ab8b55219c40caf 100644 (file)
@@ -39,6 +39,12 @@ subsections or subsubsections.
 link to any pieces of automatically generated documentation, like
 the IR or certain NR appendices.
 
+@item
+The bibliography in Community->Publications is generated automatically
+from @file{.bib} files; formatting is done automatically by
+@file{texi-web.bst}.
+
+@item
 @dots{}
 
 @item