X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=buildscripts%2Fadd_html_footer.py;h=da827c130164de217acb3ae553191f28c6d4d287;hb=91708b30fba67f8fd589980e03ff420c26473a5a;hp=a7bc7e11d97e6a7c732a06f7d5887bb67b659feb;hpb=711cf44d0ab28f3159230c84d63c0b19199408b0;p=lilypond.git
diff --git a/buildscripts/add_html_footer.py b/buildscripts/add_html_footer.py
index a7bc7e11d9..da827c1301 100644
--- a/buildscripts/add_html_footer.py
+++ b/buildscripts/add_html_footer.py
@@ -9,45 +9,68 @@ import time
import langdefs
-default_header = r"""
+# This is to try to make the docball not too big with almost duplicate files
+# see process_links()
+non_copied_pages = ['Documentation/user/out-www/lilypond-big-page',
+ 'Documentation/user/out-www/lilypond-internals-big-page',
+ 'Documentation/user/out-www/music-glossary-big-page',
+ 'out-www/examples',
+ 'Documentation/topdocs',
+ 'Documentation/bibliography',
+ 'Documentation/out-www/THANKS',
+ 'Documentation/out-www/DEDICATION',
+ 'input/']
+
+def _doc (s):
+ return s
+
+header = r"""
"""
-default_footer = r'''
+footer = '''
-This page is for %(package_name)s-%(package_version)s (%(branch_str)s).
+%(footer_name_version)s
+
+
+%(footer_report_errors)s
+
+%(footer_suggest_docs)s
-
-Report errors to %(mail_address)s.
'''
+footer_name_version = _doc ('This page is for %(package_name)s-%(package_version)s (%(branch_str)s).')
+footer_report_errors = _doc ('Report errors to %(mail_address)s.')
+# ugh, must not have "_doc" in strings because it is naively replaced with "_" in hacked gettext process
+footer_suggest_docs = _doc ('Your suggestions for the documentation 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 = ''
footer_tag = ''
-def _ (s):
- return s
-
-language_available = _ ("Other languages: %s.") % "%(language_menu)s"
-browser_language = _ ("Using automatic language selection.") \
- % "/web/about/browser-language"
+lang_available = _doc ("Other languages: %s.")
+browser_lang = _doc ('About automatic language selection.')
+browser_language_url = "/web/about/browser-language"
-LANGUAGES_TEMPLATE = '''\
+LANGUAGES_TEMPLATE = '''
%(language_available)s
%(browser_language)s
-''' % vars ()
+'''
html_re = re.compile ('(.*?)(?:[.]([^/.]*))?[.]html$')
+pages_dict = {}
def build_pages_dict (filelist):
"""Build dictionnary of available translations of each page"""
- pages_dict = {}
+ global pages_dict
for f in filelist:
m = html_re.match (f)
if m:
@@ -60,25 +83,39 @@ def build_pages_dict (filelist):
pages_dict[g[0]] = [e]
else:
pages_dict[g[0]].append (e)
- return pages_dict
+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/snippets|Documentation/user/out-www/(lilypond|music-glossary|lilypond-program|lilypond-learning))/')
+
+snippets_ref_re = re.compile (r'href="(\.\./)?lilypond-snippets')
+
+## 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 _urls (s, prefix):
+ if splitted_docs_re.match (prefix):
+ s = re.sub ('(href|src)="(lily-.*?|.*?[.]png)"', '\\1="../\\2"', s)
+
+ # fix Snippets xrefs ad hoc
+ s = snippets_ref_re.sub ('href="source/input/lsr/lilypond-snippets', s)
-def do_file (prefix, lang_ext, target, header, footer, pages_dict, out_root, name_filter,
- package_name, package_version, branch_str, mail_address_url, mail_address):
- file_name = langdefs.lang_file_name (prefix, lang_ext, '.html')
- in_f = open (file_name)
- s = in_f.read()
- in_f.close()
-
- s = re.sub ('%', '%%', 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 re.sub ('href="source/(.*?)"', lambda m: source_links_replace (m, source_val), s)
- ### add header
+def add_header (s):
+ """Add header ( and doctype)"""
if re.search (header_tag, s) == None:
body = ''
s = re.sub ('(?i)', body, s)
if re.search ('(?i)]*>', body + header, s, 1)
- elif re.search ('(?i)', '' + header, s, 1)
else:
s = header + s
@@ -88,10 +125,9 @@ def do_file (prefix, lang_ext, target, header, footer, pages_dict, out_root, nam
if re.search ('(?i)\n'
s = doctype + s
+ return s
- # remove info's annoying's indication of referencing external document
- s = re.sub (' \((lilypond|lilypond-internals|music-glossary)\)', '', s)
-
+def add_title (s):
# urg
# maybe find first node?
fallback_web_title = '-- --'
@@ -99,108 +135,117 @@ def do_file (prefix, lang_ext, target, header, footer, pages_dict, out_root, nam
if m:
fallback_web_title = m.group (1)
s = re.sub ('@WEB-TITLE@', fallback_web_title, s)
+ return s
- ### add footer
- page_flavors = {}
- if re.search (footer_tag, s) == None:
- if re.search ('(?i)', footer_tag + footer + '\n' + '', s, 1)
- elif re.search ('(?i)', footer_tag + footer + '\n' + '', s, 1)
+info_nav_bar = re.compile (r'', re.M | re.S)
+info_footnote_hr = re.compile (r'
\s*()?\s*', re.M | re.I)
+
+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
in case there are footnotes at the end of the Info HTML page
+ if info_footnote_hr.search (s):
+ custom_footer = '\n' + footer
else:
- s += footer_tag + footer + '\n'
-
- # Find available translations of this page.
- available = []
- missing = []
- for l in langdefs.LANGUAGES:
- e = l.webext
- if lang_ext != e:
- if e in pages_dict[prefix]:
- available.append (l)
- elif lang_ext == '' and l.enabled: # English version of missing translated pages will be written
- missing.append (e)
-
- 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.
- # Don't strip .html suffix for documentation index because of
- # lilypond/ vs. lilypond.html conflict
- if prefix == 'Documentation/out-www/index':
- page_flavors[file_name] = s
- else:
- page_flavors[file_name] = re.sub (
- '''(href|src)=[\'"]([^/][.]*[^.:\'"]*)(.html|.png)(#[^"\']*|)[\'"]''',
- '\\1="\\2\\4"', s)
- elif target == 'offline':
- if lang_ext == '':
- page_flavors[file_name] = s
- for e in missing:
- page_flavors[langdefs.lang_file_name (prefix, e, '.html')] = re.sub (
- '''href=[\'"]([^/][.]*[^.:\'"]*)(.html)(#[^"\']*|)[\'"]''',
- 'href="\\1.' + e + '\\2\\3"', s)
- else:
- page_flavors[file_name] = re.sub (
+ custom_footer = '
\n\n' + footer
+ else:
+ custom_footer = footer
+ if re.search ('(?i)', footer_tag + custom_footer + '\n' + '