Multilingual Support - Revision history

Tom: /* Geeklog 2.2.0 and later */

2017-12-11T15:05:15Z

‎Geeklog 2.2.0 and later

Tom: /* Geeklog 2.2.0 and later */

2017-12-11T14:58:07Z

‎Geeklog 2.2.0 and later

Tom: /* Geeklog 2.2.0 and later */

2017-12-11T00:11:59Z

‎Geeklog 2.2.0 and later

Tom: /* Geeklog 1.5.0 and later */

2017-12-11T00:07:47Z

‎Geeklog 1.5.0 and later

LWC: /* Blocks */ Stressed what's disabled

2009-12-15T16:19:09Z

‎Blocks: Stressed what's disabled

LWC: Fixed English

2009-10-31T00:28:40Z

Fixed English

LWC: Multi-Language Support moved to Multilingual Support: Fixed English

2009-10-31T00:23:17Z

Multi-Language Support moved to Multilingual Support: Fixed English

Dirk: fixed "locale settings" link (anchor changed)

2009-05-09T19:07:01Z

fixed "locale settings" link (anchor changed)

Dirk: Typo

2008-12-06T19:47:45Z

Typo

Dirk: Multi-lingual blocks (as of 1.5.1)

2008-12-06T19:46:26Z

Multi-lingual blocks (as of 1.5.1)

@@ Line 69: / Line 69: @@
 === Geeklog 2.2.0 and later ===
-As of Geeklog 2.2.0 multi-language items of plugins, articles and topics are fully supported. No more guess work is involved by just parsing the URL for a language tag including an anonymous user directly visiting a muti language page and any user using the switch language block. Switch Language block also uses switchlang_homepage config option if enabled and item doesn't exist in language will return to homepage else a 404 is displayed. This supports normal, rewrite , and routing URLs.
+As of Geeklog 2.2.0 multi-language items of plugins (like Staticpages), articles and topics are fully supported. No more guess work is involved by just parsing the URL for a language code, which may just be part of an id and not an actual code. This update supports normal, rewrite, and routing URLs.
-No more guessing at URLs for item ids and language variables. Plugins now need to register a core hidden config option langurl_pluginname to support multi-language items. This config option will store an array with the follow information about the url that supports multiple languages:
+This means an anonymous user directly visiting a muti language page will see the page in the language code specified in the item id. Users using the switch language block will see the item in the new language as long as the id exists for the new language. Switch Language block also uses switchlang_homepage config option if enabled and item doesn't exist in language will return to homepage else a 404 error is displayed.
-directory, filename, id variable name
+Plugins now need to register a core hidden config option langurl_pluginname to support multi-language items. This config option will store an array with the follow information about the url that supports multiple languages:
 Also required to support PLG_getItemInfo (which calls plugin_getiteminfo_pluginname) that can return if the Id exists or not of the item.
 Plugin Developers see function _getLanguageInfoFromURL in lib-common for more information (which replaced COM_getLanguageFromURL).
 === The shortcuts ===

@@ Line 69: / Line 69: @@
 === Geeklog 2.2.0 and later ===
-As of Geeklog 2.2.0 multi-language items of plugins, articles and topics are fully supported including an anonymous user directly visiting a muti language page and any user using the switch language block. Switch Language block also uses switchlang_homepage config option if enabled and item doesn't exist in language will return to homepage else a 404 is displayed. This supports normal, rewrite , and routing URLs.
+As of Geeklog 2.2.0 multi-language items of plugins, articles and topics are fully supported. No more guess work is involved by just parsing the URL for a language tag including an anonymous user directly visiting a muti language page and any user using the switch language block. Switch Language block also uses switchlang_homepage config option if enabled and item doesn't exist in language will return to homepage else a 404 is displayed. This supports normal, rewrite , and routing URLs.
 No more guessing at URLs for item ids and language variables. Plugins now need to register a core hidden config option langurl_pluginname to support multi-language items. This config option will store an array with the follow information about the url that supports multiple languages:

@@ Line 69: / Line 69: @@
 === Geeklog 2.2.0 and later ===
-As of Geeklog 2.2.0 ...
+As of Geeklog 2.2.0 multi-language items of plugins, articles and topics are fully supported including an anonymous user directly visiting a muti language page and any user using the switch language block. Switch Language block also uses switchlang_homepage config option if enabled and item doesn't exist in language will return to homepage else a 404 is displayed. This supports normal, rewrite , and routing URLs.
 === The shortcuts ===

