Merge lp:~mitya57/ubuntu-packaging-guide/translator-credits into lp:ubuntu-packaging-guide

[Dmitry Shachnev]

This branch adds:

- a script that generates a list of translators in .txt or .html formats;
- "Help translate" and "View the list of translators" links to the page bottom.

This should (hopefully) motivate new translators to take part in our project.

Using the script (it's written in Python 3.x, I'll port add-languages to Python 3 also later):

- ./debian/scripts/build-list-of-translators — will create output for supported languages (es and ru) in translators.txt;
- ./debian/scripts/build-list-of-translators -a — will create output for all languages;
- ./debian/scripts/build-list-of-translators -l lv -l ca — will create output for Latvian and Catalan languages.
- ./debian/scripts/build-list-of-translators -o translators.html — will create an HTML file on output. One should also copy style.css from debian/scripts/data to the directory containing that HTML file.

Running the script will print something like this to stdout:

Processing languages: vi ru sv nl sl te(s) ja mk de id it tr en_AU(s) zh_TW lv ca fr es kn(s) zh_HK pt_BR hr hu(s)

(s) means that the language is skipped because the translators list is not available;
(e) means that the given .po file doesn't exist.

This will actually work after first translations update, but I've put an example of generated page to http://people.ubuntu.com/~mitya57/ubuntu-packaging-guide-translators.html.

[lp:~mitya57/ubuntu-packaging-guide/translator-credits]

288. By Launchpad Translations on behalf of ubuntu-packaging-guide-team on 2013-02-16

Launchpad automatic translations update.

289. By Dmitry Shachnev on 2013-02-16

udd-merging.rst: remove reference, it was moved to udd-intro.rst

290. By Launchpad Translations on behalf of ubuntu-packaging-guide-team on 2013-02-17

Launchpad automatic translations update.

291. By Launchpad Translations on behalf of ubuntu-packaging-guide-team on 2013-02-18

Launchpad automatic translations update.

292. By Dmitry Shachnev on 2013-02-18

Fix header in po/de.po

293. By Dmitry Shachnev on 2013-02-18

* Add a script to build the list of translators, run it during build.
* Add "Help translate" and "View the list of translators" links to
  layout.html.
* Add a build-dependency on python3-polib, and also prefer python3-sphinx
  to not use two python stacks at the build time.

294. By Dmitry Shachnev on 2013-02-18

Update .pot file

[Dmitry Shachnev (mitya57)]

Pushed a cleaner patchset, it now installs translators.html along with .css to Sphinx's static directories.

[Daniel Holbach (dholbach)]

If you build this in current 'raring' do you also get something like this?

dh build --builddirectory=_build
   dh_testdir -O--builddirectory=_build
   dh_auto_configure -O--builddirectory=_build
   debian/rules override_dh_auto_build
make[1]: Entering directory `/tmp/buildd/ubuntu-packaging-guide-0.3.1'
make latexpdf
make[2]: Entering directory `/tmp/buildd/ubuntu-packaging-guide-0.3.1'
Compiling .mo files in po/es/LC_MESSAGES
sphinx-build -Dlanguage=es -b latex -d _build/doctrees . _build/latex/es
Running Sphinx v1.1.3
Making output directory...

Exception occurred:
  File "/usr/lib/python3/dist-packages/sphinx/cmdline.py", line 188, in main
    warningiserror, tags)
  File "/usr/lib/python3/dist-packages/sphinx/application.py", line 102, in __init__
    confoverrides or {}, self.tags)
  File "/usr/lib/python3/dist-packages/sphinx/config.py", line 216, in __init__
    exec(code, config)
  File "/tmp/buildd/ubuntu-packaging-guide-0.3.1/conf.py", line 50, in <module>
    head=open(changelog).readline()
  File "/usr/lib/python3.3/encodings/ascii.py", line 26, in decode
    return codecs.ascii_decode(input, self.errors)[0]
UnicodeDecodeError: 'ascii' codec can't decode byte 0xc5 in position 1262: ordinal not in range(128)

review: Needs Information

[Daniel Holbach (dholbach)]

That's with sphinx 1.1.3+dfsg-5ubuntu1.

[Daniel Holbach (dholbach)]

Apart from that the change looks great as it is.

