2 # -*- coding: utf-8; -*-
4 ### texi2html customization script for LilyPond
5 ### Author: Reinhold Kainhofer <reinhold@kainhofer.com>, 2008.
6 ### Some code parts copied from texi2html and adapted. These functions
7 ### were written mainly by Patrice Dumas
11 ### Features implemented here:
12 ### -) For split manuals, the main page is index.html.
13 ### -) All @unnumbered* sections are placed into the same file
14 ### (implemented by split_at_numbered_sections)
15 ### -) Use our custom CSS file, with IE-specific fixes in another CSS file,
16 ### impelmented by lilypond_css_lines
17 ### -) TOC (folded, with the current page highlighted) in an overflown <div>
18 ### is added to every page; implemented by:
19 ### lilypond_print_element_header -- building of the TOC
20 ### lilypond_toc_body -- generation of customized TOC output
21 ### lilypond_print_page_head -- start <div id="main">
22 ### print_lilypond_page_foot -- closing id=main, output of footer & TOC
23 ### -) External refs are formatted only as "Text of the node" (not as >>see
24 ### "NODE" section "SECTION" in "BOOK"<< like with default texi2html). Also,
25 ### the leading "(book-name)" is removed.
26 ### Implemented by overriding lilypond_external_ref
27 ### -) Navigation bars on top/bottom of the page and between sections are not
28 ### left-aligned, but use a combination of left/center/right aligned table
29 ### cells; For this, I heavily extend the texi2html code to allow for
30 ### differently aligned cells and for multi-line tables);
31 ### Implemented in lilypond_print_navigation
32 ### -) Different formatting than the default: example uses the same formatting
34 ### -) Allow translated section titles: All section titles can be translated,
35 ### the original (English) title is associated with @translationof. This is
36 ### needed, because the file name / anchor is generated from the original
37 ### English title, since otherwise language-autoselection would break with
39 ### Since it is then no longer possible to obtain the file name from the
40 ### section title, I keep a sectionname<=>filename/anchor around. This way,
41 ### xrefs from other manuals can simply load that map and retrieve the
42 ### correct file name for the link. Implemented in:
43 ### lilypond_unknown (handling of @translationof, in case
44 ### extract_texi_filenames.py messes up...)
45 ### lilypond_element_file_name (correct file name: use the map)
46 ### lilypond_element_target_name (correct anchor: use the map)
47 ### lilypond_init_map (read in the externally created map from disk)
48 ### lilypond_external_href (load the map for xrefs, use the correct
50 ### -) The HTML anchors for all sections are derived from the node name /
51 ### section title (pre-generated in the .xref-map file). Implemented by:
52 ### lilypond_element_target_name (adjust section anchors)
53 ### -) Use the standard footnote format "<sup>nr</sup> text" instead of the
54 ### ugly format of texi2html (<h3>(nr)</h3><p>text</p>). Implemented in
55 ### makeinfo_like_foot_line_and_ref
56 ### makeinfo_like_foot_lines
57 ### makeinfo_like_paragraph
60 ### Useful helper functions:
61 ### -) texinfo_file_name($node_name): returns a texinfo-compatible file name
62 ### for the given string $node_name (whitespace trimmed/replaced by -,
63 ### non-standard chars replaced by _xxxx (ascii char code) and forced to
64 ### start with a letter by prepending t_g if necessary)
67 package Texi2HTML::Config;
69 #############################################################################
71 #############################################################################
74 my $LY_LANGUAGES = {};
75 $LY_LANGUAGES->{'fr'} = {
76 'Back to Documentation Index' => 'Retour à l\'accueil de la documentation',
78 $LY_LANGUAGES->{'es'} = {
79 'Back to Documentation Index' => 'Volver al índice de la documentación',
81 $LY_LANGUAGES->{'de'} = {
82 'Back to Documentation Index' => 'Zur Dokumentationsübersicht',
84 $LY_LANGUAGES->{'ja'} = {
85 'Back to Documentation Index' => 'ドキュメント インデックスに戻る',
89 sub ly_get_string () {
90 my $lang = $Texi2HTML::THISDOC{current_lang};
92 if ($lang and $lang ne "en" and $LY_LANGUAGES->{$lang}->{$string}) {
93 return $LY_LANGUAGES->{$lang}->{$string};
100 #############################################################################
101 ### SETTINGS FOR TEXI2HTML
102 #############################################################################
104 # Validation fix for texi2html<=1.82
105 $Texi2HTML::Config::DOCTYPE = '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">';
107 @Texi2HTML::Config::CSS_REFS = (
108 {FILENAME => "lilypond-web.css", TITLE => "Default style"},
109 {FILENAME => "lilypond-web-alt1.css", TITLE => "Alternate style 1"},
110 {FILENAME => "lilypond-web-alt2.css", TITLE => "Alternate style 2"},
113 # GOP tweak: We don't have alternate stylesheets right now
114 #@Texi2HTML::Config::ALT_CSS_REFS = (
115 # {FILENAME => "lilypond.css", TITLE => "Andrew Hawryluk's design" },
116 # {FILENAME => "lilypond-blue.css", TITLE => "Kurt Kroon's blue design" },
119 $Texi2HTML::Config::USE_ACCESSKEY = 1;
120 $Texi2HTML::Config::USE_LINKS = 1;
121 $Texi2HTML::Config::USE_REL_REV = 1;
122 $Texi2HTML::Config::SPLIT_INDEX = 0;
123 $Texi2HTML::Config::SEPARATED_FOOTNOTES = 0; # Print footnotes on same page, not separated
124 # FIXME: remove for GOP
125 #if ($Texi2HTML::Config::SPLIT eq 'section') {
126 # $Texi2HTML::Config::element_file_name = \&lilypond_element_file_name;
130 # FIXME: creates duplicate anchors, which causes Opera to barf;
131 # should be fixed in lilypond-texi2html.init too
132 # $Texi2HTML::Config::element_target_name = \&lilypond_element_target_name;
133 $default_print_element_header = $Texi2HTML::Config::print_element_header;
134 $Texi2HTML::Config::print_element_header = \&lilypond_print_element_header;
135 $Texi2HTML::Config::print_page_foot = \&print_lilypond_page_foot;
136 $Texi2HTML::Config::print_navigation = \&lilypond_print_navigation;
137 $Texi2HTML::Config::external_ref = \&lilypond_external_ref;
138 $default_external_href = $Texi2HTML::Config::external_href;
139 $Texi2HTML::Config::external_href = \&lilypond_external_href;
140 $default_toc_body = $Texi2HTML::Config::toc_body;
141 $Texi2HTML::Config::toc_body = \&lilypond_toc_body;
142 $Texi2HTML::Config::css_lines = \&lilypond_css_lines;
143 $default_unknown = $Texi2HTML::Config::unknown;
144 $Texi2HTML::Config::unknown = \&lilypond_unknown;
145 $default_print_page_head = $Texi2HTML::Config::print_page_head;
146 $Texi2HTML::Config::print_page_head = \&lilypond_print_page_head;
147 # $Texi2HTML::Config::foot_line_and_ref = \&lilypond_foot_line_and_ref;
148 $Texi2HTML::Config::foot_line_and_ref = \&makeinfo_like_foot_line_and_ref;
149 $Texi2HTML::Config::foot_lines = \&makeinfo_like_foot_lines;
150 $Texi2HTML::Config::paragraph = \&makeinfo_like_paragraph;
154 # Examples should be formatted similar to quotes:
155 $Texi2HTML::Config::complex_format_map->{'example'} = {
156 'begin' => q{"<blockquote>"},
157 'end' => q{"</blockquote>\n"},
161 %Texi2HTML::config::misc_pages_targets = (
162 'Overview' => 'Overview',
163 'Contents' => 'Contents',
168 my @section_to_filename;
173 #############################################################################
175 #############################################################################
178 $Data::Dumper::Maxdepth = 2;
180 sub print_element_info($)
183 print "~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
184 print "Element: $element\n";
185 print Dumper($element);
192 #############################################################################
194 #############################################################################
196 # Convert a given node name to its proper file name (normalization as explained
197 # in the texinfo manual:
198 # http://www.gnu.org/software/texinfo/manual/texinfo/html_node/HTML-Xref-Node-Name-Expansion.html
199 sub texinfo_file_name($)
203 # File name normalization by texinfo:
204 # 1/2: letters and numbers are left unchanged
205 # 3/4: multiple, leading and trailing whitespace is removed
206 $text = main::normalise_space($text);
207 # 5/6: all remaining spaces are converted to '-', all other 7- or 8-bit
208 # chars are replaced by _xxxx (xxxx=ascii character code)
209 while ($text ne '') {
210 if ($text =~ s/^([A-Za-z0-9]+)//o) { # number or letter stay unchanged
212 } elsif ($text =~ s/^ //o) { # space -> '-'
214 } elsif ($text =~ s/^(.)//o) { # Otherwise use _xxxx (ascii char code)
216 if ( $ccode <= 0xFFFF ) {
217 $result .= sprintf("_%04x", $ccode);
219 $result .= sprintf("__%06x", $ccode);
223 # 7: if name does not begin with a letter, prepend 't_g' (so it starts with a letter)
224 if ($result !~ /^[a-zA-Z]/) {
225 $result = 't_g' . $result;
232 # Load a file containing a nodename<=>filename map (tab-sepatared, i.e.
233 # NODENAME\tFILENAME\tANCHOR
234 # Returns a ref to a hash "Node title" => ["FilenameWithoutExt", "Anchor"]
235 sub load_map_file ($)
240 if (open(XREFFILE, $mapfile)) {
242 while ( $line = <XREFFILE> ) {
243 # parse the tab-separated entries and insert them into the map:
245 my @entries = split(/\t/, $line);
246 if (scalar (@entries) == 3) {
247 $node_map->{$entries[0]} = [$entries[1], $entries[2]];
249 print STDERR "Invalid entry in the node file $mapfile: $line\n";
254 print STDERR "WARNING: Unable to load the map file $mapfile\n";
260 # Split the given path into dir and basename (with .texi removed). Used mainly
261 # to get the path/basename of the original texi input file
262 sub split_texi_filename ($)
265 my ($docu_dir, $docu_name);
266 if ($docu =~ /(.*\/)/) {
267 chop($docu_dir = $1);
269 $docu_name =~ s/.*\///;
274 $docu_name =~ s/\.te?x(i|info)?$//;
275 return ($docu_dir, $docu_name);
282 #############################################################################
284 #############################################################################
286 # Include our standard CSS file, not hard-coded CSS code directly in the HTML!
287 # For IE, conditionally include the lilypond-ie-fixes.css style sheet
288 sub lilypond_css_lines ($$)
290 my $import_lines = shift;
291 my $rule_lines = shift;
292 return if (defined($Texi2HTML::THISDOC{'CSS_LINES'}));
293 if (@$rule_lines or @$import_lines)
295 $Texi2HTML::THISDOC{'CSS_LINES'} = "<style type=\"text/css\">\n<!--\n";
296 $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$import_lines) . "\n" if (@$import_lines);
297 $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$rule_lines) . "\n" if (@$rule_lines);
298 $Texi2HTML::THISDOC{'CSS_LINES'} .= "-->\n</style>\n";
300 foreach my $ref (@CSS_REFS)
302 $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"stylesheet\" type=\"text/css\" title=\"$ref->{TITLE}\" href=\"$ref->{FILENAME}\">\n";
305 # GOP tweak: We don't have alternate stylesheets
306 #foreach my $ref (@Texi2HTML::Config::ALT_CSS_REFS)
308 # $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"alternate stylesheet\" type=\"text/css\" href=\"$ref->{FILENAME}\" title=\"$ref->{TITLE}\">\n";
311 # GOP tweak: We aren't using an IE-specific stylesheet
312 #$Texi2HTML::THISDOC{'CSS_LINES'} .= "<!--[if lte IE 7]>\n<link href=\"lilypond-ie-fixes.css\" rel=\"stylesheet\" type=\"text/css\">\n<![endif]-->\n";
319 #############################################################################
320 ### SPLITTING BASED ON NUMBERED SECTIONS
321 #############################################################################
323 # FIXME: removed for GOP.
326 #############################################################################
327 ### CLEANER LINK TITLE FOR EXTERNAL REFS
328 #############################################################################
330 # The default formatting of external refs returns e.g.
331 # "(lilypond-internals)Timing_translator", so we remove all (...) from the
332 # file_and_node argument. Also, we want only a very simple format, so we don't
333 # even call the default handler!
334 sub lilypond_external_ref($$$$$$)
339 my $file_node = shift;
341 my $cross_ref = shift;
343 my $displaytext = '';
345 # 1) if we have a cross ref name, that's the text to be displayed:
346 # 2) For the top node, use the (printable) name of the manual, unless we
347 # have an explicit cross ref name
348 # 3) In all other cases use the section name
349 if ($cross_ref ne '') {
350 $displaytext = $cross_ref;
351 } elsif (($section eq '') or ($section eq 'Top')) {
352 $displaytext = $book;
354 $displaytext = $section;
357 $displaytext = &$anchor('', $href, $displaytext) if ($displaytext ne '');
358 return &$I('%{node_file_href}', { 'node_file_href' => $displaytext });
365 #############################################################################
366 ### HANDLING TRANSLATED SECTIONS: handle @translationof, secname<->filename
367 ### map stored on disk, xrefs in other manuals load that map
368 #############################################################################
371 # Try to make use of @translationof to generate files according to the original
372 # English section title...
373 sub lilypond_unknown($$$$$)
381 # the @translationof macro provides the original English section title,
382 # which should be used for file/anchor naming, while the title will be
383 # translated to each language
384 # It is already used by extract_texi_filenames.py, so this should not be
385 # necessary here at all. Still, I'll leave the code in just in case the
386 # python script messed up ;-)
387 if ($pass == 1 and $macro eq "translationof") {
388 if (ref($state->{'element'}) eq 'HASH') {
389 $state->{'element'}->{'translationof'} = main::normalise_space($line);
391 return ('', 1, undef, undef);
393 return &$default_unknown($macro, $line, $pass, $stack, $state);
400 my %translated_books = ();
401 # Construct a href to an external source of information.
402 # node is the node with texinfo @-commands
403 # node_id is the node transliterated and transformed as explained in the
405 # node_xhtml_id is the node transformed such that it is unique and can
406 # be used to make an html cross ref as explained in the texinfo manual
407 # file is the file in '(file)node'
408 sub lilypond_external_href($$$)
412 my $node_hxmlt_id = shift;
415 # 1) Keep a hash of book->section_map
416 # 2) if not file in keys hash => try to load the map (assign empty map if
417 # non-existent => will load only once!)
418 # 3) if node in the section=>(file, anchor) map, replace node_id and
419 # node_xhtml_id by the map's values
420 # 4) call the default_external_href with these values (or the old ones if not found)
422 if (($node_id ne '') and defined($file) and ($node_id ne 'Top')) {
423 my $map_name = $file;
424 $map_name =~ s/-big-page//;
426 # Load the map if we haven't done so already
427 if (!exists($translated_books{$map_name})) {
428 my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
429 my $map_filename = main::locate_include_file ("${map_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
430 || main::locate_include_file ("${map_name}.xref-map");
431 $translated_books{$map_name} = load_map_file ($map_filename);
434 # look up translation. use these values instead of the old filename/anchor
435 my $section_name_map = $translated_books{$map_name};
436 my $node_text = main::remove_texi($node);
437 if (defined($section_name_map->{$node_text})) {
438 ($node_id, $node_hxmlt_id) = @{$section_name_map->{$node_text}};
440 print STDERR "WARNING: Unable to find node '$node_text' in book $map_name.\n";
445 return &$default_external_href($node, $node_id, $node_hxmlt_id, $file);
447 return &$default_external_href($node, $node_id, $node_hxmlt_id);
455 #############################################################################
456 ### CUSTOM TOC FOR EACH PAGE (in a frame on the left)
457 #############################################################################
459 my $page_toc_depth = 2;
460 my @default_toc = [];
463 # Initialize the toc_depth to 1 if the command-line option -D=short_toc is given
464 sub lilypond_init_toc_depth ()
466 if (exists($main::value{'short_toc'}) and not exists($main::value{'bigpage'})) {
470 # Set the TOC-depth (depending on a texinfo variable short_toc) in a
471 # command-handler, so we have them available when creating the pages
472 push @Texi2HTML::Config::command_handler_process, \&lilypond_init_toc_depth;
475 # recursively generate the TOC entries for the element and its children (which
476 # are only shown up to maxlevel. All ancestors of the current element are also
477 # shown with their immediate children, irrespective of their level.
478 # Unnumbered entries are only printed out if they are at top-level or 2nd level
479 # or their parent element is an ancestor of the currently viewed node.
480 # The conditions to call this method to print the entry for a child node is:
481 # -) the parent is an ancestor of the current page node
482 # -) the parent is a numbered element at top-level toplevel (i.e. show numbered
483 # and unnumbered 2nd-level children of numbered nodes)
484 # -) the child element is a numbered node below level maxlevel
485 sub generate_ly_toc_entries($$$)
488 my $element_path = shift;
490 #my $maxlevel = shift;
492 # Skip undefined sections, plus all sections generated by index splitting
493 return() if (not defined($element) or exists($element->{'index_page'}));
495 my $level = $element->{'toc_level'};
496 my $is_parent_of_current = $element->{'id'} && $element_path->{$element->{'id'}};
497 my $ind = ' ' x $level;
498 # GDP hack: leave this open for color
499 my $this_css_class = " class=\"";
500 $this_css_class .= $is_parent_of_current ? " toc_current" : "";
502 # GDP tweak: if the node name is in the color_X list
503 # TODO: use a hash, load from file?
504 # FIXME: load from file, to allow for translations!
508 "Learning", "Glossary", "Essay",
509 "Contact", "Tiny examples", "Bug reports"
512 "Features", "Examples", "Freedom",
513 "Unix", "MacOS X", "Windows",
514 "Notation", "Usage", "Snippets",
515 "Help us", "Development", "Authors"
518 "Productions", "Testimonials",
519 "Source", "Old downloads",
520 "FAQ", "Changes", "Internals",
521 "Publications", "Old news"
526 "Translated", "Old", "FDL"
529 my $addColor = " colorDefault";
530 foreach $color (@color_1) {
531 if ($element->{'text'} eq $color) {
532 $addColor = " color1";
535 foreach $color (@color_2) {
536 if ($element->{'text'} eq $color) {
537 $addColor = " color2";
540 foreach $color (@color_3) {
541 if ($element->{'text'} eq $color) {
542 $addColor = " color3";
545 foreach $color (@color_4) {
546 if ($element->{'text'} eq $color) {
547 $addColor = " color4";
551 $this_css_class .= $addColor . "\"";
556 my $entry = "$ind<li$this_css_class>" . &$anchor ($element->{'tocid'}, "$element->{'file'}#$element->{'target'}",$element->{'text'});
558 push (@result, $entry);
559 my $children = $element->{'section_childs'};
560 if (defined($children) and (ref($children) eq "ARRAY")) {
561 my $force_children = $is_parent_of_current or ($level == 1 and $element->{'number'});
562 my @child_result = ();
563 foreach my $c (@$children) {
564 my $is_numbered_child = defined ($c->{'number'});
565 my $below_maxlevel = $c->{'toc_level'} le $maxlevel;
566 if ($force_children or ($is_numbered_child and $below_maxlevel)) {
567 my @child_res = generate_ly_toc_entries($c, $element_path, $maxlevel);
568 push (@child_result, @child_res);
571 # if no child nodes were generated, e.g. for the index, where expanded pages
572 # are ignored, don't generate a list at all...
574 push (@result, "\n$ind<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
576 # GOP tweak: (next 2 lines; alternates)
577 push (@result, "$ind<li$this_css_class>" . &$anchor ($element->{'tocid'}, "$element->{'file'}#$element->{'target'}","(main)"));
578 #push (@result, "$ind<li$this_css_class>" . &$anchor ($element->{'tocid'}, "$element->{'file'}#$element->{'target'}","(".$element->{'text'}." main)"));
579 push (@result, @child_result);
580 push (@result, "$ind</ul>\n");
583 push (@result, "$ind</li>\n");
588 # Print a customized TOC, containing only the first two levels plus the whole
589 # path to the current page
590 sub lilypond_generate_page_toc_body($)
593 my $current_element = $element;
595 $parentelements{$element->{'id'}} = 1;
596 # Find the path to the current element
597 while ( defined($current_element->{'sectionup'}) and
598 ($current_element->{'sectionup'} ne $current_element) )
600 $parentelements{$current_element->{'sectionup'}->{'id'}} = 1
601 if ($current_element->{'sectionup'}->{'id'} ne '');
602 $current_element = $current_element->{'sectionup'};
604 return () if not defined($current_element);
605 # Create the toc entries recursively
607 my @toc_entries = ("<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
608 # my @toc_entries = ("<div class=\"contents\">\n", "<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
610 # FIXME: add link to main page, really hackily.
611 if ($element->{'sectionup'}) {
612 # it's not the top element
613 push (@toc_entries, "<li><a href=\"index.html\">Main</a></li>\n");
615 push (@toc_entries, "<li class=\"toc_current\"><a href=\"index.html\">Main</a></li>\n");
618 my $children = $current_element->{'section_childs'};
619 # FIXME: generate toc
620 foreach ( @$children ) {
621 push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth));
623 # FIXME: add search entry box
624 push (@toc_entries, "<li><form action=\"#\" method=\"get\"><input onfocus=\"this.value=''\" type=\"text\" name=\"search\" id=\"search\" value=\"Search\"></form></li>\n");
626 push (@toc_entries, "</ul>\n");
628 # push (@toc_entries, "</div>\n");
629 push (@toc_entries, "\n");
633 sub lilypond_print_toc_div ($$)
637 my @lines = @$tocref;
638 # use default TOC if no custom lines have been generated
639 @lines = @default_toc if (not @lines);
642 print $fh "\n\n<div id=\"tocframe\">\n";
643 #print $fh "<div class=\"contents\">\n";
645 # Remove the leading "GNU LilyPond --- " from the manual title
646 my $topname = $Texi2HTML::NAME{'Top'};
647 $topname =~ s/^GNU LilyPond(:| &[mn]dash;) //;
649 # construct the top-level Docs index (relative path and including language!)
650 my $lang = $Texi2HTML::THISDOC{current_lang};
651 if ($lang and $lang ne "en") {
657 $reldir = "../" if ($Texi2HTML::Config::SPLIT eq 'section');
658 my $uplink = $reldir."index.${lang}html";
660 # print $fh "<p class=\"toc_uplink\"><a href=\"$uplink\"
661 # title=\"Documentation Index\"><< " .
662 # &ly_get_string ('Back to Documentation Index') .
665 # print $fh '<h4 class="toc_header"> ' . &$anchor('',
666 # $Texi2HTML::HREF{'Top'},
668 # 'title="Start of the manual"'
672 foreach my $line (@lines) {
676 print $fh "</div>\n\n";
680 # Create the custom TOC for this page (partially folded, current page is
681 # highlighted) and store it in a global variable. The TOC is written out after
682 # the html contents (but positioned correctly using CSS), so that browsers with
683 # css turned off still show the contents first.
684 our @this_page_toc = ();
685 sub lilypond_print_element_header
687 my $first_in_page = shift;
688 my $previous_is_top = shift;
689 if ($first_in_page and not @this_page_toc) {
690 if (defined($Texi2HTML::THIS_ELEMENT)) {
691 # Create the TOC for this page
692 @this_page_toc = lilypond_generate_page_toc_body($Texi2HTML::THIS_ELEMENT);
695 return &$default_print_element_header( $first_in_page, $previous_is_top);
698 # Generate the HTML output for the TOC
699 sub lilypond_toc_body($)
701 my $elements_list = shift;
702 # Generate a default TOC for pages without THIS_ELEMENT
703 @default_toc = lilypond_generate_page_toc_body(@$elements_list[0]);
704 return &$default_toc_body($elements_list);
707 # Print out the TOC in a <div> at the beginning of the page
708 sub lilypond_print_page_head($)
711 &$default_print_page_head($fh);
712 print $fh "<div id=\"main\">\n";
715 # Print out the TOC in a <div>, which will be formatted as a
716 # sidebar mimicking a TOC frame
717 sub print_lilypond_page_foot($)
720 my $program_string = &$program_string();
721 # print $fh "<p><font size='-1'>$program_string</font><br>$PRE_BODY_CLOSE</p>\n";
723 # Do not include language selection in div#main
724 print $fh "<!-- end div#main here -->\n</div>\n\n";
726 print $fh "<!-- FOOTER -->\n\n";
727 print $fh "<div id=\"footer\">\n";
728 print $fh "<div id=\"language\">\n";
729 print $fh "<h3>Other languages</h3>\n";
730 print $fh "<p><a href=\"\">Deutsch</a>, Español, Français, Magyar.</p>\n";
731 print $fh "<p>About automatic language selection.</p>\n";
732 print $fh "</div>\n";
734 print $fh "<div id=\"verifier_texinfo\">\n";
735 print $fh "<h3>Validation</h3>\n";
736 print $fh "<p>Thanks to <a href=\"http://www.webdev.nl/\">webdev.nl</a>";
737 print $fh " for hosting <code>lilypond.org</code>.\n";
738 print $fh "<a href=\"http://validator.w3.org/check?uri=referer\">\n";
739 print $fh "<img src=\"http://www.w3.org/Icons/valid-html401\"\n";
740 print $fh " alt=\"Valid HTML 4.01 Transitional\"\n";
741 print $fh " height=\"31\" width=\"88\"></a></p>\n";
742 print $fh "<p>Web pages created with";
743 print $fh " <a href=\"http://www.gnu.org/software/texinfo/\">";
744 print $fh " GNU Texinfo</a>\n";
745 print $fh " and <a href=\"http://www.nongnu.org/texi2html/\">";
746 print $fh " texi2html</a>.</p>\n";
750 # Print the TOC frame and reset the TOC:
751 lilypond_print_toc_div ($fh, \@this_page_toc);
755 print $fh "</body>\n</html>\n";
762 #############################################################################
763 ### NICER / MORE FLEXIBLE NAVIGATION PANELS
764 #############################################################################
766 sub get_navigation_text
769 my $text = $NAVIGATION_TEXT{$button};
770 if ( ($button eq 'Back') or ($button eq 'FastBack') ) {
771 $text = $text . $Texi2HTML::NODE{$button} . " ";
772 } elsif ( ($button eq 'Forward') or ($button eq 'FastForward') ) {
773 $text = " " . $Texi2HTML::NODE{$button} . $text;
774 } elsif ( $button eq 'Up' ) {
775 $text = " ".$text.": " . $Texi2HTML::NODE{$button} . " ";
781 # Don't automatically create left-aligned table cells for every link, but
782 # instead create a <td> only on an appropriate '(left|right|center)-aligned-cell-n'
783 # button text. It's alignment as well as the colspan will be taken from the
784 # name of the button. Also, add 'newline' button text to create a new table
785 # row. The texts of the buttons are generated by get_navigation_text and
786 # will contain the name of the next/previous section/chapter.
787 sub lilypond_print_navigation
790 my $vertical = shift;
792 my $result = "<table class=\"nav_table\">\n";
794 $result .= "<tr>" unless $vertical;
796 foreach my $button (@$buttons)
798 $result .= qq{<tr valign="top" align="left">\n} if $vertical;
799 # Allow (left|right|center)-aligned-cell and newline as buttons!
800 if ( $button =~ /^(.*)-aligned-cell-(.*)$/ )
802 $result .= qq{</td>} unless $beginofline;
803 $result .= qq{<td valign="middle" align="$1" colspan="$2">};
806 elsif ( $button eq 'newline' )
808 $result .= qq{</td>} unless $beginofline;
809 $result .= qq{</tr>};
814 elsif (ref($button) eq 'CODE')
816 $result .= &$button($vertical);
818 elsif (ref($button) eq 'SCALAR')
820 $result .= "$$button" if defined($$button);
822 elsif (ref($button) eq 'ARRAY')
824 my $text = $button->[1];
825 my $button_href = $button->[0];
826 # verify that $button_href is simple text and text is a reference
827 if (defined($button_href) and !ref($button_href)
828 and defined($text) and (ref($text) eq 'SCALAR') and defined($$text))
830 if ($Texi2HTML::HREF{$button_href})
832 my $anchor_attributes = '';
833 if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button_href})) and ($BUTTONS_ACCESSKEY{$button_href} ne ''))
835 $anchor_attributes = "accesskey=\"$BUTTONS_ACCESSKEY{$button_href}\"";
837 if ($USE_REL_REV and (defined($BUTTONS_REL{$button_href})) and ($BUTTONS_REL{$button_href} ne ''))
839 $anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\"";
843 $Texi2HTML::HREF{$button_href},
844 get_navigation_text($$text),
850 $result .= get_navigation_text($$text);
854 elsif ($button eq ' ')
855 { # handle space button
857 ($ICONS && $ACTIVE_ICONS{' '}) ?
858 &$button_icon_img($BUTTONS_NAME{$button}, $ACTIVE_ICONS{' '}) :
859 $NAVIGATION_TEXT{' '};
862 elsif ($Texi2HTML::HREF{$button})
864 my $btitle = $BUTTONS_GOTO{$button} ?
865 'title="' . $BUTTONS_GOTO{$button} . '"' : '';
866 if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button})) and ($BUTTONS_ACCESSKEY{$button} ne ''))
868 $btitle .= " accesskey=\"$BUTTONS_ACCESSKEY{$button}\"";
870 if ($USE_REL_REV and (defined($BUTTONS_REL{$button})) and ($BUTTONS_REL{$button} ne ''))
872 $btitle .= " rel=\"$BUTTONS_REL{$button}\"";
874 if ($ICONS && $ACTIVE_ICONS{$button})
878 $Texi2HTML::HREF{$button},
879 &$button_icon_img($BUTTONS_NAME{$button},
880 $ACTIVE_ICONS{$button},
881 $Texi2HTML::SIMPLE_TEXT{$button}),
890 $Texi2HTML::HREF{$button},
891 get_navigation_text($button),
898 { # button is passive
900 $ICONS && $PASSIVE_ICONS{$button} ?
901 &$button_icon_img($BUTTONS_NAME{$button},
902 $PASSIVE_ICONS{$button},
903 $Texi2HTML::SIMPLE_TEXT{$button}) :
905 "[" . get_navigation_text($button) . "]";
907 $result .= "</td>\n" if $vertical;
908 $result .= "</tr>\n" if $vertical;
910 $result .= "</td>" unless $beginofline;
911 $result .= "</tr>" unless $vertical;
912 $result .= "</table>\n";
918 @Texi2HTML::Config::SECTION_BUTTONS =
919 ('left-aligned-cell-1', 'FastBack',
920 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
921 'right-aligned-cell-1', 'FastForward',
923 'left-aligned-cell-2', 'Back',
924 'center-aligned-cell-1', 'Up',
925 'right-aligned-cell-2', 'Forward'
928 # buttons for misc stuff
929 @Texi2HTML::Config::MISC_BUTTONS = ('center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About');
931 # buttons for chapter file footers
932 # (and headers but only if SECTION_NAVIGATION is false)
933 @Texi2HTML::Config::CHAPTER_BUTTONS =
934 ('left-aligned-cell-1', 'FastBack',
935 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
936 'right-aligned-cell-1', 'FastForward',
939 # buttons for section file footers
940 @Texi2HTML::Config::SECTION_FOOTER_BUTTONS =
941 ('left-aligned-cell-1', 'FastBack',
942 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
943 'right-aligned-cell-1', 'FastForward',
945 'left-aligned-cell-2', 'Back',
946 'center-aligned-cell-1', 'Up',
947 'right-aligned-cell-2', 'Forward'
950 @Texi2HTML::Config::NODE_FOOTER_BUTTONS =
951 ('left-aligned-cell-1', 'FastBack',
952 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
953 'right-aligned-cell-1', 'FastForward',
955 'left-aligned-cell-2', 'Back',
956 'center-aligned-cell-1', 'Up',
957 'right-aligned-cell-2', 'Forward'
964 #############################################################################
965 ### FOOTNOTE FORMATTING
966 #############################################################################
968 # Format footnotes in a nicer way: Instead of printing the number in a separate
969 # (nr) heading line, use the standard way of prepending <sup>nr</sup> immediately
970 # before the fn text.
973 # The following code is copied from texi2html's examples/makeinfo.init and
974 # should be updated when texi2html makes some changes there!
976 my $makekinfo_like_footnote_absolute_number = 0;
978 sub makeinfo_like_foot_line_and_ref($$$$$$$$)
980 my $foot_num = shift;
981 my $relative_num = shift;
984 my $from_file = shift;
985 my $footnote_file = shift;
989 $makekinfo_like_footnote_absolute_number++;
991 # this is a bit obscure, this allows to add an anchor only if formatted
992 # as part of the document.
993 $docid = '' if ($state->{'outside_document'} or $state->{'multiple_pass'});
995 if ($from_file eq $footnote_file)
997 $from_file = $footnote_file = '';
1000 my $foot_anchor = "<sup>" . &$anchor($docid, "$footnote_file#$footid", $relative_num) . "</sup>";
1001 $foot_anchor = &$anchor($docid, "$footnote_file#$footid", "($relative_num)") if ($state->{'preformatted'});
1003 # unshift @$lines, "<li>";
1004 # push @$lines, "</li>\n";
1005 return ($lines, $foot_anchor);
1008 sub makeinfo_like_foot_lines($)
1011 unshift @$lines, "<hr>\n<h4>$Texi2HTML::I18n::WORDS->{'Footnotes_Title'}</h4>\n";
1012 #<ol type=\"1\">\n";
1013 # push @$lines, "</ol>";
1017 my %makekinfo_like_paragraph_in_footnote_nr;
1019 sub makeinfo_like_paragraph ($$$$$$$$$$$$$)
1024 my $paragraph_command = shift;
1025 my $paragraph_command_formatted = shift;
1026 my $paragraph_number = shift;
1028 my $item_nr = shift;
1029 my $enumerate_style = shift;
1031 my $command_stack_at_end = shift;
1032 my $command_stack_at_begin = shift;
1034 #print STDERR "format: $format\n" if (defined($format));
1035 #print STDERR "paragraph @$command_stack_at_end; @$command_stack_at_begin\n";
1036 $paragraph_command_formatted = '' if (!defined($paragraph_command_formatted) or
1037 exists($special_list_commands{$format}->{$paragraph_command}));
1038 return '' if ($text =~ /^\s*$/);
1039 foreach my $style(t2h_collect_styles($command_stack_at_begin))
1041 $text = t2h_begin_style($style, $text);
1043 foreach my $style(t2h_collect_styles($command_stack_at_end))
1045 $text = t2h_end_style($style, $text);
1047 if (defined($paragraph_number) and defined($$paragraph_number))
1049 $$paragraph_number++;
1050 return $text if (($format eq 'itemize' or $format eq 'enumerate') and
1051 ($$paragraph_number == 1));
1056 $open .= " align=\"$paragraph_style{$align}\"";
1058 my $footnote_text = '';
1059 if (defined($command_stack_at_begin->[0]) and $command_stack_at_begin->[0] eq 'footnote')
1061 my $state = $Texi2HTML::THISDOC{'state'};
1062 $makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number}++;
1063 if ($makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number} <= 1)
1065 $open.=' class="footnote"';
1066 my $document_file = $state->{'footnote_document_file'};
1067 if ($document_file eq $state->{'footnote_footnote_file'})
1069 $document_file = '';
1071 my $docid = $state->{'footnote_place_id'};
1072 my $doc_state = $state->{'footnote_document_state'};
1073 $docid = '' if ($doc_state->{'outside_document'} or $doc_state->{'multiple_pass'});
1074 my $foot_label = &$anchor($state->{'footnote_footnote_id'},
1075 $document_file . "#$state->{'footnote_place_id'}",
1076 "$state->{'footnote_number_in_page'}");
1077 $footnote_text = "<small>[${foot_label}]</small> ";
1080 return $open.'>'.$footnote_text.$text.'</p>';
1084 #############################################################################
1086 #############################################################################
1088 # For split pages, use index.html as start page!
1089 if ($Texi2HTML::Config::SPLIT eq 'section') {
1090 $Texi2HTML::Config::TOP_FILE = 'index.html';