3d text tool - 'insert lorem' was crashing, also add this to the text menu.
[blender.git] / doc / python_api / examples / bpy.app.translations.py
1 """
2 Intro
3 -----
4
5 .. warning::
6    Most of this object should only be useful if you actually manipulate i18n stuff from Python.
7    If you are a regular addon, you should only bother about :const:`contexts` member,
8    and the :func:`register`/:func:`unregister` functions! The :func:`pgettext` family of functions
9    should only be used in rare, specific cases (like e.g. complex "composited" UI strings...).
10
11 | To add translations to your python script, you must define a dictionary formatted like that:
12 |    ``{locale: {msg_key: msg_translation, ...}, ...}``
13 | where:
14
15 * locale is either a lang iso code (e.g. ``fr``), a lang+country code (e.g. ``pt_BR``),
16   a lang+variant code (e.g. ``sr@latin``), or a full code (e.g. ``uz_UZ@cyrilic``).
17 * msg_key is a tuple (context, org message) - use, as much as possible, the predefined :const:`contexts`.
18 * msg_translation is the translated message in given language!
19
20 Then, call ``bpy.app.translations.register(__name__, your_dict)`` in your ``register()`` function, and \n"
21 ``bpy.app.translations.unregister(__name__)`` in your ``unregister()`` one.
22
23 The ``Manage UI translations`` addon has several functions to help you collect strings to translate, and
24 generate the needed python code (the translation dictionary), as well as optional intermediary po files
25 if you want some... See
26 `How to Translate Blender <http://wiki.blender.org/index.php/Dev:Doc/Process/Translate_Blender>`_ and
27 `Using i18n in Blender Code <http://wiki.blender.org/index.php/Dev:Source/Interface/Internationalization>`_
28 for more info.
29
30 Module References
31 -----------------
32
33 """