(.*?)

+### print_lilypond_page_foot -- closing id=main, output of footer & TOC +### -) External refs are formatted only as "Text of the node" (not as >>see +### "NODE" section "SECTION" in "BOOK"<< like with default texi2html). Also, +### the leading "(book-name)" is removed. +### Implemented by overriding lilypond_external_ref +### -) Navigation bars on top/bottom of the page and between sections are not +### left-aligned, but use a combination of left/center/right aligned table +### cells; For this, I heavily extend the texi2html code to allow for +### differently aligned cells and for multi-line tables); +### Implemented in lilypond_print_navigation +### -) Different formatting than the default: example uses the same formatting +### as quote. +### -) Allow translated section titles: All section titles can be translated, +### the original (English) title is associated with @translationof. This is +### needed, because the file name / anchor is generated from the original +### 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 +### correct file name for the link. Implemented in: +### lilypond_unknown (handling of @translationof, in case +### extract_texi_filenames.py messes up...) +### split_at_numbered_sections (correct file name: 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 +### 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: +### split_at_numbered_sections (adjust section anchors) +### -) Use the standard footnote format "^nr text" instead of the +### ugly format of texi2html (

(nr)

text

). Implemented in +### lilypond_foot_line_and_ref +### +### +### Useful helper functions: +### -) texinfo_file_name($node_name): returns a texinfo-compatible file name +### for the given string $node_name (whitespace trimmed/replaced by -, +### non-standard chars replaced by _xxxx (ascii char code) and forced to +### start with a letter by prepending t_g if necessary) + + +package Texi2HTML::Config; + + + + + +############################################################################# +### SETTINGS FOR TEXI2HTML +############################################################################# + +@Texi2HTML::Config::CSS_REFS = ("lilypond.css"); +$Texi2HTML::Config::USE_ACCESSKEY = 1; +$Texi2HTML::Config::USE_LINKS = 1; +$Texi2HTML::Config::USE_REL_REV = 1; +$Texi2HTML::Config::SEPARATED_FOOTNOTES = 0; # Print footnotes on same page, not separated +$Texi2HTML::Config::element_file_name = \&split_at_numbered_sections; +$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; +$Texi2HTML::Config::external_ref = \&lilypond_external_ref; +$Texi2HTML::Config::external_href = \&lilypond_external_href; +$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; + +# Examples should be formatted similar to quotes: +$Texi2HTML::Config::complex_format_map->{'example'} = { + 'begin' => q{"

