Update Finnish translation
[nomnom.git] / doc / HowtoTranslate
blob33040a974de4208b198a4557dd70b66e8145cea9
2 HOWTO: Translate
3 ================
5 NOTES
7 If you are unsure where NomNom saves the config file, open the Preferences
8 (Ctrl+E) and choose "Options". The same info is also available in the About
9 dialog.
11   * You can set "qmShowPaths=true" in your config file to have NomNom dump
12   the qm search paths. They are printed to stderr in addition to displayed
13   in the "Select language" dialog.
15     [General]
16     qmShowPaths=true
18   * You can add an additional qm search path by adding "qmPath=$path" to your
19   config file, e.g.:
21     [General]
22     qmPath=/path/to/my/qmfiles
24   * The "About" dialog HTML content (containing the version information, etc.)
25   does not necessarily need to be translated, if you do however, consider
26   leaving the GPL for <http://www.gnu.org/licenses/translations.html>
29 CREATING NEW TRANSLATION
31 Checklist
33   1) Get the latest source code from <http://nomnom.sourceforge.net/>
35      - Please do not use the NomNom git repository code for this,
36      the development code is a subject to frequent changes
38   2) Install the required Qt tools, e.g. lupdate, lrelease, linguist
40 Get started
42   1) cd to the top source code dir
44   2) Run "mkdir tmp; cd tmp; cmake ..; mkdir tr"
46   3) Run "lupdate src/ i/ -ts tr/nomnom_$locale.ts"
47     e.g. "lupdate src/ i/ -ts tr/nomnom_fi.ts" # for Finnish
49   4) Edit (translate) the created tr/nomnom_$locale.ts file
50     e.g. linguist tr/nomnom_$locale.ts
52 Test translation
54   5) Run "make && mv nomnom_$locale.qm tr/ && ./nomnom"
56   Or, copy the produced qm file to one of the following paths:
58     $config_qmPath
59     `cwd`/tr
60     ~/.config/nomnom/tr/
61     ~/.local/share/nomnom/tr/
62     $CMAKE_INSTALL_PREFIX/share/nomnom/tr/
64   Alternatively, use linguist (File / Release).
66   6) Run "./nomnom".
67   
68     Skip if you have done this previously:
69         - Open Preferences / Options
70         - Click "Language..." and select the language
71         - Restart NomNom
73     Check that everything looks as it should.
75   7) Repeat steps 4-6 until you are happy with the results.
78 UPDATE EXISTING TRANSLATION
80 The existing strings may change sometimes. We are also constantly adding new
81 ones as the project evolves. This means that the translations must be updated
82 accordingly.
84 Checklist
85   * See "CREATING NEW TRANSLATION" and "Checklist" above
87 Get started
89   1) cd to the top source code dir
91   2) Run "lupdate -no-obsolete src/ i/ -ts tr/nomnom_$locale.ts"
93 Test the updated translation
95   See the steps 4-7 under "CREATING NEW TRANSLATION" and "Test translation"
96   above.
99 SUBMIT TRANSLATION
101 We can add your translation at the upstream to the distribution.
102 Open a new ticket to the Feature tracker at:
103     <http://sourceforge.net/projects/nomnom/support/>
105 And submit your ts file.
106 Thanks!