#!/usr/bin/env perl
+# -*- coding: utf-8; -*-
### texi2html customization script for Lilypond
### Author: Reinhold Kainhofer <reinhold@kainhofer.com>, 2008.
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;
$Texi2HTML::Config::complex_format_map->{'example'} = {
'begin' => q{"<blockquote><pre class=\"example\">"},
'end' => q{"</pre></blockquote>\n"},
+ 'style' => 'code',
};
%Texi2HTML::config::misc_pages_targets = (
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;
{
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 = "<style type=\"text/css\">\n<!--\n";
- $CSS_LINES .= join('',@$import_lines) . "\n" if (@$import_lines);
- $CSS_LINES .= join('',@$rule_lines) . "\n" if (@$rule_lines);
- $CSS_LINES .= "-->\n</style>\n";
+ $Texi2HTML::THISDOC{'CSS_LINES'} = "<style type=\"text/css\">\n<!--\n";
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$import_lines) . "\n" if (@$import_lines);
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$rule_lines) . "\n" if (@$rule_lines);
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= "-->\n</style>\n";
}
foreach my $ref (@CSS_REFS)
{
- $CSS_LINES .= "<link rel=\"stylesheet\" type=\"text/css\" href=\"$ref\">\n";
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"stylesheet\" type=\"text/css\" title=\"$ref->{TITLE}\" href=\"$ref->{FILENAME}\">\n";
+ }
+ foreach my $ref (@Texi2HTML::Config::ALT_CSS_REFS)
+ {
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"alternate stylesheet\" type=\"text/css\" href=\"$ref->{FILENAME}\" title=\"$ref->{TITLE}\">\n";
}
- $CSS_LINES .= "<!--[if lte IE 7]>\n<link href=\"lilypond-ie-fixes.css\" rel=\"stylesheet\" type=\"text/css\">\n<![endif]-->\n";
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= "<!--[if lte IE 7]>\n<link href=\"lilypond-ie-fixes.css\" rel=\"stylesheet\" type=\"text/css\">\n<![endif]-->\n";
}
}
# 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 {
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);
}
# 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<li$this_css_class>" . &$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<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
push (@result, @child_result);
- push (@result, "$ind</ul></li>\n");
+ push (@result, "$ind</ul>\n");
}
- } else {
- push (@result, $entry . "</li>\n");
}
+ push (@result, "$ind</li>\n");
return @result;
}
my @toc_entries = ("<div class=\"contents\">\n", "<ul$NO_BULLET_LIST_ATTRIBUTE>\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, "</ul>\n");
push (@toc_entries, "</div>\n");
# use default TOC if no custom lines have been generated
@lines = @default_toc if (not @lines);
if (@lines) {
+
print $fh "\n\n<div id=\"tocframe\">\n";
- print $fh '<h4> ' . $Texi2HTML::NAME{'Contents'} . "</h4>\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 "<p class=\"toc_uplink\"><a href=\"$uplink\"
+ title=\"Documentation Index\"><< " .
+ &ly_get_string ('Back to Documentation Index') .
+ "</a></p>\n";
+
+ print $fh '<h4 class="toc_header"> ' . &$anchor('',
+ $Texi2HTML::HREF{'Top'},
+ $topname,
+ 'title="Start of the manual"'
+ ) . "</h4>\n";
foreach my $line (@lines) {
print $fh $line;
}
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) {
@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
{
my $fh = shift;
my $program_string = &$program_string();
- print $fh "<p><font size='-1'>$program_string</font><br>$PRE_BODY_CLOSE</p>\n";
+# print $fh "<p><font size='-1'>$program_string</font><br>$PRE_BODY_CLOSE</p>\n";
print $fh "<!-- FOOTER -->\n\n";
print $fh "<!-- end div#main here -->\n</div>\n\n";
# 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 '<table cellpadding="', $spacing, '" cellspacing="', $spacing,
-# "\" border=\"0\" class=\"nav_table\">\n";
- print $fh "<table class=\"nav_table\">\n";
+ my $result = "<table class=\"nav_table\">\n";
- print $fh "<tr>" unless $vertical;
+ $result .= "<tr>" unless $vertical;
my $beginofline = 1;
foreach my $button (@$buttons)
{
- print $fh qq{<tr valign="top" align="left">\n} if $vertical;
+ $result .= qq{<tr valign="top" align="left">\n} if $vertical;
# Allow (left|right|center)-aligned-cell and newline as buttons!
if ( $button =~ /^(.*)-aligned-cell-(.*)$/ )
{
- print $fh qq{</td>} unless $beginofline;
- print $fh qq{<td valign="middle" align="$1" colspan="$2">};
+ $result .= qq{</td>} unless $beginofline;
+ $result .= qq{<td valign="middle" align="$1" colspan="$2">};
$beginofline = 0;
}
elsif ( $button eq 'newline' )
{
- print $fh qq{</td>} unless $beginofline;
- print $fh qq{</tr>};
- print $fh qq{<tr>};
+ $result .= qq{</td>} unless $beginofline;
+ $result .= qq{</tr>};
+ $result .= qq{<tr>};
$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})
{
$anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\"";
}
- print $fh "" .
+ $result .= "" .
&$anchor('',
$Texi2HTML::HREF{$button_href},
get_navigation_text($$text),
}
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{' '};
}
if ($ICONS && $ACTIVE_ICONS{$button})
{ # use icon
- print $fh '' .
+ $result .= '' .
&$anchor('',
$Texi2HTML::HREF{$button},
&$button_icon_img($BUTTONS_NAME{$button},
}
else
{ # use text
- print $fh
+ $result .=
'[' .
&$anchor('',
$Texi2HTML::HREF{$button},
- get_navigation_text ($button),
+ get_navigation_text($button),
$btitle
) .
']';
}
else
{ # button is passive
- print $fh
+ $result .=
$ICONS && $PASSIVE_ICONS{$button} ?
&$button_icon_img($BUTTONS_NAME{$button},
$PASSIVE_ICONS{$button},
"[" . get_navigation_text($button) . "]";
}
- print $fh "</td>\n" if $vertical;
- print $fh "</tr>\n" if $vertical;
+ $result .= "</td>\n" if $vertical;
+ $result .= "</tr>\n" if $vertical;
}
- print $fh "</td>" unless $beginofline;
- print $fh "</tr>" unless $vertical;
- print $fh "</table>\n";
+ $result .= "</td>" unless $beginofline;
+ $result .= "</tr>" unless $vertical;
+ $result .= "</table>\n";
+ return $result;
}
# 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;
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
$docid = '' if ($state->{'outside_document'} or $state->{'multiple_pass'});
if ($from_file eq $footnote_file)
- {
+ {
$from_file = $footnote_file = '';
}
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 = "<small>[${foot_label}]</small> ";
}