#!/usr/bin/env perl
+# -*- coding: utf-8; -*-
-### texi2html customization script for Lilypond
+### texi2html customization script for LilyPond
### Author: Reinhold Kainhofer <reinhold@kainhofer.com>, 2008.
### Some code parts copied from texi2html and adapted. These functions
### were written mainly by Patrice Dumas
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::ALT_CSS_REFS = (
- {FILENAME => "lilypond-mccarty.css", TITLE=>"Patrick McCarty's design"}
+@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
if ($Texi2HTML::Config::SPLIT eq 'section') {
$Texi2HTML::Config::element_file_name = \&lilypond_element_file_name;
# Examples should be formatted similar to quotes:
$Texi2HTML::Config::complex_format_map->{'example'} = {
- 'begin' => q{"<blockquote><pre class=\"example\">"},
- 'end' => q{"</pre></blockquote>\n"},
+ 'begin' => q{"<blockquote>"},
+ 'end' => q{"</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;
}
foreach my $ref (@CSS_REFS)
{
- $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"stylesheet\" type=\"text/css\" href=\"$ref\" title=\"Default style\">\n";
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"stylesheet\" type=\"text/css\" title=\"$ref->{TITLE}\" href=\"$ref->{FILENAME}\">\n";
}
- foreach my $ref (@ALT_CSS_REFS)
+ 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";
}
# 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($$$)
{
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);
}
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<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");
if (@lines) {
print $fh "\n\n<div id=\"tocframe\">\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'},
- $Texi2HTML::NAME{'Top'},
+ $topname,
'title="Start of the manual"'
) . "</h4>\n";
foreach my $line (@lines) {
projects / lilypond.git / blobdiff