Translation Team/i18n Best Practices - Revision history

Francis: Add coding header tip

2013-01-18T16:00:56Z

Add coding header tip

← Older revision		Revision as of 12:00, 18 January 2013
Line 92:		Line 92:

	Make a request by filing a ticket on bugs.sugarlabs.org. You should set Type to 'task' and Component to 'localization'. Please include a link to the project page on git.sugarlabs.org (or whatever other repository you use).		Make a request by filing a ticket on bugs.sugarlabs.org. You should set Type to 'task' and Component to 'localization'. Please include a link to the project page on git.sugarlabs.org (or whatever other repository you use).

			== Specify the character encoding if necessary ==

			Python files with non-ascii characters or declaring strings representing them, need to add the following line to the header.

			# -- coding: utf-8 --

			If not, the pootle helper won't generate the pot/po files.

Walter: /* Use plural forms */

2012-02-11T16:21:22Z

Use plural forms

← Older revision		Revision as of 12:21, 11 February 2012
Line 25:		Line 25:

	== Use plural forms ==		== Use plural forms ==
	Do not assume that all languages have a concept of singular and plural like English. Some languages might have a single form, and some have more than two form. Use [http://www.gnu.org/software/~~automake~~/manual/gettext/Plural-forms~~.html~~ plural forms] via ''ngettext()'' in these cases. Example (from sugar-update-control):		Do not assume that all languages have a concept of singular and plural like English. Some languages might have a single form, and some have more than two form. Use [http://www.gnu.org/software/gettext/manual/gettext.html#Plural-forms plural forms] via ''ngettext()'' in these cases. Example (from sugar-update-control):
	<pre>		<pre>
	header = gettext.ngettext("You can install %s update",		header = gettext.ngettext("You can install %s update",

Cjl: /* General tips */

2011-11-15T16:59:00Z

General tips

← Older revision		Revision as of 12:59, 15 November 2011
Line 1:		Line 1:
	<noinclude>{{ GoogleTrans-en \| es =show \| bg =show \| zh-CN =show \| zh-TW =show \| hr =show \| cs =show \| da =show \| nl =show \| fi =show \| fr =show \| de =show \| el =show \| hi =show \| it =show \| ja =show \| ko =show \| no =show \| pl =show \| pt =show \| ro =show \| ru =show \| sv =show }} </noinclude>{{TOCright}}		<noinclude>{{ GoogleTrans-en \| es =show \| bg =show \| zh-CN =show \| zh-TW =show \| hr =show \| cs =show \| da =show \| nl =show \| fi =show \| fr =show \| de =show \| el =show \| hi =show \| it =show \| ja =show \| ko =show \| no =show \| pl =show \| pt =show \| ro =show \| ru =show \| sv =show }} </noinclude>{{TOCright}}
	= General tips =		= General tips =
	Here are some general tips which will make your translators happy. For a much more comprehensive list of best practices, please read the [http://live.gnome.org/TranslationProject/DevGuidelines\| Gnome i18n Guidelines].		Here are some general tips which will make your translators happy. For a much more comprehensive list of best practices, please read the [http://live.gnome.org/TranslationProject/DevGuidelines \| Gnome i18n Guidelines].
	== When in doubt, use translator-comments ==		== When in doubt, use translator-comments ==
	When you are using a string which may be confusing for the translators (contextual issues, or cultural issues), or if you want the string to be translated according to a particular convention, use translator-comments, which would show up alongside the message in the PO file translator get when they translate you software. Example (from Calculate activity)		When you are using a string which may be confusing for the translators (contextual issues, or cultural issues), or if you want the string to be translated according to a particular convention, use translator-comments, which would show up alongside the message in the PO file translator get when they translate you software. Example (from Calculate activity)

Cjl at 16:57, 15 November 2011

2011-11-15T16:57:11Z

← Older revision		Revision as of 12:57, 15 November 2011
Line 1:		Line 1:
	<noinclude>{{ GoogleTrans-en \| es =show \| bg =show \| zh-CN =show \| zh-TW =show \| hr =show \| cs =show \| da =show \| nl =show \| fi =show \| fr =show \| de =show \| el =show \| hi =show \| it =show \| ja =show \| ko =show \| no =show \| pl =show \| pt =show \| ro =show \| ru =show \| sv =show }} </noinclude>{{TOCright}}		<noinclude>{{ GoogleTrans-en \| es =show \| bg =show \| zh-CN =show \| zh-TW =show \| hr =show \| cs =show \| da =show \| nl =show \| fi =show \| fr =show \| de =show \| el =show \| hi =show \| it =show \| ja =show \| ko =show \| no =show \| pl =show \| pt =show \| ro =show \| ru =show \| sv =show }} </noinclude>{{TOCright}}
	= General tips =		= General tips =
	Here are some general tips which will make your translators happy		Here are some general tips which will make your translators happy. For a much more comprehensive list of best practices, please read the [http://live.gnome.org/TranslationProject/DevGuidelines\| Gnome i18n Guidelines].
	== When in doubt, use translator-comments ==		== When in doubt, use translator-comments ==
	When you are using a string which may be confusing for the translators (contextual issues, or cultural issues), or if you want the string to be translated according to a particular convention, use translator-comments, which would show up alongside the message in the PO file translator get when they translate you software. Example (from Calculate activity)		When you are using a string which may be confusing for the translators (contextual issues, or cultural issues), or if you want the string to be translated according to a particular convention, use translator-comments, which would show up alongside the message in the PO file translator get when they translate you software. Example (from Calculate activity)

Cjl: Reverted edits by Cjl (talk) to last revision by Godiard

2011-10-04T18:57:43Z

Reverted edits by Cjl (talk) to last revision by Godiard

← Older revision		Revision as of 14:57, 4 October 2011
Line 79:		Line 79:
	== Do not touch anything inside your po directory ==		== Do not touch anything inside your po directory ==

	~~<strike>~~ If you change anything inside the po directory (including the POT file), and push it to Git, it will create a conflict which has to be updated in the Pootle side manually. Try avoid doing this, ~~</strike>~~		If you change anything inside the po directory (including the POT file), and push it to Git, it will create a conflict which has to be updated in the Pootle side manually. Try avoid doing this, If you see any issues, please ping Sayamindu (sayamindu at sugarlabs dot org) (you can also catch him on IRC, in channels like #sugar on Freenode with the nick unmadindu). If the changeset that you have is large, send him a patch, and he will apply that from the Pootle side manually and commit.

	~~This rule is temprarily suspended. Please do not directly manipulate PO files~~, ~~but~~ please ~~'''do''' regenerate and re-commit POT files when UI string changes have been made. Please notify the Translation Team so they~~ can ~~pull the changes to the Poolte Templates project. The can be reached via the L10n list or~~ on IRC (nick~~: cjl~~).

	== Try to keep the po directory in the top level directory of your repository ==		== Try to keep the po directory in the top level directory of your repository ==

Cjl: /* Do not touch anything inside your po directory */

2011-08-08T04:13:19Z

Do not touch anything inside your po directory

← Older revision		Revision as of 00:13, 8 August 2011
Line 81:		Line 81:
	<strike> If you change anything inside the po directory (including the POT file), and push it to Git, it will create a conflict which has to be updated in the Pootle side manually. Try avoid doing this, </strike>		<strike> If you change anything inside the po directory (including the POT file), and push it to Git, it will create a conflict which has to be updated in the Pootle side manually. Try avoid doing this, </strike>

	This rule is temprarily suspended. Please do not directly manipulate PO ~~fiels~~, but please do regenerate and re-commit POT files when UI string changes have been made. Please notify the Translation Team so they can pull the changes to the Poolte Templates project. The can be reached via the L10n list or on IRC (nick: cjl).		This rule is temprarily suspended. Please do not directly manipulate PO files, but please '''do''' regenerate and re-commit POT files when UI string changes have been made. Please notify the Translation Team so they can pull the changes to the Poolte Templates project. The can be reached via the L10n list or on IRC (nick: cjl).

	== Try to keep the po directory in the top level directory of your repository ==		== Try to keep the po directory in the top level directory of your repository ==

Cjl: /* Do not touch anything inside your po directory */

2011-08-08T04:12:42Z

Do not touch anything inside your po directory

← Older revision		Revision as of 00:12, 8 August 2011
Line 79:		Line 79:
	== Do not touch anything inside your po directory ==		== Do not touch anything inside your po directory ==

	If you change anything inside the po directory (including the POT file), and push it to Git, it will create a conflict which has to be updated in the Pootle side manually. Try avoid doing this, ~~If you see any issues~~, please ~~ping Sayamindu (sayamindu at sugarlabs dot org) (you~~ can ~~also catch him~~ on IRC~~, in channels like #sugar on Freenode with the~~ nick ~~unmadindu~~)~~. If the changeset that you have is large, send him a patch, and he will apply that from the Pootle side manually and commit~~.		<strike> If you change anything inside the po directory (including the POT file), and push it to Git, it will create a conflict which has to be updated in the Pootle side manually. Try avoid doing this, </strike>

			This rule is temprarily suspended. Please do not directly manipulate PO fiels, but please do regenerate and re-commit POT files when UI string changes have been made. Please notify the Translation Team so they can pull the changes to the Poolte Templates project. The can be reached via the L10n list or on IRC (nick: cjl).

	== Try to keep the po directory in the top level directory of your repository ==		== Try to keep the po directory in the top level directory of your repository ==

Godiard at 19:31, 11 January 2011

2011-01-11T19:31:10Z

← Older revision		Revision as of 15:31, 11 January 2011
Line 87:		Line 87:
	== Add user pootle to the committer list for your activity ==		== Add user pootle to the committer list for your activity ==

	If you have set up your activity on git.suagrlabs.org, please add the user pootle to the committer list so that po files can be updated for your project. (You add new committers from the right-hand menu on the repository page (where you will find a link to http://git.sugarlabs.org~~/projects~~/[your activity]~~/repos~~/mainline~~/committers/new~~).		If you have set up your activity on git.suagrlabs.org, please add the user pootle to the committer list so that po files can be updated for your project. (You add new committers from the button "Manage colaborators" in the right-hand menu on the repository mainline page (where you will find a link to http://git.sugarlabs.org/[your activity]/mainline).

	== Request to have your project included in pootle ==		== Request to have your project included in pootle ==

	Make a request by filing a ticket on bugs.sugarlabs.org. You should set Type to 'task' and Component to 'localization'. Please include a link to the project page on git.sugarlabs.org (or whatever other repository you use).		Make a request by filing a ticket on bugs.sugarlabs.org. You should set Type to 'task' and Component to 'localization'. Please include a link to the project page on git.sugarlabs.org (or whatever other repository you use).

Walter: /* Pootle specific tips */

2010-04-11T15:56:32Z

Pootle specific tips

← Older revision		Revision as of 11:56, 11 April 2010
Line 84:		Line 84:

	The various homebrew helper scripts which keep Pootle running properly make the assume that the po directory will be in the toplevel of the source repository. Try to avoid putting the po directory under a directory like i18n or such, as this will need yet another special casing in the helper scripts, making stuff more difficult to maintain.		The various homebrew helper scripts which keep Pootle running properly make the assume that the po directory will be in the toplevel of the source repository. Try to avoid putting the po directory under a directory like i18n or such, as this will need yet another special casing in the helper scripts, making stuff more difficult to maintain.

			== Add user pootle to the committer list for your activity ==

			If you have set up your activity on git.suagrlabs.org, please add the user pootle to the committer list so that po files can be updated for your project. (You add new committers from the right-hand menu on the repository page (where you will find a link to http://git.sugarlabs.org/projects/[your activity]/repos/mainline/committers/new).

			== Request to have your project included in pootle ==

			Make a request by filing a ticket on bugs.sugarlabs.org. You should set Type to 'task' and Component to 'localization'. Please include a link to the project page on git.sugarlabs.org (or whatever other repository you use).

Clytie: /* Use plural forms */ Added section for msgid-previous

2010-03-26T10:28:01Z

Use plural forms: Added section for msgid-previous

← Older revision		Revision as of 06:28, 26 March 2010
Line 32:		Line 32:
	</pre>		</pre>

			== Show changes in strings ==
			Use the "--previous" option with msgmerge when updating PO files. This option will output strings like this:
			<pre>
			#, string header
			#\|msgid "This is the old string"
			msgid "This is the new string"
			msgstr "This is the old string translated"
			</pre>
			so translators can see what has changed. Some translation editors will highlight the changes, which is particularly helpful with complex strings, very long strings or strings with code/formatting. This option definitely improves the accuracy of translation updates.

	== Use white-spaces and newlines only when you need to ==		== Use white-spaces and newlines only when you need to ==