new file for translator information

git-svn-id: svn://localhost/ardour2/branches/3.0@9450 d708f5d6-7413-0410-9779-e7cbd77b26cf

1 files changed, 51 insertions, 0 deletions

diff --git a/TRANSLATORS b/TRANSLATORS
new file mode 100644
index 0000000000..b54095848c
--- /dev/null
+++ b/TRANSLATORS
@@ -0,0 +1,51 @@
+Ardour User Interface Translation How-To
+
+Ardour's user interface can be translated into many languages. For this the application uses gettext engine. It works like this: there is a plain text editable PO file for every language that contains a number of sequences like: a line in English, a line in target language and a reference to a line in source code where original text in English comes from. The build system then creates a binary version of each PO file with MO file extension and places it in a system directory where running instance of Ardour will pick and use it.
+
+Ardour has two main PO files to translate: for user interface and for Ardour's library. Some messages from the library are actually passed to user interface (various warnings, for example), so ideally you have to translate both. For example, Russian translation is located here:
+
+gtk_ardour/po/ru.po
+libs/ardour/po/ru.po
+
+Every PO file's name is a two-character code, e.g. de for German, es for Spanish and so on. However it's fairly common to have localizations for local versions of a language, e.g. pt_BR would stand for Brazilian Portuguese, and es_MX would stand for Mexican Spanish. Please refer to ISO language code table for details.
+
+Here is the best workflow for existing translations.
+
+1. Build Ardour  using './waf' command
+2. Run './waf i18n'. This will update all existing translations
+3. Open a PO file in you PO editor of choice (see below)
+4. Open Ardour, find something untranslated, locate this phrase in PO file, translate 
+5. Repeat previous step several times, save the PO file
+6. In gtk_ardour/po/ run 'msgfmt -o gtk2_ardour.mo LANG.po' where LANG.po is your PO file
+7. Run 'sudo cp gtk2_ardour.mo /usr/local/share/locale/LANG/LC_MESSAGES/' where LANG is two- or four letter code (see above)
+8. Restart Ardour to see what your translation looks like and whether it needs fixes, e.g. has to be shorter
+
+When you are done, save the file and submit it to the tracker.
+
+There are some more things you need to know.
+
+1. Where does a phrase come from?
+
+Often when you go through translation hunting for untranslated messagesm you stumble upon things you have no idea where they come from. To assist you there most advanced PO editors have means to tell you which source code file it comes from, or, in some cases, even show the context in source code. Ardour has pretty much meaningful names for source code files, so it should help. If it doesn't, ask on IRC for help.
+
+2. Variables
+
+You will often meet things like "%1" or "%2" in translation. This is a variable that should be left intact. Here is an example:
+
+"Cannot load XML for session from %1"
+
+When Ardour runs, this "%1" will be substituted with "Ardour" so that the whole phrase will be "Cannot load XML for session from Ardour". If Mixbus runs, this will be "Cannot load XML for session from Mixbus" instead. You get the idea. So just place this variable in your translation in a way that makes the phrase sound natural in your language and make sure you know where the phrase comes from (see above) so that you know how to translate it correctly.
+
+3. Plural forms
+
+English has two plural forms, but many other languages have three and even four plural forms. Some parts of Ardour's code respect that, but some not (check for existing bug reports). A PO editor usually simplifies translating every plural form by putting every plural form into a dedicated tab.
+
+4. PO editors
+
+It's really up to you which PO editor you choose. These ones are most popular:
+
+poEdit. It works on Linux, Mac and Windows. The user interface is fairly simple. 
+
+Lokalize. Part of KDE desktop environment. It's a fairly advanced translation tool.
+
+GTranslator. Usually considered as GNOME translation tool, but has very few actual GNOME dependencies. Feature-wise it's someewhere between poEdit and Lokalize.
\ No newline at end of file