[Daniel Holbach (dholbach)]

Building r291 seems to work fine.

[Dmitry Shachnev (mitya57)]

Looks like a side-effect of python-sphinx -> python3-sphinx change.
I'll investigate that tomorrow (writing from phone now), feel free to
revert that part for now.

[Dmitry Shachnev (mitya57)]

I can't reproduce the crash in the up-to-date raring pbuilder chroot. William Grant suggested me to try chroot from https://launchpad.net/api/devel/ubuntu/raring/i386, will do that later.

[Dmitry Shachnev (mitya57)]

Sorry, commented on wrong MP :(

[Daniel Holbach (dholbach)]

Ok, found the bug... it was easily fixed by:

=== modified file 'conf.py'
--- conf.py 2013-02-11 09:22:39 +0000
+++ conf.py 2013-02-19 10:42:03 +0000
@@ -11,7 +11,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.

-import sys, os, re, glob
+import sys, os, re, glob, codecs

 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -47,7 +47,7 @@

 changelog = "debian/changelog"
 if os.path.exists(changelog):
- head=open(changelog).readline()
+ head=codecs.open(changelog, mode='r', encoding='utf-8').readline()
     match = re.compile(".*\((.*)\).*").match(head)
     if match:
         version = match.group(1)

This was necessary because of "Dražen Lučanin" in debian/changelog. :-)

Pushed the fixed along with yours.

review: Approve

[Daniel Holbach (dholbach)]

A question: will translators.html be shipped in the packages?

[Dmitry Shachnev (mitya57)]

> A question: will translators.html be shipped in the packages?

Of course, it already is.

=== modified file '.bzrignore'
--- .bzrignore	2012-03-01 03:21:49 +0000
+++ .bzrignore	2013-02-18 12:37:22 +0000
@@ -2,3 +2,4 @@
 po/*
 !po/*.pot
 !po/*.po
+translators.html

=== modified file 'Makefile'
--- Makefile	2013-02-11 12:36:03 +0000
+++ Makefile	2013-02-18 12:37:22 +0000
@@ -44,8 +44,9 @@
 clean:
 	-rm -rf $(BUILDDIR)/* $(PODIR)/.doctrees \
 	$(foreach lang,$(LANGS),$(PODIR)/$(lang)/)
+	rm -f translators.html
 
-html: $(foreach lang,$(LANGS),html-$(lang))
+html: $(foreach lang,$(LANGS),html-$(lang)) translators.html
 	# Always build an English version, even if there are no .po files.
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	mv $(BUILDDIR)/html/ubuntu-packaging-guide/*html $(BUILDDIR)/html/
@@ -61,7 +62,7 @@
 	sed -i 's/ubuntu-packaging-guide\///g' $(BUILDDIR)/html/searchindex.js
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html"
-html-%: locale-%
+html-%: locale-% translators.html
 	$(SPHINXBUILD) -Dlanguage=$* -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html/$*
 	mv $(BUILDDIR)/html/$*/ubuntu-packaging-guide/*html $(BUILDDIR)/html/$*
 	mv $(BUILDDIR)/html/$*/_sources/ubuntu-packaging-guide/*.txt $(BUILDDIR)/html/$*/_sources/
@@ -77,16 +78,16 @@
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$*."
 
-dirhtml: $(foreach lang,$(LANGS),dirhtml-$(lang))
+dirhtml: $(foreach lang,$(LANGS),dirhtml-$(lang)) translators.html
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml/en
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml/en"
-dirhtml-%: locale-%
+dirhtml-%: locale-% translators.html
 	$(SPHINXBUILD) -Dlanguage=$* -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml/$*
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml/$*."
 
-singlehtml: $(foreach lang,$(LANGS),singlehtml-$(lang))
+singlehtml: $(foreach lang,$(LANGS),singlehtml-$(lang)) translators.html
 	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
 	mv $(BUILDDIR)/singlehtml/ubuntu-packaging-guide/*html  $(BUILDDIR)/singlehtml
 	sed -i 's/href="..\//href=".\//g' $(BUILDDIR)/singlehtml/index.html
@@ -95,7 +96,7 @@
 	sed -i 's/src="..\/_static/src=".\/_static/g' $(BUILDDIR)/singlehtml/index.html
 	@echo
 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml"
-singlehtml-%: locale-%
+singlehtml-%: locale-% translators.html
 	$(SPHINXBUILD) -Dlanguage=$* -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml/$*
 	mv $(BUILDDIR)/singlehtml/$*/ubuntu-packaging-guide/*html  $(BUILDDIR)/singlehtml/$*
 	sed -i 's/href="..\//href=".\//g' $(BUILDDIR)/singlehtml/$*/index.html
