lilypond-texi2html.init

   1 #!/usr/bin/env perl
   2
   3 ### texi2html customization script for Lilypond
   4 ### Author: Reinhold Kainhofer <reinhold@kainhofer.com>, 2008.
   5 ###         Some code parts copied from texi2html and adapted.
   6 ### License: GPLv2+
   7 ###
   8 ###
   9 ### Features implemented here:
  10 ### -) For split manuals, the main page is index.html.
  11 ### -) All @unnumbered* sections are placed into the same file
  12 ###    (implemented by split_at_numbered_sections)
  13 ### -) Use our custom CSS file, with IE-specific fixes in another CSS file,
  14 ###    impelmented by lilypond_css_lines
  15 ### -) TOC (folded, with the current page highlighted) in an overflown <div>
  16 ###    is added to every page; implemented by:
  17 ###           lilypond_print_element_header -- building of the TOC
  18 ###           lilypond_toc_body -- generation of customized TOC output
  19 ###           lilypond_print_page_head -- start <div id="main">
  20 ###           print_lilypond_page_foot -- closing id=main, output of footer & TOC
  21 ### -) External refs are formatted only as "Text of the node" (not as >>see
  22 ###    "NODE" section "SECTION" in "BOOK"<< like with default texi2html). Also,
  23 ###    the leading "(book-name)" is removed.
  24 ###    Implemented by overriding lilypond_external_ref
  25 ### -) Navigation bars on top/bottom of the page and between sections are not
  26 ###    left-aligned, but use a combination of left/center/right aligned table
  27 ###    cells; For this, I heavily extend the texi2html code to allow for
  28 ###    differently aligned cells and for multi-line tables);
  29 ###    Implemented in lilypond_print_navigation
  30 ### -) Different formatting than the default: example uses the same formatting
  31 ###    as quote.
  32 ### -) Allow translated section titles: All section titles can be translated,
  33 ###    the original (English) title is associated with @translationof. This is
  34 ###    needed, because the file name / anchor is generated from the original
  35 ###    English title, since otherwise language-autoselection would break with
  36 ###    posted links.
  37 ###    Since it is then no longer possible to obtain the file name from the
  38 ###    section title, I keep a sectionname<=>filename/anchor around. This way,
  39 ###    xrefs from other manuals can simply load that map and retrieve the
  40 ###    correct file name for the link. Implemented in:
  41 ###           lilypond_unknown (handling of @translationof, in case
  42 ###                             extract_texi_filenames.py messes up...)
  43 ###           split_at_numbered_sections (correct file name: use the map)
  44 ###           lilypond_init_map (read in the externally created map from disk)
  45 ###           lilypond_external_href (load the map for xrefs, use the correct
  46 ###                                   link target)
  47 ### -) The HTML anchors for all sections are derived from the node name /
  48 ###    section title (pre-generated in the .xref-map file). Implemented by:
  49 ###           lilypond_node_file_name (adjust node anchors)
  50 ###           split_at_numbered_sections (adjust section anchors)
  51 ###
  52 ###
  53 ### Useful helper functions:
  54 ### -) texinfo_file_name($node_name): returns a texinfo-compatible file name
  55 ###    for the given string $node_name (whitespace trimmed/replaced by -,
  56 ###    non-standard chars replaced by _xxxx (ascii char code) and forced to
  57 ###    start with a letter by prepending t_g if necessary)
  58
  59
  60 package Texi2HTML::Config;
  61
  62
  63
  64
  65
  66 #############################################################################
  67 ###  SETTINGS FOR TEXI2HTML
  68 #############################################################################
  69
  70 @Texi2HTML::Config::CSS_REFS      = ("lilypond.css");
  71 $Texi2HTML::Config::USE_ACCESSKEY = 1;
  72 $Texi2HTML::Config::USE_LINKS     = 1;
  73 $Texi2HTML::Config::USE_REL_REV   = 1;
  74 $Texi2HTML::Config::element_file_name    = \&split_at_numbered_sections;
  75 $Texi2HTML::Config::node_file_name       = \&lilypond_node_file_name;
  76 $Texi2HTML::Config::print_element_header = \&lilypond_print_element_header;
  77 $Texi2HTML::Config::print_page_foot      = \&print_lilypond_page_foot;
  78 $Texi2HTML::Config::print_navigation     = \&lilypond_print_navigation;
  79 $Texi2HTML::Config::external_ref         = \&lilypond_external_ref;
  80 $Texi2HTML::Config::external_href        = \&lilypond_external_href;
  81 $Texi2HTML::Config::toc_body             = \&lilypond_toc_body;
  82 $Texi2HTML::Config::css_lines            = \&lilypond_css_lines;
  83 $Texi2HTML::Config::unknown              = \&lilypond_unknown;
  84 $Texi2HTML::Config::print_page_head      = \&lilypond_print_page_head;
  85
  86 # Examples should be formatted similar to quotes:
  87 $Texi2HTML::Config::complex_format_map->{'example'} = {
  88   'begin' => q{"<blockquote><pre class=\"example\">"},
  89   'end' => q{"</pre></blockquote>\n"},
  90  };
  91
  92
  93 my @section_to_filename;
  94
  95
  96
  97
  98 #############################################################################
  99 ###  DEBUGGING
 100 #############################################################################
 101
 102 use Data::Dumper;
 103 $Data::Dumper::Maxdepth = 2;
 104
 105 sub print_element_info($)
 106 {
 107   my $element = shift;
 108   print "~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
 109   print "Element: $element\n";
 110   print Dumper($element);
 111 }
 112
 113
 114
 115
 116
 117 #############################################################################
 118 ###  HELPER FUNCTIONS
 119 #############################################################################
 120
 121 # Convert a given node name to its proper file name (normalization as explained
 122 # in the texinfo manual:
 123 # http://www.gnu.org/software/texinfo/manual/texinfo/html_node/HTML-Xref-Node-Name-Expansion.html
 124 sub texinfo_file_name($)
 125 {
 126   my $text = shift;
 127   my $result = '';
 128   # File name normalization by texinfo:
 129   # 1/2: letters and numbers are left unchanged
 130   # 3/4: multiple, leading and trailing whitespace is removed
 131   $text = main::normalise_space($text);
 132   # 5/6: all remaining spaces are converted to '-', all other 7- or 8-bit
 133   #      chars are replaced by _xxxx (xxxx=ascii character code)
 134   while ($text ne '') {
 135     if ($text =~ s/^([A-Za-z0-9]+)//o) { # number or letter stay unchanged
 136       $result .= $1;
 137     } elsif ($text =~ s/^ //o) { # space -> '-'
 138       $result .= '-';
 139     } elsif ($text =~ s/^(.)//o) { # Otherwise use _xxxx (ascii char code)
 140       my $ccode = ord($1);
 141       if ( $ccode <= 0xFFFF ) {
 142         $result .= sprintf("_%04x", $ccode);
 143       } else {
 144         $result .= sprintf("__%06x", $ccode);
 145       }
 146     }
 147   }
 148   # 7: if name does not begin with a letter, prepend 't_g' (so it starts with a letter)
 149   if ($result !~ /^[a-zA-Z]/) {
 150     $result = 't_g' . $result;
 151   }
 152   # DONE
 153   return $result
 154 }
 155
 156
 157 # Load a file containing a nodename<=>filename map (tab-sepatared, i.e.
 158 # NODENAME\tFILENAME\tANCHOR
 159 # Returns a ref to a hash "Node title" => ["FilenameWithoutExt", "Anchor"]
 160 sub load_map_file ($)
 161 {
 162     my $mapfile = shift;
 163     my $node_map = ();
 164
 165     if (open(XREFFILE, $mapfile)) {
 166         my $line;
 167         while ( $line = <XREFFILE> ) {
 168             # parse the tab-separated entries and insert them into the map:
 169             chomp($line);
 170             my @entries = split(/\t/, $line);
 171             if (scalar (@entries) == 3) {
 172               $node_map->{$entries[0]} = [$entries[1], $entries[2]];
 173             } else {
 174               print STDERR "Invalid entry in the node file $mapfile: $line\n";
 175             }
 176         }
 177         close (XREFFILE);
 178     } else {
 179         print STDERR "WARNING: Unable to load the map file $mapfile\n";
 180     }
 181     return $node_map;
 182 }
 183
 184
 185 # Split the given path into dir and basename (with .texi removed). Used mainly
 186 # to get the path/basename of the original texi input file
 187 sub split_texi_filename ($)
 188 {
 189   my $docu = shift;
 190   my $docu_dir, $docu_name;
 191   if ($docu =~ /(.*\/)/) {
 192     chop($docu_dir = $1);
 193     $docu_name = $docu;
 194     $docu_name =~ s/.*\///;
 195   } else {
 196      $docu_dir = '.';
 197      $docu_name = $docu;
 198   }
 199   $docu_name =~ s/\.te?x(i|info)?$//;
 200   return ($docu_dir, $docu_name);
 201 }
 202
 203
 204
 205
 206
 207 #############################################################################
 208 ###  CSS HANDLING
 209 #############################################################################
 210
 211 # Include our standard CSS file, not hard-coded CSS code directly in the HTML!
 212 # For IE, conditionally include the lilypond-ie-fixes.css style sheet
 213 sub lilypond_css_lines ($$)
 214 {
 215     my $import_lines = shift;
 216     my $rule_lines = shift;
 217     return if (defined($CSS_LINES));
 218     if (@$rule_lines or @$import_lines)
 219     {
 220         $CSS_LINES = "<style type=\"text/css\">\n<!--\n";
 221         $CSS_LINES .= join('',@$import_lines) . "\n" if (@$import_lines);
 222         $CSS_LINES .= join('',@$rule_lines) . "\n" if (@$rule_lines);
 223         $CSS_LINES .= "-->\n</style>\n";
 224     }
 225     foreach my $ref (@CSS_REFS)
 226     {
 227         $CSS_LINES .= "<link rel=\"stylesheet\" type=\"text/css\" href=\"$ref\">\n";
 228     }
 229     $CSS_LINES .= "<!--[if lte IE 7]>\n<link href=\"lilypond-ie-fixes.css\" rel=\"stylesheet\" type=\"text/css\">\n<![endif]-->\n";
 230 }
 231
 232
 233
 234
 235
 236 #############################################################################
 237 ###  SPLITTING BASED ON NUMBERED SECTIONS
 238 #############################################################################
 239
 240 my $lastfilename;
 241 my $docnr = 0;
 242 my $node_to_filename_map = ();
 243
 244
 245 # modify the anchors for nodes, in particular, use the section<=>anchor map
 246 # from the .xref-map file and assign the pre-defined anchor to the node.
 247 # We don't want to split at nodes, so we don't return a valid file name
 248 # and just mis-use this function to change the node->{id}
 249 sub lilypond_node_file_name($$)
 250 {
 251   my $node = shift;
 252   my $type = shift;
 253   my $node_name = main::remove_texi($node->{'texi'});
 254
 255   if (exists ($node_to_filename_map->{$node_name})) {
 256     (my $filename, my $anchor) = @{$node_to_filename_map->{$node_name}};
 257     $node->{id} = $anchor;
 258   } elsif ($type eq "top" or $type eq "toc" or $type eq "doc"
 259            or $type eq "stoc" or $type eq "foot" or $type eq "about") {
 260      # Nothing to do
 261   } else {
 262     my $anchor = $node_name;
 263     if ($node->{translationof}) {
 264       $anchor = main::remove_texi($node->{translationof});
 265     }
 266     # normalize to the same file name as texinfo
 267     $anchor = texinfo_file_name($anchor);
 268     $node->{id} = $anchor;
 269   }
 270   return undef;
 271 }
 272
 273
 274 # This function makes sure that files are only generated for numbered sections,
 275 # but not for unnumbered ones. It is called after texi2html has done its own
 276 # splitting and simply returns the filename for the node given as first argument
 277 # Nodes with the same filename will be printed out to the same filename, so
 278 # this really all we need. Also, make sure that the file names for sections
 279 # are derived from the section title. We also might want to name the anchors
 280 # according to node titles, which works by simply overriding the id element of
 281 # the $element hash.
 282 # If an external nodename<=>filename/anchor map file is found (loaded in
 283 # lilypond_init_out, use the externally created values, otherwise use the
 284 # same logic here.
 285 sub split_at_numbered_sections($$$)
 286 {
 287   my $element = shift;
 288   my $type = shift;
 289   my $docu_name = shift;
 290   my $docu_ext = $Texi2HTML::Config::EXTENSION;
 291
 292   my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
 293   # the snippets page does not use nodes for the snippets, so in this case
 294   # we'll have to use the section name!
 295   if ($node_name eq '') {
 296     $node_name = main::remove_texi($element->{'texi'});
 297   }
 298
 299   # If we have an entry in the section<=>filename map, use that one, otherwise
 300   # generate the filename/anchor here. In the latter case, external manuals
 301   # will not be able to retrieve the file name for xrefs!!! Still, I already
 302   # had that code, so I'll leave it in in case something goes wrong with the
 303   # extract_texi_filenames.py script in the lilypond build process!
 304   if (exists ($node_to_filename_map->{$node_name})) {
 305     (my $filename, my $anchor) = @{$node_to_filename_map->{$node_name}};
 306     $filename .= ".$docu_ext" if (defined($docu_ext));
 307
 308     $element->{id} = $anchor;
 309     # unnumbered sections (except those at top-level!) always go to the same
 310     # file as the previous numbered section
 311     if (not ($element->{number}) and not ($lastfilename eq '') and ($element->{level} > 1)) {
 312       $filename = $lastfilename;
 313     }
 314     if (($filename eq $lastfilename)) {
 315       $$element{doc_nr} = $docnr;
 316     } else {
 317       $docnr += 1;
 318       $$element{doc_nr} = $docnr;
 319       $lastfilename = $filename;
 320     }
 321     return $filename;
 322
 323   } elsif ($type eq "top" or $type eq "toc" or $type eq "doc" or $type eq "stoc" or $type eq "foot" or $type eq "about") {
 324     # TOC, footer, about etc. are called with undefined $element and $type == "toc"|"stoc"|"foot"|"about"
 325     return;
 326   } else {
 327     print STDERR "WARNING: Node '$node_name' was NOT found in the map\n"
 328         unless ($node_name eq '') or ($element->{'tag'} eq 'unnumberedsec')
 329                or ($node_name =~ /NOT REALLY USED/);
 330
 331     # derive the name of the anchor (i.e. the part after # in the links!),
 332     # don't use texi2html's SECx.x default!
 333     my $sec_name = main::remove_texi($element->{'texi'});
 334     # if we have a node, use its name:
 335     if ($element->{'node_ref'}->{'texi'} ne '') {
 336       $sec_name = main::remove_texi($element->{'node_ref'}->{'texi'});
 337     }
 338     my $anchor = $sec_name;
 339     if ($element->{translationof}) {
 340       $anchor = main::remove_texi($$element{translationof});
 341     }
 342     # normalize to the same file name as texinfo
 343     $anchor = texinfo_file_name($anchor);
 344     $$element{id} = $anchor;
 345     # Numbered sections will get a filename Node_title, unnumbered sections will use
 346     # the file name of the previous numbered section:
 347     if (($element->{number}) or ($lastfilename eq '') or ($element->{level} == 1)) {
 348       my $filename = $anchor;
 349       $filename .= ".$docu_ext" if (defined($docu_ext));
 350       $docnr += 1;
 351       $$element{doc_nr} = $docnr;
 352       $lastfilename = $filename;
 353       return $filename;
 354     } else {
 355       $$element{doc_nr} = $docnr;
 356       return $lastfilename;
 357     }
 358   }
 359
 360   return;
 361 }
 362
 363
 364 ## Load the map file for the corrently processed texi file. We do this
 365 #  using a command init handler, since texi2html does not have any
 366 #  other hooks that are called after THISDOC is filled but before phase 2
 367 #  of the texi2html conversion.
 368 sub lilypond_init_map ()
 369 {
 370     my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
 371     my $map_filename = main::locate_include_file ("${docu_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
 372         || main::locate_include_file ("${docu_name}.xref-map");
 373     $node_to_filename_map = load_map_file ($map_filename);
 374 }
 375 push @Texi2HTML::Config::command_handler_init, \&lilypond_init_map;
 376
 377
 378
 379 #############################################################################
 380 ###  CLEANER LINK TITLE FOR EXTERNAL REFS
 381 #############################################################################
 382
 383 # The default formatting of external refs returns e.g.
 384 # "(lilypond-internals)Timing_translator", so we remove all (...) from the
 385 # file_and_node argument. Also, we want only a very simple format, so we don't
 386 # even call the default handler!
 387 sub lilypond_external_ref($$$$$$)
 388 {
 389   my $type = shift;
 390   my $section = shift;
 391   my $book = shift;
 392   my $file_node = shift;
 393   my $href = shift;
 394   my $cross_ref = shift;
 395
 396   my $displaytext = '';
 397
 398   # 1) if we have a cross ref name, that's the text to be displayed:
 399   # 2) For the top node, use the (printable) name of the manual, unless we
 400   #    have an explicit cross ref name
 401   # 3) In all other cases use the section name
 402   if ($cross_ref ne '') {
 403     $displaytext = $cross_ref;
 404   } elsif (($section eq '') or ($section eq 'Top')) {
 405     $displaytext = $book;
 406   } else {
 407     $displaytext = $section;
 408   }
 409
 410   $displaytext = &$anchor('', $href, $displaytext) if ($displaytext ne '');
 411   return &$I('%{node_file_href}', { 'node_file_href' => $displaytext });
 412
 413 #  Default: format as "see <a ..>NODE</a> section 'SECTION' in BOOK". We don't want this!
 414 #   return t2h_default_external_ref($type, $section, $book, $file_node, $href, $cross_ref);
 415 }
 416
 417
 418
 419
 420
 421 #############################################################################
 422 ###  HANDLING TRANSLATED SECTIONS: handle @translationof, secname<->filename
 423 ###                  map stored on disk, xrefs in other manuals load that map
 424 #############################################################################
 425
 426
 427 # Try to make use of @translationof to generate files according to the original
 428 # English section title...
 429 sub lilypond_unknown($$$$$)
 430 {
 431     my $macro = shift;
 432     my $line = shift;
 433     my $pass = shift;
 434     my $stack = shift;
 435     my $state = shift;
 436
 437     # the @translationof macro provides the original English section title,
 438     # which should be used for file/anchor naming, while the title will be
 439     # translated to each language
 440     # It is already used by extract_texi_filenames.py, so this should not be
 441     # necessary here at all. Still, I'll leave the code in just in case the
 442     # python script messed up ;-)
 443     if ($pass == 1 and $macro eq "translationof") {
 444       if (ref($state->{'element'}) eq 'HASH') {
 445         $state->{'element'}->{'translationof'} = main::normalise_space($line);
 446       }
 447       return ('', true, undef, undef);
 448     } else {
 449       return t2h_default_unknown($macro, $line, $pass, $stack, $state);
 450     }
 451 }
 452
 453
 454
 455
 456 my %translated_books = ();
 457 # Construct a href to an external source of information.
 458 # node is the node with texinfo @-commands
 459 # node_id is the node transliterated and transformed as explained in the
 460 #         texinfo manual
 461 # node_xhtml_id is the node transformed such that it is unique and can
 462 #     be used to make an html cross ref as explained in the texinfo manual
 463 # file is the file in '(file)node'
 464 sub lilypond_external_href($$$)
 465 {
 466   my $node = shift;
 467   my $node_id = shift;
 468   my $node_hxmlt_id = shift;
 469   my $file = shift;
 470   my $original_func = \&t2h_default_external_href;
 471
 472   # 1) Keep a hash of book->section_map
 473   # 2) if not file in keys hash => try to load the map (assign empty map if
 474   #    non-existent => will load only once!)
 475   # 3) if node in the section=>(file, anchor) map, replace node_id and
 476   #    node_xhtml_id by the map's values
 477   # 4) call the t2h_default_external_href with these values (or the old ones if not found)
 478
 479   if (($node_id ne '') and defined($file) and ($node_id ne 'Top')) {
 480     my $map_name = $file;
 481     $map_name =~ s/-big-page//;
 482
 483     # Load the map if we haven't done so already
 484     if (!exists($translated_books{$map_name})) {
 485       my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
 486       my $map_filename = main::locate_include_file ("${map_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
 487           || main::locate_include_file ("${map_name}.xref-map");
 488       $translated_books{$map_name} = load_map_file ($map_filename);
 489     }
 490
 491     # look up translation. use these values instead of the old filename/anchor
 492     my $section_name_map = $translated_books{$map_name};
 493     my $node_text = main::remove_texi($node);
 494     if (defined($section_name_map->{$node_text})) {
 495       ($node_id, $node_hxmlt_id) = @{$section_name_map->{$node_text}};
 496     } else {
 497       print STDERR "WARNING: Unable to find node '$node_text' in book $map_name.\n";
 498     }
 499   }
 500
 501   if (defined $file) {
 502     return &$original_func($node, $node_id, $node_hxmlt_id, $file);
 503   } else {
 504     return &$original_func($node, $node_id, $node_hxmlt_id);
 505   }
 506 }
 507
 508
 509
 510
 511
 512 #############################################################################
 513 ###  CUSTOM TOC FOR EACH PAGE (in a frame on the left)
 514 #############################################################################
 515
 516 my $page_toc_depth = 2;
 517 my @default_toc = [];
 518
 519 # recursively generate the TOC entries for the element and its children (which
 520 # are only shown up to maxlevel. All ancestors of the current element are also
 521 # shown with their immediate children, irrespective of their level.
 522 # Unnumbered entries are only printed out if they are at top-level or their
 523 # parent element is an ancestor of the currently viewed node.
 524 sub generate_ly_toc_entries($$$$)
 525 {
 526   my $element = shift;
 527   my $element_path = shift;
 528   my $maxlevel = shift;
 529   my $always_show_unnumbered_children = shift;
 530   # Skip undefined sections, plus all sections generated by index splitting
 531   return() if (not defined($element) or exists($element->{'index_page'}));
 532   my @result = ();
 533   my $level = $element->{'toc_level'};
 534   my $is_parent_of_current = $element->{'id'} && $element_path->{$element->{'id'}};
 535   my $print_children = ( ($level < $maxlevel) or $is_parent_of_current );
 536   my $ind = '  ' x $level;
 537   my $this_css_class = $is_parent_of_current ? " class=\"toc_current\"" : "";
 538
 539   my $entry = "$ind<li$this_css_class>" . &$anchor ($element->{'tocid'}, "$element->{'file'}#$element->{'id'}",$element->{'text'});
 540
 541   my $children = $element->{'section_childs'};
 542   # Don't add unnumbered entries, unless they are at top-level or a parent of the current!
 543   if (not ($element->{'number'} or $always_show_unnumbered_children)) {
 544     return @result;
 545   }
 546   if ( $print_children and defined($children) and (ref($children) eq "ARRAY") ) {
 547     push (@result, $entry);
 548     my @child_result = ();
 549     foreach (@$children) {
 550       push (@child_result, generate_ly_toc_entries($_, $element_path, $maxlevel, $is_parent_of_current));
 551     }
 552     # if no child nodes were generated, e.g. for the index, where expanded pages
 553     # are ignored, don't generate a list at all...
 554     if (@child_result) {
 555       push (@result, "\n$ind<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
 556       push (@result, @child_result);
 557       push (@result, "$ind</ul></li>\n");
 558     }
 559   } else {
 560     push (@result, $entry . "</li>\n");
 561   }
 562   return @result;
 563 }
 564
 565
 566 # Print a customized TOC, containing only the first two levels plus the whole
 567 # path to the current page
 568 sub lilypond_generate_page_toc_body($)
 569 {
 570     my $element = shift;
 571     my $current_element = $element;
 572     my %parentelements;
 573     $parentelements{$element->{'id'}} = 1;
 574     # Find the path to the current element
 575     while ( defined($current_element->{'sectionup'}) and
 576            ($current_element->{'sectionup'} ne $current_element) )
 577     {
 578       $parentelements{$current_element->{'sectionup'}->{'id'}} = 1
 579               if ($current_element->{'sectionup'}->{'id'} ne '');
 580       $current_element = $current_element->{'sectionup'};
 581     }
 582     return () if not defined($current_element);
 583     # Create the toc entries recursively
 584     my @toc_entries = ("<div class=\"contents\">\n", "<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
 585     my $children = $current_element->{'section_childs'};
 586     foreach ( @$children ) {
 587       push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth, False));
 588     }
 589     push (@toc_entries, "</ul>\n");
 590     push (@toc_entries, "</div>\n");
 591     return @toc_entries;
 592 }
 593
 594 sub lilypond_print_toc_div ($$)
 595 {
 596   my $fh = shift;
 597   my $tocref = shift;
 598   my @lines = @$tocref;
 599   # use default TOC if no custom lines have been generated
 600   @lines = @default_toc if (not @lines);
 601   if (@lines) {
 602     print $fh "\n\n<div id=\"tocframe\">\n";
 603     print $fh '<h4> ' . $Texi2HTML::NAME{'Contents'}  . "</h4>\n";
 604     foreach my $line (@lines) {
 605       print $fh $line;
 606     }
 607     print $fh "</div>\n\n";
 608   }
 609 }
 610
 611 # Create the custom TOC for this page (partially folded, current page is
 612 # highlighted) and store it in a global variable. The TOC is written out after
 613 # the html contents (but positioned correctly using CSS), so that browsers with
 614 # css turned off still show the contents first.
 615 our @this_page_toc = ();
 616 sub lilypond_print_element_header
 617 {
 618   my $fh = shift;
 619   my $first_in_page = shift;
 620   my $previous_is_top = shift;
 621   if ($first_in_page and not @this_page_toc) {
 622     if (defined($Texi2HTML::THIS_ELEMENT)) {
 623       # Create the TOC for this page
 624       @this_page_toc = lilypond_generate_page_toc_body($Texi2HTML::THIS_ELEMENT);
 625     }
 626   }
 627   return T2H_DEFAULT_print_element_header( $fh, $first_in_page, $previous_is_top);
 628 }
 629
 630 # Generate the HTML output for the TOC
 631 sub lilypond_toc_body($)
 632 {
 633     my $elements_list = shift;
 634     # Generate a default TOC for pages without THIS_ELEMENT
 635     @default_toc = lilypond_generate_page_toc_body(@$elements_list[0]);
 636     return T2H_GPL_toc_body($elements_list);
 637 }
 638
 639 # Print out the TOC in a <div> at the beginning of the page
 640 sub lilypond_print_page_head($)
 641 {
 642     my $fh = shift;
 643     T2H_DEFAULT_print_page_head($fh);
 644     print $fh "<div id=\"main\">\n";
 645 }
 646
 647 # Print out the TOC in a <div> at the end of th page, which will be formatted as a
 648 # sidebar mimicking a TOC frame
 649 sub print_lilypond_page_foot($)
 650 {
 651   my $fh = shift;
 652   my $program_string = &$program_string();
 653   print $fh "<p><font size='-1'>$program_string</font><br>$PRE_BODY_CLOSE</p>\n";
 654   print $fh "<!-- FOOTER -->\n\n";
 655   print $fh "<!-- end div#main here -->\n</div>\n\n";
 656
 657   # Print the TOC frame and reset the TOC:
 658   lilypond_print_toc_div ($fh, \@this_page_toc);
 659   @this_page_toc = ();
 660
 661   # Close the page:
 662   print $fh "</body>\n</html>\n";
 663 }
 664
 665
 666
 667
 668
 669 #############################################################################
 670 ###  NICER / MORE FLEXIBLE NAVIGATION PANELS
 671 #############################################################################
 672
 673 sub get_navigation_text
 674 {
 675   my $button = shift;
 676   my $text = $NAVIGATION_TEXT{$button};
 677   if ( ($button eq 'Back') or ($button eq 'FastBack') ) {
 678     $text = $text . $Texi2HTML::NODE{$button} . "&nbsp;";
 679   } elsif ( ($button eq 'Forward') or ($button eq 'FastForward') ) {
 680     $text = "&nbsp;" . $Texi2HTML::NODE{$button} . $text;
 681   } elsif ( $button eq 'Up' ) {
 682     $text = "&nbsp;".$text.":&nbsp;" . $Texi2HTML::NODE{$button} . "&nbsp;";
 683   }
 684   return $text;
 685 }
 686
 687
 688 # Don't automatically create left-aligned table cells for every link, but
 689 # instead create a <td> only on an appropriate '(left|right|center)-aligned-cell-n'
 690 # button text. It's alignment as well as the colspan will be taken from the
 691 # name of the button. Also, add 'newline' button text to create a new table
 692 # row. The texts of the buttons are generated by get_navigation_text and
 693 # will contain the name of the next/previous section/chapter.
 694 sub lilypond_print_navigation
 695 {
 696     my $fh = shift;
 697     my $buttons = shift;
 698     my $vertical = shift;
 699     my $spacing = 1;
 700 #     print $fh '<table cellpadding="', $spacing, '" cellspacing="', $spacing,
 701 #       "\" border=\"0\" class=\"nav_table\">\n";
 702     print $fh "<table class=\"nav_table\">\n";
 703
 704     print $fh "<tr>" unless $vertical;
 705     my $beginofline = 1;
 706     foreach my $button (@$buttons)
 707     {
 708         print $fh qq{<tr valign="top" align="left">\n} if $vertical;
 709         # Allow (left|right|center)-aligned-cell and newline as buttons!
 710         if ( $button =~ /^(.*)-aligned-cell-(.*)$/ )
 711         {
 712           print $fh qq{</td>} unless $beginofline;
 713           print $fh qq{<td valign="middle" align="$1" colspan="$2">};
 714           $beginofline = 0;
 715         }
 716         elsif ( $button eq 'newline' )
 717         {
 718           print $fh qq{</td>} unless $beginofline;
 719           print $fh qq{</tr>};
 720           print $fh qq{<tr>};
 721           $beginofline = 1;
 722
 723         }
 724         elsif (ref($button) eq 'CODE')
 725         {
 726             &$button($fh, $vertical);
 727         }
 728         elsif (ref($button) eq 'SCALAR')
 729         {
 730             print $fh "$$button" if defined($$button);
 731         }
 732         elsif (ref($button) eq 'ARRAY')
 733         {
 734             my $text = $button->[1];
 735             my $button_href = $button->[0];
 736             # verify that $button_href is simple text and text is a reference
 737             if (defined($button_href) and !ref($button_href)
 738                and defined($text) and (ref($text) eq 'SCALAR') and defined($$text))
 739             {             # use given text
 740                 if ($Texi2HTML::HREF{$button_href})
 741                 {
 742                   my $anchor_attributes = '';
 743                   if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button_href})) and ($BUTTONS_ACCESSKEY{$button_href} ne ''))
 744                   {
 745                       $anchor_attributes = "accesskey=\"$BUTTONS_ACCESSKEY{$button_href}\"";
 746                   }
 747                   if ($USE_REL_REV and (defined($BUTTONS_REL{$button_href})) and ($BUTTONS_REL{$button_href} ne ''))
 748                   {
 749                       $anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\"";
 750                   }
 751                   print $fh "" .
 752                         &$anchor('',
 753                                     $Texi2HTML::HREF{$button_href},
 754                                     get_navigation_text($$text),
 755                                     $anchor_attributes
 756                                    );
 757                 }
 758                 else
 759                 {
 760                   print $fh get_navigation_text($$text);
 761                 }
 762             }
 763         }
 764         elsif ($button eq ' ')
 765         {                       # handle space button
 766             print $fh
 767                 ($ICONS && $ACTIVE_ICONS{' '}) ?
 768                     &$button_icon_img($BUTTONS_NAME{$button}, $ACTIVE_ICONS{' '}) :
 769                         $NAVIGATION_TEXT{' '};
 770             #next;
 771         }
 772         elsif ($Texi2HTML::HREF{$button})
 773         {                       # button is active
 774             my $btitle = $BUTTONS_GOTO{$button} ?
 775                 'title="' . $BUTTONS_GOTO{$button} . '"' : '';
 776             if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button})) and ($BUTTONS_ACCESSKEY{$button} ne ''))
 777             {
 778                 $btitle .= " accesskey=\"$BUTTONS_ACCESSKEY{$button}\"";
 779             }
 780             if ($USE_REL_REV and (defined($BUTTONS_REL{$button})) and ($BUTTONS_REL{$button} ne ''))
 781             {
 782                 $btitle .= " rel=\"$BUTTONS_REL{$button}\"";
 783             }
 784             if ($ICONS && $ACTIVE_ICONS{$button})
 785             {                   # use icon
 786                 print $fh '' .
 787                     &$anchor('',
 788                         $Texi2HTML::HREF{$button},
 789                         &$button_icon_img($BUTTONS_NAME{$button},
 790                                    $ACTIVE_ICONS{$button},
 791                                    $Texi2HTML::SIMPLE_TEXT{$button}),
 792                         $btitle
 793                       );
 794             }
 795             else
 796             {                   # use text
 797                 print $fh
 798                     '[' .
 799                         &$anchor('',
 800                                     $Texi2HTML::HREF{$button},
 801                                     get_navigation_text ($button),
 802                                     $btitle
 803                                    ) .
 804                                        ']';
 805             }
 806         }
 807         else
 808         {                       # button is passive
 809             print $fh
 810                 $ICONS && $PASSIVE_ICONS{$button} ?
 811                     &$button_icon_img($BUTTONS_NAME{$button},
 812                                           $PASSIVE_ICONS{$button},
 813                                           $Texi2HTML::SIMPLE_TEXT{$button}) :
 814
 815                                               "[" . get_navigation_text($button) . "]";
 816         }
 817         print $fh "</td>\n" if $vertical;
 818         print $fh "</tr>\n" if $vertical;
 819     }
 820     print $fh "</td>" unless $beginofline;
 821     print $fh "</tr>" unless $vertical;
 822     print $fh "</table>\n";
 823 }
 824
 825
 826 @Texi2HTML::Config::SECTION_BUTTONS =
 827     ('left-aligned-cell-1', 'FastBack',
 828      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
 829      'right-aligned-cell-1', 'FastForward',
 830      'newline',
 831      'left-aligned-cell-2', 'Back',
 832      'center-aligned-cell-1', 'Up',
 833      'right-aligned-cell-2', 'Forward'
 834     );
 835
 836 # buttons for misc stuff
 837 @Texi2HTML::Config::MISC_BUTTONS = ('center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About');
 838
 839 # buttons for chapter file footers
 840 # (and headers but only if SECTION_NAVIGATION is false)
 841 @Texi2HTML::Config::CHAPTER_BUTTONS =
 842     ('left-aligned-cell-1', 'FastBack',
 843      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
 844      'right-aligned-cell-1', 'FastForward',
 845     );
 846
 847 # buttons for section file footers
 848 @Texi2HTML::Config::SECTION_FOOTER_BUTTONS =
 849     ('left-aligned-cell-1', 'FastBack',
 850      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
 851      'right-aligned-cell-1', 'FastForward',
 852      'newline',
 853      'left-aligned-cell-2', 'Back',
 854      'center-aligned-cell-1', 'Up',
 855      'right-aligned-cell-2', 'Forward'
 856     );
 857
 858 @Texi2HTML::Config::NODE_FOOTER_BUTTONS =
 859     ('left-aligned-cell-1', 'FastBack',
 860      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
 861      'right-aligned-cell-1', 'FastForward',
 862      'newline',
 863      'left-aligned-cell-2', 'Back',
 864      'center-aligned-cell-1', 'Up',
 865      'right-aligned-cell-2', 'Forward'
 866     );
 867
 868
 869
 870
 871
 872 #############################################################################
 873 ###  OTHER SETTINGS
 874 #############################################################################
 875
 876 # For split pages, use index.html as start page!
 877 if ($Texi2HTML::Config::SPLIT eq 'section') {
 878   $Texi2HTML::Config::TOP_FILE = 'index.html';
 879 }
 880
 881
 882 return 1;