LOCALSTEPMAKE_TEMPLATES=lilypond ly
LILYPOND_BOOK_FLAGS=--extra-options '-e "(ly:set-option (quote internal-type-checking) \#t)"'
README_TOP_FILES= DEDICATION THANKS
+EXTRA_DIST_FILES = lilypond-texi2html.init
include $(depth)/make/stepmake.make
--- /dev/null
+@c -*- coding: utf-8; mode: texinfo; -*-
+
+
+
+@c Don't replace quotes with directed quotes.
+
+@set txicodequoteundirected
+@set txicodequotebacktick
+
+
+@c ***** Displaying text *****
+
+@c We need this since @q{\} doesn't work with makeinfo 4.11 --
+@c say @q{@bs{}} instead.
+
+@macro bs
+\\
+@end macro
+
+
+@ifnotinfo
+
+@macro notation{TEXT}
+@var{\TEXT\}
+@end macro
+
+@end ifnotinfo
+
+@ifinfo
+
+@macro notation{TEXT}
+\TEXT\
+@end macro
+
+@end ifinfo
+
+
+@macro smallspace
+@sp 1
+@end macro
+
+
+@c ***** Displaying images not generated by lilypond-book *****
+
+@c Current installation setup of Info docs requires that all images are
+@c expected to be found in the `lilypond/' subdirectory. `lilypond-book'
+@c already generates proper @image commands for images of music; these
+@c macro definitions do the same for other images.
+
+@ifnotinfo
+
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
+@end macro
+
+@end ifnotinfo
+
+@ifinfo
+
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
+@end macro
+
+@end ifinfo
+
+
+@c ***** Headers *****
+
+@macro lydoctitle {TEXT}
+@emph{\TEXT\}
+@end macro
+
+
+@c ***** Indexing *****
+
+@c Don't remove the `@c' within the macro definition! See section 19.3,
+@c `Macro Details and Caveats', in the texinfo info file for explanation.
+
+@macro funindex {TEXT}
+@findex \TEXT\
+@kindex \TEXT\
+@c
+@end macro
+
+
+@c ***** Macros specific to translated docs *****
+
+@c ugh, cannot set/define global variable 'translationof' in any way :-(
+
+@iftex
+
+@macro translationof{TEXT}
+@end macro
+
+@end iftex
+
+@ifinfo
+
+@macro translationof{TEXT}
+@set translationof \TEXT\
+@end macro
+
+@end ifinfo
+
+@ifhtml
+
+@ifset bigpage
+@macro untranslated
+@end macro
+@end ifset
+
+@ifclear bigpage
+@macro untranslated
+UNTRANSLATED NODE: IGNORE ME
+@end macro
+@end ifclear
+
+@end ifhtml
+
+@ifnothtml
+
+@macro untranslated
+@end macro
+
+@end ifnothtml
@include version.itexi
-
-
-@c Don't replace quotes with directed quotes.
-
-@set txicodequoteundirected
-@set txicodequotebacktick
-
+@include common-macros.itexi
@c ***** Displaying text *****
-@c We need this since @q{\} doesn't work with makeinfo 4.11 --
-@c say @q{@bs{}} instead.
-
-@macro bs
-\\
-@end macro
-
-
@c To get decent quotes in ,foo' and ,,foo''.
@c These need to be split up so that "@qq{foo}." looks nice. :(
@end ifnothtml
-@ifnotinfo
-
-@macro notation{TEXT}
-@var{\TEXT\}
-@end macro
-
-@end ifnotinfo
-
-@ifinfo
-
-@macro notation{TEXT}
-\TEXT\
-@end macro
-
-@end ifinfo
-
-
-@macro smallspace
-@sp 1
-@end macro
-
-
-
-@c ***** Displaying images not generated by lilypond-book *****
-
-@c Current installation setup of Info docs requires that all images are
-@c expected to be found in the `lilypond/' subdirectory. `lilypond-book'
-@c already generates proper @image commands for images of music; these
-@c macro definitions do the same for other images.
-
-@ifnotinfo
-
-@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
-@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
-@end macro
-
-@end ifnotinfo
-
-@ifinfo
-
-@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
-@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
-@end macro
-
-@end ifinfo
-
-
-
@c ***** Headings in a doc subsection *****
@c Don't insert an empty line after @predefined! Right now
@end macro
-@macro lydoctitle {TEXT}
-@emph{\TEXT\}
-@end macro
-
-
-@c Don't remove the `@c' within the macro definition! See section 19.3,
-@c `Macro Details and Caveats', in the texinfo info file for explanation.
-
-@macro funindex {TEXT}
-@findex \TEXT\
-@kindex \TEXT\
-@c
-@end macro
-
-
@c ***** Links and references *****
@c ***** Macros specific to translated docs *****
-@c ugh, cannot set/define global variable 'translationof' in some way?
-
-@iftex
-
-@macro translationof{TEXT}
-@end macro
-
-@end iftex
-
-@ifinfo
-
-@macro
-@macro translationof{TEXT}
-@set translationof \TEXT\
-@end macro
-
-@end ifinfo
-
-
-@c TODO: If @translationof is used in translated docs
-@c see whether it is feasible to say @value{translationof}.
@macro englishref
Dieser Abschnitt wurde noch nicht übersetzt. Bitte lesen Sie den
Abschnitt im englischen Benutzerhandbuch.
@end macro
-
-@ifhtml
-
-@ifset bigpage
-@macro untranslated
-@end macro
-@end ifset
-
-@ifclear bigpage
-@macro untranslated
-UNTRANSLATED NODE: IGNORE ME
-@end macro
-@end ifclear
-
-@end ifhtml
-
-@ifnothtml
-@macro untranslated
-@end macro
-@end ifnothtml
STEPMAKE_TEMPLATES = documentation tex texinfo topdocs
LOCALSTEPMAKE_TEMPLATES = ly
+# DOCUMENTATION_INCLUDES = -I $(top-src-dir)/Documentation/user
+
include $(depth)/make/stepmake.make
HTML_PAGE_NAMES = index
@include version.itexi
-
-
-@c Don't replace quotes with directed quotes.
-
-@set txicodequoteundirected
-@set txicodequotebacktick
-
+@include common-macros.itexi
@c ***** Displaying text *****
-@c We need this since @q{\} doesn't work with makeinfo 4.11 --
-@c say @q{@bs{}} instead.
-
-@macro bs
-\\
-@end macro
-
-
@c To get decent quotes in `foo' and ``foo''.
@macro q{TEXT}
@end ifnothtml
-@ifnotinfo
-
-@macro notation{TEXT}
-@var{\TEXT\}
-@end macro
-
-@end ifnotinfo
-
-@ifinfo
-
-@macro notation{TEXT}
-\TEXT\
-@end macro
-
-@end ifinfo
-
-
-@macro smallspace
-@sp 1
-@end macro
-@c ***** Displaying images not generated by lilypond-book *****
-
-@c Current installation setup of Info docs requires that all images are
-@c expected to be found in the `lilypond/' subdirectory. `lilypond-book'
-@c already generates proper @image commands for images of music; these
-@c macro definitions do the same for other images.
-
-@ifnotinfo
-
-@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
-@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
-@end macro
-
-@end ifnotinfo
-
-@ifinfo
-
-@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
-@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
-@end macro
-
-@end ifinfo
-
-
@c ***** Headings in a doc subsection *****
@end macro
-@macro lydoctitle {TEXT}
-@emph{\TEXT\}
-@end macro
-
-
-@c Don't remove the `@c' within the macro definition! See section 19.3,
-@c `Macro Details and Caveats', in the texinfo info file for explanation.
-
-@macro funindex {TEXT}
-@findex \TEXT\
-@kindex \TEXT\
-@c
-@end macro
-
-
-
@c ***** Links and references *****
@c Definitions for references:
@c ***** Macros specific to translated docs *****
-@c ugh, cannot set/define global variable 'translationof' in some way?
-
-@iftex
-
-@macro translationof{TEXT}
-@end macro
-
-@end iftex
-
-@ifinfo
-
-@macro
-@macro translationof{TEXT}
-@set translationof \TEXT\
-@end macro
-
-@end ifinfo
-
-
-@c TODO: If @translationof is used in translated docs
-@c see whether it is feasible to say @value{translationof}.
@macro englishref
Esta sección aún no está traducida; consulte el manual en inglés.
@end macro
-
-
-@ifhtml
-
-@ifset bigpage
-@macro untranslated
-@end macro
-@end ifset
-
-@ifclear bigpage
-@macro untranslated
-UNTRANSLATED NODE: IGNORE ME
-@end macro
-@end ifclear
-
-@end ifhtml
-
-@ifnothtml
-
-@macro untranslated
-@end macro
-
-@end ifnothtml
@include version.itexi
-
-
-@c Don't replace quotes with directed quotes.
-
-@set txicodequoteundirected
-@set txicodequotebacktick
-
+@include common-macros.itexi
@c ***** Displaying text *****
-@c We need this since @q{\} doesn't work with makeinfo 4.11 --
-@c say @q{@bs{}} instead.
-
-@macro bs
-\\
-@end macro
-
@c To get decent quotes in `foo' and ``foo''.
@c FIXME: Use thin spaces for @qq.
@end ifnothtml
-@ifnotinfo
-
-@macro notation{TEXT}
-@var{\TEXT\}
-@end macro
-
-@end ifnotinfo
-
-@ifinfo
-
-@macro notation{TEXT}
-\TEXT\
-@end macro
-
-@end ifinfo
-
-
-@macro smallspace
-@sp 1
-@end macro
-
-
-
-@c ***** Displaying images not generated by lilypond-book *****
-
-@c Current installation setup of Info docs requires that all images are
-@c expected to be found in the `lilypond/' subdirectory. `lilypond-book'
-@c already generates proper @image commands for images of music; these
-@c macro definitions do the same for other images.
-
-@ifnotinfo
-
-@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
-@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
-@end macro
-
-@end ifnotinfo
-
-@ifinfo
-
-@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
-@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
-@end macro
-
-@end ifinfo
-
-
@c ***** Headings in a doc subsection *****
@end macro
-@macro lydoctitle {TEXT}
-@emph{\TEXT\}
-@end macro
-
-
-@c Don't remove the `@c' within the macro definition! See section 19.3,
-@c `Macro Details and Caveats', in the texinfo info file for explanation.
-
-@macro funindex {TEXT}
-@findex \TEXT\
-@kindex \TEXT\
-@c
-@end macro
-
@c ***** Links and references *****
@end iftex
-
@c ***** Macros specific to translated docs *****
-@c ugh, cannot set/define global variable 'translationof' in some way?
-
-@iftex
-
-@macro translationof{TEXT}
-@end macro
-
-@end iftex
-
-@ifinfo
-
-@macro translationof{TEXT}
-@set translationof \TEXT\
-@end macro
-
-@end ifinfo
-
-
-@c TODO: If @translationof is used in translated docs
-@c see whether it is feasible to say @value{translationof}.
-
@macro englishref
Cette section n'est pas encore encore traduite, veuillez
vous reporter à la documentation correspondante en anglais.
@end macro
-
-
-@ifhtml
-
-@ifset bigpage
-@macro untranslated
-@end macro
-@end ifset
-
-@ifclear bigpage
-@macro untranslated
-UNTRANSLATED NODE: IGNORE ME
-@end macro
-@end ifclear
-
-@end ifhtml
-
-@ifnothtml
-
-@macro untranslated
-@end macro
-
-@end ifnothtml
--- /dev/null
+@c -*- coding: utf-8; mode: texinfo; -*-
+@ignore
+ Translation of GIT committish: 499a511d4166feaada31114e097f86b5e0c56421
+
+ When revising a translation, copy the HEAD committish of the
+ version that you are working on. See TRANSLATION for details.
+@end ignore
+
+
+@include version.itexi
+@include common-macros.itexi
+
+
+@c ***** Displaying text *****
+
+@macro hash
+\#
+@end macro
+
+@c To get decent quotes in `foo' and ``foo''.
+@c FIXME: Use thin spaces for @qq.
+
+@ifnotinfo
+
+@macro q{TEXT}
+@quoteleft{}\TEXT\@quoteright{}
+@end macro
+
+@macro qq{TEXT}
+@quotedblleft{}\TEXT\@quotedblright{}
+@end macro
+
+@end ifnotinfo
+
+@ifinfo
+
+@macro q{TEXT}
+`\TEXT\'
+@end macro
+
+@macro qq{TEXT}
+« \TEXT\ »
+@end macro
+
+@end ifinfo
+
+
+@ifhtml
+
+@macro warning{TEXT}
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end macro
+
+@end ifhtml
+
+@ifnothtml
+
+@macro warning{TEXT}
+@quotation
+@quotation
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end quotation
+@end quotation
+@end macro
+
+@end ifnothtml
+
+
+
+@c ***** Headings in a doc subsection *****
+
+@c Don't insert an empty line after @predefined! Right now
+@c it doesn't matter, but a future implementation will probably
+@c add some code which needs this restriction.
+
+@macro predefined
+@noindent
+@subsubheading Predefined commands
+@end macro
+
+@macro snippets
+@noindent
+@subsubheading Selected Snippets
+@end macro
+
+
+@c Don't insert an empty line after @seealso! Otherwise we get
+@c unwanted extra vertical space in the PDF output.
+
+@macro seealso
+@noindent
+@subsubheading See also
+@indent
+@end macro
+
+
+@macro knownissues
+@noindent
+@subsubheading Known issues and warnings
+@end macro
+
+
+
+@c ***** Links and references *****
+
+@c Definitions for references:
+@c
+@c @rglos
+@c @rlearning
+@c @ruser
+@c @rprogram
+@c @rlsr
+@c @rinternals
+@c
+@c All these also have a @...named version which allows to specify the
+@c displayed text for the reference as second argument.
+@c
+@c ***** HTML + bigpage is a special case (other manual names); all other
+@c formats are treated similarly.
+
+
+@c *** not TeX ***
+
+@ifnottex
+
+@c ** bigpage **
+
+@ifset bigpage
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
+@end macro
+
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Music Glossary}
+@end macro
+
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
+@end macro
+
+@macro rlearningnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Learning Manual}
+@end macro
+
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page,Notation Reference}
+@end macro
+
+@macro rusernamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Notation Reference}
+@end macro
+
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
+@end macro
+
+@macro rprogramnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Application Usage}
+@end macro
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
+@end macro
+
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets-big-page,Snippets}
+@end macro
+
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
+@end macro
+
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals-big-page,Internals Reference}
+@end macro
+
+@end ifset
+
+
+@c ** not bigpage **
+
+@ifclear bigpage
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
+@end macro
+
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
+@end macro
+
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@end macro
+
+@macro rlearningnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@end macro
+
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond,Notation Reference}
+@end macro
+
+@macro rusernamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
+@end macro
+
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Application Usage}
+@end macro
+
+@macro rprogramnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
+@end macro
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
+@end macro
+
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
+@end macro
+
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
+@end macro
+
+@end ifclear
+
+@end ifnottex
+
+
+@c *** TeX ***
+
+@iftex
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
+@end macro
+
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
+@end macro
+
+@macro rlearning{TEXT}
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@end macro
+
+@macro rlearningnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning,Learning Manual}
+@end macro
+
+@macro ruser{TEXT}
+@ref{\TEXT\,,,lilypond,Notation Reference}
+@end macro
+
+@macro rusernamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
+@end macro
+
+@macro rprogram{TEXT}
+@ref{\TEXT\,,,lilypond-program,Application Usage}
+@end macro
+
+@macro rprogramnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
+@end macro
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
+@end macro
+
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
+@end macro
+
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
+@end macro
+
+@end iftex
+
+
+@c ***** Macros specific to translated docs *****
+
+@c None currently defined
--- /dev/null
+#!/usr/bin/env perl
+# -*- coding: utf-8; -*-
+
+### texi2html customization script for Lilypond
+### Author: Reinhold Kainhofer <reinhold@kainhofer.com>, 2008.
+### Some code parts copied from texi2html and adapted. These functions
+### were written mainly by Patrice Dumas
+### License: GPLv2+
+###
+###
+### Features implemented here:
+### -) For split manuals, the main page is index.html.
+### -) All @unnumbered* sections are placed into the same file
+### (implemented by split_at_numbered_sections)
+### -) Use our custom CSS file, with IE-specific fixes in another CSS file,
+### impelmented by lilypond_css_lines
+### -) TOC (folded, with the current page highlighted) in an overflown <div>
+### is added to every page; implemented by:
+### lilypond_print_element_header -- building of the TOC
+### lilypond_toc_body -- generation of customized TOC output
+### lilypond_print_page_head -- start <div id="main">
+### print_lilypond_page_foot -- closing id=main, output of footer & TOC
+### -) External refs are formatted only as "Text of the node" (not as >>see
+### "NODE" section "SECTION" in "BOOK"<< like with default texi2html). Also,
+### the leading "(book-name)" is removed.
+### Implemented by overriding lilypond_external_ref
+### -) Navigation bars on top/bottom of the page and between sections are not
+### left-aligned, but use a combination of left/center/right aligned table
+### cells; For this, I heavily extend the texi2html code to allow for
+### differently aligned cells and for multi-line tables);
+### Implemented in lilypond_print_navigation
+### -) Different formatting than the default: example uses the same formatting
+### as quote.
+### -) Allow translated section titles: All section titles can be translated,
+### the original (English) title is associated with @translationof. This is
+### needed, because the file name / anchor is generated from the original
+### English title, since otherwise language-autoselection would break with
+### posted links.
+### Since it is then no longer possible to obtain the file name from the
+### section title, I keep a sectionname<=>filename/anchor around. This way,
+### xrefs from other manuals can simply load that map and retrieve the
+### correct file name for the link. Implemented in:
+### lilypond_unknown (handling of @translationof, in case
+### extract_texi_filenames.py messes up...)
+### lilypond_element_file_name (correct file name: use the map)
+### lilypond_element_target_name (correct anchor: use the map)
+### lilypond_init_map (read in the externally created map from disk)
+### lilypond_external_href (load the map for xrefs, use the correct
+### link target)
+### -) The HTML anchors for all sections are derived from the node name /
+### section title (pre-generated in the .xref-map file). Implemented by:
+### lilypond_element_target_name (adjust section anchors)
+### -) Use the standard footnote format "<sup>nr</sup> text" instead of the
+### ugly format of texi2html (<h3>(nr)</h3><p>text</p>). Implemented in
+### makeinfo_like_foot_line_and_ref
+### makeinfo_like_foot_lines
+### makeinfo_like_paragraph
+###
+###
+### Useful helper functions:
+### -) texinfo_file_name($node_name): returns a texinfo-compatible file name
+### for the given string $node_name (whitespace trimmed/replaced by -,
+### non-standard chars replaced by _xxxx (ascii char code) and forced to
+### start with a letter by prepending t_g if necessary)
+
+
+package Texi2HTML::Config;
+
+#############################################################################
+### TRANSLATIONS
+#############################################################################
+
+use utf8;
+my $LY_LANGUAGES = {};
+$LY_LANGUAGES->{'fr'} = {
+ 'Back to Documentation Index' => 'Retour à l\'accueil de la documentation',
+};
+$LY_LANGUAGES->{'es'} = {
+ 'Back to Documentation Index' => 'Volver al índice de la documentación',
+};
+$LY_LANGUAGES->{'de'} = {
+ 'Back to Documentation Index' => 'Zur Dokumentationsübersicht',
+};
+
+
+sub ly_get_string () {
+ my $lang = $Texi2HTML::THISDOC{current_lang};
+ my $string = shift;
+ if ($lang and $lang ne "en" and $LY_LANGUAGES->{$lang}->{$string}) {
+ return $LY_LANGUAGES->{$lang}->{$string};
+ } else {
+ return $string;
+ }
+}
+
+
+#############################################################################
+### SETTINGS FOR TEXI2HTML
+#############################################################################
+
+@Texi2HTML::Config::CSS_REFS = (
+ {FILENAME => "lilypond-mccarty.css", TITLE => "Patrick McCarty's design"}
+);
+@Texi2HTML::Config::ALT_CSS_REFS = (
+ {FILENAME => "lilypond.css", TITLE => "Andrew Hawryluk's design" },
+ {FILENAME => "lilypond-blue.css", TITLE => "Kurt Kroon's blue design" },
+);
+$Texi2HTML::Config::USE_ACCESSKEY = 1;
+$Texi2HTML::Config::USE_LINKS = 1;
+$Texi2HTML::Config::USE_REL_REV = 1;
+$Texi2HTML::Config::SPLIT_INDEX = 0;
+$Texi2HTML::Config::SEPARATED_FOOTNOTES = 0; # Print footnotes on same page, not separated
+if ($Texi2HTML::Config::SPLIT eq 'section') {
+ $Texi2HTML::Config::element_file_name = \&lilypond_element_file_name;
+}
+$Texi2HTML::Config::element_target_name = \&lilypond_element_target_name;
+$default_print_element_header = $Texi2HTML::Config::print_element_header;
+$Texi2HTML::Config::print_element_header = \&lilypond_print_element_header;
+$Texi2HTML::Config::print_page_foot = \&print_lilypond_page_foot;
+$Texi2HTML::Config::print_navigation = \&lilypond_print_navigation;
+$Texi2HTML::Config::external_ref = \&lilypond_external_ref;
+$default_external_href = $Texi2HTML::Config::external_href;
+$Texi2HTML::Config::external_href = \&lilypond_external_href;
+$default_toc_body = $Texi2HTML::Config::toc_body;
+$Texi2HTML::Config::toc_body = \&lilypond_toc_body;
+$Texi2HTML::Config::css_lines = \&lilypond_css_lines;
+$default_unknown = $Texi2HTML::Config::unknown;
+$Texi2HTML::Config::unknown = \&lilypond_unknown;
+$default_print_page_head = $Texi2HTML::Config::print_page_head;
+$Texi2HTML::Config::print_page_head = \&lilypond_print_page_head;
+# $Texi2HTML::Config::foot_line_and_ref = \&lilypond_foot_line_and_ref;
+$Texi2HTML::Config::foot_line_and_ref = \&makeinfo_like_foot_line_and_ref;
+$Texi2HTML::Config::foot_lines = \&makeinfo_like_foot_lines;
+$Texi2HTML::Config::paragraph = \&makeinfo_like_paragraph;
+
+
+
+# Examples should be formatted similar to quotes:
+$Texi2HTML::Config::complex_format_map->{'example'} = {
+ 'begin' => q{"<blockquote>"},
+ 'end' => q{"</blockquote>\n"},
+ 'style' => 'code',
+ };
+
+%Texi2HTML::config::misc_pages_targets = (
+ 'Overview' => 'Overview',
+ 'Contents' => 'Contents',
+ 'About' => 'About'
+);
+
+
+my @section_to_filename;
+
+
+
+
+#############################################################################
+### DEBUGGING
+#############################################################################
+
+use Data::Dumper;
+$Data::Dumper::Maxdepth = 2;
+
+sub print_element_info($)
+{
+ my $element = shift;
+ print "~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
+ print "Element: $element\n";
+ print Dumper($element);
+}
+
+
+
+
+
+#############################################################################
+### HELPER FUNCTIONS
+#############################################################################
+
+# Convert a given node name to its proper file name (normalization as explained
+# in the texinfo manual:
+# http://www.gnu.org/software/texinfo/manual/texinfo/html_node/HTML-Xref-Node-Name-Expansion.html
+sub texinfo_file_name($)
+{
+ my $text = shift;
+ my $result = '';
+ # File name normalization by texinfo:
+ # 1/2: letters and numbers are left unchanged
+ # 3/4: multiple, leading and trailing whitespace is removed
+ $text = main::normalise_space($text);
+ # 5/6: all remaining spaces are converted to '-', all other 7- or 8-bit
+ # chars are replaced by _xxxx (xxxx=ascii character code)
+ while ($text ne '') {
+ if ($text =~ s/^([A-Za-z0-9]+)//o) { # number or letter stay unchanged
+ $result .= $1;
+ } elsif ($text =~ s/^ //o) { # space -> '-'
+ $result .= '-';
+ } elsif ($text =~ s/^(.)//o) { # Otherwise use _xxxx (ascii char code)
+ my $ccode = ord($1);
+ if ( $ccode <= 0xFFFF ) {
+ $result .= sprintf("_%04x", $ccode);
+ } else {
+ $result .= sprintf("__%06x", $ccode);
+ }
+ }
+ }
+ # 7: if name does not begin with a letter, prepend 't_g' (so it starts with a letter)
+ if ($result !~ /^[a-zA-Z]/) {
+ $result = 't_g' . $result;
+ }
+ # DONE
+ return $result
+}
+
+
+# Load a file containing a nodename<=>filename map (tab-sepatared, i.e.
+# NODENAME\tFILENAME\tANCHOR
+# Returns a ref to a hash "Node title" => ["FilenameWithoutExt", "Anchor"]
+sub load_map_file ($)
+{
+ my $mapfile = shift;
+ my $node_map = ();
+
+ if (open(XREFFILE, $mapfile)) {
+ my $line;
+ while ( $line = <XREFFILE> ) {
+ # parse the tab-separated entries and insert them into the map:
+ chomp($line);
+ my @entries = split(/\t/, $line);
+ if (scalar (@entries) == 3) {
+ $node_map->{$entries[0]} = [$entries[1], $entries[2]];
+ } else {
+ print STDERR "Invalid entry in the node file $mapfile: $line\n";
+ }
+ }
+ close (XREFFILE);
+ } else {
+ print STDERR "WARNING: Unable to load the map file $mapfile\n";
+ }
+ return $node_map;
+}
+
+
+# Split the given path into dir and basename (with .texi removed). Used mainly
+# to get the path/basename of the original texi input file
+sub split_texi_filename ($)
+{
+ my $docu = shift;
+ my ($docu_dir, $docu_name);
+ if ($docu =~ /(.*\/)/) {
+ chop($docu_dir = $1);
+ $docu_name = $docu;
+ $docu_name =~ s/.*\///;
+ } else {
+ $docu_dir = '.';
+ $docu_name = $docu;
+ }
+ $docu_name =~ s/\.te?x(i|info)?$//;
+ return ($docu_dir, $docu_name);
+}
+
+
+
+
+
+#############################################################################
+### CSS HANDLING
+#############################################################################
+
+# Include our standard CSS file, not hard-coded CSS code directly in the HTML!
+# For IE, conditionally include the lilypond-ie-fixes.css style sheet
+sub lilypond_css_lines ($$)
+{
+ my $import_lines = shift;
+ my $rule_lines = shift;
+ return if (defined($Texi2HTML::THISDOC{'CSS_LINES'}));
+ if (@$rule_lines or @$import_lines)
+ {
+ $Texi2HTML::THISDOC{'CSS_LINES'} = "<style type=\"text/css\">\n<!--\n";
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$import_lines) . "\n" if (@$import_lines);
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$rule_lines) . "\n" if (@$rule_lines);
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= "-->\n</style>\n";
+ }
+ foreach my $ref (@CSS_REFS)
+ {
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"stylesheet\" type=\"text/css\" title=\"$ref->{TITLE}\" href=\"$ref->{FILENAME}\">\n";
+ }
+ foreach my $ref (@Texi2HTML::Config::ALT_CSS_REFS)
+ {
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"alternate stylesheet\" type=\"text/css\" href=\"$ref->{FILENAME}\" title=\"$ref->{TITLE}\">\n";
+ }
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= "<!--[if lte IE 7]>\n<link href=\"lilypond-ie-fixes.css\" rel=\"stylesheet\" type=\"text/css\">\n<![endif]-->\n";
+}
+
+
+
+
+
+#############################################################################
+### SPLITTING BASED ON NUMBERED SECTIONS
+#############################################################################
+
+my $lastfilename;
+my $docnr = 0;
+my $node_to_filename_map = ();
+
+
+# This function makes sure that files are only generated for numbered sections,
+# but not for unnumbered ones. It is called after texi2html has done its own
+# splitting and simply returns the filename for the node given as first argument
+# Nodes with the same filename will be printed out to the same filename, so
+# this really all we need. Also, make sure that the file names for sections
+# are derived from the section title. We also might want to name the anchors
+# according to node titles, which works by simply overriding the id element of
+# the $element hash.
+# If an external nodename<=>filename/anchor map file is found (loaded in
+# the command handler, use the externally created values, otherwise use the
+# same logic here.
+sub lilypond_element_file_name($$$)
+{
+ my $element = shift;
+ my $type = shift;
+ my $docu_name = shift;
+ my $docu_ext = $Texi2HTML::Config::EXTENSION;
+
+ my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
+ # the snippets page does not use nodes for the snippets, so in this case
+ # we'll have to use the section name!
+ if ($node_name eq '') {
+ $node_name = main::remove_texi($element->{'texi'});
+ }
+
+ # If we have an entry in the section<=>filename map, use that one, otherwise
+ # generate the filename/anchor here. In the latter case, external manuals
+ # will not be able to retrieve the file name for xrefs!!! Still, I already
+ # had that code, so I'll leave it in in case something goes wrong with the
+ # extract_texi_filenames.py script in the lilypond build process!
+ if (exists ($node_to_filename_map->{$node_name})) {
+ (my $filename, my $anchor) = @{$node_to_filename_map->{$node_name}};
+ $filename .= ".$docu_ext" if (defined($docu_ext));
+
+ # unnumbered sections (except those at top-level!) always go to the same
+ # file as the previous numbered section
+ if (not ($element->{number}) and not ($lastfilename eq '') and ($element->{level} > 1)) {
+ $filename = $lastfilename;
+ }
+ if (($filename eq $lastfilename)) {
+ $$element{doc_nr} = $docnr;
+ } else {
+ $docnr += 1;
+ $$element{doc_nr} = $docnr;
+ $lastfilename = $filename;
+ }
+ return $filename;
+
+ } elsif ($type eq "top" or $type eq "toc" or $type eq "doc" or $type eq "stoc" or $type eq "foot" or $type eq "about") {
+ return;
+ } else {
+ print STDERR "WARNING: Node '$node_name' was NOT found in the map\n"
+ unless ($node_name eq '') or ($element->{'tag'} eq 'unnumberedsec')
+ or ($node_name =~ /NOT REALLY USED/);
+
+ # Numbered sections will get a filename Node_title, unnumbered sections will use
+ # the file name of the previous numbered section:
+ if (($element->{number}) or ($lastfilename eq '') or ($element->{level} == 1)) {
+ # normalize to the same file name as texinfo
+ if ($element->{translationof}) {
+ $node_name = main::remove_texi($element->{translationof});
+ }
+ my $filename = texinfo_file_name($node_name);
+ $filename .= ".$docu_ext" if (defined($docu_ext));
+ $docnr += 1;
+ $$element{doc_nr} = $docnr;
+ $lastfilename = $filename;
+ return $filename;
+ } else {
+ $$element{doc_nr} = $docnr;
+ return $lastfilename;
+ }
+ }
+
+ return;
+}
+
+sub lilypond_element_target_name($$$)
+{
+ my $element = shift;
+ my $target = shift;
+ my $id = shift;
+ # Target is based on node name (or sec name for secs without node attached)
+ my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
+ if ($node_name eq '') {
+ $node_name = main::remove_texi($element->{'texi'});
+ }
+
+ # If we have an entry in the section<=>filename map, use that one, otherwise
+ # generate the anchor here.
+ if (exists ($node_to_filename_map->{$node_name})) {
+ (my $filename, $target) = @{$node_to_filename_map->{$node_name}};
+ } else {
+ my $anchor = $node_name;
+ if ($element->{translationof}) {
+ $anchor = main::remove_texi($element->{translationof});
+ }
+ # normalize to the same file name as texinfo
+ $target = texinfo_file_name($anchor);
+ }
+ # TODO: Once texi2html correctly prints out the target and not the id for
+ # the sections, change this back to ($id, $target)
+ return ($target, $target);
+}
+
+
+## Load the map file for the corrently processed texi file. We do this
+# using a command init handler, since texi2html does not have any
+# other hooks that are called after THISDOC is filled but before phase 2
+# of the texi2html conversion.
+sub lilypond_init_map ()
+{
+ my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
+ my $map_filename = main::locate_include_file ("${docu_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
+ || main::locate_include_file ("${docu_name}.xref-map");
+ $node_to_filename_map = load_map_file ($map_filename);
+}
+push @Texi2HTML::Config::command_handler_init, \&lilypond_init_map;
+
+
+
+#############################################################################
+### CLEANER LINK TITLE FOR EXTERNAL REFS
+#############################################################################
+
+# The default formatting of external refs returns e.g.
+# "(lilypond-internals)Timing_translator", so we remove all (...) from the
+# file_and_node argument. Also, we want only a very simple format, so we don't
+# even call the default handler!
+sub lilypond_external_ref($$$$$$)
+{
+ my $type = shift;
+ my $section = shift;
+ my $book = shift;
+ my $file_node = shift;
+ my $href = shift;
+ my $cross_ref = shift;
+
+ my $displaytext = '';
+
+ # 1) if we have a cross ref name, that's the text to be displayed:
+ # 2) For the top node, use the (printable) name of the manual, unless we
+ # have an explicit cross ref name
+ # 3) In all other cases use the section name
+ if ($cross_ref ne '') {
+ $displaytext = $cross_ref;
+ } elsif (($section eq '') or ($section eq 'Top')) {
+ $displaytext = $book;
+ } else {
+ $displaytext = $section;
+ }
+
+ $displaytext = &$anchor('', $href, $displaytext) if ($displaytext ne '');
+ return &$I('%{node_file_href}', { 'node_file_href' => $displaytext });
+}
+
+
+
+
+
+#############################################################################
+### HANDLING TRANSLATED SECTIONS: handle @translationof, secname<->filename
+### map stored on disk, xrefs in other manuals load that map
+#############################################################################
+
+
+# Try to make use of @translationof to generate files according to the original
+# English section title...
+sub lilypond_unknown($$$$$)
+{
+ my $macro = shift;
+ my $line = shift;
+ my $pass = shift;
+ my $stack = shift;
+ my $state = shift;
+
+ # the @translationof macro provides the original English section title,
+ # which should be used for file/anchor naming, while the title will be
+ # translated to each language
+ # It is already used by extract_texi_filenames.py, so this should not be
+ # necessary here at all. Still, I'll leave the code in just in case the
+ # python script messed up ;-)
+ if ($pass == 1 and $macro eq "translationof") {
+ if (ref($state->{'element'}) eq 'HASH') {
+ $state->{'element'}->{'translationof'} = main::normalise_space($line);
+ }
+ return ('', 1, undef, undef);
+ } else {
+ return &$default_unknown($macro, $line, $pass, $stack, $state);
+ }
+}
+
+
+
+
+my %translated_books = ();
+# Construct a href to an external source of information.
+# node is the node with texinfo @-commands
+# node_id is the node transliterated and transformed as explained in the
+# texinfo manual
+# node_xhtml_id is the node transformed such that it is unique and can
+# be used to make an html cross ref as explained in the texinfo manual
+# file is the file in '(file)node'
+sub lilypond_external_href($$$)
+{
+ my $node = shift;
+ my $node_id = shift;
+ my $node_hxmlt_id = shift;
+ my $file = shift;
+
+ # 1) Keep a hash of book->section_map
+ # 2) if not file in keys hash => try to load the map (assign empty map if
+ # non-existent => will load only once!)
+ # 3) if node in the section=>(file, anchor) map, replace node_id and
+ # node_xhtml_id by the map's values
+ # 4) call the default_external_href with these values (or the old ones if not found)
+
+ if (($node_id ne '') and defined($file) and ($node_id ne 'Top')) {
+ my $map_name = $file;
+ $map_name =~ s/-big-page//;
+
+ # Load the map if we haven't done so already
+ if (!exists($translated_books{$map_name})) {
+ my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
+ my $map_filename = main::locate_include_file ("${map_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
+ || main::locate_include_file ("${map_name}.xref-map");
+ $translated_books{$map_name} = load_map_file ($map_filename);
+ }
+
+ # look up translation. use these values instead of the old filename/anchor
+ my $section_name_map = $translated_books{$map_name};
+ my $node_text = main::remove_texi($node);
+ if (defined($section_name_map->{$node_text})) {
+ ($node_id, $node_hxmlt_id) = @{$section_name_map->{$node_text}};
+ } else {
+ print STDERR "WARNING: Unable to find node '$node_text' in book $map_name.\n";
+ }
+ }
+
+ if (defined $file) {
+ return &$default_external_href($node, $node_id, $node_hxmlt_id, $file);
+ } else {
+ return &$default_external_href($node, $node_id, $node_hxmlt_id);
+ }
+}
+
+
+
+
+
+#############################################################################
+### CUSTOM TOC FOR EACH PAGE (in a frame on the left)
+#############################################################################
+
+my $page_toc_depth = 2;
+my @default_toc = [];
+
+
+# Initialize the toc_depth to 1 if the command-line option -D=short_toc is given
+sub lilypond_init_toc_depth ()
+{
+ if (exists($main::value{'short_toc'}) and not exists($main::value{'bigpage'})) {
+ $page_toc_depth = 1;
+ }
+}
+# Set the TOC-depth (depending on a texinfo variable short_toc) in a
+# command-handler, so we have them available when creating the pages
+push @Texi2HTML::Config::command_handler_process, \&lilypond_init_toc_depth;
+
+
+# recursively generate the TOC entries for the element and its children (which
+# are only shown up to maxlevel. All ancestors of the current element are also
+# shown with their immediate children, irrespective of their level.
+# Unnumbered entries are only printed out if they are at top-level or 2nd level
+# or their parent element is an ancestor of the currently viewed node.
+# The conditions to call this method to print the entry for a child node is:
+# -) the parent is an ancestor of the current page node
+# -) the parent is a numbered element at top-level toplevel (i.e. show numbered
+# and unnumbered 2nd-level children of numbered nodes)
+# -) the child element is a numbered node below level maxlevel
+sub generate_ly_toc_entries($$$)
+{
+ my $element = shift;
+ my $element_path = shift;
+ my $maxlevel = shift;
+ # Skip undefined sections, plus all sections generated by index splitting
+ return() if (not defined($element) or exists($element->{'index_page'}));
+ my @result = ();
+ my $level = $element->{'toc_level'};
+ my $is_parent_of_current = $element->{'id'} && $element_path->{$element->{'id'}};
+ my $ind = ' ' x $level;
+ my $this_css_class = $is_parent_of_current ? " class=\"toc_current\"" : "";
+
+ my $entry = "$ind<li$this_css_class>" . &$anchor ($element->{'tocid'}, "$element->{'file'}#$element->{'target'}",$element->{'text'});
+
+ push (@result, $entry);
+ my $children = $element->{'section_childs'};
+ if (defined($children) and (ref($children) eq "ARRAY")) {
+ my $force_children = $is_parent_of_current or ($level == 1 and $element->{'number'});
+ my @child_result = ();
+ foreach my $c (@$children) {
+ my $is_numbered_child = defined ($c->{'number'});
+ my $below_maxlevel = $c->{'toc_level'} le $maxlevel;
+ if ($force_children or ($is_numbered_child and $below_maxlevel)) {
+ my @child_res = generate_ly_toc_entries($c, $element_path, $maxlevel);
+ push (@child_result, @child_res);
+ }
+ }
+ # if no child nodes were generated, e.g. for the index, where expanded pages
+ # are ignored, don't generate a list at all...
+ if (@child_result) {
+ push (@result, "\n$ind<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
+ push (@result, @child_result);
+ push (@result, "$ind</ul>\n");
+ }
+ }
+ push (@result, "$ind</li>\n");
+ return @result;
+}
+
+
+# Print a customized TOC, containing only the first two levels plus the whole
+# path to the current page
+sub lilypond_generate_page_toc_body($)
+{
+ my $element = shift;
+ my $current_element = $element;
+ my %parentelements;
+ $parentelements{$element->{'id'}} = 1;
+ # Find the path to the current element
+ while ( defined($current_element->{'sectionup'}) and
+ ($current_element->{'sectionup'} ne $current_element) )
+ {
+ $parentelements{$current_element->{'sectionup'}->{'id'}} = 1
+ if ($current_element->{'sectionup'}->{'id'} ne '');
+ $current_element = $current_element->{'sectionup'};
+ }
+ return () if not defined($current_element);
+ # Create the toc entries recursively
+ my @toc_entries = ("<div class=\"contents\">\n", "<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
+ my $children = $current_element->{'section_childs'};
+ foreach ( @$children ) {
+ push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth));
+ }
+ push (@toc_entries, "</ul>\n");
+ push (@toc_entries, "</div>\n");
+ return @toc_entries;
+}
+
+sub lilypond_print_toc_div ($$)
+{
+ my $fh = shift;
+ my $tocref = shift;
+ my @lines = @$tocref;
+ # use default TOC if no custom lines have been generated
+ @lines = @default_toc if (not @lines);
+ if (@lines) {
+
+ print $fh "\n\n<div id=\"tocframe\">\n";
+
+ # Remove the leading "GNU LilyPond --- " from the manual title
+ my $topname = $Texi2HTML::NAME{'Top'};
+ $topname =~ s/^GNU LilyPond(:| &[mn]dash;) //;
+
+ # construct the top-level Docs index (relative path and including language!)
+ my $lang = $Texi2HTML::THISDOC{current_lang};
+ if ($lang and $lang ne "en") {
+ $lang .= ".";
+ } else {
+ $lang = "";
+ }
+ my $reldir = "";
+ $reldir = "../" if ($Texi2HTML::Config::SPLIT eq 'section');
+ my $uplink = $reldir."index.${lang}html";
+
+ print $fh "<p class=\"toc_uplink\"><a href=\"$uplink\"
+ title=\"Documentation Index\"><< " .
+ &ly_get_string ('Back to Documentation Index') .
+ "</a></p>\n";
+
+ print $fh '<h4 class="toc_header"> ' . &$anchor('',
+ $Texi2HTML::HREF{'Top'},
+ $topname,
+ 'title="Start of the manual"'
+ ) . "</h4>\n";
+ foreach my $line (@lines) {
+ print $fh $line;
+ }
+ print $fh "</div>\n\n";
+ }
+}
+
+# Create the custom TOC for this page (partially folded, current page is
+# highlighted) and store it in a global variable. The TOC is written out after
+# the html contents (but positioned correctly using CSS), so that browsers with
+# css turned off still show the contents first.
+our @this_page_toc = ();
+sub lilypond_print_element_header
+{
+ my $first_in_page = shift;
+ my $previous_is_top = shift;
+ if ($first_in_page and not @this_page_toc) {
+ if (defined($Texi2HTML::THIS_ELEMENT)) {
+ # Create the TOC for this page
+ @this_page_toc = lilypond_generate_page_toc_body($Texi2HTML::THIS_ELEMENT);
+ }
+ }
+ return &$default_print_element_header( $first_in_page, $previous_is_top);
+}
+
+# Generate the HTML output for the TOC
+sub lilypond_toc_body($)
+{
+ my $elements_list = shift;
+ # Generate a default TOC for pages without THIS_ELEMENT
+ @default_toc = lilypond_generate_page_toc_body(@$elements_list[0]);
+ return &$default_toc_body($elements_list);
+}
+
+# Print out the TOC in a <div> at the beginning of the page
+sub lilypond_print_page_head($)
+{
+ my $fh = shift;
+ &$default_print_page_head($fh);
+ print $fh "<div id=\"main\">\n";
+}
+
+# Print out the TOC in a <div> at the end of th page, which will be formatted as a
+# sidebar mimicking a TOC frame
+sub print_lilypond_page_foot($)
+{
+ my $fh = shift;
+ my $program_string = &$program_string();
+# print $fh "<p><font size='-1'>$program_string</font><br>$PRE_BODY_CLOSE</p>\n";
+ print $fh "<!-- FOOTER -->\n\n";
+ print $fh "<!-- end div#main here -->\n</div>\n\n";
+
+ # Print the TOC frame and reset the TOC:
+ lilypond_print_toc_div ($fh, \@this_page_toc);
+ @this_page_toc = ();
+
+ # Close the page:
+ print $fh "</body>\n</html>\n";
+}
+
+
+
+
+
+#############################################################################
+### NICER / MORE FLEXIBLE NAVIGATION PANELS
+#############################################################################
+
+sub get_navigation_text
+{
+ my $button = shift;
+ my $text = $NAVIGATION_TEXT{$button};
+ if ( ($button eq 'Back') or ($button eq 'FastBack') ) {
+ $text = $text . $Texi2HTML::NODE{$button} . " ";
+ } elsif ( ($button eq 'Forward') or ($button eq 'FastForward') ) {
+ $text = " " . $Texi2HTML::NODE{$button} . $text;
+ } elsif ( $button eq 'Up' ) {
+ $text = " ".$text.": " . $Texi2HTML::NODE{$button} . " ";
+ }
+ return $text;
+}
+
+
+# Don't automatically create left-aligned table cells for every link, but
+# instead create a <td> only on an appropriate '(left|right|center)-aligned-cell-n'
+# button text. It's alignment as well as the colspan will be taken from the
+# name of the button. Also, add 'newline' button text to create a new table
+# row. The texts of the buttons are generated by get_navigation_text and
+# will contain the name of the next/previous section/chapter.
+sub lilypond_print_navigation
+{
+ my $buttons = shift;
+ my $vertical = shift;
+ my $spacing = 1;
+ my $result = "<table class=\"nav_table\">\n";
+
+ $result .= "<tr>" unless $vertical;
+ my $beginofline = 1;
+ foreach my $button (@$buttons)
+ {
+ $result .= qq{<tr valign="top" align="left">\n} if $vertical;
+ # Allow (left|right|center)-aligned-cell and newline as buttons!
+ if ( $button =~ /^(.*)-aligned-cell-(.*)$/ )
+ {
+ $result .= qq{</td>} unless $beginofline;
+ $result .= qq{<td valign="middle" align="$1" colspan="$2">};
+ $beginofline = 0;
+ }
+ elsif ( $button eq 'newline' )
+ {
+ $result .= qq{</td>} unless $beginofline;
+ $result .= qq{</tr>};
+ $result .= qq{<tr>};
+ $beginofline = 1;
+
+ }
+ elsif (ref($button) eq 'CODE')
+ {
+ $result .= &$button($vertical);
+ }
+ elsif (ref($button) eq 'SCALAR')
+ {
+ $result .= "$$button" if defined($$button);
+ }
+ elsif (ref($button) eq 'ARRAY')
+ {
+ my $text = $button->[1];
+ my $button_href = $button->[0];
+ # verify that $button_href is simple text and text is a reference
+ if (defined($button_href) and !ref($button_href)
+ and defined($text) and (ref($text) eq 'SCALAR') and defined($$text))
+ { # use given text
+ if ($Texi2HTML::HREF{$button_href})
+ {
+ my $anchor_attributes = '';
+ if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button_href})) and ($BUTTONS_ACCESSKEY{$button_href} ne ''))
+ {
+ $anchor_attributes = "accesskey=\"$BUTTONS_ACCESSKEY{$button_href}\"";
+ }
+ if ($USE_REL_REV and (defined($BUTTONS_REL{$button_href})) and ($BUTTONS_REL{$button_href} ne ''))
+ {
+ $anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\"";
+ }
+ $result .= "" .
+ &$anchor('',
+ $Texi2HTML::HREF{$button_href},
+ get_navigation_text($$text),
+ $anchor_attributes
+ );
+ }
+ else
+ {
+ $result .= get_navigation_text($$text);
+ }
+ }
+ }
+ elsif ($button eq ' ')
+ { # handle space button
+ $result .=
+ ($ICONS && $ACTIVE_ICONS{' '}) ?
+ &$button_icon_img($BUTTONS_NAME{$button}, $ACTIVE_ICONS{' '}) :
+ $NAVIGATION_TEXT{' '};
+ #next;
+ }
+ elsif ($Texi2HTML::HREF{$button})
+ { # button is active
+ my $btitle = $BUTTONS_GOTO{$button} ?
+ 'title="' . $BUTTONS_GOTO{$button} . '"' : '';
+ if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button})) and ($BUTTONS_ACCESSKEY{$button} ne ''))
+ {
+ $btitle .= " accesskey=\"$BUTTONS_ACCESSKEY{$button}\"";
+ }
+ if ($USE_REL_REV and (defined($BUTTONS_REL{$button})) and ($BUTTONS_REL{$button} ne ''))
+ {
+ $btitle .= " rel=\"$BUTTONS_REL{$button}\"";
+ }
+ if ($ICONS && $ACTIVE_ICONS{$button})
+ { # use icon
+ $result .= '' .
+ &$anchor('',
+ $Texi2HTML::HREF{$button},
+ &$button_icon_img($BUTTONS_NAME{$button},
+ $ACTIVE_ICONS{$button},
+ $Texi2HTML::SIMPLE_TEXT{$button}),
+ $btitle
+ );
+ }
+ else
+ { # use text
+ $result .=
+ '[' .
+ &$anchor('',
+ $Texi2HTML::HREF{$button},
+ get_navigation_text($button),
+ $btitle
+ ) .
+ ']';
+ }
+ }
+ else
+ { # button is passive
+ $result .=
+ $ICONS && $PASSIVE_ICONS{$button} ?
+ &$button_icon_img($BUTTONS_NAME{$button},
+ $PASSIVE_ICONS{$button},
+ $Texi2HTML::SIMPLE_TEXT{$button}) :
+
+ "[" . get_navigation_text($button) . "]";
+ }
+ $result .= "</td>\n" if $vertical;
+ $result .= "</tr>\n" if $vertical;
+ }
+ $result .= "</td>" unless $beginofline;
+ $result .= "</tr>" unless $vertical;
+ $result .= "</table>\n";
+ return $result;
+}
+
+
+@Texi2HTML::Config::SECTION_BUTTONS =
+ ('left-aligned-cell-1', 'FastBack',
+ 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
+ 'right-aligned-cell-1', 'FastForward',
+ 'newline',
+ 'left-aligned-cell-2', 'Back',
+ 'center-aligned-cell-1', 'Up',
+ 'right-aligned-cell-2', 'Forward'
+ );
+
+# buttons for misc stuff
+@Texi2HTML::Config::MISC_BUTTONS = ('center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About');
+
+# buttons for chapter file footers
+# (and headers but only if SECTION_NAVIGATION is false)
+@Texi2HTML::Config::CHAPTER_BUTTONS =
+ ('left-aligned-cell-1', 'FastBack',
+ 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
+ 'right-aligned-cell-1', 'FastForward',
+ );
+
+# buttons for section file footers
+@Texi2HTML::Config::SECTION_FOOTER_BUTTONS =
+ ('left-aligned-cell-1', 'FastBack',
+ 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
+ 'right-aligned-cell-1', 'FastForward',
+ 'newline',
+ 'left-aligned-cell-2', 'Back',
+ 'center-aligned-cell-1', 'Up',
+ 'right-aligned-cell-2', 'Forward'
+ );
+
+@Texi2HTML::Config::NODE_FOOTER_BUTTONS =
+ ('left-aligned-cell-1', 'FastBack',
+ 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
+ 'right-aligned-cell-1', 'FastForward',
+ 'newline',
+ 'left-aligned-cell-2', 'Back',
+ 'center-aligned-cell-1', 'Up',
+ 'right-aligned-cell-2', 'Forward'
+ );
+
+
+
+
+
+#############################################################################
+### FOOTNOTE FORMATTING
+#############################################################################
+
+# Format footnotes in a nicer way: Instead of printing the number in a separate
+# (nr) heading line, use the standard way of prepending <sup>nr</sup> immediately
+# before the fn text.
+
+
+# The following code is copied from texi2html's examples/makeinfo.init and
+# should be updated when texi2html makes some changes there!
+
+my $makekinfo_like_footnote_absolute_number = 0;
+
+sub makeinfo_like_foot_line_and_ref($$$$$$$$)
+{
+ my $foot_num = shift;
+ my $relative_num = shift;
+ my $footid = shift;
+ my $docid = shift;
+ my $from_file = shift;
+ my $footnote_file = shift;
+ my $lines = shift;
+ my $state = shift;
+
+ $makekinfo_like_footnote_absolute_number++;
+
+ # this is a bit obscure, this allows to add an anchor only if formatted
+ # as part of the document.
+ $docid = '' if ($state->{'outside_document'} or $state->{'multiple_pass'});
+
+ if ($from_file eq $footnote_file)
+ {
+ $from_file = $footnote_file = '';
+ }
+
+ my $foot_anchor = "<sup>" . &$anchor($docid, "$footnote_file#$footid", $relative_num) . "</sup>";
+ $foot_anchor = &$anchor($docid, "$footnote_file#$footid", "($relative_num)") if ($state->{'preformatted'});
+
+# unshift @$lines, "<li>";
+# push @$lines, "</li>\n";
+ return ($lines, $foot_anchor);
+}
+
+sub makeinfo_like_foot_lines($)
+{
+ my $lines = shift;
+ unshift @$lines, "<hr>\n<h4>$Texi2HTML::I18n::WORDS->{'Footnotes_Title'}</h4>\n";
+#<ol type=\"1\">\n";
+# push @$lines, "</ol>";
+ return $lines;
+}
+
+my %makekinfo_like_paragraph_in_footnote_nr;
+
+sub makeinfo_like_paragraph ($$$$$$$$$$$$$)
+{
+ my $text = shift;
+ my $align = shift;
+ my $indent = shift;
+ my $paragraph_command = shift;
+ my $paragraph_command_formatted = shift;
+ my $paragraph_number = shift;
+ my $format = shift;
+ my $item_nr = shift;
+ my $enumerate_style = shift;
+ my $number = shift;
+ my $command_stack_at_end = shift;
+ my $command_stack_at_begin = shift;
+ my $state = shift;
+#print STDERR "format: $format\n" if (defined($format));
+#print STDERR "paragraph @$command_stack_at_end; @$command_stack_at_begin\n";
+ $paragraph_command_formatted = '' if (!defined($paragraph_command_formatted) or
+ exists($special_list_commands{$format}->{$paragraph_command}));
+ return '' if ($text =~ /^\s*$/);
+ foreach my $style(t2h_collect_styles($command_stack_at_begin))
+ {
+ $text = t2h_begin_style($style, $text);
+ }
+ foreach my $style(t2h_collect_styles($command_stack_at_end))
+ {
+ $text = t2h_end_style($style, $text);
+ }
+ if (defined($paragraph_number) and defined($$paragraph_number))
+ {
+ $$paragraph_number++;
+ return $text if (($format eq 'itemize' or $format eq 'enumerate') and
+ ($$paragraph_number == 1));
+ }
+ my $open = '<p';
+ if ($align)
+ {
+ $open .= " align=\"$paragraph_style{$align}\"";
+ }
+ my $footnote_text = '';
+ if (defined($command_stack_at_begin->[0]) and $command_stack_at_begin->[0] eq 'footnote')
+ {
+ my $state = $Texi2HTML::THISDOC{'state'};
+ $makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number}++;
+ if ($makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number} <= 1)
+ {
+ $open.=' class="footnote"';
+ my $document_file = $state->{'footnote_document_file'};
+ if ($document_file eq $state->{'footnote_footnote_file'})
+ {
+ $document_file = '';
+ }
+ my $docid = $state->{'footnote_place_id'};
+ my $doc_state = $state->{'footnote_document_state'};
+ $docid = '' if ($doc_state->{'outside_document'} or $doc_state->{'multiple_pass'});
+ my $foot_label = &$anchor($state->{'footnote_footnote_id'},
+ $document_file . "#$state->{'footnote_place_id'}",
+ "$state->{'footnote_number_in_page'}");
+ $footnote_text = "<small>[${foot_label}]</small> ";
+ }
+ }
+ return $open.'>'.$footnote_text.$text.'</p>';
+}
+
+
+#############################################################################
+### OTHER SETTINGS
+#############################################################################
+
+# For split pages, use index.html as start page!
+if ($Texi2HTML::Config::SPLIT eq 'section') {
+ $Texi2HTML::Config::TOP_FILE = 'index.html';
+}
+
+
+return 1;
--- /dev/null
+@c -*- coding: us-ascii; mode: texinfo; -*-
+@ignore
+ 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.
+@end ignore
+
+
+@include version.itexi
+@include common-macros.itexi
+
+
+@c ***** Displaying text *****
+
+@c To get decent quotes in `foo' and ``foo''.
+
+@macro q{TEXT}
+@quoteleft{}\TEXT\@quoteright{}
+@end macro
+
+@macro qq{TEXT}
+@quotedblleft{}\TEXT\@quotedblright{}
+@end macro
+
+
+@ifhtml
+
+@macro warning{TEXT}
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end macro
+
+@end ifhtml
+
+@ifnothtml
+
+@macro warning{TEXT}
+@quotation
+@quotation
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end quotation
+@end quotation
+@end macro
+
+@end ifnothtml
+
+
+
+@c ***** Headings in a doc subsection *****
+
+@c Don't insert an empty line after @predefined! Right now
+@c it doesn't matter, but a future implementation will probably
+@c add some code which needs this restriction.
+
+@macro predefined
+@noindent
+@subsubheading Predefined commands
+@end macro
+
+@c The next macro is a dummy currently since texinfo doesn't
+@c provide a real ragged-right environment yet.
+@c
+@c Due to a bug in texi2html (texi2html.pl CVS versions <= 1.245)
+@c the macro must not be empty.
+
+@macro endpredefined
+@c
+@end macro
+
+
+@macro snippets
+@noindent
+@subsubheading Selected Snippets
+@end macro
+
+
+@c Don't insert an empty line after @seealso! Otherwise we get
+@c unwanted extra vertical space in the PDF output.
+
+@macro seealso
+@noindent
+@subsubheading See also
+@indent
+@end macro
+
+
+@macro knownissues
+@noindent
+@subsubheading Known issues and warnings
+@end macro
+
+
+
+@c ***** Links and references *****
+
+@c Definitions for references:
+@c
+@c @rglos
+@c @rlearning
+@c @ruser
+@c @rprogram
+@c @rlsr
+@c @rinternals
+@c
+@c All these also have a @...named version which allows to specify the
+@c displayed text for the reference as second argument.
+@c
+@c ***** HTML + bigpage is a special case (other manual names); all other
+@c formats are treated similarly.
+
+
+@c *** not TeX ***
+
+@ifnottex
+
+@c ** bigpage **
+
+@ifset bigpage
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
+@end macro
+
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Music Glossary}
+@end macro
+
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
+@end macro
+
+@macro rlearningnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Learning Manual}
+@end macro
+
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page,Notation Reference}
+@end macro
+
+@macro rusernamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Notation Reference}
+@end macro
+
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
+@end macro
+
+@macro rprogramnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Application Usage}
+@end macro
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
+@end macro
+
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets-big-page,Snippets}
+@end macro
+
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
+@end macro
+
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals-big-page,Internals Reference}
+@end macro
+
+@end ifset
+
+
+@c ** not bigpage **
+
+@ifclear bigpage
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
+@end macro
+
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
+@end macro
+
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@end macro
+
+@macro rlearningnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@end macro
+
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond,Notation Reference}
+@end macro
+
+@macro rusernamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
+@end macro
+
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Application Usage}
+@end macro
+
+@macro rprogramnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
+@end macro
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
+@end macro
+
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
+@end macro
+
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
+@end macro
+
+@end ifclear
+
+@end ifnottex
+
+
+@c *** TeX ***
+
+@iftex
+
+@c All commands below should work in the middle of the line;
+@c we thus must not use @vindex directly since it works only if placed
+@c on a line of its own. To overcome this problem, we define a
+@c replacement macro using the internal definition of @vindex which
+@c delimits arguments in the standard way (i.e., with braces).
+
+@tex
+\gdef\lilyvindex#1{\doind{vr}{\code #1}\ignorespaces}
+@end tex
+
+@macro rglos{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,music-glossary,Music Glossary}
+@end macro
+
+@macro rglosnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
+@end macro
+
+@macro rlearning{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@end macro
+
+@macro rlearningnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning,Learning Manual}
+@end macro
+
+@macro ruser{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond,Notation Reference}
+@end macro
+
+@macro rusernamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
+@end macro
+
+@macro rprogram{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-program,Application Usage}
+@end macro
+
+@macro rprogramnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
+@end macro
+
+@macro rlsr{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
+@macro rlsrnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
+@end macro
+
+@macro rinternals{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
+@end macro
+
+@macro rinternalsnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
+@end macro
+
+@end iftex
+++ /dev/null
-@c -*- coding: us-ascii; mode: texinfo; -*-
-@ignore
- 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.
-@end ignore
-
-
-@include version.itexi
-
-
-@c Don't replace quotes with directed quotes.
-
-@set txicodequoteundirected
-@set txicodequotebacktick
-
-
-
-@c ***** Displaying text *****
-
-@c We need this since @q{\} doesn't work with makeinfo 4.11 --
-@c say @q{@bs{}} instead.
-
-@macro bs
-\\
-@end macro
-
-
-@c To get decent quotes in `foo' and ``foo''.
-
-@macro q{TEXT}
-@quoteleft{}\TEXT\@quoteright{}
-@end macro
-
-@macro qq{TEXT}
-@quotedblleft{}\TEXT\@quotedblright{}
-@end macro
-
-
-@ifhtml
-
-@macro warning{TEXT}
-@cartouche
-@b{Note:} \TEXT\
-@end cartouche
-@end macro
-
-@end ifhtml
-
-@ifnothtml
-
-@macro warning{TEXT}
-@quotation
-@quotation
-@cartouche
-@b{Note:} \TEXT\
-@end cartouche
-@end quotation
-@end quotation
-@end macro
-
-@end ifnothtml
-
-
-@ifnotinfo
-
-@macro notation{TEXT}
-@var{\TEXT\}
-@end macro
-
-@end ifnotinfo
-
-@ifinfo
-
-@macro notation{TEXT}
-\TEXT\
-@end macro
-
-@end ifinfo
-
-
-@macro smallspace
-@sp 1
-@end macro
-
-
-
-@c ***** Displaying images not generated by lilypond-book *****
-
-@c Current installation setup of Info docs requires that all images are
-@c expected to be found in the `lilypond/' subdirectory. `lilypond-book'
-@c already generates proper @image commands for images of music; these
-@c macro definitions do the same for other images.
-
-@ifnotinfo
-
-@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
-@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
-@end macro
-
-@end ifnotinfo
-
-@ifinfo
-
-@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
-@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
-@end macro
-
-@end ifinfo
-
-
-
-@c ***** Headings in a doc subsection *****
-
-@c Don't insert an empty line after @predefined! Right now
-@c it doesn't matter, but a future implementation will probably
-@c add some code which needs this restriction.
-
-@macro predefined
-@noindent
-@subsubheading Predefined commands
-@end macro
-
-@c The next macro is a dummy currently since texinfo doesn't
-@c provide a real ragged-right environment yet.
-@c
-@c Due to a bug in texi2html (texi2html.pl CVS versions <= 1.245)
-@c the macro must not be empty.
-
-@macro endpredefined
-@c
-@end macro
-
-
-@macro snippets
-@noindent
-@subsubheading Selected Snippets
-@end macro
-
-
-@c Don't insert an empty line after @seealso! Otherwise we get
-@c unwanted extra vertical space in the PDF output.
-
-@macro seealso
-@noindent
-@subsubheading See also
-@indent
-@end macro
-
-
-@macro knownissues
-@noindent
-@subsubheading Known issues and warnings
-@end macro
-
-
-@macro lydoctitle {TEXT}
-@emph{\TEXT\}
-@end macro
-
-
-@c Don't remove the `@c' within the macro definition! See section 19.3,
-@c `Macro Details and Caveats', in the texinfo info file for explanation.
-
-@macro funindex {TEXT}
-@findex \TEXT\
-@kindex \TEXT\
-@c
-@end macro
-
-
-
-@c ***** Links and references *****
-
-@c Definitions for references:
-@c
-@c @rglos
-@c @rlearning
-@c @ruser
-@c @rprogram
-@c @rlsr
-@c @rinternals
-@c
-@c All these also have a @...named version which allows to specify the
-@c displayed text for the reference as second argument.
-@c
-@c ***** HTML + bigpage is a special case (other manual names); all other
-@c formats are treated similarly.
-
-
-@c *** not TeX ***
-
-@ifnottex
-
-@c ** bigpage **
-
-@ifset bigpage
-
-@macro rglos{TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
-@end macro
-
-@macro rglosnamed{TEXT,DISPLAY}
-@vindex \TEXT\
-@ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Music Glossary}
-@end macro
-
-@macro rlearning{TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
-@end macro
-
-@macro rlearningnamed{TEXT,DISPLAY}
-@vindex \TEXT\
-@ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Learning Manual}
-@end macro
-
-@macro ruser{TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-big-page,Notation Reference}
-@end macro
-
-@macro rusernamed{TEXT,DISPLAY}
-@vindex \TEXT\
-@ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Notation Reference}
-@end macro
-
-@macro rprogram{TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
-@end macro
-
-@macro rprogramnamed{TEXT,DISPLAY}
-@vindex \TEXT\
-@ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Application Usage}
-@end macro
-
-@macro rlsr{TEXT}
-@ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
-@end macro
-
-@macro rlsrnamed{TEXT,DISPLAY}
-@ref{\TEXT\,,\DISPLAY\,lilypond-snippets-big-page,Snippets}
-@end macro
-
-@macro rinternals{TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
-@end macro
-
-@macro rinternalsnamed{TEXT,DISPLAY}
-@vindex \TEXT\
-@ref{\TEXT\,,\DISPLAY\,lilypond-internals-big-page,Internals Reference}
-@end macro
-
-@end ifset
-
-
-@c ** not bigpage **
-
-@ifclear bigpage
-
-@macro rglos{TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,music-glossary,Music Glossary}
-@end macro
-
-@macro rglosnamed{TEXT,DISPLAY}
-@vindex \TEXT\
-@ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
-@end macro
-
-@macro rlearning{TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning,Learning Manual}
-@end macro
-
-@macro rlearningnamed{TEXT,DISPLAY}
-@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning,Learning Manual}
-@end macro
-
-@macro ruser{TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,lilypond,Notation Reference}
-@end macro
-
-@macro rusernamed{TEXT,DISPLAY}
-@vindex \TEXT\
-@ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
-@end macro
-
-@macro rprogram{TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program,Application Usage}
-@end macro
-
-@macro rprogramnamed{TEXT,DISPLAY}
-@vindex \TEXT\
-@ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
-@end macro
-
-@macro rlsr{TEXT}
-@ref{\TEXT\,,,lilypond-snippets,Snippets}
-@end macro
-
-@macro rlsrnamed{TEXT,DISPLAY}
-@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
-@end macro
-
-@macro rinternals{TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-internals,Internals Reference}
-@end macro
-
-@macro rinternalsnamed{TEXT,DISPLAY}
-@vindex \TEXT\
-@ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
-@end macro
-
-@end ifclear
-
-@end ifnottex
-
-
-@c *** TeX ***
-
-@iftex
-
-@c All commands below should work in the middle of the line;
-@c we thus must not use @vindex directly since it works only if placed
-@c on a line of its own. To overcome this problem, we define a
-@c replacement macro using the internal definition of @vindex which
-@c delimits arguments in the standard way (i.e., with braces).
-
-@tex
-\gdef\lilyvindex#1{\doind{vr}{\code #1}\ignorespaces}
-@end tex
-
-@macro rglos{TEXT}
-@lilyvindex{\TEXT\}
-@ref{\TEXT\,,,music-glossary,Music Glossary}
-@end macro
-
-@macro rglosnamed{TEXT,DISPLAY}
-@lilyvindex{\TEXT\}
-@ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
-@end macro
-
-@macro rlearning{TEXT}
-@lilyvindex{\TEXT\}
-@ref{\TEXT\,,,lilypond-learning,Learning Manual}
-@end macro
-
-@macro rlearningnamed{TEXT,DISPLAY}
-@lilyvindex{\TEXT\}
-@ref{\TEXT\,,\DISPLAY\,lilypond-learning,Learning Manual}
-@end macro
-
-@macro ruser{TEXT}
-@lilyvindex{\TEXT\}
-@ref{\TEXT\,,,lilypond,Notation Reference}
-@end macro
-
-@macro rusernamed{TEXT,DISPLAY}
-@lilyvindex{\TEXT\}
-@ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
-@end macro
-
-@macro rprogram{TEXT}
-@lilyvindex{\TEXT\}
-@ref{\TEXT\,,,lilypond-program,Application Usage}
-@end macro
-
-@macro rprogramnamed{TEXT,DISPLAY}
-@lilyvindex{\TEXT\}
-@ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
-@end macro
-
-@macro rlsr{TEXT}
-@lilyvindex{\TEXT\}
-@ref{\TEXT\,,,lilypond-snippets,Snippets}
-@end macro
-
-@macro rlsrnamed{TEXT,DISPLAY}
-@lilyvindex{\TEXT\}
-@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
-@end macro
-
-@macro rinternals{TEXT}
-@lilyvindex{\TEXT\}
-@ref{\TEXT\,,,lilypond-internals,Internals Reference}
-@end macro
-
-@macro rinternalsnamed{TEXT,DISPLAY}
-@lilyvindex{\TEXT\}
-@ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
-@end macro
-
-@end iftex
RELEASE_FILES = ChangeLog RELEASE-COMMIT
RELEASE_OUT_FILES = $(RELEASE_FILES:%=$(outdir)/%)
OUT_DIST_FILES += $(RELEASE_OUT_FILES)
-EXTRA_DIST_FILES = VERSION .gitignore lilypond-texi2html.init \
+EXTRA_DIST_FILES = VERSION .gitignore \
$(README_FILES) $(SCRIPTS) $(IN_FILES)
INSTALLATION_DIR=$(local_lilypond_datadir)
INSTALLATION_FILES=$(config_make) VERSION
+++ /dev/null
-#!/usr/bin/env perl
-# -*- coding: utf-8; -*-
-
-### texi2html customization script for Lilypond
-### Author: Reinhold Kainhofer <reinhold@kainhofer.com>, 2008.
-### Some code parts copied from texi2html and adapted. These functions
-### were written mainly by Patrice Dumas
-### License: GPLv2+
-###
-###
-### Features implemented here:
-### -) For split manuals, the main page is index.html.
-### -) All @unnumbered* sections are placed into the same file
-### (implemented by split_at_numbered_sections)
-### -) Use our custom CSS file, with IE-specific fixes in another CSS file,
-### impelmented by lilypond_css_lines
-### -) TOC (folded, with the current page highlighted) in an overflown <div>
-### is added to every page; implemented by:
-### lilypond_print_element_header -- building of the TOC
-### lilypond_toc_body -- generation of customized TOC output
-### lilypond_print_page_head -- start <div id="main">
-### print_lilypond_page_foot -- closing id=main, output of footer & TOC
-### -) External refs are formatted only as "Text of the node" (not as >>see
-### "NODE" section "SECTION" in "BOOK"<< like with default texi2html). Also,
-### the leading "(book-name)" is removed.
-### Implemented by overriding lilypond_external_ref
-### -) Navigation bars on top/bottom of the page and between sections are not
-### left-aligned, but use a combination of left/center/right aligned table
-### cells; For this, I heavily extend the texi2html code to allow for
-### differently aligned cells and for multi-line tables);
-### Implemented in lilypond_print_navigation
-### -) Different formatting than the default: example uses the same formatting
-### as quote.
-### -) Allow translated section titles: All section titles can be translated,
-### the original (English) title is associated with @translationof. This is
-### needed, because the file name / anchor is generated from the original
-### English title, since otherwise language-autoselection would break with
-### posted links.
-### Since it is then no longer possible to obtain the file name from the
-### section title, I keep a sectionname<=>filename/anchor around. This way,
-### xrefs from other manuals can simply load that map and retrieve the
-### correct file name for the link. Implemented in:
-### lilypond_unknown (handling of @translationof, in case
-### extract_texi_filenames.py messes up...)
-### lilypond_element_file_name (correct file name: use the map)
-### lilypond_element_target_name (correct anchor: use the map)
-### lilypond_init_map (read in the externally created map from disk)
-### lilypond_external_href (load the map for xrefs, use the correct
-### link target)
-### -) The HTML anchors for all sections are derived from the node name /
-### section title (pre-generated in the .xref-map file). Implemented by:
-### lilypond_element_target_name (adjust section anchors)
-### -) Use the standard footnote format "<sup>nr</sup> text" instead of the
-### ugly format of texi2html (<h3>(nr)</h3><p>text</p>). Implemented in
-### makeinfo_like_foot_line_and_ref
-### makeinfo_like_foot_lines
-### makeinfo_like_paragraph
-###
-###
-### Useful helper functions:
-### -) texinfo_file_name($node_name): returns a texinfo-compatible file name
-### for the given string $node_name (whitespace trimmed/replaced by -,
-### non-standard chars replaced by _xxxx (ascii char code) and forced to
-### start with a letter by prepending t_g if necessary)
-
-
-package Texi2HTML::Config;
-
-#############################################################################
-### TRANSLATIONS
-#############################################################################
-
-use utf8;
-my $LY_LANGUAGES = {};
-$LY_LANGUAGES->{'fr'} = {
- 'Back to Documentation Index' => 'Retour à l\'accueil de la documentation',
-};
-$LY_LANGUAGES->{'es'} = {
- 'Back to Documentation Index' => 'Volver al índice de la documentación',
-};
-$LY_LANGUAGES->{'de'} = {
- 'Back to Documentation Index' => 'Zur Dokumentationsübersicht',
-};
-
-
-sub ly_get_string () {
- my $lang = $Texi2HTML::THISDOC{current_lang};
- my $string = shift;
- if ($lang and $lang ne "en" and $LY_LANGUAGES->{$lang}->{$string}) {
- return $LY_LANGUAGES->{$lang}->{$string};
- } else {
- return $string;
- }
-}
-
-
-#############################################################################
-### SETTINGS FOR TEXI2HTML
-#############################################################################
-
-@Texi2HTML::Config::CSS_REFS = (
- {FILENAME => "lilypond-mccarty.css", TITLE => "Patrick McCarty's design"}
-);
-@Texi2HTML::Config::ALT_CSS_REFS = (
- {FILENAME => "lilypond.css", TITLE => "Andrew Hawryluk's design" },
- {FILENAME => "lilypond-blue.css", TITLE => "Kurt Kroon's blue design" },
-);
-$Texi2HTML::Config::USE_ACCESSKEY = 1;
-$Texi2HTML::Config::USE_LINKS = 1;
-$Texi2HTML::Config::USE_REL_REV = 1;
-$Texi2HTML::Config::SPLIT_INDEX = 0;
-$Texi2HTML::Config::SEPARATED_FOOTNOTES = 0; # Print footnotes on same page, not separated
-if ($Texi2HTML::Config::SPLIT eq 'section') {
- $Texi2HTML::Config::element_file_name = \&lilypond_element_file_name;
-}
-$Texi2HTML::Config::element_target_name = \&lilypond_element_target_name;
-$default_print_element_header = $Texi2HTML::Config::print_element_header;
-$Texi2HTML::Config::print_element_header = \&lilypond_print_element_header;
-$Texi2HTML::Config::print_page_foot = \&print_lilypond_page_foot;
-$Texi2HTML::Config::print_navigation = \&lilypond_print_navigation;
-$Texi2HTML::Config::external_ref = \&lilypond_external_ref;
-$default_external_href = $Texi2HTML::Config::external_href;
-$Texi2HTML::Config::external_href = \&lilypond_external_href;
-$default_toc_body = $Texi2HTML::Config::toc_body;
-$Texi2HTML::Config::toc_body = \&lilypond_toc_body;
-$Texi2HTML::Config::css_lines = \&lilypond_css_lines;
-$default_unknown = $Texi2HTML::Config::unknown;
-$Texi2HTML::Config::unknown = \&lilypond_unknown;
-$default_print_page_head = $Texi2HTML::Config::print_page_head;
-$Texi2HTML::Config::print_page_head = \&lilypond_print_page_head;
-# $Texi2HTML::Config::foot_line_and_ref = \&lilypond_foot_line_and_ref;
-$Texi2HTML::Config::foot_line_and_ref = \&makeinfo_like_foot_line_and_ref;
-$Texi2HTML::Config::foot_lines = \&makeinfo_like_foot_lines;
-$Texi2HTML::Config::paragraph = \&makeinfo_like_paragraph;
-
-
-
-# Examples should be formatted similar to quotes:
-$Texi2HTML::Config::complex_format_map->{'example'} = {
- 'begin' => q{"<blockquote>"},
- 'end' => q{"</blockquote>\n"},
- 'style' => 'code',
- };
-
-%Texi2HTML::config::misc_pages_targets = (
- 'Overview' => 'Overview',
- 'Contents' => 'Contents',
- 'About' => 'About'
-);
-
-
-my @section_to_filename;
-
-
-
-
-#############################################################################
-### DEBUGGING
-#############################################################################
-
-use Data::Dumper;
-$Data::Dumper::Maxdepth = 2;
-
-sub print_element_info($)
-{
- my $element = shift;
- print "~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
- print "Element: $element\n";
- print Dumper($element);
-}
-
-
-
-
-
-#############################################################################
-### HELPER FUNCTIONS
-#############################################################################
-
-# Convert a given node name to its proper file name (normalization as explained
-# in the texinfo manual:
-# http://www.gnu.org/software/texinfo/manual/texinfo/html_node/HTML-Xref-Node-Name-Expansion.html
-sub texinfo_file_name($)
-{
- my $text = shift;
- my $result = '';
- # File name normalization by texinfo:
- # 1/2: letters and numbers are left unchanged
- # 3/4: multiple, leading and trailing whitespace is removed
- $text = main::normalise_space($text);
- # 5/6: all remaining spaces are converted to '-', all other 7- or 8-bit
- # chars are replaced by _xxxx (xxxx=ascii character code)
- while ($text ne '') {
- if ($text =~ s/^([A-Za-z0-9]+)//o) { # number or letter stay unchanged
- $result .= $1;
- } elsif ($text =~ s/^ //o) { # space -> '-'
- $result .= '-';
- } elsif ($text =~ s/^(.)//o) { # Otherwise use _xxxx (ascii char code)
- my $ccode = ord($1);
- if ( $ccode <= 0xFFFF ) {
- $result .= sprintf("_%04x", $ccode);
- } else {
- $result .= sprintf("__%06x", $ccode);
- }
- }
- }
- # 7: if name does not begin with a letter, prepend 't_g' (so it starts with a letter)
- if ($result !~ /^[a-zA-Z]/) {
- $result = 't_g' . $result;
- }
- # DONE
- return $result
-}
-
-
-# Load a file containing a nodename<=>filename map (tab-sepatared, i.e.
-# NODENAME\tFILENAME\tANCHOR
-# Returns a ref to a hash "Node title" => ["FilenameWithoutExt", "Anchor"]
-sub load_map_file ($)
-{
- my $mapfile = shift;
- my $node_map = ();
-
- if (open(XREFFILE, $mapfile)) {
- my $line;
- while ( $line = <XREFFILE> ) {
- # parse the tab-separated entries and insert them into the map:
- chomp($line);
- my @entries = split(/\t/, $line);
- if (scalar (@entries) == 3) {
- $node_map->{$entries[0]} = [$entries[1], $entries[2]];
- } else {
- print STDERR "Invalid entry in the node file $mapfile: $line\n";
- }
- }
- close (XREFFILE);
- } else {
- print STDERR "WARNING: Unable to load the map file $mapfile\n";
- }
- return $node_map;
-}
-
-
-# Split the given path into dir and basename (with .texi removed). Used mainly
-# to get the path/basename of the original texi input file
-sub split_texi_filename ($)
-{
- my $docu = shift;
- my ($docu_dir, $docu_name);
- if ($docu =~ /(.*\/)/) {
- chop($docu_dir = $1);
- $docu_name = $docu;
- $docu_name =~ s/.*\///;
- } else {
- $docu_dir = '.';
- $docu_name = $docu;
- }
- $docu_name =~ s/\.te?x(i|info)?$//;
- return ($docu_dir, $docu_name);
-}
-
-
-
-
-
-#############################################################################
-### CSS HANDLING
-#############################################################################
-
-# Include our standard CSS file, not hard-coded CSS code directly in the HTML!
-# For IE, conditionally include the lilypond-ie-fixes.css style sheet
-sub lilypond_css_lines ($$)
-{
- my $import_lines = shift;
- my $rule_lines = shift;
- return if (defined($Texi2HTML::THISDOC{'CSS_LINES'}));
- if (@$rule_lines or @$import_lines)
- {
- $Texi2HTML::THISDOC{'CSS_LINES'} = "<style type=\"text/css\">\n<!--\n";
- $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$import_lines) . "\n" if (@$import_lines);
- $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$rule_lines) . "\n" if (@$rule_lines);
- $Texi2HTML::THISDOC{'CSS_LINES'} .= "-->\n</style>\n";
- }
- foreach my $ref (@CSS_REFS)
- {
- $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"stylesheet\" type=\"text/css\" title=\"$ref->{TITLE}\" href=\"$ref->{FILENAME}\">\n";
- }
- foreach my $ref (@Texi2HTML::Config::ALT_CSS_REFS)
- {
- $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"alternate stylesheet\" type=\"text/css\" href=\"$ref->{FILENAME}\" title=\"$ref->{TITLE}\">\n";
- }
- $Texi2HTML::THISDOC{'CSS_LINES'} .= "<!--[if lte IE 7]>\n<link href=\"lilypond-ie-fixes.css\" rel=\"stylesheet\" type=\"text/css\">\n<![endif]-->\n";
-}
-
-
-
-
-
-#############################################################################
-### SPLITTING BASED ON NUMBERED SECTIONS
-#############################################################################
-
-my $lastfilename;
-my $docnr = 0;
-my $node_to_filename_map = ();
-
-
-# This function makes sure that files are only generated for numbered sections,
-# but not for unnumbered ones. It is called after texi2html has done its own
-# splitting and simply returns the filename for the node given as first argument
-# Nodes with the same filename will be printed out to the same filename, so
-# this really all we need. Also, make sure that the file names for sections
-# are derived from the section title. We also might want to name the anchors
-# according to node titles, which works by simply overriding the id element of
-# the $element hash.
-# If an external nodename<=>filename/anchor map file is found (loaded in
-# the command handler, use the externally created values, otherwise use the
-# same logic here.
-sub lilypond_element_file_name($$$)
-{
- my $element = shift;
- my $type = shift;
- my $docu_name = shift;
- my $docu_ext = $Texi2HTML::Config::EXTENSION;
-
- my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
- # the snippets page does not use nodes for the snippets, so in this case
- # we'll have to use the section name!
- if ($node_name eq '') {
- $node_name = main::remove_texi($element->{'texi'});
- }
-
- # If we have an entry in the section<=>filename map, use that one, otherwise
- # generate the filename/anchor here. In the latter case, external manuals
- # will not be able to retrieve the file name for xrefs!!! Still, I already
- # had that code, so I'll leave it in in case something goes wrong with the
- # extract_texi_filenames.py script in the lilypond build process!
- if (exists ($node_to_filename_map->{$node_name})) {
- (my $filename, my $anchor) = @{$node_to_filename_map->{$node_name}};
- $filename .= ".$docu_ext" if (defined($docu_ext));
-
- # unnumbered sections (except those at top-level!) always go to the same
- # file as the previous numbered section
- if (not ($element->{number}) and not ($lastfilename eq '') and ($element->{level} > 1)) {
- $filename = $lastfilename;
- }
- if (($filename eq $lastfilename)) {
- $$element{doc_nr} = $docnr;
- } else {
- $docnr += 1;
- $$element{doc_nr} = $docnr;
- $lastfilename = $filename;
- }
- return $filename;
-
- } elsif ($type eq "top" or $type eq "toc" or $type eq "doc" or $type eq "stoc" or $type eq "foot" or $type eq "about") {
- return;
- } else {
- print STDERR "WARNING: Node '$node_name' was NOT found in the map\n"
- unless ($node_name eq '') or ($element->{'tag'} eq 'unnumberedsec')
- or ($node_name =~ /NOT REALLY USED/);
-
- # Numbered sections will get a filename Node_title, unnumbered sections will use
- # the file name of the previous numbered section:
- if (($element->{number}) or ($lastfilename eq '') or ($element->{level} == 1)) {
- # normalize to the same file name as texinfo
- if ($element->{translationof}) {
- $node_name = main::remove_texi($element->{translationof});
- }
- my $filename = texinfo_file_name($node_name);
- $filename .= ".$docu_ext" if (defined($docu_ext));
- $docnr += 1;
- $$element{doc_nr} = $docnr;
- $lastfilename = $filename;
- return $filename;
- } else {
- $$element{doc_nr} = $docnr;
- return $lastfilename;
- }
- }
-
- return;
-}
-
-sub lilypond_element_target_name($$$)
-{
- my $element = shift;
- my $target = shift;
- my $id = shift;
- # Target is based on node name (or sec name for secs without node attached)
- my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
- if ($node_name eq '') {
- $node_name = main::remove_texi($element->{'texi'});
- }
-
- # If we have an entry in the section<=>filename map, use that one, otherwise
- # generate the anchor here.
- if (exists ($node_to_filename_map->{$node_name})) {
- (my $filename, $target) = @{$node_to_filename_map->{$node_name}};
- } else {
- my $anchor = $node_name;
- if ($element->{translationof}) {
- $anchor = main::remove_texi($element->{translationof});
- }
- # normalize to the same file name as texinfo
- $target = texinfo_file_name($anchor);
- }
- # TODO: Once texi2html correctly prints out the target and not the id for
- # the sections, change this back to ($id, $target)
- return ($target, $target);
-}
-
-
-## Load the map file for the corrently processed texi file. We do this
-# using a command init handler, since texi2html does not have any
-# other hooks that are called after THISDOC is filled but before phase 2
-# of the texi2html conversion.
-sub lilypond_init_map ()
-{
- my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
- my $map_filename = main::locate_include_file ("${docu_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
- || main::locate_include_file ("${docu_name}.xref-map");
- $node_to_filename_map = load_map_file ($map_filename);
-}
-push @Texi2HTML::Config::command_handler_init, \&lilypond_init_map;
-
-
-
-#############################################################################
-### CLEANER LINK TITLE FOR EXTERNAL REFS
-#############################################################################
-
-# The default formatting of external refs returns e.g.
-# "(lilypond-internals)Timing_translator", so we remove all (...) from the
-# file_and_node argument. Also, we want only a very simple format, so we don't
-# even call the default handler!
-sub lilypond_external_ref($$$$$$)
-{
- my $type = shift;
- my $section = shift;
- my $book = shift;
- my $file_node = shift;
- my $href = shift;
- my $cross_ref = shift;
-
- my $displaytext = '';
-
- # 1) if we have a cross ref name, that's the text to be displayed:
- # 2) For the top node, use the (printable) name of the manual, unless we
- # have an explicit cross ref name
- # 3) In all other cases use the section name
- if ($cross_ref ne '') {
- $displaytext = $cross_ref;
- } elsif (($section eq '') or ($section eq 'Top')) {
- $displaytext = $book;
- } else {
- $displaytext = $section;
- }
-
- $displaytext = &$anchor('', $href, $displaytext) if ($displaytext ne '');
- return &$I('%{node_file_href}', { 'node_file_href' => $displaytext });
-}
-
-
-
-
-
-#############################################################################
-### HANDLING TRANSLATED SECTIONS: handle @translationof, secname<->filename
-### map stored on disk, xrefs in other manuals load that map
-#############################################################################
-
-
-# Try to make use of @translationof to generate files according to the original
-# English section title...
-sub lilypond_unknown($$$$$)
-{
- my $macro = shift;
- my $line = shift;
- my $pass = shift;
- my $stack = shift;
- my $state = shift;
-
- # the @translationof macro provides the original English section title,
- # which should be used for file/anchor naming, while the title will be
- # translated to each language
- # It is already used by extract_texi_filenames.py, so this should not be
- # necessary here at all. Still, I'll leave the code in just in case the
- # python script messed up ;-)
- if ($pass == 1 and $macro eq "translationof") {
- if (ref($state->{'element'}) eq 'HASH') {
- $state->{'element'}->{'translationof'} = main::normalise_space($line);
- }
- return ('', 1, undef, undef);
- } else {
- return &$default_unknown($macro, $line, $pass, $stack, $state);
- }
-}
-
-
-
-
-my %translated_books = ();
-# Construct a href to an external source of information.
-# node is the node with texinfo @-commands
-# node_id is the node transliterated and transformed as explained in the
-# texinfo manual
-# node_xhtml_id is the node transformed such that it is unique and can
-# be used to make an html cross ref as explained in the texinfo manual
-# file is the file in '(file)node'
-sub lilypond_external_href($$$)
-{
- my $node = shift;
- my $node_id = shift;
- my $node_hxmlt_id = shift;
- my $file = shift;
-
- # 1) Keep a hash of book->section_map
- # 2) if not file in keys hash => try to load the map (assign empty map if
- # non-existent => will load only once!)
- # 3) if node in the section=>(file, anchor) map, replace node_id and
- # node_xhtml_id by the map's values
- # 4) call the default_external_href with these values (or the old ones if not found)
-
- if (($node_id ne '') and defined($file) and ($node_id ne 'Top')) {
- my $map_name = $file;
- $map_name =~ s/-big-page//;
-
- # Load the map if we haven't done so already
- if (!exists($translated_books{$map_name})) {
- my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
- my $map_filename = main::locate_include_file ("${map_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
- || main::locate_include_file ("${map_name}.xref-map");
- $translated_books{$map_name} = load_map_file ($map_filename);
- }
-
- # look up translation. use these values instead of the old filename/anchor
- my $section_name_map = $translated_books{$map_name};
- my $node_text = main::remove_texi($node);
- if (defined($section_name_map->{$node_text})) {
- ($node_id, $node_hxmlt_id) = @{$section_name_map->{$node_text}};
- } else {
- print STDERR "WARNING: Unable to find node '$node_text' in book $map_name.\n";
- }
- }
-
- if (defined $file) {
- return &$default_external_href($node, $node_id, $node_hxmlt_id, $file);
- } else {
- return &$default_external_href($node, $node_id, $node_hxmlt_id);
- }
-}
-
-
-
-
-
-#############################################################################
-### CUSTOM TOC FOR EACH PAGE (in a frame on the left)
-#############################################################################
-
-my $page_toc_depth = 2;
-my @default_toc = [];
-
-
-# Initialize the toc_depth to 1 if the command-line option -D=short_toc is given
-sub lilypond_init_toc_depth ()
-{
- if (exists($main::value{'short_toc'}) and not exists($main::value{'bigpage'})) {
- $page_toc_depth = 1;
- }
-}
-# Set the TOC-depth (depending on a texinfo variable short_toc) in a
-# command-handler, so we have them available when creating the pages
-push @Texi2HTML::Config::command_handler_process, \&lilypond_init_toc_depth;
-
-
-# recursively generate the TOC entries for the element and its children (which
-# are only shown up to maxlevel. All ancestors of the current element are also
-# shown with their immediate children, irrespective of their level.
-# Unnumbered entries are only printed out if they are at top-level or 2nd level
-# or their parent element is an ancestor of the currently viewed node.
-# The conditions to call this method to print the entry for a child node is:
-# -) the parent is an ancestor of the current page node
-# -) the parent is a numbered element at top-level toplevel (i.e. show numbered
-# and unnumbered 2nd-level children of numbered nodes)
-# -) the child element is a numbered node below level maxlevel
-sub generate_ly_toc_entries($$$)
-{
- my $element = shift;
- my $element_path = shift;
- my $maxlevel = shift;
- # Skip undefined sections, plus all sections generated by index splitting
- return() if (not defined($element) or exists($element->{'index_page'}));
- my @result = ();
- my $level = $element->{'toc_level'};
- my $is_parent_of_current = $element->{'id'} && $element_path->{$element->{'id'}};
- my $ind = ' ' x $level;
- my $this_css_class = $is_parent_of_current ? " class=\"toc_current\"" : "";
-
- my $entry = "$ind<li$this_css_class>" . &$anchor ($element->{'tocid'}, "$element->{'file'}#$element->{'target'}",$element->{'text'});
-
- push (@result, $entry);
- my $children = $element->{'section_childs'};
- if (defined($children) and (ref($children) eq "ARRAY")) {
- my $force_children = $is_parent_of_current or ($level == 1 and $element->{'number'});
- my @child_result = ();
- foreach my $c (@$children) {
- my $is_numbered_child = defined ($c->{'number'});
- my $below_maxlevel = $c->{'toc_level'} le $maxlevel;
- if ($force_children or ($is_numbered_child and $below_maxlevel)) {
- my @child_res = generate_ly_toc_entries($c, $element_path, $maxlevel);
- push (@child_result, @child_res);
- }
- }
- # if no child nodes were generated, e.g. for the index, where expanded pages
- # are ignored, don't generate a list at all...
- if (@child_result) {
- push (@result, "\n$ind<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
- push (@result, @child_result);
- push (@result, "$ind</ul>\n");
- }
- }
- push (@result, "$ind</li>\n");
- return @result;
-}
-
-
-# Print a customized TOC, containing only the first two levels plus the whole
-# path to the current page
-sub lilypond_generate_page_toc_body($)
-{
- my $element = shift;
- my $current_element = $element;
- my %parentelements;
- $parentelements{$element->{'id'}} = 1;
- # Find the path to the current element
- while ( defined($current_element->{'sectionup'}) and
- ($current_element->{'sectionup'} ne $current_element) )
- {
- $parentelements{$current_element->{'sectionup'}->{'id'}} = 1
- if ($current_element->{'sectionup'}->{'id'} ne '');
- $current_element = $current_element->{'sectionup'};
- }
- return () if not defined($current_element);
- # Create the toc entries recursively
- my @toc_entries = ("<div class=\"contents\">\n", "<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
- my $children = $current_element->{'section_childs'};
- foreach ( @$children ) {
- push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth));
- }
- push (@toc_entries, "</ul>\n");
- push (@toc_entries, "</div>\n");
- return @toc_entries;
-}
-
-sub lilypond_print_toc_div ($$)
-{
- my $fh = shift;
- my $tocref = shift;
- my @lines = @$tocref;
- # use default TOC if no custom lines have been generated
- @lines = @default_toc if (not @lines);
- if (@lines) {
-
- print $fh "\n\n<div id=\"tocframe\">\n";
-
- # Remove the leading "GNU LilyPond --- " from the manual title
- my $topname = $Texi2HTML::NAME{'Top'};
- $topname =~ s/^GNU LilyPond(:| &[mn]dash;) //;
-
- # construct the top-level Docs index (relative path and including language!)
- my $lang = $Texi2HTML::THISDOC{current_lang};
- if ($lang and $lang ne "en") {
- $lang .= ".";
- } else {
- $lang = "";
- }
- my $reldir = "";
- $reldir = "../" if ($Texi2HTML::Config::SPLIT eq 'section');
- my $uplink = $reldir."index.${lang}html";
-
- print $fh "<p class=\"toc_uplink\"><a href=\"$uplink\"
- title=\"Documentation Index\"><< " .
- &ly_get_string ('Back to Documentation Index') .
- "</a></p>\n";
-
- print $fh '<h4 class="toc_header"> ' . &$anchor('',
- $Texi2HTML::HREF{'Top'},
- $topname,
- 'title="Start of the manual"'
- ) . "</h4>\n";
- foreach my $line (@lines) {
- print $fh $line;
- }
- print $fh "</div>\n\n";
- }
-}
-
-# Create the custom TOC for this page (partially folded, current page is
-# highlighted) and store it in a global variable. The TOC is written out after
-# the html contents (but positioned correctly using CSS), so that browsers with
-# css turned off still show the contents first.
-our @this_page_toc = ();
-sub lilypond_print_element_header
-{
- my $first_in_page = shift;
- my $previous_is_top = shift;
- if ($first_in_page and not @this_page_toc) {
- if (defined($Texi2HTML::THIS_ELEMENT)) {
- # Create the TOC for this page
- @this_page_toc = lilypond_generate_page_toc_body($Texi2HTML::THIS_ELEMENT);
- }
- }
- return &$default_print_element_header( $first_in_page, $previous_is_top);
-}
-
-# Generate the HTML output for the TOC
-sub lilypond_toc_body($)
-{
- my $elements_list = shift;
- # Generate a default TOC for pages without THIS_ELEMENT
- @default_toc = lilypond_generate_page_toc_body(@$elements_list[0]);
- return &$default_toc_body($elements_list);
-}
-
-# Print out the TOC in a <div> at the beginning of the page
-sub lilypond_print_page_head($)
-{
- my $fh = shift;
- &$default_print_page_head($fh);
- print $fh "<div id=\"main\">\n";
-}
-
-# Print out the TOC in a <div> at the end of th page, which will be formatted as a
-# sidebar mimicking a TOC frame
-sub print_lilypond_page_foot($)
-{
- my $fh = shift;
- my $program_string = &$program_string();
-# print $fh "<p><font size='-1'>$program_string</font><br>$PRE_BODY_CLOSE</p>\n";
- print $fh "<!-- FOOTER -->\n\n";
- print $fh "<!-- end div#main here -->\n</div>\n\n";
-
- # Print the TOC frame and reset the TOC:
- lilypond_print_toc_div ($fh, \@this_page_toc);
- @this_page_toc = ();
-
- # Close the page:
- print $fh "</body>\n</html>\n";
-}
-
-
-
-
-
-#############################################################################
-### NICER / MORE FLEXIBLE NAVIGATION PANELS
-#############################################################################
-
-sub get_navigation_text
-{
- my $button = shift;
- my $text = $NAVIGATION_TEXT{$button};
- if ( ($button eq 'Back') or ($button eq 'FastBack') ) {
- $text = $text . $Texi2HTML::NODE{$button} . " ";
- } elsif ( ($button eq 'Forward') or ($button eq 'FastForward') ) {
- $text = " " . $Texi2HTML::NODE{$button} . $text;
- } elsif ( $button eq 'Up' ) {
- $text = " ".$text.": " . $Texi2HTML::NODE{$button} . " ";
- }
- return $text;
-}
-
-
-# Don't automatically create left-aligned table cells for every link, but
-# instead create a <td> only on an appropriate '(left|right|center)-aligned-cell-n'
-# button text. It's alignment as well as the colspan will be taken from the
-# name of the button. Also, add 'newline' button text to create a new table
-# row. The texts of the buttons are generated by get_navigation_text and
-# will contain the name of the next/previous section/chapter.
-sub lilypond_print_navigation
-{
- my $buttons = shift;
- my $vertical = shift;
- my $spacing = 1;
- my $result = "<table class=\"nav_table\">\n";
-
- $result .= "<tr>" unless $vertical;
- my $beginofline = 1;
- foreach my $button (@$buttons)
- {
- $result .= qq{<tr valign="top" align="left">\n} if $vertical;
- # Allow (left|right|center)-aligned-cell and newline as buttons!
- if ( $button =~ /^(.*)-aligned-cell-(.*)$/ )
- {
- $result .= qq{</td>} unless $beginofline;
- $result .= qq{<td valign="middle" align="$1" colspan="$2">};
- $beginofline = 0;
- }
- elsif ( $button eq 'newline' )
- {
- $result .= qq{</td>} unless $beginofline;
- $result .= qq{</tr>};
- $result .= qq{<tr>};
- $beginofline = 1;
-
- }
- elsif (ref($button) eq 'CODE')
- {
- $result .= &$button($vertical);
- }
- elsif (ref($button) eq 'SCALAR')
- {
- $result .= "$$button" if defined($$button);
- }
- elsif (ref($button) eq 'ARRAY')
- {
- my $text = $button->[1];
- my $button_href = $button->[0];
- # verify that $button_href is simple text and text is a reference
- if (defined($button_href) and !ref($button_href)
- and defined($text) and (ref($text) eq 'SCALAR') and defined($$text))
- { # use given text
- if ($Texi2HTML::HREF{$button_href})
- {
- my $anchor_attributes = '';
- if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button_href})) and ($BUTTONS_ACCESSKEY{$button_href} ne ''))
- {
- $anchor_attributes = "accesskey=\"$BUTTONS_ACCESSKEY{$button_href}\"";
- }
- if ($USE_REL_REV and (defined($BUTTONS_REL{$button_href})) and ($BUTTONS_REL{$button_href} ne ''))
- {
- $anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\"";
- }
- $result .= "" .
- &$anchor('',
- $Texi2HTML::HREF{$button_href},
- get_navigation_text($$text),
- $anchor_attributes
- );
- }
- else
- {
- $result .= get_navigation_text($$text);
- }
- }
- }
- elsif ($button eq ' ')
- { # handle space button
- $result .=
- ($ICONS && $ACTIVE_ICONS{' '}) ?
- &$button_icon_img($BUTTONS_NAME{$button}, $ACTIVE_ICONS{' '}) :
- $NAVIGATION_TEXT{' '};
- #next;
- }
- elsif ($Texi2HTML::HREF{$button})
- { # button is active
- my $btitle = $BUTTONS_GOTO{$button} ?
- 'title="' . $BUTTONS_GOTO{$button} . '"' : '';
- if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button})) and ($BUTTONS_ACCESSKEY{$button} ne ''))
- {
- $btitle .= " accesskey=\"$BUTTONS_ACCESSKEY{$button}\"";
- }
- if ($USE_REL_REV and (defined($BUTTONS_REL{$button})) and ($BUTTONS_REL{$button} ne ''))
- {
- $btitle .= " rel=\"$BUTTONS_REL{$button}\"";
- }
- if ($ICONS && $ACTIVE_ICONS{$button})
- { # use icon
- $result .= '' .
- &$anchor('',
- $Texi2HTML::HREF{$button},
- &$button_icon_img($BUTTONS_NAME{$button},
- $ACTIVE_ICONS{$button},
- $Texi2HTML::SIMPLE_TEXT{$button}),
- $btitle
- );
- }
- else
- { # use text
- $result .=
- '[' .
- &$anchor('',
- $Texi2HTML::HREF{$button},
- get_navigation_text($button),
- $btitle
- ) .
- ']';
- }
- }
- else
- { # button is passive
- $result .=
- $ICONS && $PASSIVE_ICONS{$button} ?
- &$button_icon_img($BUTTONS_NAME{$button},
- $PASSIVE_ICONS{$button},
- $Texi2HTML::SIMPLE_TEXT{$button}) :
-
- "[" . get_navigation_text($button) . "]";
- }
- $result .= "</td>\n" if $vertical;
- $result .= "</tr>\n" if $vertical;
- }
- $result .= "</td>" unless $beginofline;
- $result .= "</tr>" unless $vertical;
- $result .= "</table>\n";
- return $result;
-}
-
-
-@Texi2HTML::Config::SECTION_BUTTONS =
- ('left-aligned-cell-1', 'FastBack',
- 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
- 'right-aligned-cell-1', 'FastForward',
- 'newline',
- 'left-aligned-cell-2', 'Back',
- 'center-aligned-cell-1', 'Up',
- 'right-aligned-cell-2', 'Forward'
- );
-
-# buttons for misc stuff
-@Texi2HTML::Config::MISC_BUTTONS = ('center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About');
-
-# buttons for chapter file footers
-# (and headers but only if SECTION_NAVIGATION is false)
-@Texi2HTML::Config::CHAPTER_BUTTONS =
- ('left-aligned-cell-1', 'FastBack',
- 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
- 'right-aligned-cell-1', 'FastForward',
- );
-
-# buttons for section file footers
-@Texi2HTML::Config::SECTION_FOOTER_BUTTONS =
- ('left-aligned-cell-1', 'FastBack',
- 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
- 'right-aligned-cell-1', 'FastForward',
- 'newline',
- 'left-aligned-cell-2', 'Back',
- 'center-aligned-cell-1', 'Up',
- 'right-aligned-cell-2', 'Forward'
- );
-
-@Texi2HTML::Config::NODE_FOOTER_BUTTONS =
- ('left-aligned-cell-1', 'FastBack',
- 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
- 'right-aligned-cell-1', 'FastForward',
- 'newline',
- 'left-aligned-cell-2', 'Back',
- 'center-aligned-cell-1', 'Up',
- 'right-aligned-cell-2', 'Forward'
- );
-
-
-
-
-
-#############################################################################
-### FOOTNOTE FORMATTING
-#############################################################################
-
-# Format footnotes in a nicer way: Instead of printing the number in a separate
-# (nr) heading line, use the standard way of prepending <sup>nr</sup> immediately
-# before the fn text.
-
-
-# The following code is copied from texi2html's examples/makeinfo.init and
-# should be updated when texi2html makes some changes there!
-
-my $makekinfo_like_footnote_absolute_number = 0;
-
-sub makeinfo_like_foot_line_and_ref($$$$$$$$)
-{
- my $foot_num = shift;
- my $relative_num = shift;
- my $footid = shift;
- my $docid = shift;
- my $from_file = shift;
- my $footnote_file = shift;
- my $lines = shift;
- my $state = shift;
-
- $makekinfo_like_footnote_absolute_number++;
-
- # this is a bit obscure, this allows to add an anchor only if formatted
- # as part of the document.
- $docid = '' if ($state->{'outside_document'} or $state->{'multiple_pass'});
-
- if ($from_file eq $footnote_file)
- {
- $from_file = $footnote_file = '';
- }
-
- my $foot_anchor = "<sup>" . &$anchor($docid, "$footnote_file#$footid", $relative_num) . "</sup>";
- $foot_anchor = &$anchor($docid, "$footnote_file#$footid", "($relative_num)") if ($state->{'preformatted'});
-
-# unshift @$lines, "<li>";
-# push @$lines, "</li>\n";
- return ($lines, $foot_anchor);
-}
-
-sub makeinfo_like_foot_lines($)
-{
- my $lines = shift;
- unshift @$lines, "<hr>\n<h4>$Texi2HTML::I18n::WORDS->{'Footnotes_Title'}</h4>\n";
-#<ol type=\"1\">\n";
-# push @$lines, "</ol>";
- return $lines;
-}
-
-my %makekinfo_like_paragraph_in_footnote_nr;
-
-sub makeinfo_like_paragraph ($$$$$$$$$$$$$)
-{
- my $text = shift;
- my $align = shift;
- my $indent = shift;
- my $paragraph_command = shift;
- my $paragraph_command_formatted = shift;
- my $paragraph_number = shift;
- my $format = shift;
- my $item_nr = shift;
- my $enumerate_style = shift;
- my $number = shift;
- my $command_stack_at_end = shift;
- my $command_stack_at_begin = shift;
- my $state = shift;
-#print STDERR "format: $format\n" if (defined($format));
-#print STDERR "paragraph @$command_stack_at_end; @$command_stack_at_begin\n";
- $paragraph_command_formatted = '' if (!defined($paragraph_command_formatted) or
- exists($special_list_commands{$format}->{$paragraph_command}));
- return '' if ($text =~ /^\s*$/);
- foreach my $style(t2h_collect_styles($command_stack_at_begin))
- {
- $text = t2h_begin_style($style, $text);
- }
- foreach my $style(t2h_collect_styles($command_stack_at_end))
- {
- $text = t2h_end_style($style, $text);
- }
- if (defined($paragraph_number) and defined($$paragraph_number))
- {
- $$paragraph_number++;
- return $text if (($format eq 'itemize' or $format eq 'enumerate') and
- ($$paragraph_number == 1));
- }
- my $open = '<p';
- if ($align)
- {
- $open .= " align=\"$paragraph_style{$align}\"";
- }
- my $footnote_text = '';
- if (defined($command_stack_at_begin->[0]) and $command_stack_at_begin->[0] eq 'footnote')
- {
- my $state = $Texi2HTML::THISDOC{'state'};
- $makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number}++;
- if ($makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number} <= 1)
- {
- $open.=' class="footnote"';
- my $document_file = $state->{'footnote_document_file'};
- if ($document_file eq $state->{'footnote_footnote_file'})
- {
- $document_file = '';
- }
- my $docid = $state->{'footnote_place_id'};
- my $doc_state = $state->{'footnote_document_state'};
- $docid = '' if ($doc_state->{'outside_document'} or $doc_state->{'multiple_pass'});
- my $foot_label = &$anchor($state->{'footnote_footnote_id'},
- $document_file . "#$state->{'footnote_place_id'}",
- "$state->{'footnote_number_in_page'}");
- $footnote_text = "<small>[${foot_label}]</small> ";
- }
- }
- return $open.'>'.$footnote_text.$text.'</p>';
-}
-
-
-#############################################################################
-### OTHER SETTINGS
-#############################################################################
-
-# For split pages, use index.html as start page!
-if ($Texi2HTML::Config::SPLIT eq 'section') {
- $Texi2HTML::Config::TOP_FILE = 'index.html';
-}
-
-
-return 1;
XREF_MAPS_FILES=$(TELY_FILES:%.tely=$(XREF_MAPS_DIR)/%.$(ISOLANG).xref-map)
# texi2html flags
-TEXI2HTML_INIT= --init-file=$(top-src-dir)/lilypond-texi2html.init
+TEXI2HTML_INIT= --init-file=$(top-src-dir)/Documentation/lilypond-texi2html.init
TEXI2HTML_LANG=--lang=$(ISOLANG)
TEXI2HTML_FLAGS += $(TEXI2HTML_LANG) $(DOCUMENTATION_INCLUDES) \
-I $(XREF_MAPS_DIR)
LILYPOND_BOOK_INCLUDES = -I $(src-dir)/ -I $(outdir) -I $(input-dir) \
-I $(input-dir)/lsr/ -I $(input-dir)/regression/ -I $(input-dir)/manual/ \
-I $(input-dir)/tutorial/ -I $(top-build-dir)/mf/$(outconfbase)/ \
- -I $(top-build-dir)/mf/out/ -I $(top-src-dir)/input/manual
+ -I $(top-build-dir)/mf/out/ -I $(top-src-dir)/input/manual \
+ -I $(top-src-dir)/Documentation
## override from cmd line to speed up.
ANTI_ALIAS_FACTOR=2
TEXI_FILES = $(call src-wildcard,*.texi)
-
ALL_SOURCES += $(TEXI_FILES)
-
TEXINFO_SOURCES = $(TEXI_FILES)
OUTTXT_FILES += $(addprefix $(outdir)/,$(TEXI_FILES:.texi=.txt))
TEXINFO_PAPERSIZE_OPTION= $(if $(findstring $(PAPERSIZE),a4),,-t @afourpaper)
+DOCUMENTATION_INCLUDES += -I $(top-src-dir)/Documentation
+
MAKEINFO_FLAGS += --enable-encoding $(DOCUMENTATION_INCLUDES)
MAKEINFO = LANG= $(MAKEINFO_PROGRAM) $(MAKEINFO_FLAGS)
TEXI2HTML_LANG = --lang=$(ISOLANG)
endif
TEXI2HTML_FLAGS += $(DOCUMENTATION_INCLUDES) --I=$(XREF_MAPS_DIR)
-TEXI2HTML_INIT = --init-file=$(top-src-dir)/lilypond-texi2html.init
+TEXI2HTML_INIT = --init-file=$(top-src-dir)/Documentation/lilypond-texi2html.init
TEXI2HTML = $(TEXI2HTML_PROGRAM) $(TEXI2HTML_FLAGS) $(TEXI2HTML_LANG)
TEXI2PDF_FLAGS += $(DOCUMENTATION_INCLUDES)
TO_TOP_FILES=$(addprefix $(outdir)/, $(addsuffix .txt, $(README_TOP_FILES)))
-DOCUMENTATION_INCLUDES = -I $(top-src-dir)/Documentation/user
+DOCUMENTATION_INCLUDES += -I $(top-src-dir)/Documentation/user