@@ -226,8 +227,10 @@
 
 gettext:
 	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(PODIR)/
-	sed -i '/^# [0-9a-f]\{32\}/d' $(PODIR)/ubuntu-packaging-guide.pot
-	@echo
+	@sed -i '/^# [0-9a-f]\{32\}/d' $(PODIR)/ubuntu-packaging-guide.pot
+	@echo "# Will be replaced with a list of translators" >> $(PODIR)/ubuntu-packaging-guide.pot
+	@echo "msgid \"translator-credits\"" >> $(PODIR)/ubuntu-packaging-guide.pot
+	@echo "msgstr \"\"" >> $(PODIR)/ubuntu-packaging-guide.pot
 	@echo "Build finished. The message catalogs are in $(PODIR)/."
 
 changes:
@@ -255,3 +258,5 @@
 	else echo "$*.po not available, skipping .mo building"; \
 	fi
 
+translators.html:
+	debian/scripts/build-list-of-translators -a -o translators.html

=== modified file 'conf.py'
--- conf.py	2013-02-11 09:22:39 +0000
+++ conf.py	2013-02-18 12:37:22 +0000
@@ -132,7 +132,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['_static', 'translators.html']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

=== modified file 'debian/changelog'
--- debian/changelog	2013-02-12 07:08:12 +0000
+++ debian/changelog	2013-02-18 12:37:22 +0000
@@ -11,6 +11,11 @@
     - Add a build-dependency on cm-super-minimal.
     - Disable times package when language is russian.
   * Update README and add some information for translators.
+  * Add a script to build the list of translators, run it during build.
+  * Add "Help translate" and "View the list of translators" links to
+    layout.html.
+  * Add a build-dependency on python3-polib, and also prefer python3-sphinx
+    to not use two python stacks at the build time.
 
   [ Daniel Holbach ]
   * Document where to find a list of required autopkgtests and where 

=== modified file 'debian/control'
--- debian/control	2013-02-11 07:46:42 +0000
+++ debian/control	2013-02-18 12:37:22 +0000
@@ -7,7 +7,8 @@
 Vcs-Browser: https://code.launchpad.net/~ubuntu-packaging-guide-team/ubuntu-packaging-guide/trunk
 Build-Depends: debhelper (>= 7.0.50~),
                doc-base,
-               python-sphinx (>= 1.1~),
+               python3-sphinx | python-sphinx (>= 1.1~),
+               python3-polib,
                texlive-fonts-recommended,
                texlive-latex-recommended,
                texlive-latex-extra,

