Mercurial > pidgin.yaz
annotate doc/plugin-i18n.dox @ 27826:5f9ca519ea9f
propagate from branch 'im.pidgin.pidgin' (head 90011f8844f95be26206d5698b603f1692f319a0)
to branch 'im.pidgin.pidgin.yaz' (head e4862d866bc0b147e783d27c1faa51f1d3e0b58a)
author | Yoshiki Yazawa <yaz@honeyplanet.jp> |
---|---|
date | Thu, 24 Apr 2008 02:28:24 +0000 |
parents | 901cbc91db27 |
children |
rev | line source |
---|---|
13400 | 1 /** @page plugin-i18n Third Party Plugin Translation Support |
2 | |
3 @section Introduction | |
21711
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
4 For the purpose of this document we're going to assume that your plugin: |
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
5 |
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
6 - Is set up to use autotools. It may be possible to add translation support |
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
7 without autotools, but we have no idea how. We may not want to know, either ;) |
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
8 - Has an autogen.sh. You may have also called this bootstrap.sh or similar. |
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
9 - Resides in a source tree that has @c configure.ac and @c Makefile.am in the |
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
10 top-level directory as well as a @c src directory in which the plugin's source |
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
11 is located. A @c Makefile.am should also exist in the @c src directory. |
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
12 |
13400 | 13 For a plugin to have translation support there are a few steps that need to |
14 followed: | |
15 | |
21711
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
16 - In your autogen.sh, add the following after your other utility checks: |
13400 | 17 @code |
18 (intltoolize --version) < /dev/null > /dev/null 2>&1 || { | |
19 echo; | |
20 echo "You must have intltool installed to compile <YOUR PLUGIN NAME>"; | |
21 echo; | |
22 exit; | |
23 } | |
24 @endcode | |
21711
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
25 Then before your call to aclocal add: |
13400 | 26 @code |
27 intltoolize --force --copy | |
28 @endcode | |
21711
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
29 - Now edit configure.ac and add the following: |
13400 | 30 @code |
31 AC_PROG_INTLTOOL | |
32 | |
33 GETTEXT_PACKAGE=<YOUR PLUGIN NAME> | |
34 AC_SUBST(GETTEXT_PACKAGE) | |
35 AC_DEFINE_UNQUOTED(GETTEXT_PACKAGE, ["$GETTEXT_PACKAGE"], [Define the gettext package to be used]) | |
36 | |
37 ALL_LINGUAS="" | |
38 AM_GLIB_GNU_GETTEXT | |
39 @endcode | |
40 The position of these macros in the file don't really matter, but if you | |
16196 | 41 have issues either play around with it or feel free to ask one of the Pidgin |
13400 | 42 developers. Finally add 'po/Makefile.in' to you 'AC_OUTPUT' command. |
43 - Now create a directory named 'po'. | |
44 - 'cd' into the 'po' directory. | |
45 - Create/edit the file 'POTFILE.in' in your favorite editor. Each line | |
46 should be the name of a file that could or does have strings marked for | |
47 translating (we're getting to that step). These file names should be | |
21711
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
48 relative to the top directory of your plugin's source tree. |
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
49 - 'cd' back to the top directory of your plugin's source tree. |
13400 | 50 - Open 'Makefile.am' and add 'po' to your 'SUBDIRS' variable. |
21711
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
51 - While still in the top directory of your plugin's source tree, execute |
13400 | 52 'intltool-prepare'. This will setup anything extra that intltool needs. |
21711
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
53 - Fire off 'autogen.sh' and when it's completed, verify that you have a |
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
54 'po/POTFILES' (notice the lack of a .in). If you do, everything should be |
13400 | 55 set on the autotools side. |
56 - Take a break, stretch your legs, smoke a cigarette, whatever, because | |
57 we're done with the autotools part. | |
58 - When you're ready, 'cd' into the directory with the source files for your | |
59 plugin. | |
16196 | 60 - Open the file containing the PurplePluginInfo structure. |
13400 | 61 - If you're not already, please make sure that you are including the |
62 'config.h' file for you plugin. Note that 'config.h' could be whatever | |
63 you told autohead to use with AM_CONFIG_HEADER. Also add the following: | |
64 @code | |
65 #include <glib/gi18n-lib.h> | |
66 @endcode | |
67 Make sure that this include is after you include of your 'config.h', | |
21711
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
68 otherwise you will break your build. Also note that if you wish to |
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
69 maintain compatibility with older versions of GLib, you will need to |
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
70 include additional preprocessor directives, which we won't cover here. |
901cbc91db27
Some tweaks to grim's plugin translation documentation.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16196
diff
changeset
|
71 - This is where things get a bit goofy. libpurple is going to try to |
16196 | 72 translate our strings using the libpurple gettext package. So we have to |
73 convert them before libpurple attempts to. | |
13400 | 74 - To do this, we're going to change the entries for name, summary, and |
75 description to NULL. | |
76 - Next, locate your 'init_plugin' function. Your name for this function | |
16196 | 77 may vary, but it's the second parameter to 'PURPLE_INIT_PLUGIN'. |
13400 | 78 - Now add the following within your 'init_plugin' function: |
79 @code | |
80 #ifdef ENABLE_NLS | |
81 bindtextdomain(GETTEXT_PACKAGE, LOCALEDIR); | |
82 bind_textdomain_codeset(GETTEXT_PACKAGE, "UTF-8"); | |
83 #endif /* ENABLE_NLS */ | |
84 | |
85 info.name = _("<YOUR PLUGIN NAME>"); | |
86 info.summary = _("<YOUR PLUGIN SUMMARY>"); | |
87 info.description = _("<YOUR PLUGIN DESCRIPTION>"); | |
88 @endcode | |
89 Note that the _() is intentional, and that it is telling intltool that | |
90 this string should be translated. There is also N_() which says that a | |
91 string should only be marked for translation but should not be translated | |
92 yet. | |
93 - Go through the rest of your code and mark all the other strings for | |
94 translation with _(). | |
13402
1d8fc7347a91
[gaim-migrate @ 15777]
Richard Laager <rlaager@wiktel.com>
parents:
13400
diff
changeset
|
95 - When thats done, feel free to commit your work, create your po template |
13400 | 96 (pot file) or whatever. |
97 - To create you po template, 'cd' to 'po' and execute: | |
98 @code | |
99 intltool-update --pot | |
100 @endcode | |
101 - To add new translations to your plugin, all you have to do is add the | |
102 language code to the 'ALL_LINGUAS' variable in your configure.ac. Take | |
103 note that this list of languages should be separated by a space. After | |
104 you have added the language code to 'ALL_LINGUAS', drop the xx.po file | |
105 into 'po', and re-'autogen.sh'. After a full build you should now be | |
106 able to use the translation. | |
107 */ |