Translations - Revision history

Dirk: 20 -> 30

2013-03-29T14:41:32Z

20 -> 30

Dirk: Pointed out that you can also send patches for the translations

2010-04-04T15:54:57Z

Pointed out that you can also send patches for the translations

Dirk: minor updates / corrections

2009-05-23T13:51:00Z

minor updates / corrections

Dirk: "French" was a bad example ...

2009-05-09T07:37:33Z

"French" was a bad example ...

Dirk: added xmlsitemap plugin and the documentation (as of 1.6.0)

2009-05-06T14:49:12Z

added xmlsitemap plugin and the documentation (as of 1.6.0)

Dirk: fixed example

2008-08-11T08:42:04Z

fixed example

Dirk: Language files

2008-08-10T20:12:11Z

Language files

Dirk: Getting help / publishing

2008-08-10T20:00:15Z

Getting help / publishing

Dirk: Started page on how to create / update a translation

2008-08-10T19:50:45Z

Started page on how to create / update a translation

New page

= Creating a new translation =

Geeklog has already been translated into [[What Languages are Available?|more than 20 languages]]. If your language is not among them, you may want to check for a related language first. But usually, the best way to start a new translation is to make a copy of english.php (or english_utf-8.php) and give it the English(!) name of your language.

Things to consider:
* The character set: If you're using UTF-8, that should be reflected in the name of the language file.
* Dialects / variations of a language: Local variations of a "main" language should also be reflected in the file name. See, for example, portuguese_brazil.php for "Portuguese, as spoken in Brazil".

== Character set and text direction ==

Your language file should define the character set to use for your language:

<pre>$LANG_CHARSET = 'iso-8859-1';</pre>

For languages that are written right-to-left (e.g. Hebrew, Arabic), you should also set

<pre>$LANG_DIRECTION = 'rtl';</pre>

If <code>$LANG_DIRECTION</code> is not set in the language file, the left-to-right is assumed.

== The $LANG arrays ==

Geeklog uses PHP arrays to define the texts used, e.g.

<pre>$LANG01 = array(
1 => 'Contributed by:',
2 => 'read more',
(...)
);</pre>

So whenever Geeklog needs the text for "read more", it refers to <code>$LANG[2]</code> and picks up the localized text from the current language file. So you only need to translate the text to the right of the <tt>=></tt> sign.

Note that some language arrays are using a textual key instead of a number, e.g.

