X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lilypond-texi2html.init;h=6abc48cd980eb76659e85c2f9b20c8d45c36d05a;hb=9c3ecc7d6e596e8151a58ce7ed0dd9e1b0802d1e;hp=35d3d17cb0ab50d1eb655703674956b624207e3e;hpb=d1329e1f202e9427912c495a695a5d60867d1791;p=lilypond.git diff --git a/lilypond-texi2html.init b/lilypond-texi2html.init index 35d3d17cb0..6abc48cd98 100644 --- a/lilypond-texi2html.init +++ b/lilypond-texi2html.init @@ -1,8 +1,10 @@ #!/usr/bin/env perl +# -*- coding: utf-8; -*- ### texi2html customization script for Lilypond ### Author: Reinhold Kainhofer , 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 +14,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
+### 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
@@ -35,15 +37,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 "nr text" instead of the +### ugly format of texi2html (

(nr)

text

). Implemented in +### makeinfo_like_foot_line_and_ref +### makeinfo_like_foot_lines +### makeinfo_like_paragraph ### ### ### Useful helper functions: @@ -55,19 +66,54 @@ 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' => '', +}; + + +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::element_file_name = \&split_at_numbered_sections; +$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; +} +$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,13 +123,26 @@ $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'} = { 'begin' => q{"
"},
   'end' => q{"
\n"}, + 'style' => 'code', }; +%Texi2HTML::config::misc_pages_targets = ( + 'Overview' => 'Overview', + 'Contents' => 'Contents', + 'About' => 'About' +); + my @section_to_filename; @@ -158,24 +217,44 @@ sub load_map_file ($) my $node_map = (); if (open(XREFFILE, $mapfile)) { - while ( ) { + my $line; + while ( $line = ) { # parse the tab-separated entries and insert them into the map: - chomp($_); - my @entries = split(/\t/, $_); + chomp($line); + my @entries = split(/\t/, $line); if (scalar (@entries) == 3) { $node_map->{$entries[0]} = [$entries[1], $entries[2]]; } else { - print STDERR "Invalid entry in the node file $mapfile: $_\n"; + print STDERR "Invalid entry in the node file $mapfile: $line\n"; } } 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; } +# Split the given path into dir and basename (with .texi removed). Used mainly +# to get the path/basename of the original texi input file +sub split_texi_filename ($) +{ + my $docu = shift; + my ($docu_dir, $docu_name); + if ($docu =~ /(.*\/)/) { + chop($docu_dir = $1); + $docu_name = $docu; + $docu_name =~ s/.*\///; + } else { + $docu_dir = '.'; + $docu_name = $docu; + } + $docu_name =~ s/\.te?x(i|info)?$//; + return ($docu_dir, $docu_name); +} + + @@ -189,19 +268,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 = "\n"; + $Texi2HTML::THISDOC{'CSS_LINES'} = "\n"; } foreach my $ref (@CSS_REFS) { - $CSS_LINES .= "\n"; + $Texi2HTML::THISDOC{'CSS_LINES'} .= "{TITLE}\" href=\"$ref->{FILENAME}\">\n"; } - $CSS_LINES .= "\n"; + foreach my $ref (@Texi2HTML::Config::ALT_CSS_REFS) + { + $Texi2HTML::THISDOC{'CSS_LINES'} .= "{FILENAME}\" title=\"$ref->{TITLE}\">\n"; + } + $Texi2HTML::THISDOC{'CSS_LINES'} .= "\n"; } @@ -216,6 +299,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 @@ -225,9 +309,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; @@ -235,11 +319,27 @@ sub split_at_numbered_sections($$$) my $docu_ext = $Texi2HTML::Config::EXTENSION; my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'}); + # the snippets page does not use nodes for the snippets, so in this case + # we'll have to use the section name! + 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 filename/anchor here. In the latter case, external manuals + # will not be able to retrieve the file name for xrefs!!! Still, I already + # had that code, so I'll leave it in in case something goes wrong with the + # extract_texi_filenames.py script in the lilypond build process! 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)); - $element->{id} = $anchor; - if ($filename == $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; @@ -249,36 +349,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 ''; - # If we have an entry in the section<=>filename map, use that one, otherwise - # generate the filename/anchor here. In the latter case, external manuals - # will not be able to retrieve the file name for xrefs!!! Still, I already - # had that code, so I'll leave it in in case something goes wrong with the - #extract_texi_filenames.py script in the lilypond build process! - # TODO: lookup node name in nodename<=>filename map - - # 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 ($element->{'node_ref'}->{'texi'} ne '') { # if we have a node, use its name: - $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; + unless ($node_name eq '') or ($element->{'tag'} eq 'unnumberedsec') + or ($node_name =~ /NOT REALLY USED/); + # 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; @@ -293,26 +377,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'}); + } -## 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 + # 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 +# 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 = $Texi2HTML::THISDOC{'input_file_name'}; - my $docu_dir, $docu_name; - if ($docu =~ /(.*\/)/) { - chop($docu_dir = $1); - $docu_name = $docu; - $docu_name =~ s/.*\///; - } else { - $docu_dir = '.'; - $docu_name = $docu; - } - $docu_name =~ s/\.te?x(i|info)?$//; - - my $map_filename = "$docu_dir/${docu_name}_xref.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"); $node_to_filename_map = load_map_file ($map_filename); } push @Texi2HTML::Config::command_handler_init, \&lilypond_init_map; @@ -336,9 +438,22 @@ sub lilypond_external_ref($$$$$$) my $href = shift; my $cross_ref = shift; - $file_node =~ s/\(.*\)//; - $file_node = &$anchor('', $href, $file_node) if ($file_node ne ''); - return &$I('%{node_file_href}', { 'node_file_href' => $file_node }); + 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 + # 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 ($section eq 'Top')) { + $displaytext = $book; + } else { + $displaytext = $section; + } + + $displaytext = &$anchor('', $href, $displaytext) if ($displaytext ne ''); + return &$I('%{node_file_href}', { 'node_file_href' => $displaytext }); # Default: format as "see NODE section 'SECTION' in BOOK". We don't want this! # return t2h_default_external_ref($type, $section, $book, $file_node, $href, $cross_ref); @@ -371,10 +486,10 @@ sub lilypond_unknown($$$$$) # necessary here at all. Still, I'll leave the code in just in case the # python script messed up ;-) if ($pass == 1 and $macro eq "translationof") { - if (ref($state->{'element'})=='HASH') { + 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); } @@ -395,183 +510,39 @@ sub lilypond_external_href($$$) { my $node = shift; my $node_id = shift; - my $node_xhtml_id = shift; + my $node_hxmlt_id = shift; my $file = shift; my $original_func = \&t2h_default_external_href; - # TODO: # 1) Keep a hash of book->section_map - # 2) if not file in keys hash => try to load the map (assign empty map is non-existent => will load only once!) - # 3) if node in the section=>(file, anchor) map, replace node_id and node_xhtml_id by the map's values + # 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 + # 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) -# print STDERR "lilypond_external_href: texi_node='$node', node_file='$node_id', node_xhtml_id='$node_xhtml_id', file='$file'\n"; - if (($node_id ne '') and defined($file)) { - if (!exists($translated_books{$file})) { - print STDERR "Map for book $file not yet loaded, trying to initialize\n"; - # TODO: Load the file... - $translated_books{$file}={}; + + if (($node_id ne '') and defined($file) and ($node_id ne 'Top')) { + my $map_name = $file; + $map_name =~ s/-big-page//; + + # 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 = 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); } - my $section_name_map = $translated_books{$file}; - if (exists($section_name_map->{$node_id})) { - print STDERR "Found key $node_id in section_name_map\n"; - # TODO: Assign the new values to $file, $node_id and $node_xhtml_id! - # TODO: Am I doing this right? - (my $filename, my $anchor) = @$section_name_map->{$node_id}; - $filename .= ".$docu_ext" if (defined($docu_ext)); - - $node_xhtml_id = $anchor; - $file = $filename; + # look up translation. use these values instead of the old filename/anchor + my $section_name_map = $translated_books{$map_name}; + my $node_text = main::remove_texi($node); + 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_id in section_name_map\n"; + print STDERR "WARNING: Unable to find node '$node_text' in book $map_name.\n"; } } -# Code copied from texi2html: -# I'll need to find the correct path to the map file and texi2html already -# seems to do a good job for this with the following code, which I will -# need to strip down to those parts that we really need: -# -# $file = '' if (!defined($file)); -# my $default_target_split = $EXTERNAL_CROSSREF_SPLIT; -# my $target_split; -# my $target_mono; -# my $href_split; -# my $href_mono; -# if ($file ne '') -# { -# if ($NEW_CROSSREF_STYLE) -# { -# $file =~ s/\.[^\.]*$//; -# $file =~ s/^.*\///; -# my $href; -# if (exists($Texi2HTML::THISDOC{'htmlxref'}->{$file})) -# { -# if (exists($Texi2HTML::THISDOC{'htmlxref'}->{$file}->{'split'})) -# { -# $target_split = 1; -# $href_split = $Texi2HTML::THISDOC{'htmlxref'}->{$file}->{'split'}->{'href'}; -# } -# if (exists($Texi2HTML::THISDOC{'htmlxref'}->{$file}->{'mono'})) -# { -# $target_mono = 1; -# $href_mono = $Texi2HTML::THISDOC{'htmlxref'}->{$file}->{'mono'}->{'href'}; -# } -# } -# -# if ((not $target_mono) and (not $target_split)) -# { # nothing specified for that manual, use default -# $target_split = $default_target_split; -# } -# elsif ($target_split and $target_mono) -# { # depends on the splitting of the manual -# $target_split = $SPLIT; -# } -# elsif ($target_mono) -# { # only mono specified -# $target_split = 0; -# } -# -# if ($target_split) -# { -# if (defined($href_split)) -# { -# $file = "$href_split"; -# } -# elsif (defined($EXTERNAL_DIR)) -# { -# $file = "$EXTERNAL_DIR/$file"; -# } -# elsif ($SPLIT) -# { -# $file = "../$file"; -# } -# $file .= "/"; -# } -# else -# {# target not split -# if (defined($href_mono)) -# { -# $file = "$href_mono"; -# } -# else -# { -# if (defined($EXTERNAL_DIR)) -# { -# $file = "$EXTERNAL_DIR/$file"; -# } -# elsif ($SPLIT) -# { -# $file = "../$file"; -# } -# $file .= "." . $NODE_FILE_EXTENSION; -# } -# } -# } -# else -# { -# $file .= "/"; -# if (defined($EXTERNAL_DIR)) -# { -# $file = $EXTERNAL_DIR . $file; -# } -# else -# { -# $file = '../' . $file; -# } -# } -# } -# else -# { -# $target_split = $default_target_split; -# } -# if ($node eq '') -# { -# if ($NEW_CROSSREF_STYLE) -# { -# if ($target_split) -# { -# return $file . $TOP_NODE_FILE . '.' . $NODE_FILE_EXTENSION . '#Top'; -# # or ? -# #return $file . '#Top'; -# } -# else -# { -# return $file . '#Top'; -# } -# } -# else -# { -# return $file; -# } -# } -# my $target; -# if ($NEW_CROSSREF_STYLE) -# { -# $node = $node_id; -# $target = $node_xhtml_id; -# } -# else -# { -# $node = main::remove_texi($node); -# $node =~ s/[^\w\.\-]/-/g; -# } -# my $file_basename = $node; -# $file_basename = $TOP_NODE_FILE if ($node =~ /^top$/i); -# if ($NEW_CROSSREF_STYLE) -# { -# if ($target_split) -# { -# return $file . $file_basename . ".$NODE_FILE_EXTENSION" . '#' . $target; -# } -# else -# { -# return $file . '#' . $target; -# } -# } -# else -# { -# return $file . $file_basename . ".$NODE_FILE_EXTENSION"; -# } + if (defined $file) { return &$original_func($node, $node_id, $node_hxmlt_id, $file); } else { @@ -593,46 +564,50 @@ 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 -# 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" . &$anchor ($element->{'tocid'}, "$element->{'file'}#$element->{'id'}",$element->{'text'}); + my $entry = "$ind" . &$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\n"); push (@result, @child_result); - push (@result, "$ind\n"); + push (@result, "$ind\n"); } - } else { - push (@result, $entry . "\n"); } + push (@result, "$ind\n"); return @result; } @@ -658,7 +633,7 @@ sub lilypond_generate_page_toc_body($) my @toc_entries = ("
\n", "\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, "\n"); push (@toc_entries, "
\n"); @@ -673,8 +648,34 @@ sub lilypond_print_toc_div ($$) # use default TOC if no custom lines have been generated @lines = @default_toc if (not @lines); if (@lines) { + print $fh "\n\n
\n"; - print $fh '

' . $Texi2HTML::NAME{'Contents'} . "

\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 "

<< " . + &ly_get_string ('Back to Documentation Index') . + "

\n"; + + print $fh '

' . &$anchor('', + $Texi2HTML::HREF{'Top'}, + $topname, + 'title="Start of the manual"' + ) . "

\n"; foreach my $line (@lines) { print $fh $line; } @@ -689,7 +690,6 @@ sub lilypond_print_toc_div ($$) 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) { @@ -698,7 +698,7 @@ sub lilypond_print_element_header @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 @@ -724,7 +724,7 @@ sub print_lilypond_page_foot($) { my $fh = shift; my $program_string = &$program_string(); - print $fh "

$program_string
$PRE_BODY_CLOSE

\n"; +# print $fh "

$program_string
$PRE_BODY_CLOSE

\n"; print $fh "\n\n"; print $fh "\n
\n\n"; @@ -767,48 +767,45 @@ sub get_navigation_text # 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 '\n"; - print $fh "
\n"; + my $result = "
\n"; - print $fh "" unless $vertical; + $result .= "" unless $vertical; my $beginofline = 1; foreach my $button (@$buttons) { - print $fh qq{\n} if $vertical; + $result .= qq{\n} if $vertical; # Allow (left|right|center)-aligned-cell and newline as buttons! if ( $button =~ /^(.*)-aligned-cell-(.*)$/ ) { - print $fh qq{} unless $beginofline; - print $fh qq{} unless $beginofline; + $result .= qq{} unless $beginofline; - print $fh qq{}; - print $fh qq{}; + $result .= qq{} unless $beginofline; + $result .= qq{}; + $result .= qq{}; $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}) @@ -822,7 +819,7 @@ sub lilypond_print_navigation { $anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\""; } - print $fh "" . + $result .= "" . &$anchor('', $Texi2HTML::HREF{$button_href}, get_navigation_text($$text), @@ -831,13 +828,13 @@ sub lilypond_print_navigation } 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{' '}; @@ -857,7 +854,7 @@ sub lilypond_print_navigation } if ($ICONS && $ACTIVE_ICONS{$button}) { # use icon - print $fh '' . + $result .= '' . &$anchor('', $Texi2HTML::HREF{$button}, &$button_icon_img($BUTTONS_NAME{$button}, @@ -868,11 +865,11 @@ sub lilypond_print_navigation } else { # use text - print $fh + $result .= '[' . &$anchor('', $Texi2HTML::HREF{$button}, - get_navigation_text ($button), + get_navigation_text($button), $btitle ) . ']'; @@ -880,7 +877,7 @@ sub lilypond_print_navigation } else { # button is passive - print $fh + $result .= $ICONS && $PASSIVE_ICONS{$button} ? &$button_icon_img($BUTTONS_NAME{$button}, $PASSIVE_ICONS{$button}, @@ -888,12 +885,13 @@ sub lilypond_print_navigation "[" . get_navigation_text($button) . "]"; } - print $fh "\n" if $vertical; - print $fh "\n" if $vertical; + $result .= "\n" if $vertical; + $result .= "\n" if $vertical; } - print $fh "" unless $beginofline; - print $fh "" unless $vertical; - print $fh "
}; + $result .= qq{}; $beginofline = 0; } elsif ( $button eq 'newline' ) { - print $fh qq{
\n"; + $result .= "" unless $beginofline; + $result .= "" unless $vertical; + $result .= "\n"; + return $result; } @@ -943,12 +941,132 @@ 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 nr 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 = "" . &$anchor($docid, "$footnote_file#$footid", $relative_num) . ""; + $foot_anchor = &$anchor($docid, "$footnote_file#$footid", "($relative_num)") if ($state->{'preformatted'}); + +# unshift @$lines, "
  • "; +# push @$lines, "
    • \n"; + return ($lines, $foot_anchor); +} + +sub makeinfo_like_foot_lines($) +{ + my $lines = shift; + unshift @$lines, "
    \n

    $Texi2HTML::I18n::WORDS->{'Footnotes_Title'}

    \n"; +#
      \n"; +# push @$lines, "
    "; + 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 = '[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 = "[${foot_label}] "; + } + } + return $open.'>'.$footnote_text.$text.'

    '; +} + + ############################################################################# ### OTHER SETTINGS ############################################################################# # For split pages, use index.html as start page! -if ($Texi2HTML::Config::SPLIT == 'section') { +if ($Texi2HTML::Config::SPLIT eq 'section') { $Texi2HTML::Config::TOP_FILE = 'index.html'; }