import re
import os
import time
+import operator
import langdefs
'Documentation/user/out-www/lilypond-internals-big-page',
'Documentation/user/out-www/music-glossary-big-page',
'out-www/examples',
- 'Documentation/topdocs/out-www/NEWS',
- 'Documentation/topdocs/out-www/INSTALL',
- 'Documentation/bibliography/out-www/index',
- 'Documentation/bibliography/out-www/engraving',
- 'Documentation/bibliography/out-www/colorado',
- 'Documentation/bibliography/out-www/computer-notation'
+ 'Documentation/topdocs',
+ 'Documentation/bibliography',
'Documentation/out-www/THANKS',
'Documentation/out-www/DEDICATION',
- 'Documentation/topdocs/out-www/AUTHORS']
+ 'input/']
-def _ (s):
+def _doc (s):
return s
header = r"""
<font size="-1">
%(footer_name_version)s
<br>
+<address>
+%(footer_report_errors)s </address>
+<br>
+%(footer_suggest_docs)s
</font>
-<address><font size="-1">
-%(footer_report_errors)s </font></address>
</p>
</div>
'''
-footer_name_version = _ ('This page is for %(package_name)s-%(package_version)s (%(branch_str)s).')
-footer_report_errors = _ ('Report errors to <a href="%(mail_address_url)s">%(mail_address)s</a>.')
+footer_name_version = _doc ('This page is for %(package_name)s-%(package_version)s (%(branch_str)s).')
+footer_report_errors = _doc ('Report errors to <a href="%(mail_address_url)s">%(mail_address)s</a>.')
+# ugh, must not have "_doc" in strings because it is naively replaced with "_" in hacked gettext process
+footer_suggest_docs = _doc ('Your <a href="%(suggest_Docs_url)s">suggestions for the documentation</a> are welcome.')
mail_address = 'http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs'
+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 = _ ("Other languages: %s.")
-browser_lang = _ ('About <A HREF="%s">automatic language selection</A>.')
+lang_available = _doc ("Other languages: %s.")
+browser_lang = _
doc ('About <A HREF="%s">automatic language selection</A>.')
browser_language_url = "/web/about/browser-language"
LANGUAGES_TEMPLATE = '''
pages_dict = {}
def build_pages_dict (filelist):
- """Build dictionnary of available translations of each page"""
+ """Build dictionary of available translations of each page"""
global pages_dict
for f in filelist:
m = html_re.match (f)
else:
pages_dict[g[0]].append (e)
+def source_links_replace (m, source_val):
+ return 'href="' + os.path.join (source_val, m.group (1)) + '"'
+
+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')
+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
+# Get rid of symlinks in GNUmakefile.in (local-WWW-post)
+# this also fixes missing PNGs only present in translated docs
+def hack_urls (s, prefix):
+ if splitted_docs_re.match (prefix):
+ 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)
+
+ source_path = os.path.join (os.path.dirname (prefix), 'source')
+ if not os.path.islink (source_path):
+ return s
+ source_val = os.readlink (source_path)
+ 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
-def info_external_ref_remove (s):
- """Remove info's annoying's indication of referencing external document"""
- return re.sub (' \((lilypond|lilypond-internals|music-glossary)\)</a>', '</a>', 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 not prefix 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):
if page_flavors[k][0] != '':
t = translation[page_flavors[k][0]]
else:
- t = _
+ t = _doc
for lang in available:
lang_file = lang.file_name (os.path.basename (prefix), '.html')
if language_menu != '':
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
mail_address_url= 'mailto:' + mail_address
versiontup = package_version.split ('.')
- branch_str = _('stable-branch')
- if int ( versiontup[1]) % 2:
- branch_str = _('development-branch')
+ branch_str = _doc ('stable-branch')
+ if int (versiontup[1]) % 2:
+ branch_str = _doc ('development-branch')
for prefix, ext_list in pages_dict.items ():
for lang_ext in ext_list:
s = in_f.read()
in_f.close()
- s = re.sub ('%', '%%', s)
+ s = s.replace ('%', '%%')
+ s = hack_urls (s, prefix)
s = add_header (s)
- # seems to be no more needed
- # s = info_external_ref_remove (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_flavors = process_links (s, prefix, lang_ext, file_name, missing, target)
# Add menu after stripping: must not have autoselection for language menu.
page_flavors = add_menu (page_flavors, prefix, available, target, translation)
- # urg, this stuff is outdated and seems useless, let's disable it
- #else:
- # for e in [l.webext for l in langdefs.LANGUAGES]:
- # if not e in pages_dict[prefix]:
- # page_flavors[langdefs.lang_file_name (prefix, e, '.html')] = s
subst = dict ([i for i in globals().items() if type (i[1]) is str])
subst.update (dict ([i for i in locals().items() if type (i[1]) is str]))
for k in page_flavors.keys():
subst[name] = translation[page_flavors[k][0]] (subst[name])
subst['footer_name_version'] = subst['footer_name_version'] % subst
subst['footer_report_errors'] = subst['footer_report_errors'] % subst
+ subst['footer_suggest_docs'] = subst['footer_suggest_docs'] % subst
page_flavors[k][1] = page_flavors[k][1] % subst
out_f = open (name_filter (k), 'w')
out_f.write (page_flavors[k][1])
projects / lilypond.git / blobdiff