← Older revision		Revision as of 00:07, 11 December 2017
Line 67:		Line 67:
	Note that in Geeklog 1.5.0, you can not easily disable multilingual support again (for a workaround, see [http://www.geeklog.net/forum/viewtopic.php?showtopic=83327 here]). As of Geeklog 1.5.1, there is a litte <tt>(X)</tt> next to the options (once they're enabled). Click on the <tt>(X)</tt> to disable the options again (remember that you need to disable both of them).		Note that in Geeklog 1.5.0, you can not easily disable multilingual support again (for a workaround, see [http://www.geeklog.net/forum/viewtopic.php?showtopic=83327 here]). As of Geeklog 1.5.1, there is a litte <tt>(X)</tt> next to the options (once they're enabled). Click on the <tt>(X)</tt> to disable the options again (remember that you need to disable both of them).

		+	=== Geeklog 2.2.0 and later ===
		+
		+	As of Geeklog 2.2.0 ...

	=== The shortcuts ===		=== The shortcuts ===

@@ Line 101: / Line 101: @@
 Let's assume you want to create a multilingual "about this site" block and that your site is configured for two languages (say, English and German). For this setup you would then need ''three''(!) blocks. The block name serves as the ID and you would create blocks with the following names:
-* about_en
+* about_en (disabled)
-* about_de
+* about_de (disabled)
 * about
 The first two blocks would simply contain your content in English and German, respectively. Both blocks should be ''disabled''. The third block then serves as a placeholder for the actual block for the current language. Therefore, only this block ("about", in our example) should be enabled. When the multilingual support is enabled, you will never see the contents of that block, as it will be replaced with the proper block for the current language, e.g. "about_en" for English.
 == Switching languages ==

@@ Line 3: / Line 3: @@
 The Geeklog language files have been translated into more than 25 languages - but that only means that you can have the user interface in one of those languages. For the actual site content (articles, static pages, ...), there was no support for multiple languages, which means that you either had to have everything in one language only or you ended up with all the different language versions of, e.g. an article, being displayed to anyone.
-Euan McKay then came up with a [http://heatherengineering.com/staticpages/index.php/multilingual-en first multi-language hack], which was later [http://www.geeklog.net/forum/viewtopic.php?showtopic=61999 built upon and generalized] by LWC.
+Euan McKay then came up with a [http://heatherengineering.com/staticpages/index.php/multilingual-en first multilingual hack], which was later [http://www.geeklog.net/forum/viewtopic.php?showtopic=61999 built upon and generalized] by LWC.
-The multi-language support in Geeklog (as of version 1.4.1) is based on this earlier work by Euan and LWC.
+The multilingual support in Geeklog (as of version 1.4.1) is based on this earlier work by Euan and LWC.
 == How it works ==
-The basic idea behind the multi-language support is to encode the language of an object into its ID. For example, for a story to encode it into the story ID, like so:
+The basic idea behind the multilingual support is to encode the language of an object into its ID. For example, for a story to encode it into the story ID, like so:
 <pre>http://www.example.com/article.php/introduction_en -- English version
@@ Line 22: / Line 22: @@
 === Geeklog 1.4.1 ===
-In config.php, there is a new section to enable multi-language support and to define the list of supported languages:
+In config.php, there is a new section to enable multilingual support and to define the list of supported languages:
-<pre>// Multi-language support
+<pre>// Multilingual support
 // (note that this section is commented out - remove the '/*' and '*/' lines
 //  below to activate it and make sure you understand what it does)
@@ Line 35: / Line 35: @@
 // 3) All shortcuts must have the same length, e.g. 2 characters.
-// The shortcuts are to be used in IDs of objects that are multi-language
+// The shortcuts are to be used in IDs of objects that are multilingual
 // aware, e.g. /article.php/introduction_en and /article.php/introduction_de
 // for the English and German version of an introductory article.
@@ Line 56: / Line 56: @@
 */</pre>
-To enable multi-language support, the two arrays $_CONF['language_files'] and $_CONF['languages'] have to be defined. In the default config.php, they are commented out and, therefore, not defined.
+To enable multilingual support, the two arrays $_CONF['language_files'] and $_CONF['languages'] have to be defined. In the default config.php, they are commented out and, therefore, not defined.
 === Geeklog 1.5.0 and later ===
@@ Line 63: / Line 63: @@
 * Language Files
 * Languages
-These two options are the equivalents of the <code>$_CONF['language_files']</code> and <code>$_CONF['languages']</code> arrays, as explained above. To use the multi-language feature, '''both''' of these options have to be enabled. Other than that, the two options work as described above.
+These two options are the equivalents of the <code>$_CONF['language_files']</code> and <code>$_CONF['languages']</code> arrays, as explained above. To use the multilingual feature, '''both''' of these options have to be enabled. Other than that, the two options work as described above.
-Note that in Geeklog 1.5.0, you can not easily disable multi-language support again (for a workaround, see [http://www.geeklog.net/forum/viewtopic.php?showtopic=83327 here]). As of Geeklog 1.5.1, there is a litte <tt>(X)</tt> next to the options (once they're enabled). Click on the <tt>(X)</tt> to disable the options again (remember that you need to disable both of them).
+Note that in Geeklog 1.5.0, you can not easily disable multilingual support again (for a workaround, see [http://www.geeklog.net/forum/viewtopic.php?showtopic=83327 here]). As of Geeklog 1.5.1, there is a litte <tt>(X)</tt> next to the options (once they're enabled). Click on the <tt>(X)</tt> to disable the options again (remember that you need to disable both of them).
 === The shortcuts ===
-For each of the languages you intend to support, you will have to define a shortcut that will then be used in the IDs of the multi-language objects, as explained above.
+For each of the languages you intend to support, you will have to define a shortcut that will then be used in the IDs of the multilingual objects, as explained above.
 You can freely define these shortcuts, but it would make sense to set them in some relation to the language which they represent. From Geeklog's point of view, though, it doesn't matter whether the English language is represented by a shortcut 'en' or by 'peter'.
@@ Line 98: / Line 98: @@
 == Blocks ==
-Multi-lingual blocks are only supported as of Geeklog 1.5.1. The setup differs slightly from the setup for stories, topics, etc.
+Multilingual blocks are only supported as of Geeklog 1.5.1. The setup differs slightly from the setup for stories, topics, etc.
-Let's assume you want to create a multi-lingual "about this site" block and that your site is configured for two languages (say, English and German). For this setup you would then need ''three''(!) blocks. The block name serves as the ID and you would create blocks with the following names:
+Let's assume you want to create a multilingual "about this site" block and that your site is configured for two languages (say, English and German). For this setup you would then need ''three''(!) blocks. The block name serves as the ID and you would create blocks with the following names:
 * about_en
 * about_de
 * about
-The first two blocks would simply contain your content in English and German, respectively. Both blocks should be ''disabled''. The third block then serves as a placeholder for the actual block for the current language. Therefore, only this block ("about", in our example) should be enabled. When the multi-language support is enabled, you will never see the contents of that block, as it will be replaced with the proper block for the current language, e.g. "about_en" for English.
+The first two blocks would simply contain your content in English and German, respectively. Both blocks should be ''disabled''. The third block then serves as a placeholder for the actual block for the current language. Therefore, only this block ("about", in our example) should be enabled. When the multilingual support is enabled, you will never see the contents of that block, as it will be replaced with the proper block for the current language, e.g. "about_en" for English.
@@ Line 121: / Line 121: @@
 == Detecting the language ==
-When a user comes to a multi-language enabled site, Geeklog will check for the user's preference setting first (if it's a registered user), then for the language cookie, and if that couldn't be found, it tries to get the language from the browser's 'Accept-Language' header (which only works if you chose to use the ISO shortcuts, as explained above). If all else fails, content will be presented in the site's default language, i.e. $_CONF['language'].
+When a user comes to a multilingual enabled site, Geeklog will check for the user's preference setting first (if it's a registered user), then for the language cookie, and if that couldn't be found, it tries to get the language from the browser's 'Accept-Language' header (which only works if you chose to use the ISO shortcuts, as explained above). If all else fails, content will be presented in the site's default language, i.e. $_CONF['language'].
@@ Line 130: / Line 130: @@
 If you have a list of objects under your plugin's control and only want to show the objects in the current language, you can use the COM_getLangSQL() function when building your SQL request. It will provide the part of an SQL request to only return the objects in the current language (see the function's description in lib-common.php for details).
-COM_getLangSQL() will return an empty string when multi-language support is disabled, so you don't need to check for that yourself.
+COM_getLangSQL() will return an empty string when multilingual support is disabled, so you don't need to check for that yourself.
 Most of the time, that should be all that you need to know about supporting multiple languages in a plugin. In some scenarios, the following functions may also come in handy:
@@ Line 176: / Line 176: @@
 * To make things nicer for the user, the language could be hidden from the ID when editing objects. Instead, the user could be presented with a drop-down menu of the available languages. The shortcut could then be silently added to the ID when the object is saved.
-* [[SoC improve multi-language feature|More ideas]]
+* [[SoC improve multilingual feature|More ideas]]

← Older revision	Revision as of 00:23, 31 October 2009
(No difference)

@@ Line 155: / Line 155: @@
 $_CONF['locale_de'] = 'de_DE';</pre>
-You can switch all of the following [http://www.geeklog.net/docs/config.html#locale locale settings] as described above:
+You can switch all of the following [http://www.geeklog.net/docs/english/config.html#languages_locale locale settings] as described above:
 * <code>$_CONF['locale']</code>
 * <code>$_CONF['date']</code>

@@ Line 66: / Line 66: @@
 Note that in Geeklog 1.5.0, you can not easily disable multi-language support again (for a workaround, see [http://www.geeklog.net/forum/viewtopic.php?showtopic=83327 here]). As of Geeklog 1.5.1, there is a litte <tt>(X)</tt> next to the options (once they're enabled). Click on the <tt>(X)</tt> to disable the options again (remember that you need to disable both of them).
 === The shortcuts ===
@@ Line 93: / Line 94: @@
 Most of the time, you'll want to use the native names of the languages, e.g. "Deutsch" instead of "German", but that's only a convention.