X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lilypond-texi2html.init;h=4e33ce43826461da048de62236e9b633cb19f012;hb=32d0927f44af08231143eeb216c381b323472c2b;hp=66c269b36fb940fc33c024f40aa8e0b710027a4e;hpb=367071155ed722594587efc323c05ccfd3d3de99;p=lilypond.git diff --git a/lilypond-texi2html.init b/lilypond-texi2html.init index 66c269b36f..4e33ce4382 100644 --- a/lilypond-texi2html.init +++ b/lilypond-texi2html.init @@ -1,4 +1,5 @@ #!/usr/bin/env perl +# -*- coding: utf-8; -*- ### texi2html customization script for Lilypond ### Author: Reinhold Kainhofer , 2008. @@ -65,20 +66,56 @@ package Texi2HTML::Config; +############################################################################# +### TRANSLATIONS +############################################################################# - +use utf8; +my $LY_LANGUAGES = {}; +$LY_LANGUAGES->{'fr'} = { + 'Back to Documentation Index' => 'Retour à l\'accueil de la documentation', +}; +$LY_LANGUAGES->{'es'} = { + 'Back to Documentation Index' => 'Volver al índice de la documentación', +}; +$LY_LANGUAGES->{'de'} = { + 'Back to Documentation Index' => 'Zur Dokumentationsübersicht', +}; +$LY_LANGUAGES->{'ja'} = { + 'Back to Documentation Index' => 'ドキュメント インデックスに戻る', +}; + + +sub ly_get_string () { + my $lang = $Texi2HTML::THISDOC{current_lang}; + my $string = shift; + if ($lang and $lang ne "en" and $LY_LANGUAGES->{$lang}->{$string}) { + return $LY_LANGUAGES->{$lang}->{$string}; + } else { + return $string; + } +} ############################################################################# ### SETTINGS FOR TEXI2HTML ############################################################################# -@Texi2HTML::Config::CSS_REFS = ("lilypond.css"); +@Texi2HTML::Config::CSS_REFS = ( + {FILENAME => "lilypond-mccarty.css", TITLE => "Patrick McCarty's design"} +); +@Texi2HTML::Config::ALT_CSS_REFS = ( + {FILENAME => "lilypond.css", TITLE => "Andrew Hawryluk's design" }, + {FILENAME => "lilypond-blue.css", TITLE => "Kurt Kroon's blue design" }, +); $Texi2HTML::Config::USE_ACCESSKEY = 1; $Texi2HTML::Config::USE_LINKS = 1; $Texi2HTML::Config::USE_REL_REV = 1; +$Texi2HTML::Config::SPLIT_INDEX = 0; $Texi2HTML::Config::SEPARATED_FOOTNOTES = 0; # Print footnotes on same page, not separated -$Texi2HTML::Config::element_file_name = \&lilypond_element_file_name; +if ($Texi2HTML::Config::SPLIT eq 'section') { + $Texi2HTML::Config::element_file_name = \&lilypond_element_file_name; +} $Texi2HTML::Config::element_target_name = \&lilypond_element_target_name; $Texi2HTML::Config::print_element_header = \&lilypond_print_element_header; $Texi2HTML::Config::print_page_foot = \&print_lilypond_page_foot; @@ -100,6 +137,7 @@ $Texi2HTML::Config::paragraph = \&makeinfo_like_paragraph; $Texi2HTML::Config::complex_format_map->{'example'} = { 'begin' => q{"
"},
   'end' => q{"
\n"}, + 'style' => 'code', }; %Texi2HTML::config::misc_pages_targets = ( @@ -206,7 +244,7 @@ sub load_map_file ($) sub split_texi_filename ($) { my $docu = shift; - my $docu_dir, $docu_name; + my ($docu_dir, $docu_name); if ($docu =~ /(.*\/)/) { chop($docu_dir = $1); $docu_name = $docu; @@ -233,19 +271,23 @@ sub lilypond_css_lines ($$) { my $import_lines = shift; my $rule_lines = shift; - return if (defined($CSS_LINES)); + return if (defined($Texi2HTML::THISDOC{'CSS_LINES'})); if (@$rule_lines or @$import_lines) { - $CSS_LINES = "\n"; + $Texi2HTML::THISDOC{'CSS_LINES'} = "\n"; } foreach my $ref (@CSS_REFS) { - $CSS_LINES .= "\n"; + $Texi2HTML::THISDOC{'CSS_LINES'} .= "{TITLE}\" href=\"$ref->{FILENAME}\">\n"; + } + foreach my $ref (@Texi2HTML::Config::ALT_CSS_REFS) + { + $Texi2HTML::THISDOC{'CSS_LINES'} .= "{FILENAME}\" title=\"$ref->{TITLE}\">\n"; } - $CSS_LINES .= "\n"; + $Texi2HTML::THISDOC{'CSS_LINES'} .= "\n"; } @@ -270,7 +312,7 @@ my $node_to_filename_map = (); # according to node titles, which works by simply overriding the id element of # the $element hash. # If an external nodename<=>filename/anchor map file is found (loaded in -# lilypond_init_out, use the externally created values, otherwise use the +# the command handler, use the externally created values, otherwise use the # same logic here. sub lilypond_element_file_name($$$) { @@ -350,7 +392,7 @@ sub lilypond_element_target_name($$$) } # If we have an entry in the section<=>filename map, use that one, otherwise - # generate the anchor here. + # generate the anchor here. if (exists ($node_to_filename_map->{$node_name})) { (my $filename, $target) = @{$node_to_filename_map->{$node_name}}; } else { @@ -450,7 +492,7 @@ sub lilypond_unknown($$$$$) if (ref($state->{'element'}) eq 'HASH') { $state->{'element'}->{'translationof'} = main::normalise_space($line); } - return ('', true, undef, undef); + return ('', 1, undef, undef); } else { return t2h_default_unknown($macro, $line, $pass, $stack, $state); } @@ -522,49 +564,66 @@ sub lilypond_external_href($$$) my $page_toc_depth = 2; my @default_toc = []; + +# Initialize the toc_depth to 1 if the command-line option -D=short_toc is given +sub lilypond_init_toc_depth () +{ + if (exists($main::value{'short_toc'}) and not exists($main::value{'bigpage'})) { + $page_toc_depth = 1; + } +} +# Set the TOC-depth (depending on a texinfo variable short_toc) in a +# command-handler, so we have them available when creating the pages +push @Texi2HTML::Config::command_handler_process, \&lilypond_init_toc_depth; + + # 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. -# Unnumbered entries are only printed out if they are at top-level or their -# parent element is an ancestor of the currently viewed node. -sub generate_ly_toc_entries($$$$) +# Unnumbered entries are only printed out if they are at top-level or 2nd level +# or their parent element is an ancestor of the currently viewed node. +# The conditions to call this method to print the entry for a child node is: +# -) the parent is an ancestor of the current page node +# -) the parent is a numbered element at top-level toplevel (i.e. show numbered +# and unnumbered 2nd-level children of numbered nodes) +# -) the child element is a numbered node below level maxlevel +sub generate_ly_toc_entries($$$) { my $element = shift; my $element_path = shift; my $maxlevel = shift; - my $always_show_unnumbered_children = 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->{'id'} && $element_path->{$element->{'id'}}; - 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->{'target'}",$element->{'text'}); + push (@result, $entry); my $children = $element->{'section_childs'}; - # Don't add unnumbered entries, unless they are at top-level or a parent of the current! - if (not ($element->{'number'} or $always_show_unnumbered_children)) { - return @result; - } - if ( $print_children and defined($children) and (ref($children) eq "ARRAY") ) { - push (@result, $entry); + if (defined($children) and (ref($children) eq "ARRAY")) { + my $force_children = $is_parent_of_current or ($level == 1 and $element->{'number'}); my @child_result = (); - foreach (@$children) { - push (@child_result, generate_ly_toc_entries($_, $element_path, $maxlevel, $is_parent_of_current)); + foreach my $c (@$children) { + my $is_numbered_child = defined ($c->{'number'}); + my $below_maxlevel = $c->{'toc_level'} le $maxlevel; + if ($force_children or ($is_numbered_child and $below_maxlevel)) { + my @child_res = generate_ly_toc_entries($c, $element_path, $maxlevel); + push (@child_result, @child_res); + } } # 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, "\n$ind\n"); push (@result, @child_result); - push (@result, "$ind\n"); + push (@result, "$ind\n"); } - } else { - push (@result, $entry . "\n"); } + push (@result, "$ind\n"); return @result; } @@ -590,7 +649,7 @@ sub lilypond_generate_page_toc_body($) my @toc_entries = ("
\n", "\n"); my $children = $current_element->{'section_childs'}; foreach ( @$children ) { - push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth, False)); + push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth)); } push (@toc_entries, "\n"); push (@toc_entries, "
\n"); @@ -605,8 +664,34 @@ sub lilypond_print_toc_div ($$) # use default TOC if no custom lines have been generated @lines = @default_toc if (not @lines); if (@lines) { + print $fh "\n\n
\n"; - print $fh '

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

