X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lilypond-texi2html.init;h=026d55dfb5e8298368f2ca126f9d8b8497deefa3;hb=d03883358e67bb40a80a49dfc703db69dd362f25;hp=2483e0f20151695b02f68263b518822b267b8f44;hpb=1e0e5fb4cd57035ffdd00ee1f306c555b483a61f;p=lilypond.git

diff --git a/lilypond-texi2html.init b/lilypond-texi2html.init
index 2483e0f201..026d55dfb5 100644
--- a/lilypond-texi2html.init
+++ b/lilypond-texi2html.init
@@ -2,7 +2,8 @@
 
 ### texi2html customization script for Lilypond
 ### Author: Reinhold Kainhofer <reinhold@kainhofer.com>, 2008.
-###         Some code parts copied from texi2html and adapted.
+###         Some code parts copied from texi2html and adapted. These functions
+###         were written mainly by Patrice Dumas
 ### License: GPLv2+
 ###
 ###
@@ -12,8 +13,8 @@
 ###    (implemented by split_at_numbered_sections)
 ### -) Use our custom CSS file, with IE-specific fixes in another CSS file,
 ###    impelmented by lilypond_css_lines
-### -) TOC (folded, with the current page highlighted) in an iframe is added
-###    to every page; implemented by:
+### -) TOC (folded, with the current page highlighted) in an overflown <div>
+###    is added to every page; implemented by:
 ###           lilypond_print_element_header -- building of the TOC
 ###           lilypond_toc_body -- generation of customized TOC output
 ###           lilypond_print_page_head -- start <div id="main">
@@ -35,15 +36,24 @@
 ###    English title, since otherwise language-autoselection would break with
 ###    posted links.
 ###    Since it is then no longer possible to obtain the file name from the
-###    section title, I keep a sectionname<=>filename/anchor around. This way, 
-###    xrefs from other manuals can simply load that map and retrieve the 
+###    section title, I keep a sectionname<=>filename/anchor around. This way,
+###    xrefs from other manuals can simply load that map and retrieve the
 ###    correct file name for the link. Implemented in:
-###           lilypond_unknown (handling of @translationof, in case 
+###           lilypond_unknown (handling of @translationof, in case
 ###                             extract_texi_filenames.py messes up...)
-###           split_at_numbered_sections (correct file name: use the map)
+###           lilypond_element_file_name (correct file name: use the map)
+###           lilypond_element_target_name (correct anchor: use the map)
 ###           lilypond_init_map (read in the externally created map from disk)
-###           lilypond_external_href (load the map for xrefs, use the correct 
+###           lilypond_external_href (load the map for xrefs, use the correct
 ###                                   link target)
+### -) The HTML anchors for all sections are derived from the node name /
+###    section title (pre-generated in the .xref-map file). Implemented by:
+###           lilypond_element_target_name (adjust section anchors)
+### -) Use the standard footnote format "<sup>nr</sup> text" instead of the
+###    ugly format of texi2html (<h3>(nr)</h3><p>text</p>). Implemented in
+###           makeinfo_like_foot_line_and_ref
+###           makeinfo_like_foot_lines
+###           makeinfo_like_paragraph
 ###
 ###
 ### Useful helper functions:
@@ -64,10 +74,15 @@ package Texi2HTML::Config;
 #############################################################################
 
 @Texi2HTML::Config::CSS_REFS      = ("lilypond.css");
+@Texi2HTML::Config::ALT_CSS_REFS      = ( 
+    {FILENAME => "lilypond-mccarty.css", TITLE=>"Patrick McCarty's design"}
+);
 $Texi2HTML::Config::USE_ACCESSKEY = 1;
 $Texi2HTML::Config::USE_LINKS     = 1;
 $Texi2HTML::Config::USE_REL_REV   = 1;
-$Texi2HTML::Config::element_file_name    = \&split_at_numbered_sections;
+$Texi2HTML::Config::SEPARATED_FOOTNOTES = 0; # Print footnotes on same page, not separated
+$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::print_navigation     = \&lilypond_print_navigation;
@@ -77,6 +92,12 @@ $Texi2HTML::Config::toc_body             = \&lilypond_toc_body;
 $Texi2HTML::Config::css_lines            = \&lilypond_css_lines;
 $Texi2HTML::Config::unknown              = \&lilypond_unknown;
 $Texi2HTML::Config::print_page_head      = \&lilypond_print_page_head;
