summaryrefslogtreecommitdiff
path: root/docs/dev/internationalization.rst
diff options
context:
space:
mode:
authorTomás Touceda <chiiph@leap.se>2013-03-06 15:27:23 -0300
committerTomás Touceda <chiiph@leap.se>2013-03-06 15:27:23 -0300
commit5ff29dc57e2877a14e705d09b7042cddf4165d0a (patch)
tree18e5817a105f0aaa7a9a752f7b644e44a6c867bc /docs/dev/internationalization.rst
parente23553caaf93a734578b02f9130dee38161d0e22 (diff)
Remove everything to start from scratch
Diffstat (limited to 'docs/dev/internationalization.rst')
-rw-r--r--docs/dev/internationalization.rst117
1 files changed, 0 insertions, 117 deletions
diff --git a/docs/dev/internationalization.rst b/docs/dev/internationalization.rst
deleted file mode 100644
index 1a9af0be..00000000
--- a/docs/dev/internationalization.rst
+++ /dev/null
@@ -1,117 +0,0 @@
-.. _i18n:
-
-Internationalization
-====================
-
-This part of the documentation covers the localization and translation of LEAP Client.
-Because we want to *bring fire to the people*, in as many countries and languages as possible.
-
-Translating the LEAP Client PyQt Application
---------------------------------------------
-
-.. raw:: html
-
- <div><a target="_blank" style="text-decoration:none; color:black; font-size:66%" href="https://www.transifex.com/projects/p/leap-client/resource/leap-client/" title="See more information on Transifex.com">Top translations: leap-client » leap-client</a><br/><img border="0" src="https://www.transifex.com/projects/p/leap-client/resource/leap-client/chart/image_png"/><br/><a target="_blank" href="https://www.transifex.com/"><img border="0" src="https://ds0k0en9abmn1.cloudfront.net/static/charts/images/tx-logo-micro.646b0065fce6.png"/></a></div>
-
-
-For translators
-^^^^^^^^^^^^^^^
-.. note::
- We should probably move the translators info to a top level section of the docs, and leave this
- as internal notes.
-
-
-We are using `transifex <http://transifex.com/projects/p/leap-client>`_ to coordinate translation efforts. If you want to contribute, just sign up there and ...
-
-.. note::
- ... and what??
-
-For devs: i18n conventions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. note::
- should say something about our special cases (provider labels and exceptions) when we get decision about it.
-
-Refer to `pyqt documentation <http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/i18n.html>`_.
-
-tl;dr;::
-
- self.tr('your string')
-
-for any string that you want to be translated, as long as the instance derives from ``QObject``.
-
-If you have to translate something that it is not a ``QObject``, use the magic leap ``translate`` method:
-
-
-.. code-block:: python
-
- from leap.util.translations import translate
-
- class Foo(object):
- bar = translate(<Context>, <string>, <comment>)
-
-
-.. Note about this: there seems to be some problems with the .tr method
- so the translate method could actually be the preferred thing in all the cases.
- Still missing what to do for language labels (json-based).
- --kali
-
-For i18n maintainers
-^^^^^^^^^^^^^^^^^^^^
-
-You need ``pylupdate4`` and ``lrelease`` for these steps. To get it, in debian::
-
- $ apt-get install pyqt4-dev-tools qt4-linguist-tools
-
-If you do not already have it, install the ``transifex-client`` from the cheese shop::
-
- pip install transifex-client
-
-You can learn more about the transifex-client `here <http://help.transifex.com/features/client/index.html>`_.
-
-**1.** Add any new source files to the project file, ``data/leap_client.pro``. *We should automate this with some templating, it's tedious.*
-
-**2.** Update the source .ts file ``data/ts/en_US.ts``.::
-
- $ make translations
-
-**3.** Push source .ts file to transifex::
-
- $ tx push -s
-
-**4.** Let the translation fairies do their work...
-
-**5.** *Et voila!* Get updated .ts files for each language from ``Transifex``. For instance, to pull updated spanish translations::
-
- $ tx pull -l es
- Pulling new translations for resource leap-client.leap-client (source: data/ts/en_US.ts)
- -> es: data/translations/es.ts
- Done.
-
-
-Note that there is a configuration option in ``.tx/config`` for setting the minimum completion percentage needed to be able to actually pull a resource.
-
-**6.** Generate .qm files from the updated .ts files::
-
- $ make translations
-
-and yes, it's the same command than in step 2. One less thing to remember :)
-
-**7.** Check that the .qm for the language you're working with is listed in ``data/resources/locale.qrc`` file. That should take the translated files from ``data/translations``
-
-**8.** Re-generate ``src/leap/gui/locale_qrc``. This is the embedded resource file that we load in the main app entry point; and from where we load the data for the qt translator object::
-
- $ make resources
-
-If you want to try it, just set your LANG environment variable::
-
- $ LANG=es_ES leap-client
-
-
-Translating the Documentation
-------------------------------
-
-.. note::
- ...unfinished
-
-`translating sphinx docs <http://sphinx-doc.org/intl.html>`_