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