"},
+  'end' => q{"

\n"}, + }; + +%Texi2HTML::config::misc_pages_targets = ( + 'Overview' => 'Overview', + 'Contents' => 'Contents', + 'About' => 'About' +); + + +my @section_to_filename; + + + + +############################################################################# +### DEBUGGING +############################################################################# + +use Data::Dumper; +$Data::Dumper::Maxdepth = 2; + +sub print_element_info($) +{ + my $element = shift; + print "~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n"; + print "Element: $element\n"; + print Dumper($element); +} + + + + + +############################################################################# +### HELPER FUNCTIONS +############################################################################# + +# 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 +sub texinfo_file_name($) +{ + my $text = shift; + my $result = ''; + # File name normalization by texinfo: + # 1/2: letters and numbers are left unchanged + # 3/4: multiple, leading and trailing whitespace is removed + $text = main::normalise_space($text); + # 5/6: all remaining spaces are converted to '-', all other 7- or 8-bit + # chars are replaced by _xxxx (xxxx=ascii character code) + while ($text ne '') { + if ($text =~ s/^([A-Za-z0-9]+)//o) { # number or letter stay unchanged + $result .= $1; + } elsif ($text =~ s/^ //o) { # space -> '-' + $result .= '-'; + } elsif ($text =~ s/^(.)//o) { # Otherwise use _xxxx (ascii char code) + my $ccode = ord($1); + if ( $ccode <= 0xFFFF ) { + $result .= sprintf("_%04x", $ccode); + } else { + $result .= sprintf("__%06x", $ccode); + } + } + } + # 7: if name does not begin with a letter, prepend 't_g' (so it starts with a letter) + if ($result !~ /^[a-zA-Z]/) { + $result = 't_g' . $result; + } + # DONE + return $result +} + + +# Load a file containing a nodename<=>filename map (tab-sepatared, i.e. +# NODENAME\tFILENAME\tANCHOR +# Returns a ref to a hash "Node title" => ["FilenameWithoutExt", "Anchor"] +sub load_map_file ($) +{ + my $mapfile = shift; + my $node_map = (); + + if (open(XREFFILE, $mapfile)) { + my $line; + while ( $line = ) { + # parse the tab-separated entries and insert them into the map: + 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: $line\n"; + } + } + close (XREFFILE); + } else { + 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); +} + + + + + +############################################################################# +### CSS HANDLING +############################################################################# + +# Include our standard CSS file, not hard-coded CSS code directly in the HTML! +# For IE, conditionally include the lilypond-ie-fixes.css style sheet +sub lilypond_css_lines ($$) +{ + my $import_lines = shift; + my $rule_lines = shift; + return if (defined($CSS_LINES)); + if (@$rule_lines or @$import_lines) + { + $CSS_LINES = "\n"; + } + foreach my $ref (@CSS_REFS) + { + $CSS_LINES .= "\n"; + } + $CSS_LINES .= "\n"; +} + + + + + +############################################################################# +### SPLITTING BASED ON NUMBERED SECTIONS +############################################################################# + +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 +# Nodes with the same filename will be printed out to the same filename, so +# this really all we need. Also, make sure that the file names for sections +# are derived from the section title. We also might want to name the anchors +# 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 +# same logic here. +sub split_at_numbered_sections($$$) +{ + my $element = shift; + my $type = shift; + my $docu_name = shift; + 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)); + + # need to override both target (used as anchor in links to this section) and + # id (used in the tag for this section)! + $element->{'id'} = $element->{'target'} = $anchor; + + # 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; + $$element{doc_nr} = $docnr; + $lastfilename = $filename; + } + 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" + if ($type eq "top") { + $element->{'id'} = $element->{'target'} = "Top"; + } + 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); + # need to override both target (used as anchor in links to this section) and + # id (used in the tag for this section)! + $element->{'id'} = $element->{'target'} = $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; + $filename .= ".$docu_ext" if (defined($docu_ext)); + $docnr += 1; + $$element{doc_nr} = $docnr; + $lastfilename = $filename; + return $filename; + } else { + $$element{doc_nr} = $docnr; + return $lastfilename; + } + } + + return; +} + + +## 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 = 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; + + + +############################################################################# +### CLEANER LINK TITLE FOR EXTERNAL REFS +############################################################################# + +# The default formatting of external refs returns e.g. +# "(lilypond-internals)Timing_translator", so we remove all (...) from the +# file_and_node argument. Also, we want only a very simple format, so we don't +# even call the default handler! +sub lilypond_external_ref($$$$$$) +{ + my $type = shift; + my $section = shift; + my $book = shift; + my $file_node = shift; + my $href = shift; + my $cross_ref = shift; + + 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); +} + + + + + +############################################################################# +### HANDLING TRANSLATED SECTIONS: handle @translationof, secname<->filename +### map stored on disk, xrefs in other manuals load that map +############################################################################# + + +# Try to make use of @translationof to generate files according to the original +# English section title... +sub lilypond_unknown($$$$$) +{ + my $macro = shift; + my $line = shift; + my $pass = shift; + my $stack = shift; + my $state = shift; + + # the @translationof macro provides the original English section title, + # which should be used for file/anchor naming, while the title will be + # translated to each language + # It is already used by extract_texi_filenames.py, so this should not be + # 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'}) eq 'HASH') { + $state->{'element'}->{'translationof'} = main::normalise_space($line); + } + return ('', true, undef, undef); + } else { + return t2h_default_unknown($macro, $line, $pass, $stack, $state); + } +} + + + + +my %translated_books = (); +# Construct a href to an external source of information. +# node is the node with texinfo @-commands +# node_id is the node transliterated and transformed as explained in the +# texinfo manual +# node_xhtml_id is the node transformed such that it is unique and can +# be used to make an html cross ref as explained in the texinfo manual +# file is the file in '(file)node' +sub lilypond_external_href($$$) +{ + my $node = shift; + my $node_id = shift; + my $node_hxmlt_id = shift; + my $file = shift; + 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 + # 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) + + 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); + } + + # 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 "WARNING: Unable to find node '$node_text' in book $map_name.\n"; + } + } + + if (defined $file) { + return &$original_func($node, $node_id, $node_hxmlt_id, $file); + } else { + return &$original_func($node, $node_id, $node_hxmlt_id); + } +} + + + + + +############################################################################# +### CUSTOM TOC FOR EACH PAGE (in a frame on the left) +############################################################################# + +my $page_toc_depth = 2; +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($$$$) +{ + 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 $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); + my @child_result = (); + foreach (@$children) { + push (@child_result, generate_ly_toc_entries($_, $element_path, $maxlevel, $is_parent_of_current)); + } + # 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"); + } + } else { + push (@result, $entry . "\n"); + } + return @result; +} + + +# Print a customized TOC, containing only the first two levels plus the whole +# path to the current page +sub lilypond_generate_page_toc_body($) +{ + my $element = shift; + my $current_element = $element; + my %parentelements; + $parentelements{$element->{'id'}} = 1; + # Find the path to the current element + while ( defined($current_element->{'sectionup'}) and + ($current_element->{'sectionup'} ne $current_element) ) + { + $parentelements{$current_element->{'sectionup'}->{'id'}} = 1 + if ($current_element->{'sectionup'}->{'id'} ne ''); + $current_element = $current_element->{'sectionup'}; + } + return () if not defined($current_element); + # Create the toc entries recursively + 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, "\n"); + push (@toc_entries, "

\n"); + return @toc_entries; +} + +sub lilypond_print_toc_div ($$) +{ + my $fh = shift; + my $tocref = shift; + my @lines = @$tocref; + # 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"; + foreach my $line (@lines) { + print $fh $line; + } + print $fh "

\n\n"; + } +} + +# Create the custom TOC for this page (partially folded, current page is +# highlighted) and store it in a global variable. The TOC is written out after +# the html contents (but positioned correctly using CSS), so that browsers with +# css turned off still show the contents first. +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) { + if (defined($Texi2HTML::THIS_ELEMENT)) { + # Create the TOC for this page + @this_page_toc = lilypond_generate_page_toc_body($Texi2HTML::THIS_ELEMENT); + } + } + return T2H_DEFAULT_print_element_header( $fh, $first_in_page, $previous_is_top); +} + +# Generate the HTML output for the TOC +sub lilypond_toc_body($) +{ + my $elements_list = shift; + # Generate a default TOC for pages without THIS_ELEMENT + @default_toc = lilypond_generate_page_toc_body(@$elements_list[0]); + return T2H_GPL_toc_body($elements_list); +} + +# Print out the TOC in a

