]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/lilypond-texi2html.init
Doc: [web] Make texi2html notice non-constant, refactor cut-and-paste coding.
[lilypond.git] / Documentation / lilypond-texi2html.init
index 666aa015ac12de151f932d070fcad037d0c50d25..343847826b9ceaef32a9ddcb757cc535760fd708 100644 (file)
 ###    non-standard chars replaced by _xxxx (ascii char code) and forced to
 ###    start with a letter by prepending t_g if necessary)
 
+package main;
+$original_normalise_node = \&normalise_node;
+
+sub t2h_default_normalise_node($)
+{
+    my $text = shift;
+    $original_normalise_node->($text);
+}
+
+*normalise_node = sub($)
+{
+    my $text = shift;
+    return &$Texi2HTML::Config::normalise_node($text);
+};
 
 package Texi2HTML::Config;
+##$normalise_node = \&t2h_default_normalise_node;
+$normalise_node = \&lilypond_normalise_node;
+
 
 use utf8;
 use Encode qw(decode);
@@ -104,6 +121,11 @@ $LY_LANGUAGES->{'it'} = {
     '<p>Thanks to ${webdev_link} for hosting ${lily_site}.' => '',
 };
 
+$LY_LANGUAGES->{'nl'} = {
+    'Back to Documentation Index' => 'Terug naar de Documentatieindex',
+    '<p>Met dank aan ${webdev_link} voor het hosten van ${lily_site}.' => '',
+};
+
 # FIXME: request the translations below then send them to texi2html/texinfo devs
 $LANGUAGES->{'it'} = {
                        '  The buttons in the navigation panels have the following meaning:' => '  I bottoni nei pannelli di navigazione hanno il seguente significato:',
@@ -544,7 +566,7 @@ $Texi2HTML::Config::DOCTYPE = '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Tran
 );
 
 sub web_settings() {
-  print STDERR "Initializing settings for web site\n";
+  print STDERR "Initializing settings for web site: [$Texi2HTML::THISDOC{current_lang}]\n";
   $Texi2HTML::Config::BODYTEXT = "";
   @Texi2HTML::Config::CSS_REFS      = (
       {FILENAME => "lilypond-web.css", TITLE => "Patrick McCarty's design"}
@@ -630,6 +652,19 @@ sub print_element_info($)
 ###  HELPER FUNCTIONS
 #############################################################################
 
+# only lc() the last portion of an href
+sub lc_last($)
+{
+  my $href = shift;
+  my @hrefsplit = split('/', $href);
+  # change the last portion (the filename), if it exists
+  if ($#hrefsplit > 0) {
+    @hrefsplit[$#hrefsplit] = lc( @hrefsplit[$#hrefsplit] );
+    $href = join("/", @hrefsplit);
+  }
+  return $href;
+}
+
 # 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
@@ -662,7 +697,7 @@ sub texinfo_file_name($)
     $result = 't_g' . $result;
   }
   # DONE
-  return lc($result)
+  return lc_last($result)
 }
 
 # Load a file containing a nodename<=>filename map (tab-sepatared, i.e.
@@ -767,6 +802,7 @@ sub lilypond_css_lines ($$)
 my $lastfilename;
 my $docnr = 0;
 my $node_to_filename_map = ();
+$source_to_translationof_map = ();
 
 
 # This function makes sure that files are only generated for numbered sections,
@@ -802,11 +838,12 @@ sub lilypond_element_file_name($$$)
   if (exists ($node_to_filename_map->{$node_name})) {
     (my $filename, my $anchor) = @{$node_to_filename_map->{$node_name}};
     $filename .= ".$docu_ext" if (defined($docu_ext));
+    # don't do lc_last here, otherwise the colors are messed up!
     $filename = lc($filename);
 
     # unnumbered sections (except those at top-level!) always go to the same
     # file as the previous numbered section
-    if (not $docu_name == "web" and not ($element->{number})
+    if (not ($web_manual) and not ($element->{number})
        and not ($lastfilename eq '') and ($element->{level} > 1)) {
       $filename = $lastfilename;
     }
@@ -817,7 +854,8 @@ sub lilypond_element_file_name($$$)
       $$element{doc_nr} = $docnr;
       $lastfilename = $filename;
     }
-    print STDERR "Output file name: $filename\n";
+    #print STDERR "Output file name: $filename\n";
+    $filename = lc_last($filename);
     return $filename;
 
   } elsif ($type eq "top" or $type eq "toc" or $type eq "doc" or
@@ -837,7 +875,7 @@ sub lilypond_element_file_name($$$)
       }
       my $filename = texinfo_file_name($node_name);
       $filename .= ".$docu_ext" if (defined($docu_ext));
-      $filename = lc($filename);
+      $filename = lc_last($filename);
       $docnr += 1;
       $$element{doc_nr} = $docnr;
       $lastfilename = $filename;
@@ -845,7 +883,7 @@ sub lilypond_element_file_name($$$)
       return $filename;
     } else {
       $$element{doc_nr} = $docnr;
-      $filename = lc ($filename);
+      $filename = lc_last($filename);
       print STDERR "File name: $filename\n";
       return $filename;
     }
