4 Postprocess HTML files.
13 # This is to try to make the docball not too big with almost duplicate files
15 non_copied_pages = ['Documentation/user/out-www/lilypond-big-page',
16 'Documentation/user/out-www/lilypond-internals-big-page',
17 'Documentation/user/out-www/lilypond-learning-big-page',
18 'Documentation/user/out-www/lilypond-program-big-page',
19 'Documentation/user/out-www/music-glossary-big-page',
21 'Documentation/topdocs',
22 'Documentation/bibliography',
23 'Documentation/out-www/THANKS',
24 'Documentation/out-www/DEDICATION',
25 'Documentation/out-www/devel',
35 <div style="background-color: #e8ffe8; padding: 2; border: #c0ffc0 1px solid;">
38 %(footer_name_version)s
41 %(footer_report_errors)s </address>
43 %(footer_suggest_docs)s
48 footer_name_version = _doc ('This page is for %(package_name)s-%(package_version)s (%(branch_str)s).')
49 footer_report_errors = _doc ('Report errors to <a href="%(mail_address_url)s">%(mail_address)s</a>.')
50 # ugh, must not have "_doc" in strings because it is naively replaced with "_" in hacked gettext process
51 footer_suggest_docs = _doc ('Your <a href="%(suggest_Docs_url)s">suggestions for the documentation</a> are welcome.')
53 mail_address = 'http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs'
54 suggest_Docs_url = 'http://lilypond.org/web/devel/participating/documentation-adding'
56 header_tag = '<!-- header_tag -->'
57 header_tag_re = re.compile (header_tag)
59 footer_tag = '<!-- footer_tag -->'
60 footer_tag_re = re.compile (footer_tag)
62 lang_available = _doc ("Other languages: %s.")
63 browser_lang = _doc ('About <A HREF="%s">automatic language selection</A>.')
64 browser_language_url = "/web/about/browser-language"
66 LANGUAGES_TEMPLATE = '''
68 %(language_available)s
75 html_re = re.compile ('(.*?)(?:[.]([^/.]*))?[.]html$')
78 def build_pages_dict (filelist):
79 """Build dictionary of available translations of each page"""
85 if len (g) <= 1 or g[1] == None:
89 if not g[0] in pages_dict:
90 pages_dict[g[0]] = [e]
92 pages_dict[g[0]].append (e)
94 def source_links_replace (m, source_val):
95 return 'href="' + os.path.join (source_val, m.group (1)) + '"'
97 splitted_docs_re = re.compile ('(input/lsr/out-www/lilypond-snippets|Documentation/user/out-www/(lilypond|music-glossary|lilypond-program|lilypond-learning))/')
99 snippets_ref_re = re.compile (r'href="(\.\./)?lilypond-snippets')
100 user_ref_re = re.compile (r'href="(?:\.\./)?lilypond(-internals|-learning|-program|(?!-snippets))')
102 ## Windows does not support symlinks.
103 # This function avoids creating symlinks for splitted HTML manuals
104 # Get rid of symlinks in GNUmakefile.in (local-WWW-post)
105 # this also fixes missing PNGs only present in translated docs
106 def hack_urls (s, prefix):
107 if splitted_docs_re.match (prefix):
108 s = re.sub ('(href|src)="(../lily-.*?|.*?[.]png)"', '\\1="../\\2"', s)
110 # fix xrefs between documents in different directories ad hoc
111 if 'user/out-www/lilypond' in prefix:
112 s = snippets_ref_re.sub ('href="source/input/lsr/lilypond-snippets', s)
113 elif 'input/lsr' in prefix:
114 s = user_ref_re.sub ('href="source/Documentation/user/lilypond\\1', s)
116 source_path = os.path.join (os.path.dirname (prefix), 'source')
117 if not os.path.islink (source_path):
119 source_val = os.readlink (source_path)
120 return re.sub ('href="source/(.*?)"', lambda m: source_links_replace (m, source_val), s)
122 body_tag_re = re.compile ('(?i)<body([^>]*)>')
123 html_tag_re = re.compile ('(?i)<html>')
124 doctype_re = re.compile ('(?i)<!DOCTYPE')
125 doctype = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">\n'
128 """Add header (<body> and doctype)"""
129 if header_tag_re.search (s) == None:
130 body = '<body bgcolor="white" text="black" \\1>'
131 (s, n) = body_tag_re.subn (body + header, s, 1)
133 (s, n) = html_tag_re.subn ('<html>' + header, s, 1)
137 s = header_tag + '\n' + s
139 if doctype_re.search (s) == None:
143 title_tag_re = re.compile ('.*?<title>(.*?)</title>', re.DOTALL)
144 AT_web_title_re = re.compile ('@WEB-TITLE@')
148 # maybe find first node?
149 fallback_web_title = '-- --'
150 m = title_tag_re.match (s)
152 fallback_web_title = m.group (1)
153 s = AT_web_title_re.sub (fallback_web_title, s)
156 footer_insert_re = re.compile ('<!--\s*FOOTER\s*-->')
157 end_body_re = re.compile ('(?i)</body>')
158 end_html_re = re.compile ('(?i)</html>')
160 def add_footer (s, footer_text):
162 (s, n) = footer_insert_re.subn (footer_text + '\n' + '<!-- FOOTER -->', s, 1)
164 (s, n) = end_body_re.subn (footer_text + '\n' + '</body>', s, 1)
166 (s, n) = end_html_re.subn (footer_text + '\n' + '</html>', s, 1)
168 s += footer_text + '\n'
171 def find_translations (prefix, lang_ext):
172 """find available translations of a page"""
175 for l in langdefs.LANGUAGES:
178 if e in pages_dict[prefix]:
180 elif lang_ext == '' and l.enabled and reduce (operator.and_, [not prefix.startswith (s) for s in non_copied_pages]):
181 # English version of missing translated pages will be written
183 return available, missing
185 online_links_re = re.compile ('''(href|src)=[\'"]([^/][.]*[^.:\'"]*)(.html|.png)(#[^"\']*|)[\'"]''')
186 offline_links_re = re.compile ('''href=[\'"]([^/][.]*[^.:\'"]*)(.html)(#[^"\']*|)[\'"]''')
188 def process_links (s, prefix, lang_ext, file_name, missing, target):
190 if target == 'online':
191 # Strip .html, .png suffix for auto language selection (content
192 # negotiation). The menu must keep the full extension, so do
193 # this before adding the menu.
194 page_flavors[file_name] = \
195 [lang_ext, online_links_re.sub ('\\1="\\2\\4"', s)]
196 elif target == 'offline':
197 # in LANG doc index: don't rewrite .html suffixes
198 # as not all .LANG.html pages exist;
199 # the doc index should be translated and contain the right links
200 if prefix == 'Documentation/out-www/index':
201 page_flavors[file_name] = [lang_ext, s]
203 page_flavors[file_name] = [lang_ext, s]
205 page_flavors[langdefs.lang_file_name (prefix, e, '.html')] = \
206 [e, offline_links_re.sub ('href="\\1.' + e + '\\2\\3"', s)]
208 page_flavors[file_name] = \
210 offline_links_re.sub ('href="\\1.' + lang_ext + '\\2\\3"', s)]
213 def add_menu (page_flavors, prefix, available, target, translation):
214 for k in page_flavors:
217 if page_flavors[k][0] != '':
218 t = translation[page_flavors[k][0]]
221 for lang in available:
222 lang_file = lang.file_name (os.path.basename (prefix), '.html')
223 if language_menu != '':
224 language_menu += ', '
225 language_menu += '<a href="%s">%s</a>' % (lang_file, t (lang.name))
226 if target == 'offline':
227 browser_language = ''
228 elif target == 'online':
229 browser_language = t (browser_lang) % browser_language_url
231 language_available = t (lang_available) % language_menu
232 languages = LANGUAGES_TEMPLATE % vars ()
233 # put language menu before '</body>' and '</html>' tags
234 page_flavors[k][1] = add_footer (page_flavors[k][1], languages)
238 def process_html_files (package_name = '',
239 package_version = '',
241 name_filter = lambda s: s):
242 """Add header, footer and tweak links to a number of HTML files
245 package_name=NAME set package_name to NAME
246 package_version=VERSION set package version to VERSION
247 targets=offline|online set page processing depending on the target
248 offline is for reading HTML pages locally
249 online is for hosting the HTML pages on a website with content
251 name_filter a HTML file name filter
253 translation = langdefs.translation
254 localtime = time.strftime ('%c %Z', time.localtime (time.time ()))
256 if "http://" in mail_address:
257 mail_address_url = mail_address
259 mail_address_url= 'mailto:' + mail_address
261 versiontup = package_version.split ('.')
262 branch_str = _doc ('stable-branch')
263 if int (versiontup[1]) % 2:
264 branch_str = _doc ('development-branch')
266 # Initialize dictionaries for string formatting
268 subst[''] = dict ([i for i in globals ().items() if type (i[1]) is str])
269 subst[''].update (dict ([i for i in locals ().items() if type (i[1]) is str]))
270 for l in translation:
271 e = langdefs.LANGDICT[l].webext
274 for name in subst['']:
275 subst[e][name] = translation[l] (subst[''][name])
276 # Do deeper string formatting as early as possible,
277 # so only one '%' formatting pass is needed later
279 subst[e]['footer_name_version'] = subst[e]['footer_name_version'] % subst[e]
280 subst[e]['footer_report_errors'] = subst[e]['footer_report_errors'] % subst[e]
281 subst[e]['footer_suggest_docs'] = subst[e]['footer_suggest_docs'] % subst[e]
283 for prefix, ext_list in pages_dict.items ():
284 for lang_ext in ext_list:
285 file_name = langdefs.lang_file_name (prefix, lang_ext, '.html')
286 in_f = open (file_name)
290 s = s.replace ('%', '%%')
291 s = hack_urls (s, prefix)
295 if footer_tag_re.search (s) == None:
296 s = add_footer (s, footer_tag + footer)
298 available, missing = find_translations (prefix, lang_ext)
299 page_flavors = process_links (s, prefix, lang_ext, file_name, missing, target)
300 # Add menu after stripping: must not have autoselection for language menu.
301 page_flavors = add_menu (page_flavors, prefix, available, target, translation)
302 for k in page_flavors:
303 page_flavors[k][1] = page_flavors[k][1] % subst[page_flavors[k][0]]
304 out_f = open (name_filter (k), 'w')
305 out_f.write (page_flavors[k][1])
307 # if the page is translated, a .en.html symlink is necessary for content negotiation
308 if target == 'online' and ext_list != ['']:
309 os.symlink (os.path.basename (prefix) + '.html', name_filter (prefix + '.en.html'))