at the beginning of the page +sub lilypond_print_page_head($) +{ + my $fh = shift; + T2H_DEFAULT_print_page_head($fh); + print $fh "

\n"; +} + +# Print out the TOC in a

at the end of th page, which will be formatted as a +# sidebar mimicking a TOC frame +sub print_lilypond_page_foot($) +{ + my $fh = shift; + my $program_string = &$program_string(); + print $fh "

$program_string
$PRE_BODY_CLOSE

\n"; + print $fh "\n\n"; + print $fh "\n

\n\n"; + + # Print the TOC frame and reset the TOC: + lilypond_print_toc_div ($fh, \@this_page_toc); + @this_page_toc = (); + + # Close the page: + print $fh "\n\n"; +} + + + + + +############################################################################# +### NICER / MORE FLEXIBLE NAVIGATION PANELS +############################################################################# + +sub get_navigation_text +{ + my $button = shift; + my $text = $NAVIGATION_TEXT{$button}; + if ( ($button eq 'Back') or ($button eq 'FastBack') ) { + $text = $text . $Texi2HTML::NODE{$button} . " "; + } elsif ( ($button eq 'Forward') or ($button eq 'FastForward') ) { + $text = " " . $Texi2HTML::NODE{$button} . $text; + } elsif ( $button eq 'Up' ) { + $text = " ".$text.": " . $Texi2HTML::NODE{$button} . " "; + } + return $text; +} + + +# Don't automatically create left-aligned table cells for every link, but +# instead create a only on an appropriate '(left|right|center)-aligned-cell-n' +# button text. It's alignment as well as the colspan will be taken from the +# name of the button. Also, add 'newline' button text to create a new table +# row. The texts of the buttons are generated by get_navigation_text and +# 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"; + + print $fh "" unless $vertical; + my $beginofline = 1; + foreach my $button (@$buttons) + { + print $fh 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; + print $fh qq{}; + print $fh qq{}; + $beginofline = 1; + + } + elsif (ref($button) eq 'CODE') + { + &$button($fh, $vertical); + } + elsif (ref($button) eq 'SCALAR') + { + print $fh "$$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) + and defined($text) and (ref($text) eq 'SCALAR') and defined($$text)) + { # use given text + if ($Texi2HTML::HREF{$button_href}) + { + my $anchor_attributes = ''; + if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button_href})) and ($BUTTONS_ACCESSKEY{$button_href} ne '')) + { + $anchor_attributes = "accesskey=\"$BUTTONS_ACCESSKEY{$button_href}\""; + } + if ($USE_REL_REV and (defined($BUTTONS_REL{$button_href})) and ($BUTTONS_REL{$button_href} ne '')) + { + $anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\""; + } + print $fh "" . + &$anchor('', + $Texi2HTML::HREF{$button_href}, + get_navigation_text($$text), + $anchor_attributes + ); + } + else + { + print $fh get_navigation_text($$text); + } + } + } + elsif ($button eq ' ') + { # handle space button + print $fh + ($ICONS && $ACTIVE_ICONS{' '}) ? + &$button_icon_img($BUTTONS_NAME{$button}, $ACTIVE_ICONS{' '}) : + $NAVIGATION_TEXT{' '}; + #next; + } + elsif ($Texi2HTML::HREF{$button}) + { # button is active + my $btitle = $BUTTONS_GOTO{$button} ? + 'title="' . $BUTTONS_GOTO{$button} . '"' : ''; + if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button})) and ($BUTTONS_ACCESSKEY{$button} ne '')) + { + $btitle .= " accesskey=\"$BUTTONS_ACCESSKEY{$button}\""; + } + if ($USE_REL_REV and (defined($BUTTONS_REL{$button})) and ($BUTTONS_REL{$button} ne '')) + { + $btitle .= " rel=\"$BUTTONS_REL{$button}\""; + } + if ($ICONS && $ACTIVE_ICONS{$button}) + { # use icon + print $fh '' . + &$anchor('', + $Texi2HTML::HREF{$button}, + &$button_icon_img($BUTTONS_NAME{$button}, + $ACTIVE_ICONS{$button}, + $Texi2HTML::SIMPLE_TEXT{$button}), + $btitle + ); + } + else + { # use text + print $fh + '[' . + &$anchor('', + $Texi2HTML::HREF{$button}, + get_navigation_text ($button), + $btitle + ) . + ']'; + } + } + else + { # button is passive + print $fh + $ICONS && $PASSIVE_ICONS{$button} ? + &$button_icon_img($BUTTONS_NAME{$button}, + $PASSIVE_ICONS{$button}, + $Texi2HTML::SIMPLE_TEXT{$button}) : + + "[" . get_navigation_text($button) . "]"; + } + print $fh "\n" if $vertical; + print $fh "\n" if $vertical; + } + print $fh "" unless $beginofline; + print $fh "" unless $vertical; + print $fh "

}; + $beginofline = 0; + } + elsif ( $button eq 'newline' ) + { + print $fh qq{

\n"; +} + + +@Texi2HTML::Config::SECTION_BUTTONS = + ('left-aligned-cell-1', 'FastBack', + 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About', + 'right-aligned-cell-1', 'FastForward', + 'newline', + 'left-aligned-cell-2', 'Back', + 'center-aligned-cell-1', 'Up', + 'right-aligned-cell-2', 'Forward' + ); + +# buttons for misc stuff +@Texi2HTML::Config::MISC_BUTTONS = ('center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About'); + +# buttons for chapter file footers +# (and headers but only if SECTION_NAVIGATION is false) +@Texi2HTML::Config::CHAPTER_BUTTONS = + ('left-aligned-cell-1', 'FastBack', + 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About', + 'right-aligned-cell-1', 'FastForward', + ); + +# buttons for section file footers +@Texi2HTML::Config::SECTION_FOOTER_BUTTONS = + ('left-aligned-cell-1', 'FastBack', + 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About', + 'right-aligned-cell-1', 'FastForward', + 'newline', + 'left-aligned-cell-2', 'Back', + 'center-aligned-cell-1', 'Up', + 'right-aligned-cell-2', 'Forward' + ); + +@Texi2HTML::Config::NODE_FOOTER_BUTTONS = + ('left-aligned-cell-1', 'FastBack', + 'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About', + 'right-aligned-cell-1', 'FastForward', + 'newline', + 'left-aligned-cell-2', 'Back', + 'center-aligned-cell-1', 'Up', + 'right-aligned-cell-2', 'Forward' + ); + + + + + +############################################################################# +### 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. +sub lilypond_foot_line_and_ref($$$$$$$) +{ + my $number_in_doc = shift; + my $number_in_page = shift; + my $footnote_id = shift; + my $place_id = shift; + my $document_file = shift; + my $footnote_file = shift; + my $lines = shift; + my $state = shift; + + if ($document_file eq $footnote_file) + { + $document_file = $footnote_file = ''; + } + # FN number printed before the fn text: + my $tmptxt = &$anchor($footnote_id, $document_file . "#$place_id", + "^{$number_in_doc}"); + # unfortunately, the @$lines contain the already formatted footnote in the + # from

...

. This means that we have to modify this string and + # insert the FN number manually. The default (nr) on a separate line before + # the FN text is just plain ugly: + $lines->[0] =~ s/^

$tmptxt /; + # this is a bit obscure, this allows to add an anchor only if formatted + # as part of the document. + $place_id = '' if ($state->{'outside_document'} or $state->{'multiple_pass'}); + # return FN lines and text to be inserted in the running text (link to FN) + return ($lines, &$anchor($place_id, $footnote_file . "#$footnote_id", + "^{$number_in_doc}")); +} + + + +############################################################################# +### OTHER SETTINGS +############################################################################# + +# For split pages, use index.html as start page! +if ($Texi2HTML::Config::SPLIT eq 'section') { + $Texi2HTML::Config::TOP_FILE = 'index.html'; +} + + +return 1; diff --git a/make/doc-i18n-root-targets.make b/make/doc-i18n-root-targets.make index 4e917c5da0..8afe50af84 100644 --- a/make/doc-i18n-root-targets.make +++ b/make/doc-i18n-root-targets.make @@ -1,4 +1,4 @@ default: -local-WWW: $(OUT_HTML_FILES) +local-WWW-2: $(OUT_HTML_FILES) $(PYTHON) $(buildscript-dir)/mass-link.py --prepend-suffix .$(ISOLANG) hard $(outdir) $(top-build-dir)/Documentation/$(outdir) $(HTML_FILES) diff --git a/make/doc-i18n-user-rules.make b/make/doc-i18n-user-rules.make new file mode 100644 index 0000000000..91f09c47a1 --- /dev/null +++ b/make/doc-i18n-user-rules.make @@ -0,0 +1,33 @@ +$(outdir)/%/index.html: $(outdir)/%.texi $(XREF_MAPS_DIR)/%.$(ISOLANG).xref-map $(OUT_PNG_IMAGES) $(outdir)/version.itexi + mkdir -p $(dir $@) + $(TEXI2HTML) --I=$(outdir) $(TEXI2HTML_FLAGS) --output=$(dir $@) --prefix=index --split=section $(TEXI2HTML_INIT) $< + cp $(top-src-dir)/Documentation/lilypond*.css $(dir $@) + +$(outdir)/%-big-page.html: $(outdir)/%.texi $(XREF_MAPS_DIR)/%.$(ISOLANG).xref-map $(OUT_PNG_IMAGES) $(outdir)/version.itexi + $(TEXI2HTML) --I=$(outdir) -D bigpage $(TEXI2HTML_FLAGS) --output=$@ $(TEXI2HTML_INIT) $< + cp $(top-src-dir)/Documentation/lilypond*.css $(dir $@) + +$(outdir)/%.pdftexi: $(outdir)/%.texi $(outdir)/version.itexi + $(PYTHON) $(buildscript-dir)/texi-gettext.py $(ISOLANG) $< + +$(outdir)/%.pdf: $(outdir)/%.pdftexi $(outdir)/version.itexi + cd $(outdir); texi2pdf $(TEXI2PDF_FLAGS) $(TEXINFO_PAPERSIZE_OPTION) $(notdir $*).pdftexi + +$(outdir)/version.%: $(top-src-dir)/VERSION + echo '@macro version'> $@ + echo $(TOPLEVEL_VERSION)>> $@ + echo '@end macro'>> $@ + +$(outdir)/%.png: $(top-build-dir)/Documentation/user/$(outdir)/%.png + ln -f $< $@ + +$(XREF_MAPS_DIR)/%.$(ISOLANG).xref-map: $(outdir)/%.texi + $(PYTHON) $(buildscript-dir)/extract_texi_filenames.py -o $(XREF_MAPS_DIR) $< + +# This makes sure lilypond-doc gettext domain has been compiled +# before lilypond-book runs +$(TELY_FILES): doc-po + +$(MASTER_TEXI_FILES): $(ITELY_FILES) $(ITEXI_FILES) + +.SECONDARY: diff --git a/make/doc-i18n-user-targets.make b/make/doc-i18n-user-targets.make new file mode 100644 index 0000000000..7f8f6799b0 --- /dev/null +++ b/make/doc-i18n-user-targets.make @@ -0,0 +1,14 @@ +default: + +local-WWW-1: $(MASTER_TEXI_FILES) $(PDF_FILES) $(XREF_MAPS_FILES) + +# BIG_PAGE_HTML_FILES is defined differently in each language makefile +local-WWW-2: $(DEEP_HTML_FILES) $(BIG_PAGE_HTML_FILES) + find $(outdir) -name '*.html' | xargs grep -L 'UNTRANSLATED NODE: IGNORE ME' | xargs $(PYTHON) $(buildscript-dir)/html-gettext.py $(ISOLANG) + find $(outdir) -name '*.html' | xargs grep -L --label="" 'UNTRANSLATED NODE: IGNORE ME' | sed 's!$(outdir)/!!g' | xargs $(PYTHON) $(buildscript-dir)/mass-link.py --prepend-suffix .$(ISOLANG) hard $(outdir) $(top-build-dir)/Documentation/user/$(outdir) $(TELY_FILES:%.tely=%.pdf) + find $(outdir) $ -name 'lily-*.png' -o -name 'lily-*.ly' $ | sed 's!$(outdir)/!!g' | xargs $(PYTHON) $(buildscript-dir)/mass-link.py hard $(outdir) $(top-build-dir)/Documentation/user/$(outdir) + +doc-po: + $(MAKE) -C $(depth)/Documentation/po out=www messages + +.PHONY: doc-po diff --git a/make/doc-i18n-user-vars.make b/make/doc-i18n-user-vars.make new file mode 100644 index 0000000000..bee28ee46b --- /dev/null +++ b/make/doc-i18n-user-vars.make @@ -0,0 +1,36 @@ +# ISOLANG must be defined + +LANGS = $(shell $(PYTHON) $(buildscript-dir)/langdefs.py) + +SOURCE_PNG_IMAGES=$(shell ls $(top-src-dir)/Documentation/user/*.png) +OUT_PNG_IMAGES=$(SOURCE_PNG_IMAGES:$(top-src-dir)/Documentation/user/%.png=$(outdir)/%.png) $(outdir)/context-example.png + +TELY_FILES := $(call src-wildcard,*.tely) +MASTER_TEXI_FILES := $(TELY_FILES:%.tely=$(outdir)/%.texi) +BIG_PAGE_HTML_FILES := $(BIG_PAGE_MANUALS:%=$(outdir)/%-big-page.html) +DEEP_HTML_FILES := $(TELY_FILES:%.tely=$(outdir)/%/index.html) +PDF_FILES := $(TELY_FILES:%.tely=$(outdir)/%.pdf) + +ITELY_FILES := $(call src-wildcard,*.itely) +ITEXI_FILES := $(call src-wildcard,*.itexi) + +DOCUMENTATION_INCLUDES = \ + -I $(top-src-dir)/Documentation/user \ + -I $(top-build-dir)/Documentation/user/$(outdir) + +LILYPOND_BOOK_INCLUDES += $(DOCUMENTATION_INCLUDES) +MAKEINFO_FLAGS += --force --enable-encoding $(DOCUMENTATION_INCLUDES) +MAKEINFO = LANG= $(MAKEINFO_PROGRAM) $(MAKEINFO_FLAGS) + +# texi2html xref map files +XREF_MAPS_DIR=$(top-build-dir)/out/xref-maps +XREF_MAPS_FILES=$(TELY_FILES:%.tely=$(XREF_MAPS_DIR)/%.$(ISOLANG).xref-map) + +# texi2html flags +TEXI2HTML_INIT= --init-file=$(top-src-dir)/lilypond-texi2html.init +TEXI2HTML_LANG=--lang=$(ISOLANG) +TEXI2HTML_FLAGS += $(TEXI2HTML_LANG) $(DOCUMENTATION_INCLUDES) \ + -I $(XREF_MAPS_DIR) +TEXI2HTML = LANG= $(TEXI2HTML_PROGRAM) + +TEXI2PDF_FLAGS += -q --batch $(DOCUMENTATION_INCLUDES) diff --git a/make/doclang-rules.make b/make/doclang-rules.make deleted file mode 100644 index 10fa6ef382..0000000000 --- a/make/doclang-rules.make +++ /dev/null @@ -1,27 +0,0 @@ -$(outdir)/%/index.html: $(outdir)/%.texi $(outdir)/version.itexi - mkdir -p $(dir $@) - $(MAKEINFO) -P $(outdir) --output=$(outdir)/$* --css-include=$(top-src-dir)/Documentation/texinfo.css --html $< - -$(outdir)/%-big-page.html: $(outdir)/%.texi $(outdir)/version.itexi - $(MAKEINFO) -P $(outdir) --output=$@ --css-include=$(top-src-dir)/Documentation/texinfo.css --html --no-split --no-headers $< - -$(outdir)/%.pdftexi: $(outdir)/%.texi doc-po $(outdir)/version.itexi - $(PYTHON) $(buildscript-dir)/texi-gettext.py $(ISOLANG) $< - -$(outdir)/%.pdf: $(outdir)/%.pdftexi - cd $(outdir); texi2pdf $(TEXI2PDF_FLAGS) $(TEXINFO_PAPERSIZE_OPTION) $(notdir $*).pdftexi - -$(outdir)/version.%: $(top-src-dir)/VERSION - echo '@macro version'> $@ - echo $(TOPLEVEL_VERSION)>> $@ - echo '@end macro'>> $@ - -# This makes sure lilypond-doc gettext domain has been compiled -# before lilypond-book runs -%.tely: doc-po - -$(OUT_TEXI_FILES): $(ITELY_FILES) $(ITEXI_FILES) - -$(DEEP_HTML_FILES) $(PDF_FILES): $(ITELY_FILES) $(ITEXI_FILES) - -.SECONDARY: diff --git a/make/doclang-targets.make b/make/doclang-targets.make deleted file mode 100644 index 4fd4bad694..0000000000 --- a/make/doclang-targets.make +++ /dev/null @@ -1,10 +0,0 @@ -default: - -# BIG_PAGE_HTML_FILES is defined differently in each language makefile -local-WWW: $(DEEP_HTML_FILES) $(PDF_FILES) doc-po $(BIG_PAGE_HTML_FILES) - find $(outdir) -name '*.html' | xargs grep -L 'UNTRANSLATED NODE: IGNORE ME' | xargs $(PYTHON) $(buildscript-dir)/html-gettext.py $(ISOLANG) - find $(outdir) -name '*.html' | xargs grep -L --label="" 'UNTRANSLATED NODE: IGNORE ME' | sed 's!$(outdir)/!!g' | xargs $(PYTHON) $(buildscript-dir)/mass-link.py --prepend-suffix .$(ISOLANG) hard $(outdir) $(top-build-dir)/Documentation/user/$(outdir) $(TELY_FILES:%.tely=%.pdf) - find $(outdir) $ -name 'lily-*.png' -o -name 'lily-*.ly' $ | sed 's!$(outdir)/!!g' | xargs $(PYTHON) $(buildscript-dir)/mass-link.py hard $(outdir) $(top-build-dir)/Documentation/user/$(outdir) - -doc-po: - $(MAKE) -C $(depth)/Documentation/po out=www messages diff --git a/make/doclang-vars.make b/make/doclang-vars.make deleted file mode 100644 index 08d17b919a..0000000000 --- a/make/doclang-vars.make +++ /dev/null @@ -1,21 +0,0 @@ -# ISOLANG must be defined - -LANGS = $(shell $(PYTHON) $(buildscript-dir)/langdefs.py) - -DOCUMENTATION_INCLUDES = \ - -I $(top-src-dir)/Documentation/user \ - -I $(top-build-dir)/Documentation/user/$(outdir) - -LILYPOND_BOOK_INCLUDES += $(DOCUMENTATION_INCLUDES) -MAKEINFO_FLAGS += --force --enable-encoding $(DOCUMENTATION_INCLUDES) -MAKEINFO = LANG= $(MAKEINFO_PROGRAM) $(MAKEINFO_FLAGS) - -TEXI2PDF_FLAGS += -q --batch $(DOCUMENTATION_INCLUDES) - -TELY_FILES = $(call src-wildcard,*.tely) -OUT_TEXI_FILES = $(TELY_FILES:%.tely=$(outdir)/%.texi) -DEEP_HTML_FILES = $(TELY_FILES:%.tely=$(outdir)/%/index.html) -PDF_FILES = $(TELY_FILES:%.tely=$(outdir)/%.pdf) - -ITELY_FILES := $(call src-wildcard,*.itely) -ITEXI_FILES := $(call src-wildcard,*.itexi) diff --git a/make/generic-vars.make b/make/generic-vars.make index 201a9ea7a4..428e5b900a 100644 --- a/make/generic-vars.make +++ b/make/generic-vars.make @@ -18,6 +18,7 @@ mi2mu-dir = $(src-depth)/mi2mu make-dir = $(src-depth)/make include-flower = $(src-depth)/flower/include +export PYTHONPATH:=$(buildscript-dir):$(PYTHONPATH) LILYPOND_INCLUDES = $(include-flower) $(depth)/flower/$(outdir) diff --git a/make/ly-rules.make b/make/ly-rules.make index bc9e47b963..fe849db405 100644 --- a/make/ly-rules.make +++ b/make/ly-rules.make @@ -12,14 +12,11 @@ $(outdir)/%.latex: %.doc # don't do ``cd $(outdir)'', and assume that $(outdir)/.. is the src dir. # it is not, for --srcdir builds $(outdir)/%.texi: %.tely $(outdir)/version.itexi - $(PYTHON) $(LILYPOND_BOOK) $(LILYPOND_BOOK_INCLUDES) --process='$(LILYPOND_BOOK_PROCESS) $(LILYPOND_BOOK_LILYPOND_FLAGS)' --output=$(outdir) --format=$(LILYPOND_BOOK_FORMAT) $(LILYPOND_BOOK_FLAGS) $< + $(PYTHON) $(LILYPOND_BOOK) $(LILYPOND_BOOK_INCLUDES) --process='$(LILYPOND_BOOK_PROCESS) $(LILYPOND_BOOK_LILYPOND_FLAGS)' --output=$(outdir) --format=$(LILYPOND_BOOK_FORMAT) $(LILYPOND_BOOK_FLAGS) $< $(outdir)/%.texi: $(outdir)/%.tely $(outdir)/version.itexi $(PYTHON) $(LILYPOND_BOOK) $(LILYPOND_BOOK_INCLUDES) --process='$(LILYPOND_BOOK_PROCESS) $(LILYPOND_BOOK_INCLUDES) $(LILYPOND_BOOK_LILYPOND_FLAGS)' --output=$(outdir) --format=$(LILYPOND_BOOK_FORMAT) $(LILYPOND_BOOK_FLAGS) $< -# -# DON'T REMOVE SOURCE FILES, otherwise the .TEXI ALWAYS OUT OF DATE. -# rm -f $< $(outdir)/%.html.omf: %.tely $(call GENERATE_OMF,html) diff --git a/make/lysdoc-rules.make b/make/lysdoc-rules.make index b465501883..be960222b7 100644 --- a/make/lysdoc-rules.make +++ b/make/lysdoc-rules.make @@ -1,4 +1,3 @@ - $(outdir)/collated-files.tely: $(LY_FILES) $(OUT_LY_FILES) $(PYTHON) $(buildscript-dir)/lys-to-tely.py --name=$(outdir)/collated-files.tely --title="$(TITLE)" $^ diff --git a/make/lysdoc-targets.make b/make/lysdoc-targets.make index c2d08b5fec..0b5d6ec2ed 100644 --- a/make/lysdoc-targets.make +++ b/make/lysdoc-targets.make @@ -1,8 +1,6 @@ +local-WWW-1: $(outdir)/collated-files.texi $(outdir)/collated-files.pdf - -local-WWW: $(outdir)/collated-files.html $(outdir)/collated-files.pdf - -#.PRECIOUS: $(outdir)/$(NAME).texi +local-WWW-2: $(outdir)/collated-files.html local-test-baseline: rm -rf $(outdir)-baseline diff --git a/make/lysdoc-vars.make b/make/lysdoc-vars.make index e653213363..96d44b12f3 100644 --- a/make/lysdoc-vars.make +++ b/make/lysdoc-vars.make @@ -1,4 +1,2 @@ TITLE=LYs Doc -NAME=collated-files - diff --git a/make/mutopia-targets.make b/make/mutopia-targets.make index 4a12833a55..deaf240861 100644 --- a/make/mutopia-targets.make +++ b/make/mutopia-targets.make @@ -1,14 +1,12 @@ .PHONY: download mutopia png ps scores tar .PRECIOUS: $(outdir)/%.ps $(outdir)/%-book.ps -.PRECIOUS: $(outdir)-letter/%.dvi $(outdir)-letter/%.ps +.PRECIOUS: $(outdir)-letter/%.ps all: $(OUT_FILES) -# we want dvi_examples as well, because they get thrown away otherwise -# incurring another costly lilypond run. -local-WWW: $(ly_examples) $(pdf_examples) $(png_examples) +local-WWW-1: $(ly_examples) $(pdf_examples) $(png_examples) tar: mkdir -p $(outdir)/$(tarball) @@ -24,7 +22,7 @@ scores: $(score_ps) $(MAKE) ps_examples="$<" ps local-mutopia: - $(MAKE) examples="$(mutopia-examples)" PAPERSIZE=letter local-WWW $(mutopia-letter) + $(MAKE) examples="$(mutopia-examples)" PAPERSIZE=letter local-WWW-1 $(mutopia-letter) mutopia: local-mutopia $(LOOP) diff --git a/scm/document-backend.scm b/scm/document-backend.scm index 02a09736b0..8d7bb3bc25 100644 --- a/scm/document-backend.scm +++ b/scm/document-backend.scm @@ -25,13 +25,13 @@ (if (pair? uprops) (string-append - "\n\n@unnumberedsubsubsec User settable properties:\n" + "\n\n@subsubheading User settable properties:\n" (description-list->texi user-propdocs #t)) "") (if (pair? iprops) (string-append - "\n\n@unnumberedsubsubsec Internal properties:\n" + "\n\n@subsubheading Internal properties:\n" (description-list->texi internal-propdocs #t)) "")))) diff --git a/scm/documentation-generate.scm b/scm/documentation-generate.scm index 7f87df80fd..36af5b3a69 100644 --- a/scm/documentation-generate.scm +++ b/scm/documentation-generate.scm @@ -70,98 +70,60 @@ "(lilypond/lilypond-internals.info)") " -@c NOTE: This is documentation-generate.scm, not macros.itexi +@include macros.texi +@ignore +@omftitle LilyPond internals +@omfcreator Han-Wen Nienhuys and Jan Nieuwenhuizen +@omfdescription Programmer's reference of the LilyPond music engraving system +@omftype user's guide +@omflanguage English +@omfcategory Applications|Publishing +@end ignore -@macro q{TEXT} -@quoteleft{}\\TEXT\\@quoteright{} -@end macro - -@macro qq{TEXT} -@quotedblleft{}\\TEXT\\@quotedblright{} -@end macro - +@iftex +@afourpaper +@c don't replace quotes with directed quotes +@tex +\\gdef\\SETtxicodequoteundirected{Foo} +\\gdef\\SETtxicodequotebacktick{Bla} +@end tex +@end iftex @ifhtml -@c ***** HTML ***** - -@ifset bigpage - -@macro ruser{TEXT} -@ref{\\TEXT\\,,,lilypond-big-page,Notation Reference} -@cindex \\TEXT\\ -@end macro - -@end ifset - -@ifclear bigpage - -@macro ruser{NAME} -@ref{\\NAME\\,,,lilypond,Notation Reference} -@cindex \\NAME\\ -@end macro - -@end ifclear - -@macro inputfileref{DIR,NAME} -@uref{source/\\DIR\\/out-www/collated-files.html#\\NAME\\,@file{\\DIR\\/\\NAME\\}}@c -@end macro - +This document is also available as a +@uref{source/Documentation/user/lilypond-internals.pdf,PDF} and as +@uref{source/Documentation/user/lilypond-internals-big-page.html,one big page}. @end ifhtml +@finalout -@ifinfo -@c ***** info ***** +@titlepage +@title LilyPond +@subtitle The music typesetter +@titlefont{Internals Reference} +@author The LilyPond development team -@macro ruser{NAME} -@ref{\\NAME\\,,,lilypond,Notation Reference} -@cindex \\NAME\\ -@end macro +Copyright @copyright{} 1999--2008 by the authors -@macro inputfileref{DIR,NAME} -@file{\\DIR\\/\\NAME\\} -@end macro +@vskip 20pt -@end ifinfo - - -@iftex -@c ***** TeX ***** - -@macro ruser{NAME} -@ref{\\NAME\\}@c -@end macro - -@macro inputfileref{DIR,NAME}@c -@file{\\DIR\\/\\NAME\\}@c -@end macro - -@end iftex - - -@macro rinternals{NAME} -@ref{\\NAME\\} -@end macro - - -@ignore -@omftitle LilyPond internals -@omfcreator Han-Wen Nienhuys and Jan Nieuwenhuizen -@omfdescription Programmer's reference of the LilyPond music engraving system -@omftype user's guide -@omflanguage English -@omfcategory Applications|Publishing -@end ignore +For LilyPond version @version{} +@end titlepage +@contents +@ifnottex ") out-port) (define top-node (make #:name "Top" - #:text - (string-append "This is the program reference for version " + #:text + (string-append " +@end ifnottex +This is the program reference for version " (lilypond-version) " of LilyPond, the GNU music typesetter.") diff --git a/scm/documentation-lib.scm b/scm/documentation-lib.scm index bd824aebc9..4a25f5420c 100644 --- a/scm/documentation-lib.scm +++ b/scm/documentation-lib.scm @@ -63,9 +63,9 @@ (cdr (assoc level '( ;; Hmm, texinfo doesn't have ``part'' (0 . "@top") - (1 . "@unnumbered") - (2 . "@unnumberedsec") - (3 . "@unnumberedsubsec") + (1 . "@chapter") + (2 . "@section") + (3 . "@subsection") (4 . "@unnumberedsubsubsec") (5 . "@unnumberedsubsubsec"))))) diff --git a/stepmake/stepmake/documentation-targets.make b/stepmake/stepmake/documentation-targets.make index 8bcb8223fc..0f63330a21 100644 --- a/stepmake/stepmake/documentation-targets.make +++ b/stepmake/stepmake/documentation-targets.make @@ -1,5 +1 @@ -# do we need this? default: - -local-WWW: $(OUTHTML_FILES) - diff --git a/stepmake/stepmake/generic-targets.make b/stepmake/stepmake/generic-targets.make index 24f8f65aed..2df68ac3ca 100644 --- a/stepmake/stepmake/generic-targets.make +++ b/stepmake/stepmake/generic-targets.make @@ -1,5 +1,6 @@ -.PHONY : all clean bin-clean config default dist doc exe help\ - html lib TAGS po +.PHONY : all clean bin-clean config default dist doc exe help html lib TAGS\ + po web web-1 WWW-1 WWW-2 WWW-post local-WWW-1 local-WWW-2\ + web-install all: default $(LOOP) @@ -168,22 +169,31 @@ $(config_make): $(top-src-dir)/configure touch $@ # do something for multiple simultaneous configs. -################ website. +#### Documentation (website and tarball) -local-WWW: -local-WWW-post: +# documentation is built in two stages, +# plus WWW-post (only at toplevel) +# see INSTALL for more information. + +local-WWW-1: +local-WWW-2: web-install: +WWW-post: -WWW: local-WWW +WWW-1: local-WWW-1 $(LOOP) -WWW-post: local-WWW-post +WWW-2: local-WWW-2 $(LOOP) web: - $(MAKE) out=www WWW + $(MAKE) out=www WWW-1 + $(MAKE) out=www WWW-2 $(MAKE) out=www WWW-post +web-1: + $(MAKE) out=www WWW-1 + web-clean: find -name out-www | xargs rm -rf $(MAKE) out=www clean diff --git a/stepmake/stepmake/texinfo-rules.make b/stepmake/stepmake/texinfo-rules.make index c6e29cde73..b44b6300ec 100644 --- a/stepmake/stepmake/texinfo-rules.make +++ b/stepmake/stepmake/texinfo-rules.make @@ -26,11 +26,14 @@ endif $(outdir)/%.info: $(outdir)/%.texi $(outdir)/$(INFO_IMAGES_DIR).info-images-dir.dep $(outdir)/version.itexi $(MAKEINFO) -I$(outdir) --output=$@ $< -$(outdir)/%-big-page.html: $(outdir)/%.texi $(outdir)/version.itexi - $(MAKEINFO) -I $(outdir) --output=$@ --css-include=$(top-src-dir)/Documentation/texinfo.css --html --no-split -D bigpage --no-headers $< +$(outdir)/%-big-page.html: $(outdir)/%.texi $(XREF_MAPS_DIR)/%.xref-map $(outdir)/version.itexi + $(TEXI2HTML) --I=$(outdir) -D bigpage --output=$@ $(TEXI2HTML_INIT) $< + cp $(top-src-dir)/Documentation/lilypond*.css $(dir $@) -$(outdir)/%.html: $(outdir)/%.texi $(outdir)/version.itexi - $(MAKEINFO) -I $(outdir) --output=$@ --css-include=$(top-src-dir)/Documentation/texinfo.css --html --no-split --no-headers $< + +$(outdir)/%.html: $(outdir)/%.texi $(XREF_MAPS_DIR)/%.xref-map $(outdir)/version.itexi + $(TEXI2HTML) --I=$(outdir) --output=$@ $(TEXI2HTML_INIT) $< + cp $(top-src-dir)/Documentation/lilypond*.css $(dir $@) $(outdir)/%.html.omf: %.texi $(call GENERATE_OMF,html) @@ -41,9 +44,10 @@ $(outdir)/%.pdf.omf: %.texi $(outdir)/%.ps.gz.omf: %.texi $(call GENERATE_OMF,ps.gz) -$(outdir)/%/index.html: $(outdir)/%.texi $(outdir)/version.itexi +$(outdir)/%/index.html: $(outdir)/%.texi $(XREF_MAPS_DIR)/%.xref-map $(outdir)/version.itexi mkdir -p $(dir $@) - $(MAKEINFO) -I $(outdir) --output=$(dir $@) --css-include=$(top-src-dir)/Documentation/texinfo.css --html $< + $(TEXI2HTML) --I=$(outdir) --output=$(dir $@) --prefix=index --split=section $(TEXI2HTML_INIT) $< + cp $(top-src-dir)/Documentation/lilypond*.css $(dir $@) $(outdir)/%.pdf: $(outdir)/%.texi $(outdir)/version.itexi cd $(outdir); texi2pdf $(TEXI2PDF_FLAGS) --batch $(TEXINFO_PAPERSIZE_OPTION) $( $@ echo $(TOPLEVEL_VERSION)>> $@ diff --git a/stepmake/stepmake/texinfo-targets.make b/stepmake/stepmake/texinfo-targets.make index 245b2e6c62..75365a2e7d 100644 --- a/stepmake/stepmake/texinfo-targets.make +++ b/stepmake/stepmake/texinfo-targets.make @@ -2,7 +2,7 @@ default: $(INFO_FILES) -local-WWW: $(addprefix $(outdir)/,$(TEXI_FILES:.texi=.html)) +local-WWW-1: $(XREF_MAPS_FILES) local-doc: $(OUTTXT_FILES) diff --git a/stepmake/stepmake/texinfo-vars.make b/stepmake/stepmake/texinfo-vars.make index d53bd8f7dd..1a67332d4b 100644 --- a/stepmake/stepmake/texinfo-vars.make +++ b/stepmake/stepmake/texinfo-vars.make @@ -1,4 +1,3 @@ - TEXI_FILES = $(call src-wildcard,*.texi) ALL_SOURCES += $(TEXI_FILES) @@ -14,6 +13,19 @@ TEXINFO_PAPERSIZE_OPTION= $(if $(findstring $(PAPERSIZE),a4),,-t @afourpaper) MAKEINFO_FLAGS = --enable-encoding MAKEINFO = LANG= $(MAKEINFO_PROGRAM) $(MAKEINFO_FLAGS) +# texi2html xref map files +XREF_MAPS_DIR=$(top-build-dir)/out/xref-maps +XREF_MAPS_FILES=$(INFO_DOCS:%=$(XREF_MAPS_DIR)/%.xref-map) + +# texi2html flags +ifneq ($(ISOLANG),) +TEXI2HTML_LANG = --lang=$(ISOLANG) +endif +TEXI2HTML_FLAGS += --css-ref=lilypond.css $(DOCUMENTATION_INCLUDES) \ + --I=$(XREF_MAPS_DIR) +TEXI2HTML_INIT = --init-file=$(top-src-dir)/lilypond-texi2html.init +TEXI2HTML = $(TEXI2HTML_PROGRAM) $(TEXI2HTML_FLAGS) $(TEXI2HTML_LANG) + TEXI2PDF_FLAGS += -q # info stuff diff --git a/stepmake/stepmake/topdocs-targets.make b/stepmake/stepmake/topdocs-targets.make index 5c4777ec92..93d2f9cccf 100644 --- a/stepmake/stepmake/topdocs-targets.make +++ b/stepmake/stepmake/topdocs-targets.make @@ -1,6 +1,8 @@ default: local-doc -local-WWW: $(HTML_FILES) $(PDF_FILES) +local-WWW-1: $(PDF_FILES) + +local-WWW-2: $(HTML_FILES) make-txt-files: $(TO_TOP_FILES)