=== added file 'debian/scripts/build-list-of-translators'
--- debian/scripts/build-list-of-translators	1970-01-01 00:00:00 +0000
+++ debian/scripts/build-list-of-translators	2013-02-18 12:37:22 +0000
@@ -0,0 +1,109 @@
+#!/usr/bin/python3
+
+# Builds a list in translators for the given languages
+# Run with "--help" to get more info
+# Author: Dmitry Shachnev <[e-mail]>, 2013
+
+import argparse
+import sys
+import fnmatch
+
+from os import listdir
+from os.path import exists, isfile, join, dirname
+
+try:
+    import polib
+except ImportError:
+    sys.exit("Error: you should have 'python3-polib' package installed.")
+
+def parse_translator_string(translator_string):
+    """Parses translator string and returns (name, url) tuple."""
+    name, url = translator_string.rsplit(' ', 1)
+    return name[2:], url
+
+def write_txt(translators, fname):
+    outputfile = open(fname, 'w')
+    outputfile.write('Ubuntu Packaging Guide translators\n')
+    outputfile.write('==================================\n')
+    for langname in sorted(translators):
+        outputfile.write('\n' + langname + ' language:\n')
+        for name, url in translators[langname]:
+            outputfile.write('  - ' + name + ' <' + url + '>\n')
+    outputfile.close()
+
+def write_html(translators, fname):
+    templatefile = open(join(dirname(__file__)  , 'data', 'template.html'))
+    template = templatefile.read()
+    templatefile.close()
+    content = '<h1>Ubuntu Packaging Guide translators</h1>'
+    for langname in sorted(translators):
+        langid = langname.lower().replace('(', '').replace(')', '').replace(' ', '-')
+        content += '\n<h2 id="' + langid + '">' + langname + ' language</h2>\n<ul>\n'
+        for name, url in translators[langname]:
+            content += '<li>' + name + ' &lt;<a href="' + url + '">'
+            content += url + '</a>&gt;\n'
+        content += '</ul>'
+    outputfile = open(fname, 'w')
+    outputfile.write(template.replace('%CONTENT%', content))
+    outputfile.close()
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-o', '--output-file', default='translators.txt',
+        help='file to save the output to (default: translators.txt)')
+    parser.add_argument('-a', '--all-languages', action='store_true',
+        help='output for all languages (not just accepted ones)')
+    parser.add_argument('-l', '--language', action='append',
+        help='output for the given language (can be set multiple times)')
+    args = parser.parse_args()
+
+    languages = None
+    working_dir = '.'
+    if not exists('po'):
+        working_dir = join('..', '..')
+    if not exists(join(working_dir, 'po')):
+        sys.exit('Error: "po" directory not found!')
+
+    if args.all_languages:
+        pofiles = fnmatch.filter(listdir(join(working_dir, 'po')), '*.po')
+        languages = [fname[:-3] for fname in pofiles]
+    elif args.language:
+        languages = args.language
+    else:
+        if isfile(join(working_dir, 'Makefile')):
+            makefile = open(join(working_dir, 'Makefile'))
+        else:
+            sys.exit('Error: Makefile not found!')
+        for line in makefile:
+            if line.startswith('LANGS = '):
+                languages = line.split()[2:]
+        makefile.close()
+        if not languages:
+            sys.exit('Error: no LANGS set in Makefile!')
+
+    translators = {}
+    sys.stdout.write('Processing languages:')
+    sys.stdout.flush()
+    for language in languages:
+        sys.stdout.write(' ' + language)
+        sys.stdout.flush()
+        if not isfile(join(working_dir, 'po', language+'.po')):
+            sys.stdout.write('(e)')
+            continue
+        pofile = polib.pofile(join(working_dir, 'po', language+'.po'))
+        langname = pofile.header[:pofile.header.find('translation')-1]
+        for entry in pofile:
+            if entry.msgid == 'translator-credits' and entry.msgstr:
+                translators[langname] = map(parse_translator_string,
+                    entry.msgstr.split('\n')[1:])
+        if langname not in translators:
+            sys.stdout.write('(s)')
+
+    if args.output_file.endswith('.html'):
+        write_html(translators, args.output_file)
+    else:
+        write_txt(translators, args.output_file)
+    print('\nOutput written as', args.output_file)
+
+if __name__ == '__main__':
+    main()

=== added directory 'debian/scripts/data'
=== added file 'debian/scripts/data/template.html'
--- debian/scripts/data/template.html	1970-01-01 00:00:00 +0000
+++ debian/scripts/data/template.html	2013-02-18 12:37:22 +0000
@@ -0,0 +1,27 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
+<html>
+<head>
+<meta http-equiv="content-type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="translators.css">
+<title>Ubuntu Packaging Guide translators</title>
+</head>
+<body>
+<table class="page-areas">
+<tr class="area-toppanel">
+<td>
+<div class="toppanel">
+<a href="http://developer.ubuntu.com/" class="dev-link">
+<img src="images/logo-ubuntu.png" alt="Ubuntu logo">
+developer
+</a>
+</div>
+</td>
+</tr>
+<tr class="area-content"><td>
+<div class="content">
+%CONTENT%
+</div>
+</td></tr>
+</table>
+</body>
+</html>

=== modified file 'po/ubuntu-packaging-guide.pot'
--- po/ubuntu-packaging-guide.pot	2013-02-12 07:08:12 +0000
+++ po/ubuntu-packaging-guide.pot	2013-02-18 12:37:22 +0000
@@ -8,7 +8,7 @@
 msgstr ""
 "Project-Id-Version: ubuntu-packaging-guide 0.3.1\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2013-02-12 11:02\n"
