Documentation/lilypond-texi2html.init

   1 #!/usr/bin/env perl
   2
   3 # {
   4 package Texi2HTML::Config;
   5
   6 my $lastfilename;
   7 my $docnr = 0;
   8 my $page_toc_depth = 2;
   9
  10 use Data::Dumper;
  11 $Data::Dumper::Maxdepth = 2;
  12
  13 sub print_element_info($)
  14 {
  15   my $element = shift;
  16   print "~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
  17   print "Element: $element\n";
  18   print Dumper($element);
  19 }
  20
  21
  22 # This function makes sure that files are only generated for numbered sections,
  23 # but not for unnumbered ones. It is called after texi2html has done its own
  24 # splitting and simply returns the filename for the node given as first argument
  25 # Nodes with the same filename will be printed out to the same filename, so
  26 # this really all we need. Also, make sure that the file names for sections
  27 # are derived from the section title. We also might want to name the anchors
  28 # according to node titles, which works by simply overriding the id element of
  29 # the $element hash.
  30 sub split_at_numbered_sections($$$)
  31 {
  32   my $element = shift;
  33   my $type = shift;
  34   my $docu_name = shift;
  35   my $docu_ext = $Texi2HTML::Config::EXTENSION;
  36
  37 #   if ($$element{number} eq "1.1") {
  38 #     print_element_info ($element);
  39 #   }
  40
  41   # TOC, footer, about etc. are called with undefined $element and $type == "toc"|"stoc"|"foot"|"about"
  42   if ($type eq "toc" or $type eq "stoc" or $type eq "foot" or $type eq "about") {
  43     return;
  44   } else {
  45     # derive the name of the anchor (i.e. the part after # in the links!),
  46     # don't use texi2html's SECx.x default!
  47     my $anchor = main::remove_texi($$element{texi});
  48     if ($$element{translationof}) {
  49       $anchor = main::remove_texi($$element{translationof});
  50     }
  51     $anchor =~ tr/\ ?:'/-/d;
  52     $$element{id} = $anchor;
  53     # Numbered sections will get a filename Section_1.1.2, unnumbered sections will use
  54     # the file name of the previous numbered section:
  55     if ($$element{number}) {
  56       my $filename = $anchor;
  57       $filename .= ".$docu_ext" if (defined($docu_ext));
  58       $docnr += 1;
  59       $$element{doc_nr} = $docnr;
  60       $lastfilename = $filename;
  61       return $filename;
  62     } else {
  63       $$element{doc_nr} = $docnr;
  64       return $lastfilename;
  65     }
  66   }
  67
  68   return;
  69 }
  70
  71
  72 # Print a link in a menu. Since we split at sections, but still want access keys,
  73 # we have to duplicate this function here :-((((
  74 sub lilypond_menu_link($$$$$$)
  75 {
  76     my $entry = shift;
  77     my $state = shift;
  78     my $href = shift;
  79     my $node = shift;
  80     my $name = shift;
  81     my $ending = shift;
  82     if (($entry eq '') or $NODE_NAME_IN_MENU or $state->{'preformatted'})
  83     {
  84         $name .= ':' if ($name ne '');
  85         $entry = "$MENU_SYMBOL$name$node";
  86     }
  87     $menu_entry_index++;
  88     my $accesskey;
  89     $accesskey = "accesskey=\"$menu_entry_index\"" if ($USE_ACCESSKEY and ($menu_entry_index < 10));
  90     $entry = &$anchor ('', $href, $entry, $accesskey) if (defined($href));
  91     return $entry if ($SIMPLE_MENU);
  92     if ($state->{'preformatted'})
  93     {
  94         return '<tr><td>' . main::do_preformatted($entry . $ending, $state);
  95     }
  96     return "<tr><td align=\"left\" valign=\"top\">$entry</td><td>&nbsp;&nbsp;</td>";
  97 }
  98
  99
 100 # The default formatting of external refs returns e.g.
 101 # "(lilypond-internals)Timing_translator", while we simply want "Timing_translator".
 102 # Solution: Remove all (...) from the file_and_node argument before calling
 103 # the default handler!
 104 sub lilypond_external_ref($$$$$$)
 105 {
 106   my $type = shift;
 107   my $section = shift;
 108   my $book = shift;
 109   my $file_node = shift;
 110   my $href = shift;
 111   my $cross_ref = shift;
 112
 113   $file_node =~ s/\(.*\)//;
 114   return t2h_default_external_ref($type, $section, $book, $file_node, $href, $cross_ref);
 115 }
 116
 117
 118 # recursively generate the TOC entries for the element and its children (which
 119 # are only shown up to maxlevel. All ancestors of the current element are also
 120 # shown with their immediate children, irrespective of their level.
 121 sub generate_ly_toc_entries($$$)
 122 {
 123   my $element = shift;
 124   my $element_path = shift;
 125   my $maxlevel = shift;
 126   # Skip undefined sections, plus all sections generated by index splitting
 127   return() if (not defined($element) or exists($element->{'index_page'}));
 128   my @result = ();
 129   my $level = $element->{'toc_level'};
 130   my $is_parent_of_current = $element_path->{$element->{'number'}};
 131   my $print_children = ( ($level < $maxlevel) or $is_parent_of_current );
 132   my $ind = '  ' x $level;
 133   my $this_css_class = $is_parent_of_current ? " class=\"toc_current\"" : "";
 134
 135   my $entry = "$ind<li$this_css_class>" . &$anchor ($element->{'tocid'}, "$element->{'file'}#$element->{'id'}",$element->{'text'});
 136
 137   my $children = $element->{'section_childs'};
 138   if ( $print_children and defined($children) and (ref($children) eq "ARRAY") ) {
 139     push (@result, $entry);
 140     my @child_result = ();
 141     foreach (@$children) {
 142       push (@child_result, generate_ly_toc_entries($_, $element_path, $maxlevel));
 143     }
 144     # if no child nodes were generated, e.g. for the index, where expanded pages
 145     # are ignored, don't generate a list at all...
 146     if (@child_result) {
 147       push (@result, "$ind<ul$NO_BULLET_LIST_ATTRIBUTE>");
 148       push (@result, @child_result);
 149       push (@result, "$ind</ul></li>\n");
 150     }
 151   } else {
 152     push (@result, $entry . "</li>\n");
 153   }
 154   return @result;
 155 }
 156
 157
 158 # Print a customized TOC, containing only the first two levels plus the whole
 159 # path to the current page
 160 sub lilypond_generate_page_toc_body($)
 161 {
 162     my $element = shift;
 163     my $current_element = $element;
 164     my %parentelements;
 165     $parentelements{$element->{'number'}} = 1;
 166     # Find the path to the current element
 167     while ( defined($current_element->{'sectionup'}) and
 168            ($current_element->{'sectionup'} ne $current_element) )
 169     {
 170       $parentelements{$current_element->{'sectionup'}->{'number'}} = 1
 171               if ($current_element->{'sectionup'}->{'number'} ne '');
 172       $current_element = $current_element->{'sectionup'};
 173     }
 174     return () if not defined($current_element);
 175     # Create the toc entries recursively
 176     my @toc_entries = ("<div class=\"contents\">", "<ul$NO_BULLET_LIST_ATTRIBUTE>");
 177     my $children = $current_element->{'section_childs'};
 178     foreach ( @$children ) {
 179       push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth));
 180     }
 181     push (@toc_entries, "</ul>");
 182     push (@toc_entries, "</div>");
 183     return @toc_entries;
 184 }
 185
 186 my @this_page_toc = ();
 187
 188 sub lilypond_print_element_header
 189 {
 190   my $fh = shift;
 191   my $first_in_page = shift;
 192   my $previous_is_top = shift;
 193   if ($first_in_page and not @this_page_toc) {
 194     if (defined($Texi2HTML::THIS_ELEMENT)) {
 195       # Create the TOC for this page
 196       @this_page_toc = lilypond_generate_page_toc_body($Texi2HTML::THIS_ELEMENT);
 197     }
 198   }
 199 #    return T2H_DEFAULT_print_element_header( $fh, $first_in_page, $previous_is_top);
 200
 201     if (($first_in_page or $previous_is_top) and $SECTION_NAVIGATION)
 202     {
 203       &$print_head_navigation($fh, \@SECTION_BUTTONS);
 204     }
 205     else
 206     { # got to do this here, as it isn't done in print_head_navigation
 207       main::print_lines($fh, $Texi2HTML::THIS_HEADER);
 208       &$print_navigation($fh, \@INSIDE_SECTION_BUTTONS) if ($SECTION_NAVIGATION);
 209     }
 210 }
 211
 212
 213
 214
 215
 216
 217
 218 # Print out the TOC in a <div> at the end of th page, which will be formatted as a
 219 # sidebar mimicking a TOC frame
 220 sub print_lilypond_page_foot($)
 221 {
 222   my $fh = shift;
 223 #   my @lines = @{$Texi2HTML::OVERVIEW};
 224 #   my $lines = $Texi2HTML::TOC_LINES;
 225   my @lines = @this_page_toc;
 226   if (not @lines) {
 227     print "We have no toc lines, generate generic ones for main::element_top::\n";
 228     @lines = @$Texi2HTML::TOC_LINES;
 229   }
 230   if (@lines) {
 231     print $fh "<div id=\"tocframe\">";
 232     print $fh '<h4> ' . $Texi2HTML::NAME{'Contents'}  . "</h4>\n";
 233     foreach my $line (@lines) {
 234       print $fh $line;
 235     }
 236     print $fh "</div>";
 237     @this_page_toc = ();
 238   }
 239   T2H_DEFAULT_print_page_foot($fh);
 240 }
 241
 242
 243
 244
 245
 246
 247
 248 sub get_navigation_text
 249 {
 250   my $button = shift;
 251   my $text = $NAVIGATION_TEXT{$button};
 252   if ( ($button eq 'Back') or ($button eq 'FastBack') ) {
 253     $text = $text . $Texi2HTML::NODE{$button} . "&nbsp;";
 254   } elsif ( ($button eq 'Forward') or ($button eq 'FastForward') ) {
 255     $text = "&nbsp;" . $Texi2HTML::NODE{$button} . $text;
 256   } elsif ( $button eq 'Up' ) {
 257     $text = "&nbsp;".$text.":&nbsp;" . $Texi2HTML::NODE{$button} . "&nbsp;";
 258   }
 259   return $text;
 260 }
 261
 262
 263 # Don't automatically create left-aligned table cells for every link, but
 264 # instead create a <td> only on an appropriate '(left|right|center)-aligned-cell-n'
 265 # button text. It's alignment as well as the colspan will be taken from the
 266 # name of the button. Also, add 'newline' button text to create a new table
 267 # row. The texts of the buttons are generated by get_navigation_text and
 268 # will contain the name of the next/previous section/chapter.
 269 sub lilypond_print_navigation
 270 {
 271     my $fh = shift;
 272     my $buttons = shift;
 273     my $vertical = shift;
 274     my $spacing = 1;
 275 #     print $fh '<table cellpadding="', $spacing, '" cellspacing="', $spacing,
 276 #       "\" border=\"0\" class=\"nav_table\">\n";
 277     print $fh "<table class=\"nav_table\">\n";
 278
 279     print $fh "<tr>" unless $vertical;
 280     my $beginofline = 1;
 281     foreach my $button (@$buttons)
 282     {
 283         print $fh qq{<tr valign="top" align="left">\n} if $vertical;
 284         # Allow (left|right|center)-aligned-cell and newline as buttons!
 285         if ( $button =~ /^(.*)-aligned-cell-(.*)$/ )
 286         {
 287           print $fh qq{</td>} unless $beginofline;
 288           print $fh qq{<td valign="middle" align="$1" colspan="$2">};
 289           $beginofline = 0;
 290         }
 291         elsif ( $button eq 'newline' )
 292         {
 293           print $fh qq{</td>} unless $beginofline;
 294           print $fh qq{</tr>};
 295           print $fh qq{<tr>};
 296           $beginofline = 1;
 297
 298         }
 299         elsif (ref($button) eq 'CODE')
 300         {
 301             &$button($fh, $vertical);
 302         }
 303         elsif (ref($button) eq 'SCALAR')
 304         {
 305             print $fh "$$button" if defined($$button);
 306         }
 307         elsif (ref($button) eq 'ARRAY')
 308         {
 309             my $text = $button->[1];
 310             my $button_href = $button->[0];
 311             # verify that $button_href is simple text and text is a reference
 312             if (defined($button_href) and !ref($button_href)
 313                and defined($text) and (ref($text) eq 'SCALAR') and defined($$text))
 314             {             # use given text
 315                 if ($Texi2HTML::HREF{$button_href})
 316                 {
 317                   my $anchor_attributes = '';
 318                   if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button_href})) and ($BUTTONS_ACCESSKEY{$button_href} ne ''))
 319                   {
 320                       $anchor_attributes = "accesskey=\"$BUTTONS_ACCESSKEY{$button_href}\"";
 321                   }
 322                   if ($USE_REL_REV and (defined($BUTTONS_REL{$button_href})) and ($BUTTONS_REL{$button_href} ne ''))
 323                   {
 324                       $anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\"";
 325                   }
 326                   print $fh "" .
 327                         &$anchor('',
 328                                     $Texi2HTML::HREF{$button_href},
 329                                     get_navigation_text($$text),
 330                                     $anchor_attributes
 331                                    );
 332                 }
 333                 else
 334                 {
 335                   print $fh get_navigation_text($$text);
 336                 }
 337             }
 338         }
 339         elsif ($button eq ' ')
 340         {                       # handle space button
 341             print $fh
 342                 ($ICONS && $ACTIVE_ICONS{' '}) ?
 343                     &$button_icon_img($BUTTONS_NAME{$button}, $ACTIVE_ICONS{' '}) :
 344                         $NAVIGATION_TEXT{' '};
 345             #next;
 346         }
 347         elsif ($Texi2HTML::HREF{$button})
 348         {                       # button is active
 349             my $btitle = $BUTTONS_GOTO{$button} ?
 350                 'title="' . $BUTTONS_GOTO{$button} . '"' : '';
 351             if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button})) and ($BUTTONS_ACCESSKEY{$button} ne ''))
 352             {
 353                 $btitle .= " accesskey=\"$BUTTONS_ACCESSKEY{$button}\"";
 354             }
 355             if ($USE_REL_REV and (defined($BUTTONS_REL{$button})) and ($BUTTONS_REL{$button} ne ''))
 356             {
 357                 $btitle .= " rel=\"$BUTTONS_REL{$button}\"";
 358             }
 359             if ($ICONS && $ACTIVE_ICONS{$button})
 360             {                   # use icon
 361                 print $fh '' .
 362                     &$anchor('',
 363                         $Texi2HTML::HREF{$button},
 364                         &$button_icon_img($BUTTONS_NAME{$button},
 365                                    $ACTIVE_ICONS{$button},
 366                                    $Texi2HTML::SIMPLE_TEXT{$button}),
 367                         $btitle
 368                       );
 369             }
 370             else
 371             {                   # use text
 372                 print $fh
 373                     '[' .
 374                         &$anchor('',
 375                                     $Texi2HTML::HREF{$button},
 376                                     get_navigation_text ($button),
 377                                     $btitle
 378                                    ) .
 379                                        ']';
 380             }
 381         }
 382         else
 383         {                       # button is passive
 384             print $fh
 385                 $ICONS && $PASSIVE_ICONS{$button} ?
 386                     &$button_icon_img($BUTTONS_NAME{$button},
 387                                           $PASSIVE_ICONS{$button},
 388                                           $Texi2HTML::SIMPLE_TEXT{$button}) :
 389
 390                                               "[" . get_navigation_text($button) . "]";
 391         }
 392         print $fh "</td>\n" if $vertical;
 393         print $fh "</tr>\n" if $vertical;
 394     }
 395     print $fh "</td>" unless $beginofline;
 396     print $fh "</tr>" unless $vertical;
 397     print $fh "</table>\n";
 398 }
 399
 400
 401 @Texi2HTML::Config::SECTION_BUTTONS =
 402     ('left-aligned-cell-1', 'FastBack',
 403      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
 404      'right-aligned-cell-1', 'FastForward',
 405      'newline',
 406      'left-aligned-cell-2', 'Back',
 407      'center-aligned-cell-1', 'Up',
 408      'right-aligned-cell-2', 'Forward'
 409     );
 410
 411 # buttons for misc stuff
 412 @Texi2HTML::Config::MISC_BUTTONS = ('center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About');
 413
 414 # buttons for chapter file footers
 415 # (and headers but only if SECTION_NAVIGATION is false)
 416 @Texi2HTML::Config::CHAPTER_BUTTONS =
 417     ('left-aligned-cell-1', 'FastBack',
 418      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
 419      'right-aligned-cell-1', 'FastForward',
 420     );
 421
 422 # buttons for section file footers
 423 @Texi2HTML::Config::SECTION_FOOTER_BUTTONS =
 424     ('left-aligned-cell-1', 'FastBack',
 425      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
 426      'right-aligned-cell-1', 'FastForward',
 427      'newline',
 428      'left-aligned-cell-2', 'Back',
 429      'center-aligned-cell-1', 'Up',
 430      'right-aligned-cell-2', 'Forward'
 431     );
 432
 433 @Texi2HTML::Config::NODE_FOOTER_BUTTONS =
 434     ('left-aligned-cell-1', 'FastBack',
 435      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
 436      'right-aligned-cell-1', 'FastForward',
 437      'newline',
 438      'left-aligned-cell-2', 'Back',
 439      'center-aligned-cell-1', 'Up',
 440      'right-aligned-cell-2', 'Forward'
 441     );
 442
 443 @Texi2HTML::Config::INSIDE_SECTION_BUTTONS =
 444     ('left-aligned-cell-2', 'Back',
 445      'center-aligned-cell-1', 'Up',
 446      'right-aligned-cell-2', 'Forward'
 447     );
 448
 449
 450 # $Texi2HTML::Config::SPLIT = 'section';
 451 # @Texi2HTML::Config::CSS_REFS = ("lilypond.css");
 452 $Texi2HTML::Config::USE_ACCESSKEY = 1;
 453 $Texi2HTML::Config::USE_LINKS = 1;
 454 $Texi2HTML::Config::USE_REL_REV = 1;
 455 $Texi2HTML::Config::element_file_name = \&split_at_numbered_sections;
 456 $Texi2HTML::Config::print_element_header = \&lilypond_print_element_header;
 457 $Texi2HTML::Config::print_page_foot = \&print_lilypond_page_foot;
 458 $Texi2HTML::Config::print_navigation = \&lilypond_print_navigation;
 459 $Texi2HTML::Config::external_ref = \&lilypond_external_ref;
 460 $Texi2HTML::Config::menu_link = \&lilypond_menu_link;
 461
 462
 463 # For split pages, use index(.lang).html as start page!
 464 if ($Texi2HTML::Config::SPLIT == 'section') {
 465   my $lng = $Texi2HTML::THISDOC{'current_lang'};
 466   if ($lng and ($lng ne "en")) {
 467     $Texi2HTML::Config::TOP_FILE = 'index.'.$lng.'.html';
 468   } else {
 469     $Texi2HTML::Config::TOP_FILE = 'index.html';
 470   }
 471 }
 472
 473 if ($Texi2HTML::THISDOC{'current_lang'}) {
 474   $Texi2HTML::Config::EXTENSION = $Texi2HTML::THISDOC{'current_lang'} . "." .
 475         $docu_ext = $Texi2HTML::Config::EXTENSION;;
 476 }
 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     if ($pass == 1 and $macro eq "translationof") {
 494       if (ref($state->{'element'})=='HASH') {
 495         $state->{'element'}->{'translationof'} = main::normalise_space($line);
 496       }
 497       return ('', true, undef, undef);
 498     } else {
 499       return t2h_default_unknown($macro, $line, $pass, $stack, $state);
 500     }
 501 }
 502 $Texi2HTML::Config::unknown                  = \&lilypond_unknown;
 503
 504
 505
 506 return 1;