### texi2html customization script for Lilypond
### Author: Reinhold Kainhofer <reinhold@kainhofer.com>, 2008.
-### Some code parts copied from texi2html and adapted.
+### Some code parts copied from texi2html and adapted. These functions
+### were written mainly by Patrice Dumas
### License: GPLv2+
###
###
### lilypond_element_target_name (adjust section anchors)
### -) Use the standard footnote format "<sup>nr</sup> text" instead of the
### ugly format of texi2html (<h3>(nr)</h3><p>text</p>). Implemented in
-### lilypond_foot_line_and_ref
+### makeinfo_like_foot_line_and_ref
+### makeinfo_like_foot_lines
+### makeinfo_like_paragraph
###
###
### Useful helper functions:
### 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" }
+);
$Texi2HTML::Config::USE_ACCESSKEY = 1;
$Texi2HTML::Config::USE_LINKS = 1;
$Texi2HTML::Config::USE_REL_REV = 1;
+$Texi2HTML::Config::SPLIT_INDEX = 0;
$Texi2HTML::Config::SEPARATED_FOOTNOTES = 0; # Print footnotes on same page, not separated
-$Texi2HTML::Config::element_file_name = \&lilypond_element_file_name;
+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::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 = \&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'} = {
{
my $import_lines = shift;
my $rule_lines = shift;
- return if (defined($CSS_LINES));
+ return if (defined($Texi2HTML::THISDOC{'CSS_LINES'}));
if (@$rule_lines or @$import_lines)
{
- $CSS_LINES = "<style type=\"text/css\">\n<!--\n";
- $CSS_LINES .= join('',@$import_lines) . "\n" if (@$import_lines);
- $CSS_LINES .= join('',@$rule_lines) . "\n" if (@$rule_lines);
- $CSS_LINES .= "-->\n</style>\n";
+ $Texi2HTML::THISDOC{'CSS_LINES'} = "<style type=\"text/css\">\n<!--\n";
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$import_lines) . "\n" if (@$import_lines);
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$rule_lines) . "\n" if (@$rule_lines);
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= "-->\n</style>\n";
}
foreach my $ref (@CSS_REFS)
{
- $CSS_LINES .= "<link rel=\"stylesheet\" type=\"text/css\" href=\"$ref\">\n";
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"stylesheet\" type=\"text/css\" title=\"$ref->{TITLE}\" href=\"$ref->{FILENAME}\">\n";
}
- $CSS_LINES .= "<!--[if lte IE 7]>\n<link href=\"lilypond-ie-fixes.css\" rel=\"stylesheet\" type=\"text/css\">\n<![endif]-->\n";
+ foreach my $ref (@ALT_CSS_REFS)
+ {
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= "<link rel=\"alternate stylesheet\" type=\"text/css\" href=\"$ref->{FILENAME}\" title=\"$ref->{TITLE}\">\n";
+ }
+ $Texi2HTML::THISDOC{'CSS_LINES'} .= "<!--[if lte IE 7]>\n<link href=\"lilypond-ie-fixes.css\" rel=\"stylesheet\" type=\"text/css\">\n<![endif]-->\n";
}
}
# If we have an entry in the section<=>filename map, use that one, otherwise
- # generate the anchor here.
+ # generate the anchor here.
if (exists ($node_to_filename_map->{$node_name})) {
(my $filename, $target) = @{$node_to_filename_map->{$node_name}};
} else {
# use default TOC if no custom lines have been generated
@lines = @default_toc if (not @lines);
if (@lines) {
+
print $fh "\n\n<div id=\"tocframe\">\n";
- print $fh '<h4> ' . $Texi2HTML::NAME{'Contents'} . "</h4>\n";
+ print $fh '<h4 class="toc_header"> ' . &$anchor('',
+ $Texi2HTML::HREF{'Top'},
+ $Texi2HTML::NAME{'Top'},
+ 'title="Start of the manual"'
+ ) . "</h4>\n";
foreach my $line (@lines) {
print $fh $line;
}
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) {
@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
{
my $fh = shift;
my $program_string = &$program_string();
- print $fh "<p><font size='-1'>$program_string</font><br>$PRE_BODY_CLOSE</p>\n";
+
# print $fh "<p><font size='-1'>$program_string</font><br>$PRE_BODY_CLOSE</p>\n";
print $fh "<!-- FOOTER -->\n\n";
print $fh "<!-- end div#main here -->\n</div>\n\n";
# 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 '<table cellpadding="', $spacing, '" cellspacing="', $spacing,
-# "\" border=\"0\" class=\"nav_table\">\n";
- print $fh "<table class=\"nav_table\">\n";
+ my $result = "<table class=\"nav_table\">\n";
- print $fh "<tr>" unless $vertical;
+ $result .= "<tr>" unless $vertical;
my $beginofline = 1;
foreach my $button (@$buttons)
{
- print $fh qq{<tr valign="top" align="left">\n} if $vertical;
+ $result .= qq{<tr valign="top" align="left">\n} if $vertical;
# Allow (left|right|center)-aligned-cell and newline as buttons!
if ( $button =~ /^(.*)-aligned-cell-(.*)$/ )
{
- print $fh qq{</td>} unless $beginofline;
- print $fh qq{<td valign="middle" align="$1" colspan="$2">};
+ $result .= qq{</td>} unless $beginofline;
+ $result .= qq{<td valign="middle" align="$1" colspan="$2">};
$beginofline = 0;
}
elsif ( $button eq 'newline' )
{
- print $fh qq{</td>} unless $beginofline;
- print $fh qq{</tr>};
- print $fh qq{<tr>};
+ $result .= qq{</td>} unless $beginofline;
+ $result .= qq{</tr>};
+ $result .= qq{<tr>};
$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})
{
$anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\"";
}
- print $fh "" .
+ $result .= "" .
&$anchor('',
$Texi2HTML::HREF{$button_href},
get_navigation_text($$text),
}
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{' '};
}
if ($ICONS && $ACTIVE_ICONS{$button})
{ # use icon
- print $fh '' .
+ $result .= '' .
&$anchor('',
$Texi2HTML::HREF{$button},
&$button_icon_img($BUTTONS_NAME{$button},
}
else
{ # use text
- print $fh
+ $result .=
'[' .
&$anchor('',
$Texi2HTML::HREF{$button},
- get_navigation_text ($button),
+ get_navigation_text($button),
$btitle
) .
']';
}
else
{ # button is passive
- print $fh
+ $result .=
$ICONS && $PASSIVE_ICONS{$button} ?
&$button_icon_img($BUTTONS_NAME{$button},
$PASSIVE_ICONS{$button},
"[" . get_navigation_text($button) . "]";
}
- print $fh "</td>\n" if $vertical;
- print $fh "</tr>\n" if $vertical;
+ $result .= "</td>\n" if $vertical;
+ $result .= "</tr>\n" if $vertical;
}
- print $fh "</td>" unless $beginofline;
- print $fh "</tr>" unless $vertical;
- print $fh "</table>\n";
+ $result .= "</td>" unless $beginofline;
+ $result .= "</tr>" unless $vertical;
+ $result .= "</table>\n";
+ return $result;
}
# Format footnotes in a nicer way: Instead of printing the number in a separate
# (nr) heading line, use the standard way of prepending <sup>nr</sup> immediately
# before the fn text.
-sub lilypond_foot_line_and_ref($$$$$$$)
+
+
+# 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 $number_in_doc = shift;
- my $number_in_page = shift;
- my $footnote_id = shift;
- my $place_id = shift;
- my $document_file = shift;
+ 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;
- 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",
- "<sup>$number_in_doc</sup>");
- # unfortunately, the @$lines contain the already formatted footnote in the
- # from <p>...</p>. 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/<p>/<p>$tmptxt /;
+ $makekinfo_like_footnote_absolute_number++;
+
# 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",
- "<sup>$number_in_doc</sup>"));
+ $docid = '' if ($state->{'outside_document'} or $state->{'multiple_pass'});
+
+ if ($from_file eq $footnote_file)
+ {
+ $from_file = $footnote_file = '';
+ }
+
+ my $foot_anchor = "<sup>" . &$anchor($docid, "$footnote_file#$footid", $relative_num) . "</sup>";
+ $foot_anchor = &$anchor($docid, "$footnote_file#$footid", "($relative_num)") if ($state->{'preformatted'});
+
+# unshift @$lines, "<li>";
+# push @$lines, "</li>\n";
+ return ($lines, $foot_anchor);
+}
+
+sub makeinfo_like_foot_lines($)
+{
+ my $lines = shift;
+ unshift @$lines, "<hr>\n<h4>$Texi2HTML::I18n::WORDS->{'Footnotes_Title'}</h4>\n";
+#<ol type=\"1\">\n";
+# push @$lines, "</ol>";
+ return $lines;
}
+my %makekinfo_like_paragraph_in_footnote_nr;
+
+sub makeinfo_like_paragraph ($$$$$$$$$$$$$)
+{
+ my $text = shift;
+ my $align = shift;
+ my $indent = shift;
+ my $paragraph_command = shift;
+ my $paragraph_command_formatted = shift;
+ my $paragraph_number = shift;
+ my $format = shift;
+ my $item_nr = shift;
+ my $enumerate_style = shift;
+ my $number = shift;
+ my $command_stack_at_end = shift;
+ my $command_stack_at_begin = shift;
+ my $state = shift;
+#print STDERR "format: $format\n" if (defined($format));
+#print STDERR "paragraph @$command_stack_at_end; @$command_stack_at_begin\n";
+ $paragraph_command_formatted = '' if (!defined($paragraph_command_formatted) or
+ exists($special_list_commands{$format}->{$paragraph_command}));
+ return '' if ($text =~ /^\s*$/);
+ foreach my $style(t2h_collect_styles($command_stack_at_begin))
+ {
+ $text = t2h_begin_style($style, $text);
+ }
+ foreach my $style(t2h_collect_styles($command_stack_at_end))
+ {
+ $text = t2h_end_style($style, $text);
+ }
+ if (defined($paragraph_number) and defined($$paragraph_number))
+ {
+ $$paragraph_number++;
+ return $text if (($format eq 'itemize' or $format eq 'enumerate') and
+ ($$paragraph_number == 1));
+ }
+ my $open = '<p';
+ if ($align)
+ {
+ $open .= " align=\"$paragraph_style{$align}\"";
+ }
+ my $footnote_text = '';
+ if (defined($command_stack_at_begin->[0]) and $command_stack_at_begin->[0] eq 'footnote')
+ {
+ my $state = $Texi2HTML::THISDOC{'state'};
+ $makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number}++;
+ if ($makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number} <= 1)
+ {
+ $open.=' class="footnote"';
+ my $document_file = $state->{'footnote_document_file'};
+ if ($document_file eq $state->{'footnote_footnote_file'})
+ {
+ $document_file = '';
+ }
+ my $docid = $state->{'footnote_place_id'};
+ my $doc_state = $state->{'footnote_document_state'};
+ $docid = '' if ($doc_state->{'outside_document'} or $doc_state->{'multiple_pass'});
+ my $foot_label = &$anchor($state->{'footnote_footnote_id'},
+ $document_file . "#$state->{'footnote_place_id'}",
+ "$state->{'footnote_number_in_page'}");
+ $footnote_text = "<small>[${foot_label}]</small> ";
+ }
+ }
+ return $open.'>'.$footnote_text.$text.'</p>';
+}
#############################################################################
projects / lilypond.git / blobdiff