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. These functions
   6 ###         were written mainly by Patrice Dumas
   7 ### License: GPLv2+
   8 ###
   9 ###
  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
  32 ###    as quote.
  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
  37 ###    posted links.
  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
  48 ###                                   link target)
  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
  57 ###
  58 ###
  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)
  64
  65
  66 package Texi2HTML::Config;
  67
  68
  69
  70
  71
  72 #############################################################################
  73 ###  SETTINGS FOR TEXI2HTML
  74 #############################################################################
  75
  76 @Texi2HTML::Config::CSS_REFS      = (
  77     {FILENAME => "lilypond-mccarty.css", TITLE => "Patrick McCarty's design"}
  78 );
  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" },
  82 );
  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;
  90 }
  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;
 105
 106
 107
 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"},
 112   'style' => 'code',
 113  };
 114
 115 %Texi2HTML::config::misc_pages_targets = (
 116    'Overview' => 'Overview',
 117    'Contents' => 'Contents',
 118    'About' => 'About'
 119 );
 120
 121
 122 my @section_to_filename;
 123
 124
 125
 126
 127 #############################################################################
 128 ###  DEBUGGING
 129 #############################################################################
 130
 131 use Data::Dumper;
 132 $Data::Dumper::Maxdepth = 2;
 133
 134 sub print_element_info($)
 135 {
 136   my $element = shift;
 137   print "~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
 138   print "Element: $element\n";
 139   print Dumper($element);
 140 }
 141
 142
 143
 144
 145
 146 #############################################################################
 147 ###  HELPER FUNCTIONS
 148 #############################################################################
 149
 150 # Convert a given node name to its proper file name (normalization as explained
 151 # in the texinfo manual:
 152 # http://www.gnu.org/software/texinfo/manual/texinfo/html_node/HTML-Xref-Node-Name-Expansion.html
 153 sub texinfo_file_name($)
 154 {
 155   my $text = shift;
 156   my $result = '';
 157   # File name normalization by texinfo:
 158   # 1/2: letters and numbers are left unchanged
 159   # 3/4: multiple, leading and trailing whitespace is removed
 160   $text = main::normalise_space($text);
 161   # 5/6: all remaining spaces are converted to '-', all other 7- or 8-bit
 162   #      chars are replaced by _xxxx (xxxx=ascii character code)
 163   while ($text ne '') {
 164     if ($text =~ s/^([A-Za-z0-9]+)//o) { # number or letter stay unchanged
 165       $result .= $1;
 166     } elsif ($text =~ s/^ //o) { # space -> '-'
 167       $result .= '-';
 168     } elsif ($text =~ s/^(.)//o) { # Otherwise use _xxxx (ascii char code)
 169       my $ccode = ord($1);
 170       if ( $ccode <= 0xFFFF ) {
 171         $result .= sprintf("_%04x", $ccode);
 172       } else {
 173         $result .= sprintf("__%06x", $ccode);
 174       }
 175     }
 176   }
 177   # 7: if name does not begin with a letter, prepend 't_g' (so it starts with a letter)
 178   if ($result !~ /^[a-zA-Z]/) {
 179     $result = 't_g' . $result;
 180   }
 181   # DONE
 182   return $result
 183 }
 184
 185
 186 # Load a file containing a nodename<=>filename map (tab-sepatared, i.e.
 187 # NODENAME\tFILENAME\tANCHOR
 188 # Returns a ref to a hash "Node title" => ["FilenameWithoutExt", "Anchor"]
 189 sub load_map_file ($)
 190 {
 191     my $mapfile = shift;
 192     my $node_map = ();
 193
 194     if (open(XREFFILE, $mapfile)) {
 195         my $line;
 196         while ( $line = <XREFFILE> ) {
 197             # parse the tab-separated entries and insert them into the map:
 198             chomp($line);
 199             my @entries = split(/\t/, $line);
 200             if (scalar (@entries) == 3) {
 201               $node_map->{$entries[0]} = [$entries[1], $entries[2]];
 202             } else {
 203               print STDERR "Invalid entry in the node file $mapfile: $line\n";
 204             }
 205         }
 206         close (XREFFILE);
 207     } else {
 208         print STDERR "WARNING: Unable to load the map file $mapfile\n";
 209     }
 210     return $node_map;
 211 }
 212
 213
 214 # Split the given path into dir and basename (with .texi removed). Used mainly
 215 # to get the path/basename of the original texi input file
 216 sub split_texi_filename ($)
 217 {
 218   my $docu = shift;
 219   my $docu_dir, $docu_name;
 220   if ($docu =~ /(.*\/)/) {
 221     chop($docu_dir = $1);
 222     $docu_name = $docu;
 223     $docu_name =~ s/.*\///;
 224   } else {
 225      $docu_dir = '.';
 226      $docu_name = $docu;
 227   }
 228   $docu_name =~ s/\.te?x(i|info)?$//;
 229   return ($docu_dir, $docu_name);
 230 }
 231
 232
 233
 234
 235
 236 #############################################################################
 237 ###  CSS HANDLING
 238 #############################################################################
 239
 240 # Include our standard CSS file, not hard-coded CSS code directly in the HTML!
 241 # For IE, conditionally include the lilypond-ie-fixes.css style sheet
 242 sub lilypond_css_lines ($$)
 243 {
 244     my $import_lines = shift;
 245     my $rule_lines = shift;
 246     return if (defined($Texi2HTML::THISDOC{'CSS_LINES'}));
 247     if (@$rule_lines or @$import_lines)
 248     {
 249         $Texi2HTML::THISDOC{'CSS_LINES'} = "<style type=\"text/css\">\n<!--\n";
 250         $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$import_lines) . "\n" if (@$import_lines);
 251         $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$rule_lines) . "\n" if (@$rule_lines);
 252         $Texi2HTML::THISDOC{'CSS_LINES'} .= "-->\n</style>\n";
 253     }
 254     foreach my $ref (@CSS_REFS)
 255     {
 256         $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"stylesheet\" type=\"text/css\" title=\"$ref->{TITLE}\" href=\"$ref->{FILENAME}\">\n";
 257     }
 258     foreach my $ref (@ALT_CSS_REFS)
 259     {
 260         $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"alternate stylesheet\" type=\"text/css\" href=\"$ref->{FILENAME}\" title=\"$ref->{TITLE}\">\n";
 261     }
 262     $Texi2HTML::THISDOC{'CSS_LINES'} .= "<!--[if lte IE 7]>\n<link href=\"lilypond-ie-fixes.css\" rel=\"stylesheet\" type=\"text/css\">\n<![endif]-->\n";
 263 }
 264
 265
 266
 267
 268
 269 #############################################################################
 270 ###  SPLITTING BASED ON NUMBERED SECTIONS
 271 #############################################################################
 272
 273 my $lastfilename;
 274 my $docnr = 0;
 275 my $node_to_filename_map = ();
 276
 277
 278 # This function makes sure that files are only generated for numbered sections,
 279 # but not for unnumbered ones. It is called after texi2html has done its own
 280 # splitting and simply returns the filename for the node given as first argument
 281 # Nodes with the same filename will be printed out to the same filename, so
 282 # this really all we need. Also, make sure that the file names for sections
 283 # are derived from the section title. We also might want to name the anchors
 284 # according to node titles, which works by simply overriding the id element of
 285 # the $element hash.
 286 # If an external nodename<=>filename/anchor map file is found (loaded in
 287 # lilypond_init_out, use the externally created values, otherwise use the
 288 # same logic here.
 289 sub lilypond_element_file_name($$$)
 290 {
 291   my $element = shift;
 292   my $type = shift;
 293   my $docu_name = shift;
 294   my $docu_ext = $Texi2HTML::Config::EXTENSION;
 295
 296   my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
 297   # the snippets page does not use nodes for the snippets, so in this case
 298   # we'll have to use the section name!
 299   if ($node_name eq '') {
 300     $node_name = main::remove_texi($element->{'texi'});
 301   }
 302
 303   # If we have an entry in the section<=>filename map, use that one, otherwise
 304   # generate the filename/anchor here. In the latter case, external manuals
 305   # will not be able to retrieve the file name for xrefs!!! Still, I already
 306   # had that code, so I'll leave it in in case something goes wrong with the
 307   # extract_texi_filenames.py script in the lilypond build process!
 308   if (exists ($node_to_filename_map->{$node_name})) {
 309     (my $filename, my $anchor) = @{$node_to_filename_map->{$node_name}};
 310     $filename .= ".$docu_ext" if (defined($docu_ext));
 311
 312     # unnumbered sections (except those at top-level!) always go to the same
 313     # file as the previous numbered section
 314     if (not ($element->{number}) and not ($lastfilename eq '') and ($element->{level} > 1)) {
 315       $filename = $lastfilename;
 316     }
 317     if (($filename eq $lastfilename)) {
 318       $$element{doc_nr} = $docnr;
 319     } else {
 320       $docnr += 1;
 321       $$element{doc_nr} = $docnr;
 322       $lastfilename = $filename;
 323     }
 324     return $filename;
 325
 326   } elsif ($type eq "top" or $type eq "toc" or $type eq "doc" or $type eq "stoc" or $type eq "foot" or $type eq "about") {
 327     return;
 328   } else {
 329     print STDERR "WARNING: Node '$node_name' was NOT found in the map\n"
 330         unless ($node_name eq '') or ($element->{'tag'} eq 'unnumberedsec')
 331                or ($node_name =~ /NOT REALLY USED/);
 332
 333     # Numbered sections will get a filename Node_title, unnumbered sections will use
 334     # the file name of the previous numbered section:
 335     if (($element->{number}) or ($lastfilename eq '') or ($element->{level} == 1)) {
 336       # normalize to the same file name as texinfo
 337       if ($element->{translationof}) {
 338         $node_name = main::remove_texi($element->{translationof});
 339       }
 340       my $filename = texinfo_file_name($node_name);
 341       $filename .= ".$docu_ext" if (defined($docu_ext));
 342       $docnr += 1;
 343       $$element{doc_nr} = $docnr;
 344       $lastfilename = $filename;
 345       return $filename;
 346     } else {
 347       $$element{doc_nr} = $docnr;
 348       return $lastfilename;
 349     }
 350   }
 351
 352   return;
 353 }
 354
 355 sub lilypond_element_target_name($$$)
 356 {
 357   my $element = shift;
 358   my $target = shift;
 359   my $id = shift;
 360   # Target is based on node name (or sec name for secs without node attached)
 361   my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
 362   if ($node_name eq '') {
 363     $node_name = main::remove_texi($element->{'texi'});
 364   }
 365
 366   # If we have an entry in the section<=>filename map, use that one, otherwise
 367   # generate the anchor here.
 368   if (exists ($node_to_filename_map->{$node_name})) {
 369     (my $filename, $target) = @{$node_to_filename_map->{$node_name}};
 370   } else {
 371     my $anchor = $node_name;
 372     if ($element->{translationof}) {
 373       $anchor = main::remove_texi($element->{translationof});
 374     }
 375     # normalize to the same file name as texinfo
 376     $target = texinfo_file_name($anchor);
 377   }
 378   # TODO: Once texi2html correctly prints out the target and not the id for
 379   #       the sections, change this back to ($id, $target)
 380   return ($target, $target);
 381 }
 382
 383
 384 ## Load the map file for the corrently processed texi file. We do this
 385 #  using a command init handler, since texi2html does not have any
 386 #  other hooks that are called after THISDOC is filled but before phase 2
 387 #  of the texi2html conversion.
 388 sub lilypond_init_map ()
 389 {
 390     my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
 391     my $map_filename = main::locate_include_file ("${docu_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
 392         || main::locate_include_file ("${docu_name}.xref-map");
 393     $node_to_filename_map = load_map_file ($map_filename);
 394 }
 395 push @Texi2HTML::Config::command_handler_init, \&lilypond_init_map;
 396
 397
 398
 399 #############################################################################
 400 ###  CLEANER LINK TITLE FOR EXTERNAL REFS
 401 #############################################################################
 402
 403 # The default formatting of external refs returns e.g.
 404 # "(lilypond-internals)Timing_translator", so we remove all (...) from the
 405 # file_and_node argument. Also, we want only a very simple format, so we don't
 406 # even call the default handler!
 407 sub lilypond_external_ref($$$$$$)
 408 {
 409   my $type = shift;
 410   my $section = shift;
 411   my $book = shift;
 412   my $file_node = shift;
 413   my $href = shift;
 414   my $cross_ref = shift;
 415
 416   my $displaytext = '';
 417
 418   # 1) if we have a cross ref name, that's the text to be displayed:
 419   # 2) For the top node, use the (printable) name of the manual, unless we
 420   #    have an explicit cross ref name
 421   # 3) In all other cases use the section name
 422   if ($cross_ref ne '') {
 423     $displaytext = $cross_ref;
 424   } elsif (($section eq '') or ($section eq 'Top')) {
 425     $displaytext = $book;
 426   } else {
 427     $displaytext = $section;
 428   }
 429
 430   $displaytext = &$anchor('', $href, $displaytext) if ($displaytext ne '');
 431   return &$I('%{node_file_href}', { 'node_file_href' => $displaytext });
 432
 433 #  Default: format as "see <a ..>NODE</a> section 'SECTION' in BOOK". We don't want this!
 434 #   return t2h_default_external_ref($type, $section, $book, $file_node, $href, $cross_ref);
 435 }
 436
 437
 438
 439
 440
 441 #############################################################################
 442 ###  HANDLING TRANSLATED SECTIONS: handle @translationof, secname<->filename
 443 ###                  map stored on disk, xrefs in other manuals load that map
 444 #############################################################################
 445
 446
 447 # Try to make use of @translationof to generate files according to the original
 448 # English section title...
 449 sub lilypond_unknown($$$$$)
 450 {
 451     my $macro = shift;
 452     my $line = shift;
 453     my $pass = shift;
 454     my $stack = shift;
 455     my $state = shift;
 456
 457     # the @translationof macro provides the original English section title,
 458     # which should be used for file/anchor naming, while the title will be
 459     # translated to each language
 460     # It is already used by extract_texi_filenames.py, so this should not be
 461     # necessary here at all. Still, I'll leave the code in just in case the
 462     # python script messed up ;-)
 463     if ($pass == 1 and $macro eq "translationof") {
 464       if (ref($state->{'element'}) eq 'HASH') {
 465         $state->{'element'}->{'translationof'} = main::normalise_space($line);
 466       }
 467       return ('', true, undef, undef);
 468     } else {
 469       return t2h_default_unknown($macro, $line, $pass, $stack, $state);
 470     }
 471 }
 472
 473
 474
 475
 476 my %translated_books = ();
 477 # Construct a href to an external source of information.
 478 # node is the node with texinfo @-commands
 479 # node_id is the node transliterated and transformed as explained in the
 480 #         texinfo manual
 481 # node_xhtml_id is the node transformed such that it is unique and can
 482 #     be used to make an html cross ref as explained in the texinfo manual
 483 # file is the file in '(file)node'
 484 sub lilypond_external_href($$$)
 485 {
 486   my $node = shift;
 487   my $node_id = shift;
 488   my $node_hxmlt_id = shift;
 489   my $file = shift;
 490   my $original_func = \&t2h_default_external_href;
 491
 492   # 1) Keep a hash of book->section_map
 493   # 2) if not file in keys hash => try to load the map (assign empty map if
 494   #    non-existent => will load only once!)
 495   # 3) if node in the section=>(file, anchor) map, replace node_id and
 496   #    node_xhtml_id by the map's values
 497   # 4) call the t2h_default_external_href with these values (or the old ones if not found)
 498
 499   if (($node_id ne '') and defined($file) and ($node_id ne 'Top')) {
 500     my $map_name = $file;
 501     $map_name =~ s/-big-page//;
 502
 503     # Load the map if we haven't done so already
 504     if (!exists($translated_books{$map_name})) {
 505       my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
 506       my $map_filename = main::locate_include_file ("${map_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
 507           || main::locate_include_file ("${map_name}.xref-map");
 508       $translated_books{$map_name} = load_map_file ($map_filename);
 509     }
 510
 511     # look up translation. use these values instead of the old filename/anchor
 512     my $section_name_map = $translated_books{$map_name};
 513     my $node_text = main::remove_texi($node);
 514     if (defined($section_name_map->{$node_text})) {
 515       ($node_id, $node_hxmlt_id) = @{$section_name_map->{$node_text}};
 516     } else {
 517       print STDERR "WARNING: Unable to find node '$node_text' in book $map_name.\n";
 518     }
 519   }
 520
 521   if (defined $file) {
 522     return &$original_func($node, $node_id, $node_hxmlt_id, $file);
 523   } else {
 524     return &$original_func($node, $node_id, $node_hxmlt_id);
 525   }
 526 }
 527
 528
 529
 530
 531
 532 #############################################################################
 533 ###  CUSTOM TOC FOR EACH PAGE (in a frame on the left)
 534 #############################################################################
 535
 536 my $page_toc_depth = 2;
 537 my @default_toc = [];
 538
 539 # recursively generate the TOC entries for the element and its children (which
 540 # are only shown up to maxlevel. All ancestors of the current element are also
 541 # shown with their immediate children, irrespective of their level.
 542 # Unnumbered entries are only printed out if they are at top-level or their
 543 # parent element is an ancestor of the currently viewed node.
 544 sub generate_ly_toc_entries($$$$)
 545 {
 546   my $element = shift;
 547   my $element_path = shift;
 548   my $maxlevel = shift;
 549   my $always_show_unnumbered_children = shift;
 550   # Skip undefined sections, plus all sections generated by index splitting
 551   return() if (not defined($element) or exists($element->{'index_page'}));
 552   my @result = ();
 553   my $level = $element->{'toc_level'};
 554   my $is_parent_of_current = $element->{'id'} && $element_path->{$element->{'id'}};
 555   my $print_children = ( ($level < $maxlevel) or $is_parent_of_current );
 556   my $ind = '  ' x $level;
 557   my $this_css_class = $is_parent_of_current ? " class=\"toc_current\"" : "";
 558
 559   my $entry = "$ind<li$this_css_class>" . &$anchor ($element->{'tocid'}, "$element->{'file'}#$element->{'target'}",$element->{'text'});
 560
 561   my $children = $element->{'section_childs'};
 562   # Don't add unnumbered entries, unless they are at top-level or a parent of the current!
 563   if (not ($element->{'number'} or $always_show_unnumbered_children)) {
 564     return @result;
 565   }
 566   if ( $print_children and defined($children) and (ref($children) eq "ARRAY") ) {
 567     push (@result, $entry);
 568     my @child_result = ();
 569     foreach (@$children) {
 570       push (@child_result, generate_ly_toc_entries($_, $element_path, $maxlevel, $is_parent_of_current));
 571     }
 572     # if no child nodes were generated, e.g. for the index, where expanded pages
 573     # are ignored, don't generate a list at all...
 574     if (@child_result) {
 575       push (@result, "\n$ind<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
 576       push (@result, @child_result);
 577       push (@result, "$ind</ul></li>\n");
 578     }
 579   } else {
 580     push (@result, $entry . "</li>\n");
 581   }
 582   return @result;
 583 }
 584
 585
 586 # Print a customized TOC, containing only the first two levels plus the whole
 587 # path to the current page
 588 sub lilypond_generate_page_toc_body($)
 589 {
 590     my $element = shift;
 591     my $current_element = $element;
 592     my %parentelements;
 593     $parentelements{$element->{'id'}} = 1;
 594     # Find the path to the current element
 595     while ( defined($current_element->{'sectionup'}) and
 596            ($current_element->{'sectionup'} ne $current_element) )
 597     {
 598       $parentelements{$current_element->{'sectionup'}->{'id'}} = 1
 599               if ($current_element->{'sectionup'}->{'id'} ne '');
 600       $current_element = $current_element->{'sectionup'};
 601     }
 602     return () if not defined($current_element);
 603     # Create the toc entries recursively
 604     my @toc_entries = ("<div class=\"contents\">\n", "<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
 605     my $children = $current_element->{'section_childs'};
 606     foreach ( @$children ) {
 607       push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth, False));
 608     }
 609     push (@toc_entries, "</ul>\n");
 610     push (@toc_entries, "</div>\n");
 611     return @toc_entries;
 612 }
 613
 614 sub lilypond_print_toc_div ($$)
 615 {
 616   my $fh = shift;
 617   my $tocref = shift;
 618   my @lines = @$tocref;
 619   # use default TOC if no custom lines have been generated
 620   @lines = @default_toc if (not @lines);
 621   if (@lines) {
 622
 623     print $fh "\n\n<div id=\"tocframe\">\n";
 624
 625     # Remove the leading "GNU LilyPond --- " from the manual title
 626     my $topname = $Texi2HTML::NAME{'Top'};
 627     $topname =~ s/^GNU LilyPond(:| &[mn]dash;) //;
 628
 629     # construct the top-level Docs index (relative path and including language!)
 630     my $lang = $Texi2HTML::THISDOC{current_lang};
 631     if ($lang and $lang ne "en") {
 632       $lang .= ".";
 633     } else {
 634       $lang = "";
 635     }
 636     my $reldir = "";
 637     $reldir = "../" if ($Texi2HTML::Config::SPLIT eq 'section');
 638     my $uplink = $reldir."index.${lang}html";
 639
 640     print $fh "<p class=\"toc_uplink\"><a href=\"$uplink\"
 641          title=\"Documentation Index\">&lt;&lt; Back to
 642          Documentation Index</a></p>\n";
 643
 644     print $fh '<h4 class="toc_header"> ' . &$anchor('',
 645                                     $Texi2HTML::HREF{'Top'},
 646                                     $topname,
 647                                     'title="Start of the manual"'
 648                                    ) . "</h4>\n";
 649     foreach my $line (@lines) {
 650       print $fh $line;
 651     }
 652     print $fh "</div>\n\n";
 653   }
 654 }
 655
 656 # Create the custom TOC for this page (partially folded, current page is
 657 # highlighted) and store it in a global variable. The TOC is written out after
 658 # the html contents (but positioned correctly using CSS), so that browsers with
 659 # css turned off still show the contents first.
 660 our @this_page_toc = ();
 661 sub lilypond_print_element_header
 662 {
 663   my $first_in_page = shift;
 664   my $previous_is_top = shift;
 665   if ($first_in_page and not @this_page_toc) {
 666     if (defined($Texi2HTML::THIS_ELEMENT)) {
 667       # Create the TOC for this page
 668       @this_page_toc = lilypond_generate_page_toc_body($Texi2HTML::THIS_ELEMENT);
 669     }
 670   }
 671   return T2H_DEFAULT_print_element_header( $first_in_page, $previous_is_top);
 672 }
 673
 674 # Generate the HTML output for the TOC
 675 sub lilypond_toc_body($)
 676 {
 677     my $elements_list = shift;
 678     # Generate a default TOC for pages without THIS_ELEMENT
 679     @default_toc = lilypond_generate_page_toc_body(@$elements_list[0]);
 680     return T2H_GPL_toc_body($elements_list);
 681 }
 682
 683 # Print out the TOC in a <div> at the beginning of the page
 684 sub lilypond_print_page_head($)
 685 {
 686     my $fh = shift;
 687     T2H_DEFAULT_print_page_head($fh);
 688     print $fh "<div id=\"main\">\n";
 689 }
 690
 691 # Print out the TOC in a <div> at the end of th page, which will be formatted as a
 692 # sidebar mimicking a TOC frame
 693 sub print_lilypond_page_foot($)
 694 {
 695   my $fh = shift;
 696   my $program_string = &$program_string();
 697 #   print $fh "<p><font size='-1'>$program_string</font><br>$PRE_BODY_CLOSE</p>\n";
 698   print $fh "<!-- FOOTER -->\n\n";
 699   print $fh "<!-- end div#main here -->\n</div>\n\n";
 700
 701   # Print the TOC frame and reset the TOC:
 702   lilypond_print_toc_div ($fh, \@this_page_toc);
 703   @this_page_toc = ();
 704
 705   # Close the page:
 706   print $fh "</body>\n</html>\n";
 707 }
 708
 709
 710
 711
 712
 713 #############################################################################
 714 ###  NICER / MORE FLEXIBLE NAVIGATION PANELS
 715 #############################################################################
 716
 717 sub get_navigation_text
 718 {
 719   my $button = shift;
 720   my $text = $NAVIGATION_TEXT{$button};
 721   if ( ($button eq 'Back') or ($button eq 'FastBack') ) {
 722     $text = $text . $Texi2HTML::NODE{$button} . "&nbsp;";
 723   } elsif ( ($button eq 'Forward') or ($button eq 'FastForward') ) {
 724     $text = "&nbsp;" . $Texi2HTML::NODE{$button} . $text;
 725   } elsif ( $button eq 'Up' ) {
 726     $text = "&nbsp;".$text.":&nbsp;" . $Texi2HTML::NODE{$button} . "&nbsp;";
 727   }
 728   return $text;
 729 }
 730
 731
 732 # Don't automatically create left-aligned table cells for every link, but
 733 # instead create a <td> only on an appropriate '(left|right|center)-aligned-cell-n'
 734 # button text. It's alignment as well as the colspan will be taken from the
 735 # name of the button. Also, add 'newline' button text to create a new table
 736 # row. The texts of the buttons are generated by get_navigation_text and
 737 # will contain the name of the next/previous section/chapter.
 738 sub lilypond_print_navigation
 739 {
 740     my $buttons = shift;
 741     my $vertical = shift;
 742     my $spacing = 1;
 743     my $result = "<table class=\"nav_table\">\n";
 744
 745     $result .= "<tr>" unless $vertical;
 746     my $beginofline = 1;
 747     foreach my $button (@$buttons)
 748     {
 749         $result .= qq{<tr valign="top" align="left">\n} if $vertical;
 750         # Allow (left|right|center)-aligned-cell and newline as buttons!
 751         if ( $button =~ /^(.*)-aligned-cell-(.*)$/ )
 752         {
 753           $result .= qq{</td>} unless $beginofline;
 754           $result .= qq{<td valign="middle" align="$1" colspan="$2">};
 755           $beginofline = 0;
 756         }
 757         elsif ( $button eq 'newline' )
 758         {
 759           $result .= qq{</td>} unless $beginofline;
 760           $result .= qq{</tr>};
 761           $result .= qq{<tr>};
 762           $beginofline = 1;
 763
 764         }
 765         elsif (ref($button) eq 'CODE')
 766         {
 767             $result .= &$button($vertical);
 768         }
 769         elsif (ref($button) eq 'SCALAR')
 770         {
 771             $result .= "$$button" if defined($$button);
 772         }
 773         elsif (ref($button) eq 'ARRAY')
 774         {
 775             my $text = $button->[1];
 776             my $button_href = $button->[0];
 777             # verify that $button_href is simple text and text is a reference
 778             if (defined($button_href) and !ref($button_href)
 779                and defined($text) and (ref($text) eq 'SCALAR') and defined($$text))
 780             {             # use given text
 781                 if ($Texi2HTML::HREF{$button_href})
 782                 {
 783                   my $anchor_attributes = '';
 784                   if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button_href})) and ($BUTTONS_ACCESSKEY{$button_href} ne ''))
 785                   {
 786                       $anchor_attributes = "accesskey=\"$BUTTONS_ACCESSKEY{$button_href}\"";
 787                   }
 788                   if ($USE_REL_REV and (defined($BUTTONS_REL{$button_href})) and ($BUTTONS_REL{$button_href} ne ''))
 789                   {
 790                       $anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\"";
 791                   }
 792                   $result .=  "" .
 793                         &$anchor('',
 794                                     $Texi2HTML::HREF{$button_href},
 795                                     get_navigation_text($$text),
 796                                     $anchor_attributes
 797                                    );
 798                 }
 799                 else
 800                 {
 801                   $result .=  get_navigation_text($$text);
 802                 }
 803             }
 804         }
 805         elsif ($button eq ' ')
 806         {                       # handle space button
 807             $result .=
 808                 ($ICONS && $ACTIVE_ICONS{' '}) ?
 809                     &$button_icon_img($BUTTONS_NAME{$button}, $ACTIVE_ICONS{' '}) :
 810                         $NAVIGATION_TEXT{' '};
 811             #next;
 812         }
 813         elsif ($Texi2HTML::HREF{$button})
 814         {                       # button is active
 815             my $btitle = $BUTTONS_GOTO{$button} ?
 816                 'title="' . $BUTTONS_GOTO{$button} . '"' : '';
 817             if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button})) and ($BUTTONS_ACCESSKEY{$button} ne ''))
 818             {
 819                 $btitle .= " accesskey=\"$BUTTONS_ACCESSKEY{$button}\"";
 820             }
 821             if ($USE_REL_REV and (defined($BUTTONS_REL{$button})) and ($BUTTONS_REL{$button} ne ''))
 822             {
 823                 $btitle .= " rel=\"$BUTTONS_REL{$button}\"";
 824             }
 825             if ($ICONS && $ACTIVE_ICONS{$button})
 826             {                   # use icon
 827                 $result .= '' .
 828                     &$anchor('',
 829                         $Texi2HTML::HREF{$button},
 830                         &$button_icon_img($BUTTONS_NAME{$button},
 831                                    $ACTIVE_ICONS{$button},
 832                                    $Texi2HTML::SIMPLE_TEXT{$button}),
 833                         $btitle
 834                       );
 835             }
 836             else
 837             {                   # use text
 838                 $result .=
 839                     '[' .
 840                         &$anchor('',
 841                                     $Texi2HTML::HREF{$button},
 842                                     get_navigation_text($button),
 843                                     $btitle
 844                                    ) .
 845                                        ']';
 846             }
 847         }
 848         else
 849         {                       # button is passive
 850             $result .=
 851                 $ICONS && $PASSIVE_ICONS{$button} ?
 852                     &$button_icon_img($BUTTONS_NAME{$button},
 853                                           $PASSIVE_ICONS{$button},
 854                                           $Texi2HTML::SIMPLE_TEXT{$button}) :
 855
 856                                               "[" . get_navigation_text($button) . "]";
 857         }
 858         $result .= "</td>\n" if $vertical;
 859         $result .= "</tr>\n" if $vertical;
 860     }
 861     $result .= "</td>" unless $beginofline;
 862     $result .= "</tr>" unless $vertical;
 863     $result .= "</table>\n";
 864     return $result;
 865 }
 866
 867
 868 @Texi2HTML::Config::SECTION_BUTTONS =
 869     ('left-aligned-cell-1', 'FastBack',
 870      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
 871      'right-aligned-cell-1', 'FastForward',
 872      'newline',
 873      'left-aligned-cell-2', 'Back',
 874      'center-aligned-cell-1', 'Up',
 875      'right-aligned-cell-2', 'Forward'
 876     );
 877
 878 # buttons for misc stuff
 879 @Texi2HTML::Config::MISC_BUTTONS = ('center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About');
 880
 881 # buttons for chapter file footers
 882 # (and headers but only if SECTION_NAVIGATION is false)
 883 @Texi2HTML::Config::CHAPTER_BUTTONS =
 884     ('left-aligned-cell-1', 'FastBack',
 885      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
 886      'right-aligned-cell-1', 'FastForward',
 887     );
 888
 889 # buttons for section file footers
 890 @Texi2HTML::Config::SECTION_FOOTER_BUTTONS =
 891     ('left-aligned-cell-1', 'FastBack',
 892      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
 893      'right-aligned-cell-1', 'FastForward',
 894      'newline',
 895      'left-aligned-cell-2', 'Back',
 896      'center-aligned-cell-1', 'Up',
 897      'right-aligned-cell-2', 'Forward'
 898     );
 899
 900 @Texi2HTML::Config::NODE_FOOTER_BUTTONS =
 901     ('left-aligned-cell-1', 'FastBack',
 902      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
 903      'right-aligned-cell-1', 'FastForward',
 904      'newline',
 905      'left-aligned-cell-2', 'Back',
 906      'center-aligned-cell-1', 'Up',
 907      'right-aligned-cell-2', 'Forward'
 908     );
 909
 910
 911
 912
 913
 914 #############################################################################
 915 ###  FOOTNOTE FORMATTING
 916 #############################################################################
 917
 918 # Format footnotes in a nicer way: Instead of printing the number in a separate
 919 # (nr) heading line, use the standard way of prepending <sup>nr</sup> immediately
 920 # before the fn text.
 921
 922
 923 # The following code is copied from texi2html's examples/makeinfo.init and
 924 # should be updated when texi2html makes some changes there!
 925
 926 my $makekinfo_like_footnote_absolute_number = 0;
 927
 928 sub makeinfo_like_foot_line_and_ref($$$$$$$$)
 929 {
 930     my $foot_num = shift;
 931     my $relative_num = shift;
 932     my $footid = shift;
 933     my $docid = shift;
 934     my $from_file = shift;
 935     my $footnote_file = shift;
 936     my $lines = shift;
 937     my $state = shift;
 938
 939     $makekinfo_like_footnote_absolute_number++;
 940
 941     # this is a bit obscure, this allows to add an anchor only if formatted
 942     # as part of the document.
 943     $docid = '' if ($state->{'outside_document'} or $state->{'multiple_pass'});
 944
 945     if ($from_file eq $footnote_file)
 946     {
 947         $from_file = $footnote_file = '';
 948     }
 949
 950     my $foot_anchor = "<sup>" . &$anchor($docid, "$footnote_file#$footid", $relative_num) . "</sup>";
 951     $foot_anchor = &$anchor($docid, "$footnote_file#$footid", "($relative_num)") if ($state->{'preformatted'});
 952
 953 #    unshift @$lines, "<li>";
 954 #    push @$lines, "</li>\n";
 955     return ($lines, $foot_anchor);
 956 }
 957
 958 sub makeinfo_like_foot_lines($)
 959 {
 960     my $lines = shift;
 961     unshift @$lines, "<hr>\n<h4>$Texi2HTML::I18n::WORDS->{'Footnotes_Title'}</h4>\n";
 962 #<ol type=\"1\">\n";
 963 #    push @$lines, "</ol>";
 964     return $lines;
 965 }
 966
 967 my %makekinfo_like_paragraph_in_footnote_nr;
 968
 969 sub makeinfo_like_paragraph ($$$$$$$$$$$$$)
 970 {
 971     my $text = shift;
 972     my $align = shift;
 973     my $indent = shift;
 974     my $paragraph_command = shift;
 975     my $paragraph_command_formatted = shift;
 976     my $paragraph_number = shift;
 977     my $format = shift;
 978     my $item_nr = shift;
 979     my $enumerate_style = shift;
 980     my $number = shift;
 981     my $command_stack_at_end = shift;
 982     my $command_stack_at_begin = shift;
 983     my $state = shift;
 984 #print STDERR "format: $format\n" if (defined($format));
 985 #print STDERR "paragraph @$command_stack_at_end; @$command_stack_at_begin\n";
 986     $paragraph_command_formatted = '' if (!defined($paragraph_command_formatted) or
 987           exists($special_list_commands{$format}->{$paragraph_command}));
 988     return '' if ($text =~ /^\s*$/);
 989     foreach my $style(t2h_collect_styles($command_stack_at_begin))
 990     {
 991        $text = t2h_begin_style($style, $text);
 992     }
 993     foreach my $style(t2h_collect_styles($command_stack_at_end))
 994     {
 995        $text = t2h_end_style($style, $text);
 996     }
 997     if (defined($paragraph_number) and defined($$paragraph_number))
 998     {
 999          $$paragraph_number++;
1000          return $text  if (($format eq 'itemize' or $format eq 'enumerate') and
1001             ($$paragraph_number == 1));
1002     }
1003     my $open = '<p';
1004     if ($align)
1005     {
1006         $open .= " align=\"$paragraph_style{$align}\"";
1007     }
1008     my $footnote_text = '';
1009     if (defined($command_stack_at_begin->[0]) and $command_stack_at_begin->[0] eq 'footnote')
1010     {
1011         my $state = $Texi2HTML::THISDOC{'state'};
1012         $makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number}++;
1013         if ($makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number} <= 1)
1014         {
1015            $open.=' class="footnote"';
1016            my $document_file = $state->{'footnote_document_file'};
1017            if ($document_file eq $state->{'footnote_footnote_file'})
1018            {
1019                $document_file = '';
1020            }
1021            my $docid = $state->{'footnote_place_id'};
1022            my $doc_state = $state->{'footnote_document_state'};
1023            $docid = '' if ($doc_state->{'outside_document'} or $doc_state->{'multiple_pass'});
1024            my $foot_label = &$anchor($state->{'footnote_footnote_id'},
1025                  $document_file . "#$state->{'footnote_place_id'}",
1026                  "$state->{'footnote_number_in_page'}");
1027            $footnote_text = "<small>[${foot_label}]</small> ";
1028         }
1029     }
1030     return $open.'>'.$footnote_text.$text.'</p>';
1031 }
1032
1033
1034 #############################################################################
1035 ###  OTHER SETTINGS
1036 #############################################################################
1037
1038 # For split pages, use index.html as start page!
1039 if ($Texi2HTML::Config::SPLIT eq 'section') {
1040   $Texi2HTML::Config::TOP_FILE = 'index.html';
1041 }
1042
1043
1044 return 1;