Texi2html: Allow -D short_toc or @set short_toc 1 for texi2html to expand the TOC...

[lilypond.git] / lilypond-texi2html.init

diff --git a/lilypond-texi2html.init b/lilypond-texi2html.init
index 1f3bffb75b0ec9f55019fb8db17b7dbe478706a8..1382e8c5a45997cc9be869b7c26305bae6f9da9c 100644 (file)
--- 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 <reinhold@kainhofer.com>, 2008.
@@ -65,9 +66,33 @@
 
 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',
+};
 
 
+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
@@ -102,6 +127,7 @@ $Texi2HTML::Config::print_page_head      = \&lilypond_print_page_head;
 $Texi2HTML::Config::foot_line_and_ref  = \&makeinfo_like_foot_line_and_ref;
 $Texi2HTML::Config::foot_lines         = \&makeinfo_like_foot_lines;
 $Texi2HTML::Config::paragraph          = \&makeinfo_like_paragraph;
+$Texi2HTML::Config::init_out             = \&lilypond_init_out;
 
 
 
@@ -216,7 +242,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;
@@ -255,7 +281,7 @@ sub lilypond_css_lines ($$)
     {
         $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";
     }
@@ -464,7 +490,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);
     }
@@ -536,6 +562,26 @@ 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;
+  }
+}
+# We can't use a command-handler, because texinfo variables are not yet 
+# available at that stage:
+# push @Texi2HTML::Config::command_handler_init, \&lilypond_init_toc_depth;
+
+# Initialize the toc_depth to 1 if the command-line option -D=short_toc is given
+sub lilypond_init_out()
+{
+  my $rval = t2h_default_init_out();
+  lilypond_init_toc_depth ();
+  return $rval;
+}
+
 # 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.
@@ -642,8 +688,9 @@ sub lilypond_print_toc_div ($$)
     my $uplink = $reldir."index.${lang}html";
 
     print $fh "<p class=\"toc_uplink\"><a href=\"$uplink\" 
-         title=\"Documentation Index\">&lt;&lt; Back to 
-         Documentation Index</a></p>\n";
+         title=\"Documentation Index\">&lt;&lt; " .
+        &ly_get_string ('Back to Documentation Index') .
+        "</a></p>\n";
 
     print $fh '<h4 class="toc_header"> ' . &$anchor('',
                                     $Texi2HTML::HREF{'Top'},
@@ -679,6 +726,9 @@ sub lilypond_print_element_header
 sub lilypond_toc_body($)
 {
     my $elements_list = shift;
+    # Workaround: Initialize the toc-depth here, because init_out is called
+    # only later in texi2html 1.83
+    lilypond_init_toc_depth ();
     # 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);