@@ -854,6 +892,18 @@ sub lilypond_element_file_name($$$)
   return;
 }
 
+sub lilypond_normalise_node($)
+{
+    my $text = shift;
+    my $norm = main::t2h_default_normalise_node($text);
+    if (exists ($source_to_translationof_map->{$text})) {
+       my $original = $source_to_translationof_map->{$text};
+       $norm = main::t2h_default_normalise_node($original);
+    }
+
+    return $norm;
+}
+
 sub lilypond_element_target_name($$$)
 {
   my $element = shift;
@@ -879,8 +929,14 @@ sub lilypond_element_target_name($$$)
   }
   # TODO: Once texi2html correctly prints out the target and not the id for
   #       the sections, change this back to ($id, $target)
-  $target = lc($target);
-  return ($target, $target);
+  # I don't understand this comment, so I'm reluctant to delete it -gp
+  $target = lc_last($target);
+  if ($target eq lc_last($id)) {
+    $id = "";
+  } else {
+    $id = substr($id, 0, - 2); # remove the "-1"
+  }
+  return ($id, $target);
 }
 
 
@@ -893,7 +949,7 @@ sub lilypond_init_map ()
     my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
     my $map_filename = main::locate_include_file ("${docu_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
        || main::locate_include_file ("${docu_name}.xref-map");
-    print STDERR "Map filename is: $map_filename\nDocu name is $docu_name\n";
+    #print STDERR "Map filename is: $map_filename\nDocu name is $docu_name\n";
     if ($docu_name eq 'web') {
        $web_manual = 1;
        web_settings();
@@ -918,7 +974,10 @@ sub lilypond_external_ref($$$$$$)
   my $section = shift;
   my $book = shift;
   my $file_node = shift;
-  my $href = lc(shift);
+  my $href = shift;
+
+  $href = lc_last($href);
+
   my $cross_ref = shift;
 
   my $displaytext = '';
@@ -967,7 +1026,13 @@ sub lilypond_unknown($$$$$)
     # python script messed up ;-)
     if ($pass == 1 and $macro eq "translationof") {
       if (ref($state->{'element'}) eq 'HASH') {
-        $state->{'element'}->{'translationof'} = main::normalise_space($line);
+         $state->{'element'}->{'translationof'} = main::normalise_space($line);
+         my $source = main::normalise_space ($line);
+         if (ref($state->{'node_ref'}) eq 'HASH') {
+             my $translationof = $state->{'node_ref'}->{'texi'};
+             our %source_to_translationof_map;
+             $source_to_translationof_map->{$source} = $translationof;
+         }
       }
       return ('', 1, undef, undef);
     } else {
@@ -976,8 +1041,6 @@ sub lilypond_unknown($$$$$)
 }
 
 
-
-
 my %translated_books = ();
 # Construct a href to an external source of information.
 # node is the node with texinfo @-commands
@@ -1023,13 +1086,41 @@ sub lilypond_external_href($$$)
   }
 
   if (defined $file) {
-    return &$default_external_href($node, $node_id, $node_hxmlt_id, lc($file));
+    $href = &$default_external_href($node, $node_id, $node_hxmlt_id, lc_last($file));
+    remove_unneeded_anchor($href);
+
+    # TODO: very yucky, but will be fixed in issue 1004
+    if ($web_manual) {
+      my $only_web = $ENV{ONLY_WEB};
+      if ($only_web) {
+        $href = "../../doc/v2.13/Documentation/web/".$href;
+      }
+    }
+
+    return $href;
   } else {
-    return &$default_external_href($node, $node_id, $node_hxmlt_id);
+    $href = &$default_external_href($node, $node_id, $node_hxmlt_id);
+    remove_unneeded_anchor($href);
+    return $href;
   }
 }
 