<pre>$LANG_ACCESS = array(
'access' => 'Access',</pre>

Again, you should only translate the text on the right side. PHP also allows text strings as an array index, so the word "Access" would be referred to by <code>$LANG_ACCESS['access']</code> (and if you changed the <tt>'access'</tt> on the left side, this wouldn't work any more).

= Updating a translation =

Not all language files are still actively supported. Therefore, you may notice that some texts will show up in English even when you switched to a different language. The language files, as shipped with Geeklog, are updated such that they include all the required texts. Where a translation is not available, the English text is used.

To update a translation, you can either browse through the language file and look for English texts, or you can translate texts as required as you run into them when using your Geeklog site.

@@ Line 1: / Line 1: @@
 = Creating a new translation =
-Geeklog has already been translated into [[What Languages are Available?|more than 20 languages]]. If your language is not among them, you may want to check for a related language first. But usually, the best way to start a new translation is to make a copy of <tt>english.php</tt> (or <tt>english_utf-8.php</tt>) and give it the English(!) name of your language.
+Geeklog has already been translated into [[What Languages are Available?|more than 30 languages]]. If your language is not among them, you may want to check for a related language first. But usually, the best way to start a new translation is to make a copy of <tt>english.php</tt> (or <tt>english_utf-8.php</tt>) and give it the English(!) name of your language.
 Things to consider:

← Older revision		Revision as of 15:54, 4 April 2010
Line 87:		Line 87:

	Translations uploaded to geeklog.net will also usually be picked up to be included in future Geeklog releases.		Translations uploaded to geeklog.net will also usually be picked up to be included in future Geeklog releases.
		+
		+	== Sending Patches ==
		+
		+	If you are familiar with Mercurial, you can also [[Submitting Patches\|send patches]] for the language files (instead of sending the complete files). Using Mercurial's <tt>export</tt> format has the advantage that your name would [http://project.geeklog.net/cgi-bin/hgwebdir.cgi/geeklog/ show up] in the list of changes in our Mercurial repository.
		+
		+	Sending the complete file is usually easier, though. Choose whatever is easier for you.

@@ Line 5: / Line 5: @@
 Things to consider:
 * The character set: If you're using UTF-8, that should be reflected in the name of the language file (i.e. the filename should end in <tt>..._utf-8.php</tt>).
-* Dialects / variations of a language: Local variations of a "main" language should also be reflected in the file name. See, for example, portuguese_brazil.php for "Portuguese, as spoken in Brazil".
+* Dialects / variations of a language: Local variations of a "main" language should also be reflected in the file name. See, for example, <tt>portuguese_brazil.php</tt> for "Portuguese, as spoken in Brazil".
@@ Line 38: / Line 38: @@
 If <code>$LANG_DIRECTION</code> is not set in the language file, left-to-right is assumed.
-'''Note:''' These two options should only been set in the main language file and the language file for the install script. Plugins will automatically use the character set and text direction as defined in the main language file.
+'''Note:''' These two options should only be set in the main language file and the language file for the install script. Plugins will automatically use the character set and text direction as defined in the main language file.
@@ Line 51: / Line 51: @@
 );</pre>
-So whenever Geeklog needs the text for "read more", it refers to <code>$LANG01[2]</code> and picks up the localized text from the current language file. So you only need to translate the text to the right of the <tt>=></tt> sign.
+Whenever Geeklog needs the text for "read more", it refers to <code>$LANG01[2]</code> and picks up the localized text from the current language file. So you only need to translate the text to the right of the <tt>=></tt> sign.
 Note that some language arrays are using a textual key instead of a number, e.g.
@@ Line 84: / Line 84: @@
 The best way to publish your translation is to get it included in the official Geeklog tarballs. Pre-announcements of upcoming releases will be posted on the geeklog-translations mailing list, so that you can finish your work in time to be included.
-Between Geeklog releases, you can always upload your translation on geeklog.net. Make sure to compress your language file(s) as .zip or .tar.gz files to prevent special characters from being corrupted.
+Between Geeklog releases, you can always [http://www.geeklog.net/filemgmt/submit.php upload] your translation on geeklog.net. Make sure to compress your language file(s) as .zip or .tar.gz files to prevent special characters from being corrupted.
 Translations uploaded to geeklog.net will also usually be picked up to be included in future Geeklog releases.

← Older revision		Revision as of 07:37, 9 May 2009
Line 72:		Line 72:
	As of Geeklog 1.6.0, the documentation that ships with Geeklog has been moved from <tt>docs</tt> to <tt>docs/english</tt>. So now it's possible to translate the Geeklog documentation, too.		As of Geeklog 1.6.0, the documentation that ships with Geeklog has been moved from <tt>docs</tt> to <tt>docs/english</tt>. So now it's possible to translate the Geeklog documentation, too.

−	Note: The directory name for the translated documentation should not include a character set name (i.e. it should be "~~french~~", even if you're using UTF-8 for the translated files). This is because the documentation is independent from Geeklog and its character set, so there's no need to have UTF-8 and non-UTF-8 versions.	+	Note: The directory name for the translated documentation should not include a character set name (i.e. it should be "italian", even if you're using UTF-8 for the translated files). This is because the documentation is independent from Geeklog and its character set, so there's no need to have UTF-8 and non-UTF-8 versions.

@@ Line 18: / Line 18: @@
 plugins/spamx/language/english.php
 plugins/staticpages/language/english.php
 public_html/admin/install/language/english.php</pre>
@@ Line 65: / Line 66: @@
 To update a translation, you can either browse through the language file and look for English texts, or you can translate texts as required as you run into them when using your Geeklog site.

← Older revision		Revision as of 20:00, 10 August 2008
Line 46:		Line 46:

	To update a translation, you can either browse through the language file and look for English texts, or you can translate texts as required as you run into them when using your Geeklog site.		To update a translation, you can either browse through the language file and look for English texts, or you can translate texts as required as you run into them when using your Geeklog site.
		+
		+
		+	= Getting help =
		+
		+	The [http://eight.pairlist.net/mailman/listinfo/geeklog-translations geeklog-translations mailing list] is probably the best place to go to when you need help with your translation. We recommend that all maintainers of language files subscribe to this list, as we will also post information about changes in the language files in upcoming Geeklog releases on this list.
		+
		+
		+	= Publishing your translation =
		+
		+	The best way to publish your translation is to get it included in the official Geeklog tarballs. Pre-announcements of upcoming releases will be posted on the geeklog-translations mailing list, so that you can finish your work in time to be included.
		+
		+	Between Geeklog releases, you can always upload your translation on geeklog.net. Make sure to compress your language file(s) as .zip or .tar.gz files to prevent special characters from being corrupted.
		+
		+	Translations uploaded to geeklog.net will also usually be picked up to be included in future Geeklog releases.