--- /dev/null
+/***********************************************************/
+/* PAGE-WIDE SETTINGS */
+/***********************************************************/
+body {
+ margin-right: auto;
+ margin-left: auto;
+}
+
+/***********************************************************/
+/* HEADERS */
+/***********************************************************/
+h2 {
+ font-size: x-large;
+ color: #1d7b85;
+}
+.unnumberedsubsubsec {
+ font-size: large;
+ color: #1d7b85;
+}
+.subsubheading {
+ font-size: large;
+ color: #3b220d;
+}
+
+/***********************************************************/
+/* LINKS */
+/***********************************************************/
+a {
+ color: #344242;
+}
+a:visited {
+ color: #666666;
+}
+a:active {
+ color: #00cccc;
+}
+a:hover {
+ color: #1d7b85;
+ text-decoration:underline;
+}
+
+/***********************************************************/
+/* BLOCK FORMATTING */
+/***********************************************************/
+blockquote {
+ border: 1px solid #cccccc;
+ padding: 3px;
+ width: 40em;
+}
+.verbatim {
+ font-family: "Courier New",Courier,monospace;
+}
+hr {
+ border: none;
+ height: 1px;
+ color: #666666;
+ background-color: #666666;
+}
+table.cartouche {
+ border: 2px dotted #cccccc;
+ margin-left: auto;
+ margin-right: auto;
+ width: 85%;
+}
+table.cartouche td {
+ border: none;
+}
+
+/***********************************************************/
+/* TOC */
+/***********************************************************/
+.contents {
+ border: 1px dashed #339999;
+ margin: 3px 2em;
+ list-style-type: square;
+ padding-right: 1em;
+ width: 40em;
+ background-color: #fcfff9;
+}
+
+
+/***********************************************************/
+/* TOC SIDEBAR */
+/***********************************************************/
+body {
+ padding-left: 27%; /* To create space for the sidebar! */
+}
+div#tocframe {
+ position: fixed;
+ top: 0;
+ left: 0;
+ margin: 0em;
+ padding: 5px;
+ width: 25%;
+ height: 100%;
+ overflow: auto;
+ background-color: #FFFACD;
+ z-index:100;
+ list-style-type: none;
+}
+
+#tocframe .contents {
+ width: 100%;
+ border: none;
+ margin: 0em;
+ background-color: transparent;
+ list-style-type: none;
+}
+
+#tocframe ul.toc {
+ padding-left: 0px;
+ margin-left: 0px;
+}
+#tocframe ul.toc li {
+ padding-left: 0px;
+ margin-left: 0px;
+ list-style-type: none;
+}
+#tocframe ul.toc > li {
+ font-size: 12px;
+}
+#tocframe ul.toc li li {
+ padding-left: 15px;
+}
+li.toc_current {
+ font-weight: bold;
+ font-style: italic;
+}
+
+li.toc_current ul {
+ font-weight: normal;
+ font-style: normal;
+ background: transparent;
+}
+
+
+
+
+/***********************************************************/
+/* NAVIGATION */
+/***********************************************************/
+.nav_table {
+ width: 98%;
+ background-color: #CCCCCC;
+ border: 0;
+ left: auto;
+ right: auto;
+ font-size: 10pt;
+}
+
+
+
+
+
+
+/***********************************************************/
+/* OVERRIDES FOR PRINTING... */
+/***********************************************************/
+@media print {
+ /* Hide the sidebar: */
+ body { padding-left: 0; }
+ #tocframe { display: none; }
+ .nav_table { display: none; }
+}
\ No newline at end of file
* Pitch names::
@end menu
+@contents
+
+
@node Musical terms A-Z
@chapter Musical terms A-Z
import re
import os
import time
+import operator
import langdefs
suggest_Docs_url = 'http://lilypond.org/web/devel/participating/documentation-adding'
header_tag = '<!-- header_tag -->'
+header_tag_re = re.compile (header_tag)
+
footer_tag = '<!-- footer_tag -->'
+footer_tag_re = re.compile (footer_tag)
lang_available = _doc ("Other languages: %s.")
browser_lang = _doc ('About <A HREF="%s">automatic language selection</A>.')
splitted_docs_re = re.compile ('(input/lsr/out-www/lilypond-snippets|Documentation/user/out-www/(lilypond|music-glossary|lilypond-program|lilypond-learning))/')
snippets_ref_re = re.compile (r'href="(\.\./)?lilypond-snippets')
+# TODO: master has ../lily- !
+src_href_re = re.compile ('(href|src)="(lily-.*?|.*?[.]png)"')
+source_link_re = re.compile ('href="source/(.*?)"')
## Windows does not support symlinks.
# This function avoids creating symlinks for splitted HTML manuals
# this also fixes missing PNGs only present in translated docs
def hack_urls (s, prefix):
if splitted_docs_re.match (prefix):
- s = re.sub ('(href|src)="(../lily-.*?|.*?[.]png)"', '\\1="../\\2"', s)
+ s = src_href_re.sub ('\\1="../\\2"', s)
# fix Snippets xrefs ad hoc
s = snippets_ref_re.sub ('href="source/input/lsr/lilypond-snippets', s)
if not os.path.islink (source_path):
return s
source_val = os.readlink (source_path)
- return re.sub ('href="source/(.*?)"', lambda m: source_links_replace (m, source_val), s)
+ return source_link_re.sub (lambda m: source_links_replace (m, source_val), s)
+
+body_tag_re = re.compile ('(?i)<body([^>]*)>')
+html_tag_re = re.compile ('(?i)<html>')
+doctype_re = re.compile ('(?i)<!DOCTYPE')
+doctype = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">\n'
def add_header (s):
- """Add header (<BODY> and doctype)"""
- if re.search (header_tag, s) == None:
- body = '<BODY BGCOLOR=WHITE TEXT=BLACK>'
- s = re.sub ('(?i)<body>', body, s)
- if re.search ('(?i)<BODY', s):
- s = re.sub ('(?i)<body[^>]*>', body + header, s, 1)
- elif re.search ('(?i)<html', s):
- s = re.sub ('(?i)<html>', '<HTML>' + header, s, 1)
- else:
- s = header + s
+ """Add header (<body> and doctype)"""
+ if header_tag_re.search (s) == None:
+ body = '<body bgcolor="white" text="black" \\1>'
+ (s, n) = body_tag_re.subn (body + header, s, 1)
+ if not n:
+ (s, n) = html_tag_re.subn ('<html>' + header, s, 1)
+ if not n:
+ s = header + s
s = header_tag + '\n' + s
- if re.search ('(?i)<!DOCTYPE', s) == None:
- doctype = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">\n'
+ if doctype_re.search (s) == None:
s = doctype + s
return s
+title_tag_re = re.compile ('.*?<title>(.*?)</title>', re.DOTALL)
+AT_web_title_re = re.compile ('@WEB-TITLE@')
+
def add_title (s):
# urg
# maybe find first node?
fallback_web_title = '-- --'
- m = re.match ('.*?<title>(.*?)</title>', s, re.DOTALL)
+ m = title_tag_re.match (s)
if m:
fallback_web_title = m.group (1)
- s = re.sub ('@WEB-TITLE@', fallback_web_title, s)
+ s = AT_web_title_re.sub (fallback_web_title, s)
return s
-info_nav_bar = re.compile (r'<div class="node">\s*<p>\s*<a name=".+?"></a>(.+?)<hr>\s*</div>', re.M | re.S)
-info_footnote_hr = re.compile (r'<hr>\s*(</div>)?\s*</body>', re.M | re.I)
+end_body_re = re.compile ('(?i)</body>')
+end_html_re = re.compile ('(?i)</html>')
def add_footer (s):
- """add footer
-
-also add navigation bar to bottom of Info HTML pages"""
- m = info_nav_bar.search (s)
- if m:
- # avoid duplicate <hr> in case there are footnotes at the end of the Info HTML page
- if info_footnote_hr.search (s):
- custom_footer = '<div class="node">\n<p>' + m.group (1) + '</div>\n' + footer
- else:
- custom_footer = '<br><hr>\n<div class="node">\n<p>' + m.group (1) + '</div>\n' + footer
- else:
- custom_footer = footer
- if re.search ('(?i)</body', s):
- s = re.sub ('(?i)</body>', footer_tag + custom_footer + '\n' + '</BODY>', s, 1)
- elif re.search ('(?i)</html', s):
- s = re.sub ('(?i)</html>', footer_tag + custom_footer + '\n' + '</HTML>', s, 1)
- else:
- s += footer_tag + custom_footer + '\n'
+ """add footer"""
+ (s, n) = end_body_re.subn (footer_tag + footer + '\n' + '</body>', s, 1)
+ if not n:
+ (s, n) = end_html_re.subn (footer_tag + footer + '\n' + '</html>', s, 1)
+ if not n:
+ s += footer_tag + footer + '\n'
return s
def find_translations (prefix, lang_ext):
if lang_ext != e:
if e in pages_dict[prefix]:
available.append (l)
- elif lang_ext == '' and l.enabled and reduce (lambda x, y: x and y, [not prefix.startswith (s) for s in non_copied_pages]):
+ elif lang_ext == '' and l.enabled and reduce (operator.and_, [not prefix.startswith (s) for s in non_copied_pages]):
# English version of missing translated pages will be written
missing.append (e)
return available, missing
+online_links_re = re.compile ('''(href|src)=[\'"]([^/][.]*[^.:\'"]*)(.html|.png)(#[^"\']*|)[\'"]''')
+offline_links_re = re.compile ('''href=[\'"]([^/][.]*[^.:\'"]*)(.html)(#[^"\']*|)[\'"]''')
+
def process_links (s, prefix, lang_ext, file_name, missing, target):
page_flavors = {}
if target == 'online':
# Strip .html, .png suffix for auto language selection (content
# negotiation). The menu must keep the full extension, so do
# this before adding the menu.
- page_flavors[file_name] = [lang_ext, re.sub (
- '''(href|src)=[\'"]([^/][.]*[^.:\'"]*)(.html|.png)(#[^"\']*|)[\'"]''',
- '\\1="\\2\\4"', s)]
+ page_flavors[file_name] = \
+ [lang_ext, online_links_re.sub ('\\1="\\2\\4"', s)]
elif target == 'offline':
- # in LANG doc index: don't rewrite .html suffixes as not all .LANG.html pages exist
+ # in LANG doc index: don't rewrite .html suffixes
+ # as not all .LANG.html pages exist;
# the doc index should be translated and contain the right links
if prefix == 'Documentation/out-www/index':
page_flavors[file_name] = [lang_ext, s]
elif lang_ext == '':
page_flavors[file_name] = [lang_ext, s]
for e in missing:
- page_flavors[langdefs.lang_file_name (prefix, e, '.html')] = [e, re.sub (
- '''href=[\'"]([^/][.]*[^.:\'"]*)(.html)(#[^"\']*|)[\'"]''',
- 'href="\\1.' + e + '\\2\\3"', s)]
+ page_flavors[langdefs.lang_file_name (prefix, e, '.html')] = \
+ [e, offline_links_re.sub ('href="\\1.' + e + '\\2\\3"', s)]
else:
- page_flavors[file_name] = [lang_ext, re.sub (
- '''href=[\'"]([^/][.]*[^.:\'"]*)(.html)(#[^"\']*|)[\'"]''',
- 'href="\\1.' + lang_ext + '\\2\\3"', s)]
+ page_flavors[file_name] = \
+ [lang_ext,
+ offline_links_re.sub ('href="\\1.' + lang_ext + '\\2\\3"', s)]
return page_flavors
def add_menu (page_flavors, prefix, available, target, translation):
language_available = t (lang_available) % language_menu
languages = LANGUAGES_TEMPLATE % vars ()
# put language menu before '</body>' and '</html>' tags
- if re.search ('(?i)</body', page_flavors[k][1]):
- page_flavors[k][1] = re.sub ('(?i)</body>', languages + '</BODY>', page_flavors[k][1], 1)
- elif re.search ('(?i)</html', page_flavors[k][1]):
- page_flavors[k][1] = re.sub ('(?i)</html>', languages + '</HTML>', page_flavors[k][1], 1)
- else:
- page_flavors[k][1] += languages
+ (page_flavors[k][1], n) = end_body_re.subn (languages + '</body>', page_flavors[k][1], 1)
+ if not n:
+ (page_flavors[k][1], n) = end_html_re.subn (languages + '</html>', page_flavors[k][1], 1)
+ if not n:
+ page_flavors[k][1] += languages
return page_flavors
s = in_f.read()
in_f.close()
- s = re.sub ('%', '%%', s)
+ s = s.replace ('%', '%%')
s = hack_urls (s, prefix)
s = add_header (s)
### add footer
- if re.search (footer_tag, s) == None:
+ if footer_tag_re.search (s) == None:
s = add_footer (s)
available, missing = find_translations (prefix, lang_ext)
page = re.sub (r'<title>([^<]*?) - ([^<]*?)</title>', title_gettext, page)
# ugh
page = re.sub (r'(?ms)<a ((?:rel="\w+")? ?(?:accesskey="[^"]+?")? ?(?:name=".*?")? ?)(href=".+?">)(<code>)?(Appendix )?([A-Z\d.]+ |)(.+?)(?(3)</code>)</a>:?', a_href_gettext, page)
- page = re.sub (r'<h(\d)( class="\w+"|)>(Appendix |)([A-Z\d.]+ |)?([^<]+)</h\1>', h_gettext, page)
+ page = re.sub (r'<h(\d)( class="\w+"|)>\s*(Appendix |)([A-Z\d.]+ |)?([^<]+)\s*</h\1>', h_gettext, page)
page = re.sub (r'<a href="(\.\./(?:music-glossary|lilypond-program/)?(?:.+?))">(.+?)</a>', crossmanual_ref_gettext, page)
# this is necessary for entries not translated by a_href_gettext
page = re.sub (r'<a href="(.+?)">(.+?)</a>', crossmanual_ref_gettext, page)
--- /dev/null
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# tely-gettext.py
+
+# Temporary script that helps translated docs sources conversion
+# for texi2html processing
+
+# USAGE: tely-gettext.py BUILDSCRIPT-DIR LOCALEDIR LANG FILES
+
+print "tely_gettext.py"
+
+import sys
+import re
+import os
+import gettext
+
+if len (sys.argv) > 3:
+ buildscript_dir, localedir, lang = sys.argv[1:4]
+else:
+ print """USAGE: tely-gettext.py BUILDSCRIPT-DIR LOCALEDIR LANG FILES
+ For example buildscripts/tely-gettext.py buildscripts Documentation/po/out-www de Documentation/de/user/*.tely"""
+ sys.exit (1)
+
+sys.path.append (buildscript_dir)
+import langdefs
+
+double_punct_char_separator = langdefs.LANGDICT[lang].double_punct_char_sep
+t = gettext.translation('lilypond-doc', localedir, [lang])
+_doc = t.gettext
+
+include_re = re.compile (r'@include (.*?)$', re.M)
+whitespaces = re.compile (r'\s+')
+ref_re = re.compile (r'(?ms)@(ruser|rprogram|ref|rlearning)\{(.*?)\}')
+node_section_re = re.compile (r'@node (.*?)\n@((?:unnumbered|appendix)(?:(?:sub){0,2}sec)?|top|chapter|(?:sub){0,2}section|(?:major|chap|(?:sub){0,2})heading) (.*?)\n')
+menu_entry_re = re.compile (r'\* (.*?)::')
+
+def ref_gettext (m):
+ r = whitespaces.sub (' ', m.group (2))
+ return '@' + m.group (1) + '{' + _doc (r) + '}'
+
+def node_gettext (m):
+ return '@node ' + _doc (m.group (1)) + '\n@' + \
+ m.group (2) + ' ' + _doc (m.group (3)) + \
+ '\n@translationof ' + m.group (1) + '\n'
+
+def menu_entry_gettext (m):
+ return '* ' + _doc (m.group (1)) + '::'
+
+def process_file (filename):
+ print "Processing %s" % filename
+ f = open (filename, 'r')
+ page = f.read ()
+ f.close()
+ page = node_section_re.sub (node_gettext, page)
+ page = ref_re.sub (ref_gettext, page)
+ page = menu_entry_re.sub (menu_entry_gettext, page)
+ page = page.replace ("""-- SKELETON FILE --
+When you actually translate this file, please remove these lines as
+well as all `UNTRANSLATED NODE: IGNORE ME' lines.""", """@c -- SKELETON FILE --""")
+ page = page.replace ('UNTRANSLATED NODE: IGNORE ME', "@c UNTRANSLATED NODE: IGNORE ME")
+ includes = [whitespaces.sub ('', f) for f in include_re.findall (page)]
+ f = open (filename, 'w')
+ f.write (page)
+ f.close ()
+ dir = os.path.dirname (filename)
+ for file in includes:
+ p = os.path.join (dir, file)
+ if os.path.exists (p):
+ process_file (p)
+
+for filename in sys.argv[4:]:
+ process_file (filename)
tree_roots = doc_dirs,
process_dirs = outdir,
exclude_dirs = '(^|/)(' + r'|po|out|out-test|.*?[.]t2d|\w*?-root)(/|$)|Documentation/(' + '|'.join ([l.code for l in langdefs.LANGUAGES]) + ')',
- find_files = r'.*?\.(?:midi|html|pdf|png|txt|ly|signature)$|VERSION',
+ find_files = r'.*?\.(?:midi|html|pdf|png|txt|ly|signature|css)$|VERSION',
exclude_files = r'lily-[0-9a-f]+.*\.(pdf|txt)')
# actual mirrorring stuff
LN = @LN@
LN_S = @LN_S@
MAKEINFO_PROGRAM = @MAKEINFO@
+TEXI2HTML_PROGRAM = @TEXI2HTML@
METAFONT = @METAFONT@ -progname=mf
MFMODE = @MFMODE@
MSGFMT = @MSGFMT@
CPPFLAGS="$save_CPPFLAGS"
-STEPMAKE_MAKEINFO(REQUIRED, 4.11)
+# We check for makeinfo below, too. Really duplicate that check?
+## STEPMAKE_MAKEINFO(REQUIRED, 4.11)
STEPMAKE_PYTHON_DEVEL(REQUIRED)
STEPMAKE_PATH_PROG(GHOSTSCRIPT, gs, OPTIONAL, 8.15)
STEPMAKE_PERL(OPTIONAL)
STEPMAKE_PROGS(MAKEINFO, makeinfo, REQUIRED, 4.11)
+STEPMAKE_PROGS(TEXI2HTML, texi2html, REQUIRED, 1.79)
AC_DEFINE_UNQUOTED(FLOWER_VERSION, "${FULL_FLOWER_VERSION}")
@node Ancient notation
-@unnumbered Ancient notation
+@chapter Ancient notation
@lysnippets
@node Chords
-@unnumbered Chords
+@chapter Chords
@lysnippets
@node Contexts and engravers
-@unnumbered Contexts and engravers
+@chapter Contexts and engravers
@lysnippets
@node Expressive marks
-@unnumbered Expressive marks
+@chapter Expressive marks
@lysnippets
* Templates::
@end menu
+@contents
+
@c Please take care of naming every .itely
@c with an existing tag name.
@node MIDI
-@unnumbered MIDI
+@chapter MIDI
@lysnippets
@node Paper and layout
-@unnumbered Paper and layout
+@chapter Paper and layout
@lysnippets
@node Percussion
-@unnumbered Percussion
+@chapter Percussion
@lysnippets
@node Pitches
-@unnumbered Pitches
+@chapter Pitches
@lysnippets
@node Repeats
-@unnumbered Repeats
+@chapter Repeats
@lysnippets
@node Rhythms
-@unnumbered Rhythms
+@chapter Rhythms
@lysnippets
@node Simultaneous notes
-@unnumbered Simultaneous notes
+@chapter Simultaneous notes
@lysnippets
@node Spacing
-@unnumbered Spacing
+@chapter Spacing
@lysnippets
@node Staff notation
-@unnumbered Staff notation
+@chapter Staff notation
@lysnippets
@node Templates
-@unnumbered Templates
+@chapter Templates
@lysnippets
@node Text
-@unnumbered Text
+@chapter Text
@lysnippets
@node Titles
-@unnumbered Titles
+@chapter Titles
@lysnippets
@node Tweaks and overrides
-@unnumbered Tweaks and overrides
+@chapter Tweaks and overrides
@lysnippets
@node Vocal music
-@unnumbered Vocal music
+@chapter Vocal music
@lysnippets
--- /dev/null
+#!/usr/bin/env perl
+
+# {
+package Texi2HTML::Config;
+
+my $lastfilename;
+my $docnr = 0;
+my $page_toc_depth = 2;
+my @default_toc = [];
+
+use Data::Dumper;
+$Data::Dumper::Maxdepth = 2;
+
+sub print_element_info($)
+{
+ my $element = shift;
+ print "~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
+ print "Element: $element\n";
+ print Dumper($element);
+}
+
+
+# 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 $str = shift;
+ # File name normalization by texinfo:
+ # 1/2: letters and numbers are left unchanged
+ # 3/4: multiple, leading and trailing whitespace is removed
+ $str = main::normalise_space($str);
+ # 5/6: all remaining spaces are converted to '-', all other 7- or 8-bit
+ # chars are replaced by _xxxx (xxxx=ascii character code)
+ my @chars = split(//, $str);
+ my $str = '';
+ foreach my $char (@chars) {
+ if ( $char eq ' ' ) { # space -> '-'
+ $str .= '-';
+ } elsif ( ('0' le $char and $char le '9' ) or
+ ('A' le $char and $char le 'Z' ) or
+ ('a' le $char and $char le 'z' ) ) { # number or letter
+ $str .= $char;
+ } else {
+ my $ccode = ord($char);
+ my $addstr;
+ if ( ord($char)<= 0xFFFF ) {
+ $addstr = sprintf("_%4x", $ccode);
+ } else {
+ $addstr = sprintf("__%6x", $ccode);
+ }
+ # padding is done by spaces, replace by '0'
+ $addstr =~ s/\ /0/g;
+ $str .= $addstr;
+ }
+ }
+ # 7: if name begins with number, prepend 't_g' (so it starts with a letter)
+ if ($str =~ /^[0-9]/) {
+ $str = 't_g' . $str;
+ }
+ # DONE
+ return $str
+}
+
+
+
+# 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.
+sub split_at_numbered_sections($$$)
+{
+ my $element = shift;
+ my $type = shift;
+ my $docu_name = shift;
+ my $docu_ext = $Texi2HTML::Config::EXTENSION;
+
+# if ($$element{number} eq "1.1") {
+# print_element_info ($element);
+# }
+
+ # TOC, footer, about etc. are called with undefined $element and $type == "toc"|"stoc"|"foot"|"about"
+ if ($type eq "toc" or $type eq "stoc" or $type eq "foot" or $type eq "about") {
+ return;
+ } else {
+ # derive the name of the anchor (i.e. the part after # in the links!),
+ # don't use texi2html's SECx.x default!
+ my $anchor = main::remove_texi($$element{texi});
+ 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;
+ # Numbered sections will get a filename Section_1.1.2, unnumbered sections will use
+ # the file name of the previous numbered section:
+ if ($$element{number}) {
+ 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;
+}
+
+
+# The default formatting of external refs returns e.g.
+# "(lilypond-internals)Timing_translator", while we simply want "Timing_translator".
+# Solution: Remove all (...) from the file_and_node argument before calling
+# 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;
+
+ $file_node =~ s/\(.*\)//;
+ return t2h_default_external_ref($type, $section, $book, $file_node, $href, $cross_ref);
+}
+
+
+# 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.
+sub generate_ly_toc_entries($$$)
+{
+ my $element = shift;
+ my $element_path = shift;
+ my $maxlevel = 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_path->{$element->{'number'}};
+ 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<li$this_css_class>" . &$anchor ($element->{'tocid'}, "$element->{'file'}#$element->{'id'}",$element->{'text'});
+
+ my $children = $element->{'section_childs'};
+ 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));
+ }
+ # 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, "$ind<ul$NO_BULLET_LIST_ATTRIBUTE>");
+ push (@result, @child_result);
+ push (@result, "$ind</ul></li>\n");
+ }
+ } else {
+ push (@result, $entry . "</li>\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->{'number'}} = 1;
+ # Find the path to the current element
+ while ( defined($current_element->{'sectionup'}) and
+ ($current_element->{'sectionup'} ne $current_element) )
+ {
+ $parentelements{$current_element->{'sectionup'}->{'number'}} = 1
+ if ($current_element->{'sectionup'}->{'number'} ne '');
+ $current_element = $current_element->{'sectionup'};
+ }
+ return () if not defined($current_element);
+ # Create the toc entries recursively
+ my @toc_entries = ("<div class=\"contents\">", "<ul$NO_BULLET_LIST_ATTRIBUTE>");
+ my $children = $current_element->{'section_childs'};
+ foreach ( @$children ) {
+ push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth));
+ }
+ push (@toc_entries, "</ul>");
+ push (@toc_entries, "</div>");
+ return @toc_entries;
+}
+
+my @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);
+}
+
+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 <div> 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 @lines = @this_page_toc;
+ # use default TOC if no custom lines have been generated
+ @lines = @default_toc if (not @lines);
+ if (@lines) {
+ print $fh "<div id=\"tocframe\">";
+ print $fh '<h4> ' . $Texi2HTML::NAME{'Contents'} . "</h4>\n";
+ foreach my $line (@lines) {
+ print $fh $line;
+ }
+ print $fh "</div>";
+ @this_page_toc = ();
+ }
+ T2H_DEFAULT_print_page_foot($fh);
+}
+
+
+
+
+
+
+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 <td> 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 '<table cellpadding="', $spacing, '" cellspacing="', $spacing,
+# "\" border=\"0\" class=\"nav_table\">\n";
+ print $fh "<table class=\"nav_table\">\n";
+
+ print $fh "<tr>" unless $vertical;
+ my $beginofline = 1;
+ foreach my $button (@$buttons)
+ {
+ print $fh 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">};
+ $beginofline = 0;
+ }
+ elsif ( $button eq 'newline' )
+ {
+ print $fh qq{</td>} unless $beginofline;
+ print $fh qq{</tr>};
+ print $fh qq{<tr>};
+ $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 "</td>\n" if $vertical;
+ print $fh "</tr>\n" if $vertical;
+ }
+ print $fh "</td>" unless $beginofline;
+ print $fh "</tr>" unless $vertical;
+ print $fh "</table>\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'
+ );
+
+# $Texi2HTML::Config::SPLIT = 'section';
+@Texi2HTML::Config::CSS_REFS = ("lilypond.css");
+$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::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::toc_body = \&lilypond_toc_body;
+
+
+# For split pages, use index(.lang).html as start page!
+if ($Texi2HTML::Config::SPLIT == 'section') {
+# my $lng = $Texi2HTML::THISDOC{'current_lang'};
+# if ($lng and ($lng ne "en")) {
+# $Texi2HTML::Config::TOP_FILE = 'index.'.$lng.'.html';
+# } else {
+ $Texi2HTML::Config::TOP_FILE = 'index.html';
+# }
+}
+
+# if ($Texi2HTML::THISDOC{'current_lang'}) {
+# $Texi2HTML::Config::EXTENSION = $Texi2HTML::THISDOC{'current_lang'} . "." .
+# $docu_ext = $Texi2HTML::Config::EXTENSION;;
+# }
+
+
+
+# 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
+ if ($pass == 1 and $macro eq "translationof") {
+ if (ref($state->{'element'})=='HASH') {
+ $state->{'element'}->{'translationof'} = main::normalise_space($line);
+ }
+ return ('', true, undef, undef);
+ } else {
+ return t2h_default_unknown($macro, $line, $pass, $stack, $state);
+ }
+}
+$Texi2HTML::Config::unknown = \&lilypond_unknown;
+
+
+
+return 1;
-$(outdir)/%/index.html: $(outdir)/%.texi $(outdir)/version.itexi
+<<<<<<< HEAD:make/doclang-rules.make
+$(outdir)/%/index.html: $(outdir)/%.texi $(OUT_PNG_IMAGES) $(outdir)/version.itexi
mkdir -p $(dir $@)
- $(MAKEINFO) -P $(outdir) --output=$(outdir)/$* --css-include=$(top-src-dir)/Documentation/texinfo.css --html $<
+ $(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 $(outdir)/version.itexi
- $(MAKEINFO) -P $(outdir) --output=$@ --css-include=$(top-src-dir)/Documentation/texinfo.css --html --no-split --no-headers $<
+$(outdir)/%-big-page.html: $(outdir)/%.texi $(OUT_PNG_IMAGES) $(outdir)/version.itexi
+ $(TEXI2HTML) --I=$(outdir) $(TEXI2HTML_FLAGS) --output=$@ $(TEXI2HTML_INIT) $<
+ cp $(top-src-dir)/Documentation/lilypond.css $(dir $@)
$(outdir)/%.pdftexi: $(outdir)/%.texi doc-po $(outdir)/version.itexi
$(PYTHON) $(buildscript-dir)/texi-gettext.py $(ISOLANG) $<
-$(outdir)/%.pdf: $(outdir)/%.pdftexi
+$(outdir)/%.pdf: $(outdir)/%.pdftexi $(outdir)/version.itexi
cd $(outdir); texi2pdf $(TEXI2PDF_FLAGS) $(TEXINFO_PAPERSIZE_OPTION) $(notdir $*).pdftexi
$(outdir)/version.%: $(top-src-dir)/VERSION
echo $(TOPLEVEL_VERSION)>> $@
echo '@end macro'>> $@
+$(outdir)/%.png: $(top-build-dir)/Documentation/user/$(outdir)/%.png
+ ln -f $< $@
+
# This makes sure lilypond-doc gettext domain has been compiled
# before lilypond-book runs
%.tely: doc-po
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
+
DOCUMENTATION_INCLUDES = \
-I $(top-src-dir)/Documentation/user \
-I $(top-build-dir)/Documentation/user/$(outdir)
MAKEINFO_FLAGS += --force --enable-encoding $(DOCUMENTATION_INCLUDES)
MAKEINFO = LANG= $(MAKEINFO_PROGRAM) $(MAKEINFO_FLAGS)
+TEXI2HTML_INIT= --init-file=$(top-src-dir)/lilypond-texi2html.init
+TEXI2HTML_LANG=--lang=$(ISOLANG)
+TEXI2HTML_FLAGS += $(TEXI2HTML_LANG) $(DOCUMENTATION_INCLUDES)
+TEXI2HTML = LANG= $(TEXI2HTML_PROGRAM)
+
TEXI2PDF_FLAGS += --batch $(DOCUMENTATION_INCLUDES)
TELY_FILES = $(call src-wildcard,*.tely)
@ifclear bigpage
@macro ruser{NAME}
-@ref{\\NAME\\,,,lilypond}
+@ref{\\NAME\\,,,lilypond,Notation Reference}
@cindex \\NAME\\
@end macro
@macro glossaryref{NAME}
-@ref{\\NAME\\,,,music-glossary}
+@ref{\\NAME\\,,,music-glossary,Music Glossary}
@cindex \\NAME\\
@end macro
@omfcategory Applications|Publishing
@end ignore
-
+@contents
")
out-port)
(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")))))
$(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 $<
+ $(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 $<
+ $(TEXI2HTML) --I=$(outdir) --output=$@ $(TEXI2HTML_INIT) $<
+ cp $(top-src-dir)/Documentation/lilypond.css $(dir $@)
$(outdir)/%.html.omf: %.texi
$(call GENERATE_OMF,html)
$(outdir)/%/index.html: $(outdir)/%.texi $(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) $(<F)
-
TEXI_FILES = $(call src-wildcard,*.texi)
ALL_SOURCES += $(TEXI_FILES)
MAKEINFO_FLAGS = --enable-encoding
MAKEINFO = LANG= $(MAKEINFO_PROGRAM) $(MAKEINFO_FLAGS)
+ifneq ($(ISOLANG),)
+TEXI2HTML_LANG = --lang=$(ISOLANG)
+endif
+TEXI2HTML_FLAGS += --css-ref=lilypond.css $(DOCUMENTATION_INCLUDES)
+TEXI2HTML_INIT = --init-file=$(top-src-dir)/lilypond-texi2html.init
+TEXI2HTML = $(TEXI2HTML_PROGRAM) $(TEXI2HTML_FLAGS) $(TEXI2HTML_LANG)
# info stuff
INFO_INSTALL_FILES = $(wildcard $(addsuffix *, $(INFO_FILES)))
projects / lilypond.git / commitdiff