#!/usr/bin/env perl # { package Texi2HTML::Config; my $lastfilename; my $docnr = 0; my $page_toc_depth = 2; my @default_toc = []; use Data::Dumper; $Data::Dumper::Maxdepth = 2; sub print_element_info($) { my $element = shift; print "~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n"; print "Element: $element\n"; print Dumper($element); } # Convert a given node name to its proper file name (normalization as explained # in the texinfo manual: # http://www.gnu.org/software/texinfo/manual/texinfo/html_node/HTML-Xref-Node-Name-Expansion.html sub texinfo_file_name($) { my $str = shift; # File name normalization by texinfo: # 1/2: letters and numbers are left unchanged # 3/4: multiple, leading and trailing whitespace is removed $str = main::normalise_space($str); # 5/6: all remaining spaces are converted to '-', all other 7- or 8-bit # chars are replaced by _xxxx (xxxx=ascii character code) my @chars = split(//, $str); my $str = ''; foreach my $char (@chars) { if ( $char eq ' ' ) { # space -> '-' $str .= '-'; } elsif ( ('0' le $char and $char le '9' ) or ('A' le $char and $char le 'Z' ) or ('a' le $char and $char le 'z' ) ) { # number or letter $str .= $char; } else { my $ccode = ord($char); my $addstr; if ( ord($char)<= 0xFFFF ) { $addstr = sprintf("_%4x", $ccode); } else { $addstr = sprintf("__%6x", $ccode); } # padding is done by spaces, replace by '0' $addstr =~ s/\ /0/g; $str .= $addstr; } } # 7: if name begins with number, prepend 't_g' (so it starts with a letter) if ($str =~ /^[0-9]/) { $str = 't_g' . $str; } # DONE return $str } # This function makes sure that files are only generated for numbered sections, # but not for unnumbered ones. It is called after texi2html has done its own # splitting and simply returns the filename for the node given as first argument # Nodes with the same filename will be printed out to the same filename, so # this really all we need. Also, make sure that the file names for sections # are derived from the section title. We also might want to name the anchors # according to node titles, which works by simply overriding the id element of # the $element hash. sub split_at_numbered_sections($$$) { my $element = shift; my $type = shift; my $docu_name = shift; my $docu_ext = $Texi2HTML::Config::EXTENSION; # if ($$element{number} eq "1.1") { # print_element_info ($element); # } # TOC, footer, about etc. are called with undefined $element and $type == "toc"|"stoc"|"foot"|"about" if ($type eq "toc" or $type eq "stoc" or $type eq "foot" or $type eq "about") { return; } else { # derive the name of the anchor (i.e. the part after # in the links!), # don't use texi2html's SECx.x default! my $anchor = main::remove_texi($$element{texi}); if ($$element{translationof}) { $anchor = main::remove_texi($$element{translationof}); } # normalize to the same file name as texinfo $anchor = texinfo_file_name($anchor); $$element{id} = $anchor; # Numbered sections will get a filename Section_1.1.2, unnumbered sections will use # the file name of the previous numbered section: if ($$element{number}) { my $filename = $anchor; $filename .= ".$docu_ext" if (defined($docu_ext)); $docnr += 1; $$element{doc_nr} = $docnr; $lastfilename = $filename; return $filename; } else { $$element{doc_nr} = $docnr; return $lastfilename; } } return; } # The default formatting of external refs returns e.g. # "(lilypond-internals)Timing_translator", while we simply want "Timing_translator". # Solution: Remove all (...) from the file_and_node argument before calling # the default handler! sub lilypond_external_ref($$$$$$) { my $type = shift; my $section = shift; my $book = shift; my $file_node = shift; my $href = shift; my $cross_ref = shift; $file_node =~ s/\(.*\)//; return t2h_default_external_ref($type, $section, $book, $file_node, $href, $cross_ref); } # recursively generate the TOC entries for the element and its children (which # are only shown up to maxlevel. All ancestors of the current element are also # shown with their immediate children, irrespective of their level. sub generate_ly_toc_entries($$$) { my $element = shift; my $element_path = shift; my $maxlevel = shift; # Skip undefined sections, plus all sections generated by index splitting return() if (not defined($element) or exists($element->{'index_page'})); my @result = (); my $level = $element->{'toc_level'}; my $is_parent_of_current = $element_path->{$element->{'number'}}; my $print_children = ( ($level < $maxlevel) or $is_parent_of_current ); my $ind = ' ' x $level; my $this_css_class = $is_parent_of_current ? " class=\"toc_current\"" : ""; my $entry = "$ind" . &$anchor ($element->{'tocid'}, "$element->{'file'}#$element->{'id'}",$element->{'text'}); my $children = $element->{'section_childs'}; if ( $print_children and defined($children) and (ref($children) eq "ARRAY") ) { push (@result, $entry); my @child_result = (); foreach (@$children) { push (@child_result, generate_ly_toc_entries($_, $element_path, $maxlevel)); } # if no child nodes were generated, e.g. for the index, where expanded pages # are ignored, don't generate a list at all... if (@child_result) { push (@result, "$ind"); push (@result, @child_result); push (@result, "$ind\n"); } } else { push (@result, $entry . "\n"); } return @result; } # Print a customized TOC, containing only the first two levels plus the whole # path to the current page sub lilypond_generate_page_toc_body($) { my $element = shift; my $current_element = $element; my %parentelements; $parentelements{$element->{'number'}} = 1; # Find the path to the current element while ( defined($current_element->{'sectionup'}) and ($current_element->{'sectionup'} ne $current_element) ) { $parentelements{$current_element->{'sectionup'}->{'number'}} = 1 if ($current_element->{'sectionup'}->{'number'} ne ''); $current_element = $current_element->{'sectionup'}; } return () if not defined($current_element); # Create the toc entries recursively my @toc_entries = ("
", ""); my $children = $current_element->{'section_childs'}; foreach ( @$children ) { push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth)); } push (@toc_entries, ""); push (@toc_entries, "
"); return @toc_entries; } my @this_page_toc = (); sub lilypond_print_element_header { my $fh = shift; my $first_in_page = shift; my $previous_is_top = shift; if ($first_in_page and not @this_page_toc) { if (defined($Texi2HTML::THIS_ELEMENT)) { # Create the TOC for this page @this_page_toc = lilypond_generate_page_toc_body($Texi2HTML::THIS_ELEMENT); } } return T2H_DEFAULT_print_element_header( $fh, $first_in_page, $previous_is_top); } sub lilypond_toc_body($) { my $elements_list = shift; # Generate a default TOC for pages without THIS_ELEMENT @default_toc = lilypond_generate_page_toc_body(@$elements_list[0]); return T2H_GPL_toc_body($elements_list); } # Print out the TOC in a
at the end of th page, which will be formatted as a # sidebar mimicking a TOC frame sub print_lilypond_page_foot($) { my $fh = shift; my @lines = @this_page_toc; # use default TOC if no custom lines have been generated @lines = @default_toc if (not @lines); if (@lines) { print $fh "
"; print $fh '