\n"; + + # Remove the leading "GNU LilyPond --- " from the manual title + my $topname = $Texi2HTML::NAME{'Top'}; + $topname =~ s/^GNU LilyPond(:| &[mn]dash;) //; + + # construct the top-level Docs index (relative path and including language!) + my $lang = $Texi2HTML::THISDOC{current_lang}; + if ($lang and $lang ne "en") { + $lang .= "."; + } else { + $lang = ""; + } + my $reldir = ""; + $reldir = "../" if ($Texi2HTML::Config::SPLIT eq 'section'); + my $uplink = $reldir."index.${lang}html"; + + print $fh "

<< " . + &ly_get_string ('Back to Documentation Index') . + "

\n"; + + print $fh '

' . &$anchor('', + $Texi2HTML::HREF{'Top'}, + $topname, + 'title="Start of the manual"' + ) . "

\n"; foreach my $line (@lines) { print $fh $line; } @@ -621,7 +706,6 @@ sub lilypond_print_toc_div ($$) our @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) { @@ -630,7 +714,7 @@ sub lilypond_print_element_header @this_page_toc = lilypond_generate_page_toc_body($Texi2HTML::THIS_ELEMENT); } } - return T2H_DEFAULT_print_element_header( $fh, $first_in_page, $previous_is_top); + return T2H_DEFAULT_print_element_header( $first_in_page, $previous_is_top); } # Generate the HTML output for the TOC @@ -656,7 +740,7 @@ sub print_lilypond_page_foot($) { my $fh = shift; my $program_string = &$program_string(); - print $fh "

