X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Flilypond-texi2html.init;h=57340912510302b52f96a6ee8a2c9953bb262cd2;hb=5532fc797fa8370cf6d4ca242ffb5751c897bbec;hp=7bea5ad3ac153bbd75e79851f1d4f3e76647f982;hpb=5f03f8603e38802a1c38cf7a85a1c833ccfc2c39;p=lilypond.git diff --git a/Documentation/lilypond-texi2html.init b/Documentation/lilypond-texi2html.init index 7bea5ad3ac..5734091251 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); @@ -104,6 +121,11 @@ $LY_LANGUAGES->{'it'} = { '

Thanks to ${webdev_link} for hosting ${lily_site}.' => '', }; +$LY_LANGUAGES->{'nl'} = { + 'Back to Documentation Index' => 'Terug naar de Documentatieindex', + '

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 = ' "lilypond-web.css", TITLE => "Patrick McCarty's design"} @@ -561,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; @@ -630,6 +658,22 @@ 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 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; +} + # 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 +706,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. @@ -750,10 +794,25 @@ sub lilypond_css_lines ($$) $Texi2HTML::THISDOC{'CSS_LINES'} .= "{FILENAME}\" title=\"$ref->{TITLE}\">\n"; } - # FIXME: the website doesn't use ie7-specific fixes; do the - # docs still need this? -gp - $Texi2HTML::THISDOC{'CSS_LINES'} .= - "\n"; + + # The ie-fixes stylesheet is needed for the docs, but not the website. + if (not ($web_manual)) { + $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"; + } + } } @@ -767,6 +826,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 +862,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 +878,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 +899,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 +907,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 +916,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; @@ -879,8 +986,11 @@ 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); + $id = lc($target); +# $id =~ s/-1$//i; # remove any trailing "-1" + return ($target, $id); } @@ -893,7 +1003,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 +1028,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 +1080,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 +1095,6 @@ sub lilypond_unknown($$$$$) } - - my %translated_books = (); # Construct a href to an external source of information. # node is the node with texinfo @-commands @@ -990,7 +1107,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 @@ -1016,20 +1133,48 @@ 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) { - return &$default_external_href($node, $node_id, $node_hxmlt_id, lc($file)); + $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) { + 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_xhtml_id); + $href = remove_unneeded_anchor($href); + return $href; } } - +sub remove_unneeded_anchor($) +{ + my $href = shift; + my @hrefsplit = split("/", $href); + for ($i = 0; $i < @hrefsplit; $i++) { + $item = @hrefsplit[$i]; + if ($item =~ /#/) { + @splitted = split(".html#", $item); + if (@splitted[0] eq @splitted[1]) { + @hrefsplit[$i] = @splitted[0] . ".html"; + } + } + } + $href = join("/", @hrefsplit); + return $href +} @@ -1183,16 +1328,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) { @@ -1225,9 +1373,16 @@ 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}; + # strip one depth level for translations + if ($lang and $lang ne "en" and substr ($reldir, 0, 3) eq '../') { + $reldir = substr ($reldir, 3); + } + # add a / at the end if there isn't one. + if (substr ($reldir, -1) ne '/') { + $reldir .= '/'; + } + my $uplink = $reldir."Documentation/web/manuals.${lang}html"; if (not $web_manual) { print $fh "

    \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, @@ -1657,6 +1822,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 #############################################################################