-
+sub remove_unneeded_anchor($)
+{
+  my $ref = shift;
+  my @hrefsplit = split("/", $href);
+  for ($i = 0; $i < @hrefsplit; $i++) {
+    $item = @hrefsplit[$i];
+    if ($item =~ /#/) {
+      @splitted = split("#", $item);
+      if (@splitted[0] == @splitted[1]) {
+        @hrefsplit[$i] = @splitted[0]
+      }
+    }
+  }
+  $href = join("/", @hrefsplit);
+  return $href
+}
 
 
 
@@ -1064,7 +1155,7 @@ push @Texi2HTML::Config::command_handler_process, \&lilypond_init_toc_depth;
 # -) 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($$$$)
+sub generate_ly_toc_entries($$$$$)
 {
   my $element = shift;
   my $element_path = shift;
@@ -1073,6 +1164,7 @@ sub generate_ly_toc_entries($$$$)
     $maxlevel = 1;
   }
   my $child_count = shift;
+  my $current_element = shift;
   # Skip undefined sections, plus all sections generated by index splitting
   return() if (not defined($element) or exists($element->{'index_page'}));
   my @result = ();
@@ -1113,7 +1205,7 @@ sub generate_ly_toc_entries($$$$)
       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, $sub_child_count);
+           generate_ly_toc_entries($c, $element_path, $maxlevel, $sub_child_count, $current_element);
         push (@child_result, @child_res);
        $sub_child_count += 1;
       }
@@ -1123,7 +1215,9 @@ sub generate_ly_toc_entries($$$$)
     if (@child_result) {
       push (@result, "\n$ind<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
       if ($web_manual) {
-        push (@result, "$ind<li class=\"colorDefault toc_current\">" .
+        push (@result, "$ind<li class=\"colorDefault" .
+             ($element->{'text'} eq $current_element->{'text'} ?
+              ' toc_current">' : '">') .
              &$anchor ($element->{'tocid'},
                        "$element->{'file'}#$element->{'target'}",
                        $element->{'text'}) . "</li>\n");
@@ -1177,7 +1271,7 @@ sub lilypond_generate_page_toc_body($)
     }
     my $children = $current_element->{'section_childs'};
     foreach ( @$children ) {
-      push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth, 0));
+      push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth, 0, $element));
     }
     # search box
     local $/=undef;
@@ -1186,7 +1280,7 @@ sub lilypond_generate_page_toc_body($)
     open FILE, "$ENV{TOP_SRC_DIR}/Documentation/$lang/$name.ihtml" or
        open FILE, "$ENV{TOP_SRC_DIR}/Documentation/$name.ihtml"  or
        die "no such file: $name.ihtml: $!";
-    my $search_string = <FILE>;
+    my $search_string = decode ('UTF-8', <FILE>);
     $search_string = "<li>\n" . $search_string . "</li>\n";
     push (@toc_entries, $search_string);
     close FILE;
@@ -1222,9 +1316,8 @@ sub lilypond_print_toc_div ($$)
     } else {
       $lang = "";
     }
-    my $reldir = "";
-    $reldir = "../" if ($Texi2HTML::Config::SPLIT eq 'section');
-    my $uplink = $reldir."web/manuals.${lang}html";
+    my $reldir = $ENV{DEPTH};
+    my $uplink = $reldir."/Documentation/web/manuals.${lang}html";
 
     if (not $web_manual) {
       print $fh "<p class=\"toc_uplink\"><a href=\"$uplink\"