X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;ds=sidebyside;f=Documentation%2Flilypond-texi2html.init;h=96f4cb2d28765dae72cef1fedbedbb0d4349dc33;hb=229701a3277dad1c8d2057bd8cc1ba085728face;hp=55548ffb96dcee4b3c1042799f2093fe500f2eea;hpb=3b10ee8aa8c9f780934607d908e7397ca518cd41;p=lilypond.git diff --git a/Documentation/lilypond-texi2html.init b/Documentation/lilypond-texi2html.init index 55548ffb96..96f4cb2d28 100644 --- a/Documentation/lilypond-texi2html.init +++ b/Documentation/lilypond-texi2html.init @@ -63,8 +63,25 @@ ### 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); @@ -549,7 +566,7 @@ $Texi2HTML::Config::DOCTYPE = ' "lilypond-web.css", TITLE => "Patrick McCarty's design"} @@ -566,11 +583,17 @@ $Texi2HTML::Config::USE_REL_REV = 1; $Texi2HTML::Config::SPLIT_INDEX = 0; $Texi2HTML::Config::SEPARATED_FOOTNOTES = 0; # Print footnotes on same page, not separated +my $bigpage = 0; +my $have_index_entries = 0; if ($Texi2HTML::Config::SPLIT eq 'section' or $Texi2HTML::Config::SPLIT eq 'node') { $Texi2HTML::Config::element_file_name = \&lilypond_element_file_name; + $bigpage = 0; +} else { + $bigpage = 1; } +$Texi2HTML::Config::anchor = \&lilypond_anchor; $Texi2HTML::Config::element_target_name = \&lilypond_element_target_name; $default_print_element_header = $Texi2HTML::Config::print_element_header; $Texi2HTML::Config::print_element_header = \&lilypond_print_element_header; @@ -640,10 +663,13 @@ sub lc_last($) { my $href = shift; my @hrefsplit = split('/', $href); - # change the last portion (the filename), if it exists + # change the last portion (the filename), if it exists; + # if it is a plain filename with no path, change the string as a whole if ($#hrefsplit > 0) { @hrefsplit[$#hrefsplit] = lc( @hrefsplit[$#hrefsplit] ); $href = join("/", @hrefsplit); + } else { + $href = lc($href); } return $href; } @@ -772,6 +798,19 @@ sub lilypond_css_lines ($$) # docs still need this? -gp $Texi2HTML::THISDOC{'CSS_LINES'} .= "\n"; + + if ($ENV{'AJAX_SEARCH'} == 1) { + # Add the JavaScript file only if we have an index. + # Unfortunately, init_out is called after css_lines, so as a workaround + # here we have to check again for the existence of an index... + my $ix = main::get_index ("cp"); + $have_index_entries = (scalar $ix > 0); + my $reldir = ""; + $reldir = "../" unless $bigpage; + if ($have_index_entries) { + $Texi2HTML::THISDOC{'CSS_LINES'} .= "\n"; + } + } } @@ -785,6 +824,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, @@ -874,6 +914,51 @@ 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; +} + +# This function produces an anchor. +# +# arguments: +# $name : anchor name +# $href : anchor href +# text : text displayed +# extra_attribs : added to anchor attributes list +sub lilypond_anchor($;$$$) +{ + my $name = shift; + my $href = shift; + my $text = shift; + my $attributes = shift; + $href = remove_unneeded_anchor($href); + if (!defined($attributes) or ($attributes !~ /\S/)) + { + $attributes = ''; + } + else + { + $attributes = ' ' . $attributes; + } + $name = '' if (!defined($name) or ($name !~ /\S/)); + $href = '' if (!defined($href) or ($href !~ /\S/)); + $text = '' if (!defined($text)); + return $text if (($name eq '') and ($href eq '')); + $name = "name=\"$name\"" if ($name ne ''); + $href = "href=\"$href\"" if ($href ne ''); + $href = ' ' . $href if (($name ne '') and ($href ne '')); + return "$text"; +} + + sub lilypond_element_target_name($$$) { my $element = shift; @@ -901,12 +986,9 @@ sub lilypond_element_target_name($$$) # the sections, change this back to ($id, $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); + $id = lc($target); +# $id =~ s/-1$//i; # remove any trailing "-1" + return ($target, $id); } @@ -996,7 +1078,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 { @@ -1017,7 +1105,7 @@ sub lilypond_external_href($$$) { my $node = shift; my $node_id = shift; - my $node_hxmlt_id = shift; + my $node_xhtml_id = shift; my $file = shift; # 1) Keep a hash of book->section_map @@ -1043,15 +1131,15 @@ sub lilypond_external_href($$$) 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}}; + ($node_id, $node_xhtml_id) = @{$section_name_map->{$node_text}}; } else { print STDERR "WARNING: Unable to find node '$node_text' in book $map_name.\n"; } } if (defined $file) { - $href = &$default_external_href($node, $node_id, $node_hxmlt_id, lc_last($file)); - remove_unneeded_anchor($href); + $href = &$default_external_href($node, $node_id, $node_xhtml_id, lc_last($file)); + $href = remove_unneeded_anchor($href); # TODO: very yucky, but will be fixed in issue 1004 if ($web_manual) { @@ -1063,22 +1151,22 @@ sub lilypond_external_href($$$) return $href; } else { - $href = &$default_external_href($node, $node_id, $node_hxmlt_id); - remove_unneeded_anchor($href); + $href = &$default_external_href($node, $node_id, $node_xhtml_id); + $href = remove_unneeded_anchor($href); return $href; } } sub remove_unneeded_anchor($) { - my $ref = shift; + my $href = 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] + @splitted = split(".html#", $item); + if (@splitted[0] eq @splitted[1]) { + @hrefsplit[$i] = @splitted[0] . ".html"; } } } @@ -1238,16 +1326,19 @@ sub lilypond_generate_page_toc_body($) push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth, 0, $element)); } # search box - local $/=undef; - my $name = "search-box"; - $lang = $Texi2HTML::THISDOC{current_lang}; - open FILE, "$ENV{TOP_SRC_DIR}/Documentation/$lang/$name.ihtml" or + # I'm assuming that we wouldn't keep the google search box? -gp + if (!($ENV{AJAX_SEARCH} == 1)) { + local $/=undef; + my $name = "search-box"; + $lang = $Texi2HTML::THISDOC{current_lang}; + 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 = decode ('UTF-8', ); - $search_string = "
  • \n" . $search_string . "
    • \n"; - push (@toc_entries, $search_string); - close FILE; + my $search_string = decode ('UTF-8', ); + $search_string = "
  • \n" . $search_string . "
    • \n"; + push (@toc_entries, $search_string); + close FILE; + } push (@toc_entries, "\n"); if ($web_manual) { @@ -1289,6 +1380,16 @@ sub lilypond_print_toc_div ($$) &ly_get_string ('Back to Documentation Index') . "

    \n"; + # AJAX search box, written in JavaScript + if ($ENV{'AJAX_SEARCH'} == 1) { + if ($have_index_entries) { + my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'}); + print $fh '\n"; + } + } + print $fh '

    ' . &$anchor('', $Texi2HTML::HREF{'Top'}, $topname, @@ -1711,6 +1812,65 @@ sub makeinfo_like_paragraph ($$$$$$$$$$$$$) } +############################################################################# +### WRITING OUT THE INDEX FOR THE AJAX SEARCH FIELD +############################################################################# + +$Texi2HTML::Config::IDX_SUMMARY = 1; +$Texi2HTML::Config::init_out = \&lilypond_init_out; +$Texi2HTML::Config::finish_out = \&lilypond_finish_out; +$Texi2HTML::Config::index_summary_file_entry = \&lilypond_index_summary_file_entry; + +my @index_entries; + +sub lilypond_init_out () +{ + t2h_default_init_out (); + # Check whether we have an index at all! If not -> don't print out a search box! + my $ix = main::get_index ("cp"); + $have_index_entries = (scalar $ix > 0); +} + +sub lilypond_index_summary_file_entry ($$$$$$$$$) +{ + my $index_name = shift; + my $entry_text = shift; + my $entry_reference = shift; + my $formatted_entry = shift; + my $texi_entry = shift; + my $entry_element_reference = shift; + my $entry_element_header = shift; + my $is_printed = shift; + my $manual_name = shift; + + if ($ENV{'AJAX_SEARCH'}==1) { + if ($index_name eq "cp") + { + # The entries in the index file have the form: + # SearchText \t FormattedText \t EntryURL \t SectionText \t SectionURL + push @index_entries, "$entry_text\t$formatted_entry\t$entry_reference\t$entry_element_header\t$entry_element_reference\n"; + } + } +} + +sub lilypond_finish_out () +{ + if ($ENV{'AJAX_SEARCH'}==1) { + if (((scalar @index_entries) > 0) and $have_index_entries) { + my $lang = $Texi2HTML::THISDOC{current_lang}; + my $big = ""; + $big = "-big-page" if $bigpage; + my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'}); + my $idx_file = "$docu_dir/$docu_name$big.$lang.idx"; + open IDXOUTFILE, ">:utf8", $idx_file; + print IDXOUTFILE @index_entries; + close IDXOUTFILE; + } + } +} + + + ############################################################################# ### OTHER SETTINGS #############################################################################