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