Documentation/lilypond-texi2html.init

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