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/music-glossary-big-page',
19 'Documentation/topdocs',
20 'Documentation/bibliography',
21 'Documentation/out-www/THANKS',
22 'Documentation/out-www/DEDICATION',
32 <div style="background-color: #e8ffe8; padding: 2; border: #c0ffc0 1px solid;">
35 %(footer_name_version)s
38 %(footer_report_errors)s </address>
40 %(footer_suggest_docs)s
45 footer_name_version = _doc ('This page is for %(package_name)s-%(package_version)s (%(branch_str)s).')
46 footer_report_errors = _doc ('Report errors to <a href="%(mail_address_url)s">%(mail_address)s</a>.')
47 # ugh, must not have "_doc" in strings because it is naively replaced with "_" in hacked gettext process
48 footer_suggest_docs = _doc ('Your <a href="%(suggest_Docs_url)s">suggestions for the documentation</a> are welcome.')
50 mail_address = 'http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs'
51 suggest_Docs_url = 'http://lilypond.org/web/devel/participating/documentation-adding'
53 header_tag = '<!-- header_tag -->'
54 header_tag_re = re.compile (header_tag)
56 footer_tag = '<!-- footer_tag -->'
57 footer_tag_re = re.compile (footer_tag)
59 lang_available = _doc ("Other languages: %s.")
60 browser_lang = _doc ('About <A HREF="%s">automatic language selection</A>.')
61 browser_language_url = "/web/about/browser-language"
63 LANGUAGES_TEMPLATE = '''
65 %(language_available)s
72 html_re = re.compile ('(.*?)(?:[.]([^/.]*))?[.]html$')
75 def build_pages_dict (filelist):
76 """Build dictionary of available translations of each page"""
82 if len (g) <= 1 or g[1] == None:
86 if not g[0] in pages_dict.keys():
87 pages_dict[g[0]] = [e]
89 pages_dict[g[0]].append (e)
91 def source_links_replace (m, source_val):
92 return 'href="' + os.path.join (source_val, m.group (1)) + '"'
94 splitted_docs_re = re.compile ('(input/lsr/out-www/lilypond-snippets|Documentation/user/out-www/(lilypond|music-glossary|lilypond-program|lilypond-learning))/')
96 snippets_ref_re = re.compile (r'href="(\.\./)?lilypond-snippets')
97 src_href_re = re.compile ('(href|src)="(lily-.*?|.*?[.]png)"')
98 source_link_re = re.compile ('href="source/(.*?)"')
100 ## Windows does not support symlinks.
101 # This function avoids creating symlinks for splitted HTML manuals
102 # Get rid of symlinks in GNUmakefile.in (local-WWW-post)
103 # this also fixes missing PNGs only present in translated docs
104 def hack_urls (s, prefix):
105 if splitted_docs_re.match (prefix):
106 s = src_href_re.sub ('\\1="../\\2"', s)
108 # fix Snippets xrefs ad hoc
109 s = snippets_ref_re.sub ('href="source/input/lsr/lilypond-snippets', s)
111 source_path = os.path.join (os.path.dirname (prefix), 'source')
112 if not os.path.islink (source_path):
114 source_val = os.readlink (source_path)
115 return source_link_re.sub (lambda m: source_links_replace (m, source_val), s)
117 body_tag_re = re.compile ('(?i)<body([^>]*)>')
118 html_tag_re = re.compile ('(?i)<html>')
119 doctype_re = re.compile ('(?i)<!DOCTYPE')
120 doctype = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">\n'
123 """Add header (<body> and doctype)"""
124 if header_tag_re.search (s) == None:
125 body = '<body bgcolor="white" text="black" \\1>'
126 (s, n) = body_tag_re.subn (body + header, s, 1)
128 (s, n) = html_tag_re.subn ('<html>' + header, s, 1)
132 s = header_tag + '\n' + s
134 if doctype_re.search (s) == None:
138 title_tag_re = re.compile ('.*?<title>(.*?)</title>', re.DOTALL)
139 AT_web_title_re = re.compile ('@WEB-TITLE@')
143 # maybe find first node?
144 fallback_web_title = '-- --'
145 m = title_tag_re.match (s)
147 fallback_web_title = m.group (1)
148 s = AT_web_title_re.sub (fallback_web_title, s)
151 end_body_re = re.compile ('(?i)</body>')
152 end_html_re = re.compile ('(?i)</html>')
156 (s, n) = end_body_re.subn (footer_tag + footer + '\n' + '</body>', s, 1)
158 (s, n) = end_html_re.subn (footer_tag + footer + '\n' + '</html>', s, 1)
160 s += footer_tag + footer + '\n'
163 def find_translations (prefix, lang_ext):
164 """find available translations of a page"""
167 for l in langdefs.LANGUAGES:
170 if e in pages_dict[prefix]:
172 elif lang_ext == '' and l.enabled and reduce (operator.and_, [not prefix.startswith (s) for s in non_copied_pages]):
173 # English version of missing translated pages will be written
175 return available, missing
177 online_links_re = re.compile ('''(href|src)=[\'"]([^/][.]*[^.:\'"]*)(.html|.png)(#[^"\']*|)[\'"]''')
178 offline_links_re = re.compile ('''href=[\'"]([^/][.]*[^.:\'"]*)(.html)(#[^"\']*|)[\'"]''')
180 def process_links (s, prefix, lang_ext, file_name, missing, target):
182 if target == 'online':
183 # Strip .html, .png suffix for auto language selection (content
184 # negotiation). The menu must keep the full extension, so do
185 # this before adding the menu.
186 page_flavors[file_name] = \
187 [lang_ext, online_links_re.sub ('\\1="\\2\\4"', s)]
188 elif target == 'offline':
189 # in LANG doc index: don't rewrite .html suffixes
190 # as not all .LANG.html pages exist;
191 # the doc index should be translated and contain the right links
192 if prefix == 'Documentation/out-www/index':
193 page_flavors[file_name] = [lang_ext, s]
195 page_flavors[file_name] = [lang_ext, s]
197 page_flavors[langdefs.lang_file_name (prefix, e, '.html')] = \
198 [e, offline_links_re.sub ('href="\\1.' + e + '\\2\\3"', s)]
200 page_flavors[file_name] = \
202 offline_links_re.sub ('href="\\1.' + lang_ext + '\\2\\3"', s)]
205 def add_menu (page_flavors, prefix, available, target, translation):
206 for k in page_flavors.keys():
209 if page_flavors[k][0] != '':
210 t = translation[page_flavors[k][0]]
213 for lang in available:
214 lang_file = lang.file_name (os.path.basename (prefix), '.html')
215 if language_menu != '':
216 language_menu += ', '
217 language_menu += '<a href="%s">%s</a>' % (lang_file, t (lang.name))
218 if target == 'offline':
219 browser_language = ''
220 elif target == 'online':
221 browser_language = t (browser_lang) % browser_language_url
223 language_available = t (lang_available) % language_menu
224 languages = LANGUAGES_TEMPLATE % vars ()
225 # put language menu before '</body>' and '</html>' tags
226 (page_flavors[k][1], n) = end_body_re.subn (languages + '</body>', page_flavors[k][1], 1)
228 (page_flavors[k][1], n) = end_html_re.subn (languages + '</html>', page_flavors[k][1], 1)
230 page_flavors[k][1] += languages
234 def add_html_footer (translation,
236 package_version = '',
238 name_filter = lambda s: s):
239 """Add header, footer to a number of HTML files
242 translation gettext translations dictionary, with language codes as keys
243 package_name=NAME set package_name to NAME
244 package_version=VERSION set package version to VERSION
245 targets=offline|online set page processing depending on the target
246 offline is for reading HTML pages locally
247 online is for hosting the HTML pages on a website with content
249 name_filter a HTML file name filter
251 localtime = time.strftime ('%c %Z', time.localtime (time.time ()))
253 if re.search ("http://", mail_address):
254 mail_address_url = mail_address
256 mail_address_url= 'mailto:' + mail_address
258 versiontup = package_version.split ('.')
259 branch_str = _doc ('stable-branch')
260 if int (versiontup[1]) % 2:
261 branch_str = _doc ('development-branch')
263 for prefix, ext_list in pages_dict.items ():
264 for lang_ext in ext_list:
265 file_name = langdefs.lang_file_name (prefix, lang_ext, '.html')
266 in_f = open (file_name)
270 s = s.replace ('%', '%%')
271 s = hack_urls (s, prefix)
275 if footer_tag_re.search (s) == None:
278 available, missing = find_translations (prefix, lang_ext)
279 page_flavors = process_links (s, prefix, lang_ext, file_name, missing, target)
280 # Add menu after stripping: must not have autoselection for language menu.
281 page_flavors = add_menu (page_flavors, prefix, available, target, translation)
282 subst = dict ([i for i in globals().items() if type (i[1]) is str])
283 subst.update (dict ([i for i in locals().items() if type (i[1]) is str]))
284 for k in page_flavors.keys():
285 if page_flavors[k][0] in translation.keys():
286 for name in subst.keys():
287 subst[name] = translation[page_flavors[k][0]] (subst[name])
288 subst['footer_name_version'] = subst['footer_name_version'] % subst
289 subst['footer_report_errors'] = subst['footer_report_errors'] % subst
290 subst['footer_suggest_docs'] = subst['footer_suggest_docs'] % subst
291 page_flavors[k][1] = page_flavors[k][1] % subst
292 out_f = open (name_filter (k), 'w')
293 out_f.write (page_flavors[k][1])
295 # if the page is translated, a .en.html symlink is necessary for content negotiation
296 if target == 'online' and ext_list != ['']:
297 os.symlink (os.path.basename (prefix) + '.html', name_filter (prefix + '.en.html'))