+"POT-Creation-Date: 2013-02-18 16:29\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[e-mail]>\n"
@@ -2706,7 +2706,7 @@
 msgid "If you are merging an upstream release into an existing Bazaar branch that has not previously used the UDD layout, ``bzr merge-upstream`` will fail with an error that the tag for the previous upstream version is not available; the merge can't be completed without knowing what base version to merge against. To work around this, create a tag in your existing repository for the last upstream version present there; e.g., if the last Ubuntu release was *1.1-0ubuntu3*, create the tag *upstream-1.1* pointing to the bzr revision you want to use as the tip of the upstream branch."
 msgstr ""
 
-#: ../ubuntu-packaging-guide/udd-merging.rst:122
+#: ../ubuntu-packaging-guide/udd-merging.rst:121
 msgid "You will need newer versions of ``bzr`` and the ``bzr-builddeb`` for the ``merge`` command to work.  Use the versions from Ubuntu 12.04 (Precise) or the development versions from the ``bzr`` PPA.  Specifically, you need ``bzr`` version 2.5 beta 5 or newer, and ``bzr-builddeb`` version 2.8.1 or newer.  For older versions, use the ``bzr merge-package`` command instead."
 msgstr ""
 
@@ -3006,3 +3006,6 @@
 msgid "Once you've got the source package, you can build it as normal with ``pbuilder-dist`` (or ``pbuilder`` or `sbuild`_)."
 msgstr ""
 
+# Will be replaced with a list of translators
+msgid "translator-credits"
+msgstr ""

=== modified file 'themes/ubuntu/layout.html'
--- themes/ubuntu/layout.html	2012-12-24 14:32:47 +0000
+++ themes/ubuntu/layout.html	2013-02-18 12:37:22 +0000
@@ -206,6 +206,9 @@
         src="{{ pathto('_static/images/cc-by-sa.png', 1) }}" /></a>
       {%- endif %}
     {%- endif %}
+    <br />
+    <a href="http://people.ubuntu.com/~mitya57/ubuntu-packaging-guide-readme.html#translating">Help translate</a> or
+    <a href="{{ pathto('_static/translators.html', 1) }}">view the list of translators</a>.
 
   </div>
 </footer>

=== added file 'themes/ubuntu/static/translators.css'
--- themes/ubuntu/static/translators.css	1970-01-01 00:00:00 +0000
+++ themes/ubuntu/static/translators.css	2013-02-18 12:37:22 +0000
@@ -0,0 +1,72 @@
+/* Main stylesheet, adopted from WpGen default theme. */
+/* Author: Dmitry Shachnev <[e-mail]>, 2013 */
+
+body {
+  color: #222;
+  background: url("images/background-footer.png")
+  repeat scroll 0 0 #f7f6f5;
+  margin: 0px;
+  font-family: "Ubuntu";
+}
+
+a {
+  color: #dd4814;
+  text-decoration: none;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+a.dev-link:hover {
+  text-decoration: none;
+}
+
+.page-areas {
+  width: 100%;
+  height: 100%;
+  top: 0px;
+  bottom: 0px;
+}
+
+.page-areas td {
+  padding-left: 5px;
+  padding-right: 5px;
+}
+
+.area-toppanel {
+  height: 50px;
+  background-color: white;
+  font-size: 130%;
+}
+
+.area-toppanel td {
+  border-bottom: 2px solid #dd4814;
+}
+
+.area-content {
+  height: 100%;
+}
+
+.content {
+  background-color: white;
+  border: 1px solid #f96;
+  border-radius: 0.5em;
+  padding: 0.5em;
+  padding-top: 0em;
+  height: 100%;
+}
+
+.content, .toppanel {
+  margin: 0px auto;
+  max-width: 800px;
+}
+
+/* Fonts */
+
+@font-face {
+  font-family: 'Ubuntu';
+  font-style: normal;
+  font-weight: 400;
+  src: local('Ubuntu'), url(https://themes.googleusercontent.com/static/fonts/ubuntu/v4/_xyN3apAT_yRRDeqB3sPRg.woff) format('woff');
+}