+# $Texi2HTML::Config::foot_line_and_ref    = \&lilypond_foot_line_and_ref;
+$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;
+
+
 
 # Examples should be formatted similar to quotes:
 $Texi2HTML::Config::complex_format_map->{'example'} = {
@@ -84,6 +105,12 @@ $Texi2HTML::Config::complex_format_map->{'example'} = {
   'end' => q{"</pre></blockquote>\n"},
  };
 
+%Texi2HTML::config::misc_pages_targets = (
+   'Overview' => 'Overview',
+   'Contents' => 'Contents',
+   'About' => 'About'
+);
+
 
 my @section_to_filename;
 
@@ -171,7 +198,7 @@ sub load_map_file ($)
         }
         close (XREFFILE);
     } else {
-        print STDERR "Unable to load the map file $mapfile\n";
+        print STDERR "WARNING: Unable to load the map file $mapfile\n";
     }
     return $node_map;
 }
@@ -209,19 +236,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 = "<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\" href=\"$ref\">\n";
+    }
+    foreach my $ref (@ALT_CSS_REFS)
+    {
+        $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"alternate stylesheet\" type=\"text/css\" title=\"$ref->{TITLE}\" href=\"$ref->{FILENAME}\">\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";
 }
 
 
@@ -236,6 +267,7 @@ my $lastfilename;
 my $docnr = 0;
 my $node_to_filename_map = ();
 
+
 # This function makes sure that files are only generated for numbered sections,
 # but not for unnumbered ones. It is called after texi2html has done its own
 # splitting and simply returns the filename for the node given as first argument
@@ -245,9 +277,9 @@ 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 
+# lilypond_init_out, use the externally created values, otherwise use the
 # same logic here.
