3 ### texi2html customization script for Lilypond
4 ### Author: Reinhold Kainhofer <reinhold@kainhofer.com>, 2008.
5 ### Some code parts copied from texi2html and adapted. These functions
6 ### were written mainly by Patrice Dumas
10 ### Features implemented here:
11 ### -) For split manuals, the main page is index.html.
12 ### -) All @unnumbered* sections are placed into the same file
13 ### (implemented by split_at_numbered_sections)
14 ### -) Use our custom CSS file, with IE-specific fixes in another CSS file,
15 ### impelmented by lilypond_css_lines
16 ### -) TOC (folded, with the current page highlighted) in an overflown <div>
17 ### is added to every page; implemented by:
18 ### lilypond_print_element_header -- building of the TOC
19 ### lilypond_toc_body -- generation of customized TOC output
20 ### lilypond_print_page_head -- start <div id="main">
21 ### print_lilypond_page_foot -- closing id=main, output of footer & TOC
22 ### -) External refs are formatted only as "Text of the node" (not as >>see
23 ### "NODE" section "SECTION" in "BOOK"<< like with default texi2html). Also,
24 ### the leading "(book-name)" is removed.
25 ### Implemented by overriding lilypond_external_ref
26 ### -) Navigation bars on top/bottom of the page and between sections are not
27 ### left-aligned, but use a combination of left/center/right aligned table
28 ### cells; For this, I heavily extend the texi2html code to allow for
29 ### differently aligned cells and for multi-line tables);
30 ### Implemented in lilypond_print_navigation
31 ### -) Different formatting than the default: example uses the same formatting
33 ### -) Allow translated section titles: All section titles can be translated,
34 ### the original (English) title is associated with @translationof. This is
35 ### needed, because the file name / anchor is generated from the original
36 ### English title, since otherwise language-autoselection would break with
38 ### Since it is then no longer possible to obtain the file name from the
39 ### section title, I keep a sectionname<=>filename/anchor around. This way,
40 ### xrefs from other manuals can simply load that map and retrieve the
41 ### correct file name for the link. Implemented in:
42 ### lilypond_unknown (handling of @translationof, in case
43 ### extract_texi_filenames.py messes up...)
44 ### lilypond_element_file_name (correct file name: use the map)
45 ### lilypond_element_target_name (correct anchor: use the map)
46 ### lilypond_init_map (read in the externally created map from disk)
47 ### lilypond_external_href (load the map for xrefs, use the correct
49 ### -) The HTML anchors for all sections are derived from the node name /
50 ### section title (pre-generated in the .xref-map file). Implemented by:
51 ### lilypond_element_target_name (adjust section anchors)
52 ### -) Use the standard footnote format "<sup>nr</sup> text" instead of the
53 ### ugly format of texi2html (<h3>(nr)</h3><p>text</p>). Implemented in
54 ### makeinfo_like_foot_line_and_ref
55 ### makeinfo_like_foot_lines
56 ### makeinfo_like_paragraph
59 ### Useful helper functions:
60 ### -) texinfo_file_name($node_name): returns a texinfo-compatible file name
61 ### for the given string $node_name (whitespace trimmed/replaced by -,
62 ### non-standard chars replaced by _xxxx (ascii char code) and forced to
63 ### start with a letter by prepending t_g if necessary)
66 package Texi2HTML::Config;
72 #############################################################################
73 ### SETTINGS FOR TEXI2HTML
74 #############################################################################
76 @Texi2HTML::Config::CSS_REFS = (
77 {FILENAME => "lilypond-mccarty.css", TITLE => "Patrick McCarty's design"}
79 @Texi2HTML::Config::ALT_CSS_REFS = (
80 {FILENAME => "lilypond.css", TITLE => "Andrew Hawryluk's design" },
81 {FILENAME => "lilypond-blue.css", TITLE => "Kurt Kroon's blue design" },
83 $Texi2HTML::Config::USE_ACCESSKEY = 1;
84 $Texi2HTML::Config::USE_LINKS = 1;
85 $Texi2HTML::Config::USE_REL_REV = 1;
86 $Texi2HTML::Config::SPLIT_INDEX = 0;
87 $Texi2HTML::Config::SEPARATED_FOOTNOTES = 0; # Print footnotes on same page, not separated
88 if ($Texi2HTML::Config::SPLIT eq 'section') {
89 $Texi2HTML::Config::element_file_name = \&lilypond_element_file_name;
91 $Texi2HTML::Config::element_target_name = \&lilypond_element_target_name;
92 $Texi2HTML::Config::print_element_header = \&lilypond_print_element_header;
93 $Texi2HTML::Config::print_page_foot = \&print_lilypond_page_foot;
94 $Texi2HTML::Config::print_navigation = \&lilypond_print_navigation;
95 $Texi2HTML::Config::external_ref = \&lilypond_external_ref;
96 $Texi2HTML::Config::external_href = \&lilypond_external_href;
97 $Texi2HTML::Config::toc_body = \&lilypond_toc_body;
98 $Texi2HTML::Config::css_lines = \&lilypond_css_lines;
99 $Texi2HTML::Config::unknown = \&lilypond_unknown;
100 $Texi2HTML::Config::print_page_head = \&lilypond_print_page_head;
101 # $Texi2HTML::Config::foot_line_and_ref = \&lilypond_foot_line_and_ref;
102 $Texi2HTML::Config::foot_line_and_ref = \&makeinfo_like_foot_line_and_ref;
103 $Texi2HTML::Config::foot_lines = \&makeinfo_like_foot_lines;
104 $Texi2HTML::Config::paragraph = \&makeinfo_like_paragraph;
108 # Examples should be formatted similar to quotes:
109 $Texi2HTML::Config::complex_format_map->{'example'} = {
110 'begin' => q{"<blockquote><pre class=\"example\">"},
111 'end' => q{"</pre></blockquote>\n"},
114 %Texi2HTML::config::misc_pages_targets = (
115 'Overview' => 'Overview',
116 'Contents' => 'Contents',
121 my @section_to_filename;
126 #############################################################################
128 #############################################################################
131 $Data::Dumper::Maxdepth = 2;
133 sub print_element_info($)
136 print "~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
137 print "Element: $element\n";
138 print Dumper($element);
145 #############################################################################
147 #############################################################################
149 # Convert a given node name to its proper file name (normalization as explained
150 # in the texinfo manual:
151 # http://www.gnu.org/software/texinfo/manual/texinfo/html_node/HTML-Xref-Node-Name-Expansion.html
152 sub texinfo_file_name($)
156 # File name normalization by texinfo:
157 # 1/2: letters and numbers are left unchanged
158 # 3/4: multiple, leading and trailing whitespace is removed
159 $text = main::normalise_space($text);
160 # 5/6: all remaining spaces are converted to '-', all other 7- or 8-bit
161 # chars are replaced by _xxxx (xxxx=ascii character code)
162 while ($text ne '') {
163 if ($text =~ s/^([A-Za-z0-9]+)//o) { # number or letter stay unchanged
165 } elsif ($text =~ s/^ //o) { # space -> '-'
167 } elsif ($text =~ s/^(.)//o) { # Otherwise use _xxxx (ascii char code)
169 if ( $ccode <= 0xFFFF ) {
170 $result .= sprintf("_%04x", $ccode);
172 $result .= sprintf("__%06x", $ccode);
176 # 7: if name does not begin with a letter, prepend 't_g' (so it starts with a letter)
177 if ($result !~ /^[a-zA-Z]/) {
178 $result = 't_g' . $result;
185 # Load a file containing a nodename<=>filename map (tab-sepatared, i.e.
186 # NODENAME\tFILENAME\tANCHOR
187 # Returns a ref to a hash "Node title" => ["FilenameWithoutExt", "Anchor"]
188 sub load_map_file ($)
193 if (open(XREFFILE, $mapfile)) {
195 while ( $line = <XREFFILE> ) {
196 # parse the tab-separated entries and insert them into the map:
198 my @entries = split(/\t/, $line);
199 if (scalar (@entries) == 3) {
200 $node_map->{$entries[0]} = [$entries[1], $entries[2]];
202 print STDERR "Invalid entry in the node file $mapfile: $line\n";
207 print STDERR "WARNING: Unable to load the map file $mapfile\n";
213 # Split the given path into dir and basename (with .texi removed). Used mainly
214 # to get the path/basename of the original texi input file
215 sub split_texi_filename ($)
218 my $docu_dir, $docu_name;
219 if ($docu =~ /(.*\/)/) {
220 chop($docu_dir = $1);
222 $docu_name =~ s/.*\///;
227 $docu_name =~ s/\.te?x(i|info)?$//;
228 return ($docu_dir, $docu_name);
235 #############################################################################
237 #############################################################################
239 # Include our standard CSS file, not hard-coded CSS code directly in the HTML!
240 # For IE, conditionally include the lilypond-ie-fixes.css style sheet
241 sub lilypond_css_lines ($$)
243 my $import_lines = shift;
244 my $rule_lines = shift;
245 return if (defined($Texi2HTML::THISDOC{'CSS_LINES'}));
246 if (@$rule_lines or @$import_lines)
248 $Texi2HTML::THISDOC{'CSS_LINES'} = "<style type=\"text/css\">\n<!--\n";
249 $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$import_lines) . "\n" if (@$import_lines);
250 $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$rule_lines) . "\n" if (@$rule_lines);
251 $Texi2HTML::THISDOC{'CSS_LINES'} .= "-->\n</style>\n";
253 foreach my $ref (@CSS_REFS)
255 $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"stylesheet\" type=\"text/css\" title=\"$ref->{TITLE}\" href=\"$ref->{FILENAME}\">\n";
257 foreach my $ref (@ALT_CSS_REFS)
259 $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"alternate stylesheet\" type=\"text/css\" href=\"$ref->{FILENAME}\" title=\"$ref->{TITLE}\">\n";
261 $Texi2HTML::THISDOC{'CSS_LINES'} .= "<!--[if lte IE 7]>\n<link href=\"lilypond-ie-fixes.css\" rel=\"stylesheet\" type=\"text/css\">\n<![endif]-->\n";
268 #############################################################################
269 ### SPLITTING BASED ON NUMBERED SECTIONS
270 #############################################################################
274 my $node_to_filename_map = ();
277 # This function makes sure that files are only generated for numbered sections,
278 # but not for unnumbered ones. It is called after texi2html has done its own
279 # splitting and simply returns the filename for the node given as first argument
280 # Nodes with the same filename will be printed out to the same filename, so
281 # this really all we need. Also, make sure that the file names for sections
282 # are derived from the section title. We also might want to name the anchors
283 # according to node titles, which works by simply overriding the id element of
285 # If an external nodename<=>filename/anchor map file is found (loaded in
286 # lilypond_init_out, use the externally created values, otherwise use the
288 sub lilypond_element_file_name($$$)
292 my $docu_name = shift;
293 my $docu_ext = $Texi2HTML::Config::EXTENSION;
295 my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
296 # the snippets page does not use nodes for the snippets, so in this case
297 # we'll have to use the section name!
298 if ($node_name eq '') {
299 $node_name = main::remove_texi($element->{'texi'});
302 # If we have an entry in the section<=>filename map, use that one, otherwise
303 # generate the filename/anchor here. In the latter case, external manuals
304 # will not be able to retrieve the file name for xrefs!!! Still, I already
305 # had that code, so I'll leave it in in case something goes wrong with the
306 # extract_texi_filenames.py script in the lilypond build process!
307 if (exists ($node_to_filename_map->{$node_name})) {
308 (my $filename, my $anchor) = @{$node_to_filename_map->{$node_name}};
309 $filename .= ".$docu_ext" if (defined($docu_ext));
311 # unnumbered sections (except those at top-level!) always go to the same
312 # file as the previous numbered section
313 if (not ($element->{number}) and not ($lastfilename eq '') and ($element->{level} > 1)) {
314 $filename = $lastfilename;
316 if (($filename eq $lastfilename)) {
317 $$element{doc_nr} = $docnr;
320 $$element{doc_nr} = $docnr;
321 $lastfilename = $filename;
325 } elsif ($type eq "top" or $type eq "toc" or $type eq "doc" or $type eq "stoc" or $type eq "foot" or $type eq "about") {
328 print STDERR "WARNING: Node '$node_name' was NOT found in the map\n"
329 unless ($node_name eq '') or ($element->{'tag'} eq 'unnumberedsec')
330 or ($node_name =~ /NOT REALLY USED/);
332 # Numbered sections will get a filename Node_title, unnumbered sections will use
333 # the file name of the previous numbered section:
334 if (($element->{number}) or ($lastfilename eq '') or ($element->{level} == 1)) {
335 # normalize to the same file name as texinfo
336 if ($element->{translationof}) {
337 $node_name = main::remove_texi($element->{translationof});
339 my $filename = texinfo_file_name($node_name);
340 $filename .= ".$docu_ext" if (defined($docu_ext));
342 $$element{doc_nr} = $docnr;
343 $lastfilename = $filename;
346 $$element{doc_nr} = $docnr;
347 return $lastfilename;
354 sub lilypond_element_target_name($$$)
359 # Target is based on node name (or sec name for secs without node attached)
360 my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
361 if ($node_name eq '') {
362 $node_name = main::remove_texi($element->{'texi'});
365 # If we have an entry in the section<=>filename map, use that one, otherwise
366 # generate the anchor here.
367 if (exists ($node_to_filename_map->{$node_name})) {
368 (my $filename, $target) = @{$node_to_filename_map->{$node_name}};
370 my $anchor = $node_name;
371 if ($element->{translationof}) {
372 $anchor = main::remove_texi($element->{translationof});
374 # normalize to the same file name as texinfo
375 $target = texinfo_file_name($anchor);
377 # TODO: Once texi2html correctly prints out the target and not the id for
378 # the sections, change this back to ($id, $target)
379 return ($target, $target);
383 ## Load the map file for the corrently processed texi file. We do this
384 # using a command init handler, since texi2html does not have any
385 # other hooks that are called after THISDOC is filled but before phase 2
386 # of the texi2html conversion.
387 sub lilypond_init_map ()
389 my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
390 my $map_filename = main::locate_include_file ("${docu_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
391 || main::locate_include_file ("${docu_name}.xref-map");
392 $node_to_filename_map = load_map_file ($map_filename);
394 push @Texi2HTML::Config::command_handler_init, \&lilypond_init_map;
398 #############################################################################
399 ### CLEANER LINK TITLE FOR EXTERNAL REFS
400 #############################################################################
402 # The default formatting of external refs returns e.g.
403 # "(lilypond-internals)Timing_translator", so we remove all (...) from the
404 # file_and_node argument. Also, we want only a very simple format, so we don't
405 # even call the default handler!
406 sub lilypond_external_ref($$$$$$)
411 my $file_node = shift;
413 my $cross_ref = shift;
415 my $displaytext = '';
417 # 1) if we have a cross ref name, that's the text to be displayed:
418 # 2) For the top node, use the (printable) name of the manual, unless we
419 # have an explicit cross ref name
420 # 3) In all other cases use the section name
421 if ($cross_ref ne '') {
422 $displaytext = $cross_ref;
423 } elsif (($section eq '') or ($section eq 'Top')) {
424 $displaytext = $book;
426 $displaytext = $section;
429 $displaytext = &$anchor('', $href, $displaytext) if ($displaytext ne '');
430 return &$I('%{node_file_href}', { 'node_file_href' => $displaytext });
432 # Default: format as "see <a ..>NODE</a> section 'SECTION' in BOOK". We don't want this!
433 # return t2h_default_external_ref($type, $section, $book, $file_node, $href, $cross_ref);
440 #############################################################################
441 ### HANDLING TRANSLATED SECTIONS: handle @translationof, secname<->filename
442 ### map stored on disk, xrefs in other manuals load that map
443 #############################################################################
446 # Try to make use of @translationof to generate files according to the original
447 # English section title...
448 sub lilypond_unknown($$$$$)
456 # the @translationof macro provides the original English section title,
457 # which should be used for file/anchor naming, while the title will be
458 # translated to each language
459 # It is already used by extract_texi_filenames.py, so this should not be
460 # necessary here at all. Still, I'll leave the code in just in case the
461 # python script messed up ;-)
462 if ($pass == 1 and $macro eq "translationof") {
463 if (ref($state->{'element'}) eq 'HASH') {
464 $state->{'element'}->{'translationof'} = main::normalise_space($line);
466 return ('', true, undef, undef);
468 return t2h_default_unknown($macro, $line, $pass, $stack, $state);
475 my %translated_books = ();
476 # Construct a href to an external source of information.
477 # node is the node with texinfo @-commands
478 # node_id is the node transliterated and transformed as explained in the
480 # node_xhtml_id is the node transformed such that it is unique and can
481 # be used to make an html cross ref as explained in the texinfo manual
482 # file is the file in '(file)node'
483 sub lilypond_external_href($$$)
487 my $node_hxmlt_id = shift;
489 my $original_func = \&t2h_default_external_href;
491 # 1) Keep a hash of book->section_map
492 # 2) if not file in keys hash => try to load the map (assign empty map if
493 # non-existent => will load only once!)
494 # 3) if node in the section=>(file, anchor) map, replace node_id and
495 # node_xhtml_id by the map's values
496 # 4) call the t2h_default_external_href with these values (or the old ones if not found)
498 if (($node_id ne '') and defined($file) and ($node_id ne 'Top')) {
499 my $map_name = $file;
500 $map_name =~ s/-big-page//;
502 # Load the map if we haven't done so already
503 if (!exists($translated_books{$map_name})) {
504 my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
505 my $map_filename = main::locate_include_file ("${map_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
506 || main::locate_include_file ("${map_name}.xref-map");
507 $translated_books{$map_name} = load_map_file ($map_filename);
510 # look up translation. use these values instead of the old filename/anchor
511 my $section_name_map = $translated_books{$map_name};
512 my $node_text = main::remove_texi($node);
513 if (defined($section_name_map->{$node_text})) {
514 ($node_id, $node_hxmlt_id) = @{$section_name_map->{$node_text}};
516 print STDERR "WARNING: Unable to find node '$node_text' in book $map_name.\n";
521 return &$original_func($node, $node_id, $node_hxmlt_id, $file);
523 return &$original_func($node, $node_id, $node_hxmlt_id);
531 #############################################################################
532 ### CUSTOM TOC FOR EACH PAGE (in a frame on the left)
533 #############################################################################
535 my $page_toc_depth = 2;
536 my @default_toc = [];
538 # recursively generate the TOC entries for the element and its children (which
539 # are only shown up to maxlevel. All ancestors of the current element are also
540 # shown with their immediate children, irrespective of their level.
541 # Unnumbered entries are only printed out if they are at top-level or their
542 # parent element is an ancestor of the currently viewed node.
543 sub generate_ly_toc_entries($$$$)
546 my $element_path = shift;
547 my $maxlevel = shift;
548 my $always_show_unnumbered_children = shift;
549 # Skip undefined sections, plus all sections generated by index splitting
550 return() if (not defined($element) or exists($element->{'index_page'}));
552 my $level = $element->{'toc_level'};
553 my $is_parent_of_current = $element->{'id'} && $element_path->{$element->{'id'}};
554 my $print_children = ( ($level < $maxlevel) or $is_parent_of_current );
555 my $ind = ' ' x $level;
556 my $this_css_class = $is_parent_of_current ? " class=\"toc_current\"" : "";
558 my $entry = "$ind<li$this_css_class>" . &$anchor ($element->{'tocid'}, "$element->{'file'}#$element->{'target'}",$element->{'text'});
560 my $children = $element->{'section_childs'};
561 # Don't add unnumbered entries, unless they are at top-level or a parent of the current!
562 if (not ($element->{'number'} or $always_show_unnumbered_children)) {
565 if ( $print_children and defined($children) and (ref($children) eq "ARRAY") ) {
566 push (@result, $entry);
567 my @child_result = ();
568 foreach (@$children) {
569 push (@child_result, generate_ly_toc_entries($_, $element_path, $maxlevel, $is_parent_of_current));
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");
575 push (@result, @child_result);
576 push (@result, "$ind</ul></li>\n");
579 push (@result, $entry . "</li>\n");
585 # Print a customized TOC, containing only the first two levels plus the whole
586 # path to the current page
587 sub lilypond_generate_page_toc_body($)
590 my $current_element = $element;
592 $parentelements{$element->{'id'}} = 1;
593 # Find the path to the current element
594 while ( defined($current_element->{'sectionup'}) and
595 ($current_element->{'sectionup'} ne $current_element) )
597 $parentelements{$current_element->{'sectionup'}->{'id'}} = 1
598 if ($current_element->{'sectionup'}->{'id'} ne '');
599 $current_element = $current_element->{'sectionup'};
601 return () if not defined($current_element);
602 # Create the toc entries recursively
603 my @toc_entries = ("<div class=\"contents\">\n", "<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
604 my $children = $current_element->{'section_childs'};
605 foreach ( @$children ) {
606 push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth, False));
608 push (@toc_entries, "</ul>\n");
609 push (@toc_entries, "</div>\n");
613 sub lilypond_print_toc_div ($$)
617 my @lines = @$tocref;
618 # use default TOC if no custom lines have been generated
619 @lines = @default_toc if (not @lines);
622 print $fh "\n\n<div id=\"tocframe\">\n";
624 # Remove the leading "GNU LilyPond --- " from the manual title
625 my $topname = $Texi2HTML::NAME{'Top'};
626 $topname =~ s/^GNU LilyPond(:| &[mn]dash;) //;
628 # construct the top-level Docs index (relative path and including language!)
629 my $lang = $Texi2HTML::THISDOC{current_lang};
630 if ($lang and $lang ne "en") {
636 $reldir = "../" if ($Texi2HTML::Config::SPLIT eq 'section');
637 my $uplink = $reldir."index.${lang}html";
639 print $fh "<p class=\"toc_uplink\"><a href=\"$uplink\"
640 title=\"Documentation Index\"><< Back to
641 Documentation Index</a></p>\n";
643 print $fh '<h4 class="toc_header"> ' . &$anchor('',
644 $Texi2HTML::HREF{'Top'},
646 'title="Start of the manual"'
648 foreach my $line (@lines) {
651 print $fh "</div>\n\n";
655 # Create the custom TOC for this page (partially folded, current page is
656 # highlighted) and store it in a global variable. The TOC is written out after
657 # the html contents (but positioned correctly using CSS), so that browsers with
658 # css turned off still show the contents first.
659 our @this_page_toc = ();
660 sub lilypond_print_element_header
662 my $first_in_page = shift;
663 my $previous_is_top = shift;
664 if ($first_in_page and not @this_page_toc) {
665 if (defined($Texi2HTML::THIS_ELEMENT)) {
666 # Create the TOC for this page
667 @this_page_toc = lilypond_generate_page_toc_body($Texi2HTML::THIS_ELEMENT);
670 return T2H_DEFAULT_print_element_header( $first_in_page, $previous_is_top);
673 # Generate the HTML output for the TOC
674 sub lilypond_toc_body($)
676 my $elements_list = shift;
677 # Generate a default TOC for pages without THIS_ELEMENT
678 @default_toc = lilypond_generate_page_toc_body(@$elements_list[0]);
679 return T2H_GPL_toc_body($elements_list);
682 # Print out the TOC in a <div> at the beginning of the page
683 sub lilypond_print_page_head($)
686 T2H_DEFAULT_print_page_head($fh);
687 print $fh "<div id=\"main\">\n";
690 # Print out the TOC in a <div> at the end of th page, which will be formatted as a
691 # sidebar mimicking a TOC frame
692 sub print_lilypond_page_foot($)
695 my $program_string = &$program_string();
696 # print $fh "<p><font size='-1'>$program_string</font><br>$PRE_BODY_CLOSE</p>\n";
697 print $fh "<!-- FOOTER -->\n\n";
698 print $fh "<!-- end div#main here -->\n</div>\n\n";
700 # Print the TOC frame and reset the TOC:
701 lilypond_print_toc_div ($fh, \@this_page_toc);
705 print $fh "</body>\n</html>\n";
712 #############################################################################
713 ### NICER / MORE FLEXIBLE NAVIGATION PANELS
714 #############################################################################
716 sub get_navigation_text
719 my $text = $NAVIGATION_TEXT{$button};
720 if ( ($button eq 'Back') or ($button eq 'FastBack') ) {
721 $text = $text . $Texi2HTML::NODE{$button} . " ";
722 } elsif ( ($button eq 'Forward') or ($button eq 'FastForward') ) {
723 $text = " " . $Texi2HTML::NODE{$button} . $text;
724 } elsif ( $button eq 'Up' ) {
725 $text = " ".$text.": " . $Texi2HTML::NODE{$button} . " ";
731 # Don't automatically create left-aligned table cells for every link, but
732 # instead create a <td> only on an appropriate '(left|right|center)-aligned-cell-n'
733 # button text. It's alignment as well as the colspan will be taken from the
734 # name of the button. Also, add 'newline' button text to create a new table
735 # row. The texts of the buttons are generated by get_navigation_text and
736 # will contain the name of the next/previous section/chapter.
737 sub lilypond_print_navigation
740 my $vertical = shift;
742 my $result = "<table class=\"nav_table\">\n";
744 $result .= "<tr>" unless $vertical;
746 foreach my $button (@$buttons)
748 $result .= qq{<tr valign="top" align="left">\n} if $vertical;
749 # Allow (left|right|center)-aligned-cell and newline as buttons!
750 if ( $button =~ /^(.*)-aligned-cell-(.*)$/ )
752 $result .= qq{</td>} unless $beginofline;
753 $result .= qq{<td valign="middle" align="$1" colspan="$2">};
756 elsif ( $button eq 'newline' )
758 $result .= qq{</td>} unless $beginofline;
759 $result .= qq{</tr>};
764 elsif (ref($button) eq 'CODE')
766 $result .= &$button($vertical);
768 elsif (ref($button) eq 'SCALAR')
770 $result .= "$$button" if defined($$button);
772 elsif (ref($button) eq 'ARRAY')
774 my $text = $button->[1];
775 my $button_href = $button->[0];
776 # verify that $button_href is simple text and text is a reference
777 if (defined($button_href) and !ref($button_href)
778 and defined($text) and (ref($text) eq 'SCALAR') and defined($$text))
780 if ($Texi2HTML::HREF{$button_href})
782 my $anchor_attributes = '';
783 if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button_href})) and ($BUTTONS_ACCESSKEY{$button_href} ne ''))
785 $anchor_attributes = "accesskey=\"$BUTTONS_ACCESSKEY{$button_href}\"";
787 if ($USE_REL_REV and (defined($BUTTONS_REL{$button_href})) and ($BUTTONS_REL{$button_href} ne ''))
789 $anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\"";
793 $Texi2HTML::HREF{$button_href},
794 get_navigation_text($$text),
800 $result .= get_navigation_text($$text);
804 elsif ($button eq ' ')
805 { # handle space button
807 ($ICONS && $ACTIVE_ICONS{' '}) ?
808 &$button_icon_img($BUTTONS_NAME{$button}, $ACTIVE_ICONS{' '}) :
809 $NAVIGATION_TEXT{' '};
812 elsif ($Texi2HTML::HREF{$button})
814 my $btitle = $BUTTONS_GOTO{$button} ?
815 'title="' . $BUTTONS_GOTO{$button} . '"' : '';
816 if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button})) and ($BUTTONS_ACCESSKEY{$button} ne ''))
818 $btitle .= " accesskey=\"$BUTTONS_ACCESSKEY{$button}\"";
820 if ($USE_REL_REV and (defined($BUTTONS_REL{$button})) and ($BUTTONS_REL{$button} ne ''))
822 $btitle .= " rel=\"$BUTTONS_REL{$button}\"";
824 if ($ICONS && $ACTIVE_ICONS{$button})
828 $Texi2HTML::HREF{$button},
829 &$button_icon_img($BUTTONS_NAME{$button},
830 $ACTIVE_ICONS{$button},
831 $Texi2HTML::SIMPLE_TEXT{$button}),
840 $Texi2HTML::HREF{$button},
841 get_navigation_text($button),
848 { # button is passive
850 $ICONS && $PASSIVE_ICONS{$button} ?
851 &$button_icon_img($BUTTONS_NAME{$button},
852 $PASSIVE_ICONS{$button},
853 $Texi2HTML::SIMPLE_TEXT{$button}) :
855 "[" . get_navigation_text($button) . "]";
857 $result .= "</td>\n" if $vertical;
858 $result .= "</tr>\n" if $vertical;
860 $result .= "</td>" unless $beginofline;
861 $result .= "</tr>" unless $vertical;
862 $result .= "</table>\n";
867 @Texi2HTML::Config::SECTION_BUTTONS =
868 ('left-aligned-cell-1', 'FastBack',
869 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
870 'right-aligned-cell-1', 'FastForward',
872 'left-aligned-cell-2', 'Back',
873 'center-aligned-cell-1', 'Up',
874 'right-aligned-cell-2', 'Forward'
877 # buttons for misc stuff
878 @Texi2HTML::Config::MISC_BUTTONS = ('center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About');
880 # buttons for chapter file footers
881 # (and headers but only if SECTION_NAVIGATION is false)
882 @Texi2HTML::Config::CHAPTER_BUTTONS =
883 ('left-aligned-cell-1', 'FastBack',
884 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
885 'right-aligned-cell-1', 'FastForward',
888 # buttons for section file footers
889 @Texi2HTML::Config::SECTION_FOOTER_BUTTONS =
890 ('left-aligned-cell-1', 'FastBack',
891 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
892 'right-aligned-cell-1', 'FastForward',
894 'left-aligned-cell-2', 'Back',
895 'center-aligned-cell-1', 'Up',
896 'right-aligned-cell-2', 'Forward'
899 @Texi2HTML::Config::NODE_FOOTER_BUTTONS =
900 ('left-aligned-cell-1', 'FastBack',
901 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
902 'right-aligned-cell-1', 'FastForward',
904 'left-aligned-cell-2', 'Back',
905 'center-aligned-cell-1', 'Up',
906 'right-aligned-cell-2', 'Forward'
913 #############################################################################
914 ### FOOTNOTE FORMATTING
915 #############################################################################
917 # Format footnotes in a nicer way: Instead of printing the number in a separate
918 # (nr) heading line, use the standard way of prepending <sup>nr</sup> immediately
919 # before the fn text.
922 # The following code is copied from texi2html's examples/makeinfo.init and
923 # should be updated when texi2html makes some changes there!
925 my $makekinfo_like_footnote_absolute_number = 0;
927 sub makeinfo_like_foot_line_and_ref($$$$$$$$)
929 my $foot_num = shift;
930 my $relative_num = shift;
933 my $from_file = shift;
934 my $footnote_file = shift;
938 $makekinfo_like_footnote_absolute_number++;
940 # this is a bit obscure, this allows to add an anchor only if formatted
941 # as part of the document.
942 $docid = '' if ($state->{'outside_document'} or $state->{'multiple_pass'});
944 if ($from_file eq $footnote_file)
946 $from_file = $footnote_file = '';
949 my $foot_anchor = "<sup>" . &$anchor($docid, "$footnote_file#$footid", $relative_num) . "</sup>";
950 $foot_anchor = &$anchor($docid, "$footnote_file#$footid", "($relative_num)") if ($state->{'preformatted'});
952 # unshift @$lines, "<li>";
953 # push @$lines, "</li>\n";
954 return ($lines, $foot_anchor);
957 sub makeinfo_like_foot_lines($)
960 unshift @$lines, "<hr>\n<h4>$Texi2HTML::I18n::WORDS->{'Footnotes_Title'}</h4>\n";
962 # push @$lines, "</ol>";
966 my %makekinfo_like_paragraph_in_footnote_nr;
968 sub makeinfo_like_paragraph ($$$$$$$$$$$$$)
973 my $paragraph_command = shift;
974 my $paragraph_command_formatted = shift;
975 my $paragraph_number = shift;
978 my $enumerate_style = shift;
980 my $command_stack_at_end = shift;
981 my $command_stack_at_begin = shift;
983 #print STDERR "format: $format\n" if (defined($format));
984 #print STDERR "paragraph @$command_stack_at_end; @$command_stack_at_begin\n";
985 $paragraph_command_formatted = '' if (!defined($paragraph_command_formatted) or
986 exists($special_list_commands{$format}->{$paragraph_command}));
987 return '' if ($text =~ /^\s*$/);
988 foreach my $style(t2h_collect_styles($command_stack_at_begin))
990 $text = t2h_begin_style($style, $text);
992 foreach my $style(t2h_collect_styles($command_stack_at_end))
994 $text = t2h_end_style($style, $text);
996 if (defined($paragraph_number) and defined($$paragraph_number))
998 $$paragraph_number++;
999 return $text if (($format eq 'itemize' or $format eq 'enumerate') and
1000 ($$paragraph_number == 1));
1005 $open .= " align=\"$paragraph_style{$align}\"";
1007 my $footnote_text = '';
1008 if (defined($command_stack_at_begin->[0]) and $command_stack_at_begin->[0] eq 'footnote')
1010 my $state = $Texi2HTML::THISDOC{'state'};
1011 $makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number}++;
1012 if ($makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number} <= 1)
1014 $open.=' class="footnote"';
1015 my $document_file = $state->{'footnote_document_file'};
1016 if ($document_file eq $state->{'footnote_footnote_file'})
1018 $document_file = '';
1020 my $docid = $state->{'footnote_place_id'};
1021 my $doc_state = $state->{'footnote_document_state'};
1022 $docid = '' if ($doc_state->{'outside_document'} or $doc_state->{'multiple_pass'});
1023 my $foot_label = &$anchor($state->{'footnote_footnote_id'},
1024 $document_file . "#$state->{'footnote_place_id'}",
1025 "$state->{'footnote_number_in_page'}");
1026 $footnote_text = "<small>[${foot_label}]</small> ";
1029 return $open.'>'.$footnote_text.$text.'</p>';
1033 #############################################################################
1035 #############################################################################
1037 # For split pages, use index.html as start page!
1038 if ($Texi2HTML::Config::SPLIT eq 'section') {
1039 $Texi2HTML::Config::TOP_FILE = 'index.html';