' . $Texi2HTML::NAME{'Contents'} . "

\n"; foreach my $line (@lines) { print $fh $line; } print $fh "
"; @this_page_toc = (); } T2H_DEFAULT_print_page_foot($fh); } sub get_navigation_text { my $button = shift; my $text = $NAVIGATION_TEXT{$button}; if ( ($button eq 'Back') or ($button eq 'FastBack') ) { $text = $text . $Texi2HTML::NODE{$button} . " "; } elsif ( ($button eq 'Forward') or ($button eq 'FastForward') ) { $text = " " . $Texi2HTML::NODE{$button} . $text; } elsif ( $button eq 'Up' ) { $text = " ".$text.": " . $Texi2HTML::NODE{$button} . " "; } return $text; } # Don't automatically create left-aligned table cells for every link, but # instead create a only on an appropriate '(left|right|center)-aligned-cell-n' # button text. It's alignment as well as the colspan will be taken from the # name of the button. Also, add 'newline' button text to create a new table # row. The texts of the buttons are generated by get_navigation_text and # will contain the name of the next/previous section/chapter. sub lilypond_print_navigation { my $fh = shift; my $buttons = shift; my $vertical = shift; my $spacing = 1; # print $fh '\n"; print $fh "
\n"; print $fh "" unless $vertical; my $beginofline = 1; foreach my $button (@$buttons) { print $fh qq{\n} if $vertical; # Allow (left|right|center)-aligned-cell and newline as buttons! if ( $button =~ /^(.*)-aligned-cell-(.*)$/ ) { print $fh qq{} unless $beginofline; print $fh qq{} unless $beginofline; print $fh qq{}; print $fh qq{}; $beginofline = 1; } elsif (ref($button) eq 'CODE') { &$button($fh, $vertical); } elsif (ref($button) eq 'SCALAR') { print $fh "$$button" if defined($$button); } elsif (ref($button) eq 'ARRAY') { my $text = $button->[1]; my $button_href = $button->[0]; # verify that $button_href is simple text and text is a reference if (defined($button_href) and !ref($button_href) and defined($text) and (ref($text) eq 'SCALAR') and defined($$text)) { # use given text if ($Texi2HTML::HREF{$button_href}) { my $anchor_attributes = ''; if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button_href})) and ($BUTTONS_ACCESSKEY{$button_href} ne '')) { $anchor_attributes = "accesskey=\"$BUTTONS_ACCESSKEY{$button_href}\""; } if ($USE_REL_REV and (defined($BUTTONS_REL{$button_href})) and ($BUTTONS_REL{$button_href} ne '')) { $anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\""; } print $fh "" . &$anchor('', $Texi2HTML::HREF{$button_href}, get_navigation_text($$text), $anchor_attributes ); } else { print $fh get_navigation_text($$text); } } } elsif ($button eq ' ') { # handle space button print $fh ($ICONS && $ACTIVE_ICONS{' '}) ? &$button_icon_img($BUTTONS_NAME{$button}, $ACTIVE_ICONS{' '}) : $NAVIGATION_TEXT{' '}; #next; } elsif ($Texi2HTML::HREF{$button}) { # button is active my $btitle = $BUTTONS_GOTO{$button} ? 'title="' . $BUTTONS_GOTO{$button} . '"' : ''; if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button})) and ($BUTTONS_ACCESSKEY{$button} ne '')) { $btitle .= " accesskey=\"$BUTTONS_ACCESSKEY{$button}\""; } if ($USE_REL_REV and (defined($BUTTONS_REL{$button})) and ($BUTTONS_REL{$button} ne '')) { $btitle .= " rel=\"$BUTTONS_REL{$button}\""; } if ($ICONS && $ACTIVE_ICONS{$button}) { # use icon print $fh '' . &$anchor('', $Texi2HTML::HREF{$button}, &$button_icon_img($BUTTONS_NAME{$button}, $ACTIVE_ICONS{$button}, $Texi2HTML::SIMPLE_TEXT{$button}), $btitle ); } else { # use text print $fh '[' . &$anchor('', $Texi2HTML::HREF{$button}, get_navigation_text ($button), $btitle ) . ']'; } } else { # button is passive print $fh $ICONS && $PASSIVE_ICONS{$button} ? &$button_icon_img($BUTTONS_NAME{$button}, $PASSIVE_ICONS{$button}, $Texi2HTML::SIMPLE_TEXT{$button}) : "[" . get_navigation_text($button) . "]"; } print $fh "\n" if $vertical; print $fh "\n" if $vertical; } print $fh "" unless $beginofline; print $fh "" unless $vertical; print $fh "
}; $beginofline = 0; } elsif ( $button eq 'newline' ) { print $fh qq{
\n"; } @Texi2HTML::Config::SECTION_BUTTONS = ('left-aligned-cell-1', 'FastBack', 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About', 'right-aligned-cell-1', 'FastForward', 'newline', 'left-aligned-cell-2', 'Back', 'center-aligned-cell-1', 'Up', 'right-aligned-cell-2', 'Forward' ); # buttons for misc stuff @Texi2HTML::Config::MISC_BUTTONS = ('center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About'); # buttons for chapter file footers # (and headers but only if SECTION_NAVIGATION is false) @Texi2HTML::Config::CHAPTER_BUTTONS = ('left-aligned-cell-1', 'FastBack', 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About', 'right-aligned-cell-1', 'FastForward', ); # buttons for section file footers @Texi2HTML::Config::SECTION_FOOTER_BUTTONS = ('left-aligned-cell-1', 'FastBack', 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About', 'right-aligned-cell-1', 'FastForward', 'newline', 'left-aligned-cell-2', 'Back', 'center-aligned-cell-1', 'Up', 'right-aligned-cell-2', 'Forward' ); @Texi2HTML::Config::NODE_FOOTER_BUTTONS = ('left-aligned-cell-1', 'FastBack', 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About', 'right-aligned-cell-1', 'FastForward', 'newline', 'left-aligned-cell-2', 'Back', 'center-aligned-cell-1', 'Up', 'right-aligned-cell-2', 'Forward' ); # $Texi2HTML::Config::SPLIT = 'section'; @Texi2HTML::Config::CSS_REFS = ("lilypond.css"); $Texi2HTML::Config::USE_ACCESSKEY = 1; $Texi2HTML::Config::USE_LINKS = 1; $Texi2HTML::Config::USE_REL_REV = 1; $Texi2HTML::Config::element_file_name = \&split_at_numbered_sections; $Texi2HTML::Config::print_element_header = \&lilypond_print_element_header; $Texi2HTML::Config::print_page_foot = \&print_lilypond_page_foot; $Texi2HTML::Config::print_navigation = \&lilypond_print_navigation; $Texi2HTML::Config::external_ref = \&lilypond_external_ref; $Texi2HTML::Config::toc_body = \&lilypond_toc_body; # For split pages, use index(.lang).html as start page! if ($Texi2HTML::Config::SPLIT == 'section') { # my $lng = $Texi2HTML::THISDOC{'current_lang'}; # if ($lng and ($lng ne "en")) { # $Texi2HTML::Config::TOP_FILE = 'index.'.$lng.'.html'; # } else { $Texi2HTML::Config::TOP_FILE = 'index.html'; # } } # if ($Texi2HTML::THISDOC{'current_lang'}) { # $Texi2HTML::Config::EXTENSION = $Texi2HTML::THISDOC{'current_lang'} . "." . # $docu_ext = $Texi2HTML::Config::EXTENSION;; # } # Try to make use of @translationof to generate files according to the original # English section title... sub lilypond_unknown($$$$$) { my $macro = shift; my $line = shift; my $pass = shift; my $stack = shift; my $state = shift; # the @translationof macro provides the original English section title, # which should be used for file/anchor naming, while the title will be # translated to each language if ($pass == 1 and $macro eq "translationof") { if (ref($state->{'element'})=='HASH') { $state->{'element'}->{'translationof'} = main::normalise_space($line); } return ('', true, undef, undef); } else { return t2h_default_unknown($macro, $line, $pass, $stack, $state); } } $Texi2HTML::Config::unknown = \&lilypond_unknown; return 1;