-sub split_at_numbered_sections($$$)
+sub lilypond_element_file_name($$$)
 {
   my $element = shift;
   my $type = shift;
@@ -270,8 +302,12 @@ sub split_at_numbered_sections($$$)
     (my $filename, my $anchor) = @{$node_to_filename_map->{$node_name}};
     $filename .= ".$docu_ext" if (defined($docu_ext));
 
-    $element->{id} = $anchor;
-    if ($filename eq $lastfilename) {
+    # unnumbered sections (except those at top-level!) always go to the same
+    # file as the previous numbered section
+    if (not ($element->{number}) and not ($lastfilename eq '') and ($element->{level} > 1)) {
+      $filename = $lastfilename;
+    }
+    if (($filename eq $lastfilename)) {
       $$element{doc_nr} = $docnr;
     } else {
       $docnr += 1;
@@ -281,31 +317,20 @@ sub split_at_numbered_sections($$$)
     return $filename;
 
   } elsif ($type eq "top" or $type eq "toc" or $type eq "doc" or $type eq "stoc" or $type eq "foot" or $type eq "about") {
-    # TOC, footer, about etc. are called with undefined $element and $type == "toc"|"stoc"|"foot"|"about"
     return;
   } else {
     print STDERR "WARNING: Node '$node_name' was NOT found in the map\n"
         unless ($node_name eq '') or ($element->{'tag'} eq 'unnumberedsec')
                or ($node_name =~ /NOT REALLY USED/);
 
-    # derive the name of the anchor (i.e. the part after # in the links!),
-    # don't use texi2html's SECx.x default!
-    my $sec_name = main::remove_texi($element->{'texi'});
-    # if we have a node, use its name:
-    if ($element->{'node_ref'}->{'texi'} ne '') { 
-      $sec_name = main::remove_texi($element->{'node_ref'}->{'texi'});
-    }
-    my $anchor = $sec_name;
-    if ($element->{translationof}) {
-      $anchor = main::remove_texi($$element{translationof});
-    }
-    # normalize to the same file name as texinfo
-    $anchor = texinfo_file_name($anchor);
-    $$element{id} = $anchor;
     # Numbered sections will get a filename Node_title, unnumbered sections will use
     # the file name of the previous numbered section:
     if (($element->{number}) or ($lastfilename eq '') or ($element->{level} == 1)) {
-      my $filename = $anchor;
+      # normalize to the same file name as texinfo
+      if ($element->{translationof}) {
+        $node_name = main::remove_texi($element->{translationof});
+      }
+      my $filename = texinfo_file_name($node_name);
       $filename .= ".$docu_ext" if (defined($docu_ext));
       $docnr += 1;
       $$element{doc_nr} = $docnr;
@@ -320,15 +345,44 @@ sub split_at_numbered_sections($$$)
   return;
 }
 
+sub lilypond_element_target_name($$$)
+{
+  my $element = shift;
+  my $target = shift;
+  my $id = shift;
+  # Target is based on node name (or sec name for secs without node attached)
+  my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
+  if ($node_name eq '') {
+    $node_name = main::remove_texi($element->{'texi'});
+  }
+
+  # If we have an entry in the section<=>filename map, use that one, otherwise
+  # generate the anchor here.
+  if (exists ($node_to_filename_map->{$node_name})) {
+    (my $filename, $target) = @{$node_to_filename_map->{$node_name}};
+  } else {
+    my $anchor = $node_name;
+    if ($element->{translationof}) {
+      $anchor = main::remove_texi($element->{translationof});
+    }
+    # normalize to the same file name as texinfo
+    $target = texinfo_file_name($anchor);
+  }
+  # TODO: Once texi2html correctly prints out the target and not the id for
+  #       the sections, change this back to ($id, $target)
+  return ($target, $target);
+}
+
 
-## Load the map file for the corrently processed texi file. We do this 
-#  (mis-)using a command init handler, since texi2html does not have any 
+## Load the map file for the corrently processed texi file. We do this
+#  using a command init handler, since texi2html does not have any
 #  other hooks that are called after THISDOC is filled but before phase 2
 #  of the texi2html conversion.
 sub lilypond_init_map ()
 {
     my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
-    my $map_filename = "$docu_dir/${docu_name}.xref-map";
+    my $map_filename = main::locate_include_file ("${docu_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
+	|| main::locate_include_file ("${docu_name}.xref-map");
     $node_to_filename_map = load_map_file ($map_filename);
 }
 push @Texi2HTML::Config::command_handler_init, \&lilypond_init_map;
@@ -355,12 +409,12 @@ sub lilypond_external_ref($$$$$$)
   my $displaytext = '';
 
   # 1) if we have a cross ref name, that's the text to be displayed:
-  # 2) For the top node, use the (printable) name of the manual, unless we 
+  # 2) For the top node, use the (printable) name of the manual, unless we
   #    have an explicit cross ref name
   # 3) In all other cases use the section name
   if ($cross_ref ne '') {
     $displaytext = $cross_ref;
-  } elsif (($section eq '') or ($displaytext eq 'Top')) {
+  } elsif (($section eq '') or ($section eq 'Top')) {
     $displaytext = $book;
   } else {
     $displaytext = $section;
@@ -429,9 +483,9 @@ sub lilypond_external_href($$$)
   my $original_func = \&t2h_default_external_href;
 
   # 1) Keep a hash of book->section_map
-  # 2) if not file in keys hash => try to load the map (assign empty map if 
+  # 2) if not file in keys hash => try to load the map (assign empty map if
   #    non-existent => will load only once!)
-  # 3) if node in the section=>(file, anchor) map, replace node_id and 
+  # 3) if node in the section=>(file, anchor) map, replace node_id and
   #    node_xhtml_id by the map's values
   # 4) call the t2h_default_external_href with these values (or the old ones if not found)
 
@@ -442,7 +496,8 @@ sub lilypond_external_href($$$)
     # Load the map if we haven't done so already
     if (!exists($translated_books{$map_name})) {
       my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
-      my $map_filename = "$docu_dir/${map_name}.xref-map";
+      my $map_filename = main::locate_include_file ("${map_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
+	  || main::locate_include_file ("${map_name}.xref-map");
       $translated_books{$map_name} = load_map_file ($map_filename);
     }
 
@@ -452,7 +507,7 @@ sub lilypond_external_href($$$)
     if (defined($section_name_map->{$node_text})) {
       ($node_id, $node_hxmlt_id) = @{$section_name_map->{$node_text}};
     } else {
-      print STDERR "Unable to find key '$node_text' in section_name_map for book $map_name\n";
+      print STDERR "WARNING: Unable to find node '$node_text' in book $map_name.\n";
     }
   }
 
@@ -477,7 +532,7 @@ my @default_toc = [];
 # 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 
+# 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($$$$)
 {
@@ -494,7 +549,7 @@ sub generate_ly_toc_entries($$$$)
   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->{'id'}",$element->{'text'});
+  my $entry = "$ind<li$this_css_class>" . &$anchor ($element->{'tocid'}, "$element->{'file'}#$element->{'target'}",$element->{'text'});
 
   my $children = $element->{'section_childs'};
   # Don't add unnumbered entries, unless they are at top-level or a parent of the current!
@@ -608,7 +663,7 @@ sub print_lilypond_page_foot($)
 {
   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";
 
@@ -827,6 +882,126 @@ sub lilypond_print_navigation
 
 
 
+#############################################################################
+###  FOOTNOTE FORMATTING
+#############################################################################
+
+# Format footnotes in a nicer way: Instead of printing the number in a separate
+# (nr) heading line, use the standard way of prepending <sup>nr</sup> immediately
+# before the fn text.
+
+
+# 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;
+
+sub makeinfo_like_foot_line_and_ref($$$$$$$$)
+{
+    my $foot_num = shift;
+    my $relative_num = shift;
+    my $footid = shift;
+    my $docid = shift;
+    my $from_file = shift;
+    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
+    # as part of the document.
+    $docid = '' if ($state->{'outside_document'} or $state->{'multiple_pass'});
+
+    if ($from_file eq $footnote_file)
+    {
+        $from_file = $footnote_file = '';
+    }
+
+    my $foot_anchor = "<sup>" . &$anchor($docid, "$footnote_file#$footid", $relative_num) . "</sup>";
+    $foot_anchor = &$anchor($docid, "$footnote_file#$footid", "($relative_num)") if ($state->{'preformatted'});
+
+#    unshift @$lines, "<li>";
+#    push @$lines, "</li>\n";
+    return ($lines, $foot_anchor);
+}
+
+sub makeinfo_like_foot_lines($)
+{
+    my $lines = shift;
+    unshift @$lines, "<hr>\n<h4>$Texi2HTML::I18n::WORDS->{'Footnotes_Title'}</h4>\n";
+#<ol type=\"1\">\n";
+#    push @$lines, "</ol>";
+    return $lines;
+}
+
+my %makekinfo_like_paragraph_in_footnote_nr;
+
+sub makeinfo_like_paragraph ($$$$$$$$$$$$$)
+{
+    my $text = shift;
+    my $align = shift;
+    my $indent = shift;
+    my $paragraph_command = shift;
+    my $paragraph_command_formatted = shift;
+    my $paragraph_number = shift;
+    my $format = shift;
+    my $item_nr = shift;
+    my $enumerate_style = shift;
+    my $number = shift;
+    my $command_stack_at_end = shift;
+    my $command_stack_at_begin = shift;
+    my $state = shift;
+#print STDERR "format: $format\n" if (defined($format));
+#print STDERR "paragraph @$command_stack_at_end; @$command_stack_at_begin\n";
+    $paragraph_command_formatted = '' if (!defined($paragraph_command_formatted) or
+          exists($special_list_commands{$format}->{$paragraph_command}));
+    return '' if ($text =~ /^\s*$/);
+    foreach my $style(t2h_collect_styles($command_stack_at_begin))
+    {
+       $text = t2h_begin_style($style, $text);
+    }
+    foreach my $style(t2h_collect_styles($command_stack_at_end))
+    {
+       $text = t2h_end_style($style, $text);
+    }
+    if (defined($paragraph_number) and defined($$paragraph_number))
+    {
+         $$paragraph_number++;
+         return $text  if (($format eq 'itemize' or $format eq 'enumerate') and
+            ($$paragraph_number == 1));
+    }
+    my $open = '<p';
+    if ($align)
+    {
+        $open .= " align=\"$paragraph_style{$align}\"";
+    }
+    my $footnote_text = '';
+    if (defined($command_stack_at_begin->[0]) and $command_stack_at_begin->[0] eq 'footnote')
+    {
+        my $state = $Texi2HTML::THISDOC{'state'};
+        $makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number}++;
+        if ($makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number} <= 1)
+        {
+           $open.=' class="footnote"';
+           my $document_file = $state->{'footnote_document_file'};
+           if ($document_file eq $state->{'footnote_footnote_file'})
+           {
+               $document_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'}",
+                 "$state->{'footnote_number_in_page'}");
+           $footnote_text = "<small>[${foot_label}]</small> ";
+        }
+    }
+    return $open.'>'.$footnote_text.$text.'</p>';
+}
+
+
 #############################################################################
 ###  OTHER SETTINGS
 #############################################################################