Update word counts in:
contributor/doc-translation-list.itexi
+
+TODO:
+ * using markup = TexiMarkup (), html tables (columns)
+ are evenly spaced and bit too wide. This can
+ be fixed by using
+ @multitable @columnfractions 0 0 0 0 0 0 0 0,
+ but with that, PDF and info output get borked.
+ * in info and PDF, columns have too little separation
+ * using markup = HTMLMarkup (), we get nice
+ <td title="FILENAME">
+ popups -- do we want that with texi output? -- how?
+ or possibly links to the git archive?
+
'''
import sys
skeleton_str = '-- SKELETON FILE --'
section_titles_string = _doc ('Section titles')
-last_updated_string = _doc (' <p><i>Last updated %s</i></p>\n')
+last_updated_string = _doc ('Last updated %s')
detailed_status_heads = [_doc ('Translators'), _doc ('Translation checkers'),
_doc ('Translated'), _doc ('Up to date'),
_doc ('Other info')]
nodes = node_re.split (tely_doc)
return [len (space_re.split (n)) for n in nodes]
+class HTMLMarkup (object):
+ texi_header = '''@c -*- coding: utf-8; mode: texinfo; -*-
+@c This file was generated by translation-status.py -- DO NOT EDIT!
+@ignore
+ Translation of GIT committish: 0
+@end ignore
+
+'''
+ texi_footer = '''
+'''
+ def texi (self, string):
+ return (self.texi_header
+ + '''
+@ifnothtml
+Translation status currently only available in HTML.
+@end ifnothtml
+'''
+ + string
+ + self.texi_footer)
+ def entity (self, name, string='', attributes=[]):
+ attr_list = ''.join ([' %s="%s"' % x for x in attributes])
+ return '<%(name)s%(attr_list)s>%(string)s</%(name)s>' % locals ()
+ def paragraph (self, string=''):
+ return self.entity ('p', string)
+ def table (self, string):
+ return self.entity ('table', string, [('align', 'center'), ('border', '2')])
+ def row (self, string, attributes=[]):
+ return self.entity ('tr', string, attributes)
+ headrow = row
+ def headcell (self, string, attributes=[]):
+ return self.entity ('th', string, attributes)
+ def cell (self, string='', attributes=[]):
+ return self.entity ('td', string, attributes)
+ def newline (self, attributes=[]):
+ return self.entity ('br', '', attributes)[:-5]
+ def span (self, string, attributes=[]):
+ return self.entity ('span', string, attributes)
+ def small (self, string, attributes=[]):
+ return self.entity ('small', string, attributes)
+ def emph (self, string, attributes=[]):
+ return self.entity ('em', string, attributes)
+
+class TexiMarkup (HTMLMarkup):
+ def texi (self, string):
+ return (self.texi_header
+ + self.html ('''
+<style type="text/css"><!--
+th { border: 1px solid black; text-align: center; }
+td { border: 1px solid black; text-align: center; }
+!--></style>
+''')
+ + self.columnfraction_disaster (self.itemtab_disaster (string))
+ + self.texi_footer)
+ def itemtab_disaster (self, string):
+ return string.replace ('''item \n@tab ''', '''item
+''')
+ def columnfraction_disaster (self, string):
+ if False:
+ # nice trick for html-only
+ return string.replace ('@multitable', '@multitable @columnfractions 0 0 0 0 0 0 0 0 0 0')
+ tables = re.findall ('(?s)(@multitable)(.*?)(@item)', string)
+ for t in tables:
+ columns = len (re.findall ('(?s)(\n@tab)', t[1])) + 1
+ columnfractions = '@columnfractions ' + (' ' + str (1.0/columns)) * columns
+ string = string.replace ('@multitable\n',
+ '@multitable %(columnfractions)s\n' % locals (), 1)
+ return string
+ def entity (self, name, string='', attributes=[]):
+ return '''
+@%(name)s
+%(string)s
+@end %(name)s''' % locals ()
+ def paragraph (self, string=''):
+ return '''
+%(string)s''' % locals ()
+ def table (self, string):
+ # Ugh, makeinfo is fine without @columnfractions
+ # but texi2html 1.82 barfs: `empty multicolumn'
+ return (self.entity ('multitable', string))
+ def headrow (self, string, attributes=[]):
+ return '''
+@headitem ''' + string
+ def row (self, string, attributes=[]):
+ return '''
+@item ''' + string
+ def cell (self, string='', attributes=[]):
+ return '''
+@tab ''' + string
+ headcell = cell
+ def newline (self):
+ return '''
+@*
+'''
+ def html (self, string):
+ return self.entity ('ifhtml', self.entity ('html', string))
+ def nothtml (self, string):
+ return self.entity ('ifnothtml', string)
+ def span (self, string, attributes=[]):
+ return (self.html (HTMLMarkup ().span (string, attributes))
+ + self.nothtml (string))
+ def small (self, string, attributes=[]):
+ return (self.html (HTMLMarkup ().small (string, attributes))
+ + self.nothtml (string))
+ def command (self, name, string):
+ return '@%(name)s{%(string)s}' % locals ()
+ def emph (self, string, attributes=[]):
+ return self.command ('emph', string)
class TelyDocument (object):
def __init__ (self, filename):
self.contents = 'GIT committish: 0'
if os.path.exists (filename):
self.contents = open (filename).read ()
- self.top = os.path.splitext (filename)[1] in ['.tely', '.texi']
## record title and sectionning level of first Texinfo section
self.sectioning = 'unnumbered'
self.title = 'Untitled'
if m:
self.sectioning = m.group (1)
self.title = m.group (2)
- # This is all quite ugly and hairy. The original code worked
- # with @top node detection and each manual had its own @top
- # node. Not any more. Declaring .tely / .texi files to be
- # @top sort of works...
- if self.top:
- self.sectioning = 'top'
- self.level = texi_level [self.sectioning]
if not hasattr (self, 'language'):
self.language = ''
for t in include_re.findall (self.contents)]
self.included_files = [p for p in included_files if os.path.exists (p)]
+ def get_level (self):
+ return texi_level [self.sectioning]
+
def print_title (self, section_number):
+ if not hasattr (self, 'level'):
+ self.level = self.get_level ()
return section_number.increase (self.level) + self.title
and (not self.translators or not self.translators[0])
and not 'macros.itexi' in self.filename):
error (self.filename + ''': error: no translator name found
-please specify one ore more lines in the master file
-@c Translator: FirstName LastName[, FirstName LastName]..''')
+ please specify one ore more lines in the master file
+ @c Translator: FirstName LastName[, FirstName LastName]..''')
self.checkers = []
m = checkers_re.findall (self.contents)
if m:
setting to %d %%" % (self.filename, self.uptodate_percentage, alternative))
self.uptodate_percentage = alternative
+ def get_level (self):
+ return texi_level ['top']
+
def completeness (self, formats=['long'], translated=False):
if translated:
translation = self.translation
else:
return self.translation (format_table['pre-GDP'])
- def short_texi_status (self):
- s = ' <td title="%(filename)s">' % self.__dict__
+ def short_texi_status (self, markup):
+ s = ''
if self.partially_translated:
- s += '<br>\n '.join (self.translators) + '<br>\n'
+ s += markup.newline ().join (self.translators + [''])
if self.checkers:
- s += ' <small>' + \
- '<br>\n '.join (self.checkers) + '</small><br>\n'
-
+ s += markup.newline ().join ([markup.small (x) for x in self.checkers + ['']])
c = self.completeness (['color', 'long'])
- s += ' <span style="background-color: #%(color)s">\
-%(long)s</span><br>\n' % c
-
+ s += markup.span ('%(long)s' % c, [('style', 'background-color: #%(color)s' % c)])
+ s += markup.newline ()
if self.partially_translated:
u = self.uptodateness (['vague', 'color'])
- s += ' <span style="background-color: #%(color)s">\
-%(vague)s</span><br>\n' % u
-
- s += ' </td>\n'
- return s
+ s += markup.span ('%(vague)s' % u, [('style', 'background-color: #%(color)s' % u)])
+ return markup.cell (s, [('title', filename)])
def text_status (self):
s = self.completeness ('abbr')['abbr'] + ' '
-
if self.partially_translated:
s += self.uptodateness ('abbr')['abbr'] + ' '
return s
- def texi_status (self, numbering=SectionNumber ()):
- if self.title == 'Untitled':
- return ''
-
- if self.top:
- s = '''<table align="center" border="2">
- <tr align="center">
- <th>%s</th>''' % self.print_title (numbering)
- s += ''.join ([' <th>%s</th>\n' % self.translation (h)
- for h in detailed_status_heads])
- s += ' </tr>\n'
- s += (' <tr align="left">\n <td title="%%(filename)s">%s<br>(%d)</td>\n'
- % (self.translation (section_titles_string),
- sum (self.masterdocument.word_count))) % self.__dict__
-
- else:
- s = (' <tr align="left">\n <td title="%%(filename)s">%s<br>(%d)</td>\n'
- % (self.print_title (numbering),
- sum (self.masterdocument.word_count))) % self.__dict__
-
+ def texi_status (self, markup, numbering=SectionNumber ()):
+ return (markup.table (
+ markup.headrow (
+ (markup.headcell (self.print_title (numbering))
+ + ''.join ([markup.headcell (self.translation (h))
+ for h in detailed_status_heads])),
+ [('align', 'center')])
+ + markup.row (
+ (markup.cell ((self.translation (section_titles_string)
+ + markup.newline ()
+ + '%d' % sum (self.masterdocument.word_count)),
+ [('title',filename)])
+ + self.texi_body (markup, numbering)),
+ [('align','left')])
+ + self.texi_translations (markup, numbering))
+ ) + markup.paragraph ()
+
+ def texi_body (self, markup, numbering):
+ return (self.texi_translators (markup)
+ + self.texi_completeness (markup)
+ + self.texi_uptodateness (markup)
+ + self.texi_gdp (markup))
+
+ def texi_translators (self, markup):
if self.partially_translated:
- s += ' <td>' + '<br>\n '.join (self.translators) + '</td>\n'
- s += ' <td>' + '<br>\n '.join (self.checkers) + '</td>\n'
- else:
- s += ' <td></td>\n' * 2
+ return (markup.cell (markup.newline ().join (self.translators))
+ + markup.cell (markup.newline ().join (self.checkers)))
+ return markup.cell () + markup.cell ()
+ def texi_completeness (self, markup):
c = self.completeness (['color', 'short'], translated=True)
- s += ' <td><span style="background-color: #%(color)s">\
-%(short)s</span></td>\n' % {'color': c['color'],
- 'short': c['short']}
+ return markup.cell (markup.span (c['short'],
+ [('style', 'background-color: #' + c['color'])]))
+ def texi_uptodateness (self, markup):
if self.partially_translated:
u = self.uptodateness (['short', 'color'], translated=True)
- s += ' <td><span style="background-color: #%(color)s">\
-%(short)s</span></td>\n' % {'color': u['color'],
- 'short': u['short']}
- else:
- s += ' <td></td>\n'
-
- s += ' <td>' + self.gdp_status () + '</td>\n </tr>\n'
- s += ''.join ([i.translations[self.language].texi_status (numbering)
- for i in self.masterdocument.includes
- if self.language in i.translations])
-
- if self.top:
- s += '</table>\n<p></p>\n'
- return s
+ return markup.cell (markup.span (u['short'],
+ [('style', 'background-color: #' + u['color'])]))
+ return markup.cell ()
+
+ def texi_gdp (self, markup):
+ return markup.cell (self.gdp_status ())
+
+ def texi_translations (self, markup, numbering):
+ return ''.join ([i.translations[self.language].texi_status (markup, numbering)
+ for i in self.masterdocument.includes
+ if self.language in i.translations])
+
+class IncludedTranslatedTelyDocument (TranslatedTelyDocument):
+ get_level = TelyDocument.get_level
+ def texi_status (self, markup, numbering=SectionNumber ()):
+ if self.title != 'Untitled':
+ return (markup.row (
+ (markup.cell ((
+ self.print_title (numbering)
+ + markup.newline ()
+ + '%d' % sum (self.masterdocument.word_count)),
+ [('title',filename)])
+ + self.texi_body (markup, numbering)),
+ [('align','left')])
+ + self.texi_translations (markup, numbering))
+ return ''
class UntranslatedTelyDocument (TranslatedTelyDocument):
def __init__ (self, filename, masterdocument, parent_translation=None):
self.language = filename[:2]
TranslatedTelyDocument.__init__ (self, filename, masterdocument, parent_translation)
+class IncludedUntranslatedTelyDocument (UntranslatedTelyDocument, IncludedTranslatedTelyDocument):
+ get_level = TelyDocument.get_level
+
class MasterTelyDocument (TelyDocument):
def __init__ (self,
filename,
self.size = len (self.contents)
self.word_count = tely_word_count (self.contents)
self.translations = {}
- found = {}
- translations = dict ([(lang, os.path.join (lang, filename))
- for lang in langdefs.LANGDICT])
+ self.includes = []
if not self.language or self.language == 'en':
languages = [x for x in parent_translations.keys () if x != 'en']
- for lang in languages:
- self.translations[lang] = self.translated_factory (translations[lang],
- parent_translations.get (lang))
- found[lang] = not isinstance (self.translations[lang], UntranslatedTelyDocument)
- if self.top:
- for lang in [x for x in langdefs.LANGDICT if x and x != 'en']:
- if not found.get (lang, False):
- del self.translations[lang]
-
- if self.translations:
- self.includes = [MasterTelyDocument (f, self.translations)
- for f in self.included_files]
- else:
- self.includes = []
+ self.translations = dict ([x for x in
+ [(lang, self.translated_factory (os.path.join (lang, self.filename),
+ parent_translations.get (lang)))
+ for lang in languages]
+ if x[1]])
+ if self.translations:
+ self.includes = [IncludedMasterTelyDocument (f, self.translations)
+ for f in self.included_files]
+
+ def get_level (self):
+ return texi_level ['top']
def translated_factory (self, filename, parent):
if os.path.exists (filename):
return TranslatedTelyDocument (filename, self, parent)
- else:
- return UntranslatedTelyDocument (filename, self, parent)
+ return None
def update_word_counts (self, s):
s = update_word_count (s, self.filename, sum (self.word_count))
s = i.update_word_counts (s)
return s
- def texi_status (self, numbering=SectionNumber ()):
- if self.title == 'Untitled' or not self.translations:
- return ''
- if self.top:
- s = '''<table align="center" border="2">
- <tr align="center">
- <th>%s</th>''' % self.print_title (numbering)
- s += ''.join ([' <th>%s</th>\n' % l for l in sorted (self.translations.keys ())])
- s += ' </tr>\n'
- s += (' <tr align="left">\n <td title="%%(filename)s">Section titles<br>(%d)</td>\n'
- % sum (self.word_count)) % self.__dict__
-
- else: # if self is an included file
- s = (' <tr align="left">\n <td title=%%(filename)s>%s<br>(%d)</td>\n'
- % (self.print_title (numbering), sum (self.word_count))) % self.__dict__
-
- s += ''.join ([self.translations[k].short_texi_status ()
- for k in sorted (self.translations.keys ())])
- s += ' </tr>\n'
- s += ''.join ([i.texi_status (numbering) for i in self.includes])
-
- if self.top:
- s += '</table>\n<p></p>\n'
+ def texi_status (self, markup, numbering=SectionNumber ()):
+ return markup.table (
+ (markup.headrow (
+ (markup.headcell (self.print_title (numbering))
+ + ''.join ([markup.headcell (l) for l in sorted (self.translations.keys ())])),
+ [('align','center')])
+ + markup.row (
+ (markup.cell (('Section titles'
+ + markup.newline ()
+ + '(%d)' % sum (self.word_count)),
+ [('title',filename)])
+ + self.texi_body (markup, numbering)),
+ [('align','left')])
+ + self.texi_includes (markup, numbering)
+ )) + markup.paragraph ()
+
+ def texi_includes (self, markup, numbering):
+ return ''.join ([i.texi_status (markup, numbering) for i in self.includes])
+
+ def texi_body (self, markup, numbering):
+ return ''.join ([self.translations[k].short_texi_status (markup)
+ for k in sorted (self.translations.keys ())])
+
+ def text_status (self, markup, numbering=SectionNumber (), colspec=[48,12]):
+ s = (self.print_title (numbering) + ' ').ljust (colspec[0])
+ s += ''.join (['%s'.ljust (colspec[1]) % l
+ for l in sorted (self.translations.keys ())])
+ s += '\n'
+ s += ('Section titles (%d)' % \
+ sum (self.word_count)).ljust (colspec[0])
+ s += self.text_body (markup, numbering, colspec)
+ s += '\n'
return s
- def text_status (self, numbering=SectionNumber (), colspec=[48,12]):
- if self.title == 'Untitled' or not self.translations:
- return ''
+ def text_body (self, markup, numbering, colspec):
+ return (''.join ([self.translations[k].text_status ().ljust(colspec[1])
+ for k in sorted (self.translations.keys ())])
+ + '\n\n'
+ + ''.join ([i.text_status (markup, numbering) for i in self.includes]))
- s = ''
- if self.top:
- s += (self.print_title (numbering) + ' ').ljust (colspec[0])
- s += ''.join (['%s'.ljust (colspec[1]) % l
- for l in sorted (self.translations.keys ())])
- s += '\n'
- s += ('Section titles (%d)' % \
- sum (self.word_count)).ljust (colspec[0])
+class IncludedMasterTelyDocument (MasterTelyDocument):
+ get_level = TelyDocument.get_level
- else:
- s = '%s (%d) ' \
- % (self.print_title (numbering), sum (self.word_count))
- s = s.ljust (colspec[0])
-
- s += ''.join ([self.translations[k].text_status ().ljust(colspec[1])
- for k in sorted (self.translations.keys ())])
- s += '\n\n'
- s += ''.join ([i.text_status (numbering) for i in self.includes])
-
- if self.top:
- s += '\n'
- return s
+ def translated_factory (self, filename, parent):
+ if os.path.exists (filename):
+ return IncludedTranslatedTelyDocument (filename, self, parent)
+ return IncludedUntranslatedTelyDocument (filename, self, parent)
+
+ def texi_status (self, markup, numbering=SectionNumber ()):
+ if self.title != 'Untitled':
+ return (markup.row (
+ (markup.cell ((self.print_title (numbering)
+ + markup.newline ()
+ + '(%d)' % sum (self.word_count)),
+ [('title',filename)])
+ + self.texi_body (markup, numbering)),
+ [('align','left')])
+ + self.texi_includes (markup, numbering))
+ return ''
+
+ def text_status (self, markup, numbering=SectionNumber (), colspec=[48,12]):
+ if self.title != 'Untitled':
+ return (self.print_title (numbering)
+ + '(%d)' % sum (self.word_count)
+ + self.text_body (markup, numbering, colspec)
+ ).ljust (colspec[0])
+ return ''
update_category_word_counts_re = re.compile (r'(?ms)^-(\d+)-(.*?\n)\d+ *total')
date_time = buildlib.read_pipe ('LANG= date -u')[0]
-main_status_body = last_updated_string % date_time
-main_status_body += '\n'.join ([doc.texi_status () for doc in master_docs])
-
-texi_header = '''@c -*- coding: utf-8; mode: texinfo; -*-
-@c This file was generated by translation-status.py -- DO NOT EDIT!
-@ignore
- Translation of GIT committish: 0
-@end ignore
-
-@ifnothtml
-Translation status currently only available in HTML.
-@end ifnothtml
-@ifhtml
-@html
-'''
-
-texi_footer = '''
-@end html
-@end ifhtml
-'''
+# TEXI output sort of works
+# TODO: table border, td-titles :-)
+# markup = HTMLMarkup ()
+#sys.stderr.write ('''translations-status.py:713: warning: using markup = HTMLMarkup (): HTML only\n''')
+markup = TexiMarkup ()
+sys.stderr.write ('''translations-status.py:717: warning: using markup = TexiMarkup (): ugly HTML
+ output, questionable PDF and info output.
+ Consider using HTML-only markup = HTMLMarkup ()\n''')
-main_status_page = texi_header % locals () + main_status_body + texi_footer
+main_status_body = markup.paragraph (markup.emph (last_updated_string % date_time))
+main_status_body += '\n'.join ([doc.texi_status (markup) for doc in master_docs])
+main_status_page = markup.texi (main_status_body)
open ('translations.itexi', 'w').write (main_status_page)
for l in enabled_languages:
date_time = buildlib.read_pipe ('LANG=%s date -u' % l)[0]
- updated = translation[l] (last_updated_string) % date_time
- texi_status = '\n'.join ([doc.translations[l].texi_status ()
+ updated = markup.paragraph (markup.emph (translation[l] (last_updated_string) % date_time))
+ texi_status = '\n'.join ([doc.translations[l].texi_status (markup)
for doc in master_docs
if l in doc.translations])
- lang_status_page = texi_header + updated + texi_status + texi_footer
+ lang_status_page = markup.texi (updated + texi_status)
open (os.path.join (l, 'translations.itexi'), 'w').write (lang_status_page)
main_status_txt = '''Documentation translations status
''' % date_time
-main_status_txt += '\n'.join ([doc.text_status () for doc in master_docs])
+main_status_txt += '\n'.join ([doc.text_status (markup) for doc in master_docs])
status_txt_file = 'out/translations-status.txt'
progress ("Writing %s..." % status_txt_file)