$program_string
$PRE_BODY_CLOSE

\n"; +# print $fh "

$program_string
$PRE_BODY_CLOSE

\n"; print $fh "\n\n"; print $fh "\n
\n\n"; @@ -699,48 +783,45 @@ sub get_navigation_text # 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"; + my $result = "
\n"; - print $fh "" unless $vertical; + $result .= "" unless $vertical; my $beginofline = 1; foreach my $button (@$buttons) { - print $fh qq{\n} if $vertical; + $result .= 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; + $result .= qq{} unless $beginofline; - print $fh qq{}; - print $fh qq{}; + $result .= qq{} unless $beginofline; + $result .= qq{}; + $result .= qq{}; $beginofline = 1; } elsif (ref($button) eq 'CODE') { - &$button($fh, $vertical); + $result .= &$button($vertical); } elsif (ref($button) eq 'SCALAR') { - print $fh "$$button" if defined($$button); + $result .= "$$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) + 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}) @@ -754,7 +835,7 @@ sub lilypond_print_navigation { $anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\""; } - print $fh "" . + $result .= "" . &$anchor('', $Texi2HTML::HREF{$button_href}, get_navigation_text($$text), @@ -763,13 +844,13 @@ sub lilypond_print_navigation } else { - print $fh get_navigation_text($$text); + $result .= get_navigation_text($$text); } } } elsif ($button eq ' ') { # handle space button - print $fh + $result .= ($ICONS && $ACTIVE_ICONS{' '}) ? &$button_icon_img($BUTTONS_NAME{$button}, $ACTIVE_ICONS{' '}) : $NAVIGATION_TEXT{' '}; @@ -789,7 +870,7 @@ sub lilypond_print_navigation } if ($ICONS && $ACTIVE_ICONS{$button}) { # use icon - print $fh '' . + $result .= '' . &$anchor('', $Texi2HTML::HREF{$button}, &$button_icon_img($BUTTONS_NAME{$button}, @@ -800,11 +881,11 @@ sub lilypond_print_navigation } else { # use text - print $fh + $result .= '[' . &$anchor('', $Texi2HTML::HREF{$button}, - get_navigation_text ($button), + get_navigation_text($button), $btitle ) . ']'; @@ -812,7 +893,7 @@ sub lilypond_print_navigation } else { # button is passive - print $fh + $result .= $ICONS && $PASSIVE_ICONS{$button} ? &$button_icon_img($BUTTONS_NAME{$button}, $PASSIVE_ICONS{$button}, @@ -820,12 +901,13 @@ sub lilypond_print_navigation "[" . get_navigation_text($button) . "]"; } - print $fh "\n" if $vertical; - print $fh "\n" if $vertical; + $result .= "\n" if $vertical; + $result .= "\n" if $vertical; } - print $fh "" unless $beginofline; - print $fh "" unless $vertical; - print $fh "
}; + $result .= qq{}; $beginofline = 0; } elsif ( $button eq 'newline' ) { - print $fh qq{
\n"; + $result .= "" unless $beginofline; + $result .= "" unless $vertical; + $result .= "\n"; + return $result; } @@ -884,7 +966,7 @@ sub lilypond_print_navigation # before the fn text. -# The following code is copied from texi2html's examples/makeinfo.init and +# The following code is copied from texi2html's examples/makeinfo.init and # should be updated when texi2html makes some changes there! my $makekinfo_like_footnote_absolute_number = 0; @@ -899,7 +981,7 @@ sub makeinfo_like_foot_line_and_ref($$$$$$$$) my $footnote_file = shift; my $lines = shift; my $state = shift; - + $makekinfo_like_footnote_absolute_number++; # this is a bit obscure, this allows to add an anchor only if formatted @@ -907,7 +989,7 @@ sub makeinfo_like_foot_line_and_ref($$$$$$$$) $docid = '' if ($state->{'outside_document'} or $state->{'multiple_pass'}); if ($from_file eq $footnote_file) - { + { $from_file = $footnote_file = ''; } @@ -985,8 +1067,8 @@ sub makeinfo_like_paragraph ($$$$$$$$$$$$$) my $docid = $state->{'footnote_place_id'}; my $doc_state = $state->{'footnote_document_state'}; $docid = '' if ($doc_state->{'outside_document'} or $doc_state->{'multiple_pass'}); - my $foot_label = &$anchor($state->{'footnote_footnote_id'}, - $document_file . "#$state->{'footnote_place_id'}", + my $foot_label = &$anchor($state->{'footnote_footnote_id'}, + $document_file . "#$state->{'footnote_place_id'}", "$state->{'footnote_number_in_page'}"); $footnote_text = "[${foot_label}] "; }