Language Switcher Tutorial
From Joomla! Documentation
Revision as of 17:31, 6 July 2010 by Dextercowley
Joomla 1.6 includes a basic way to implement a multi-language site. This feature does not work as an association-type display where each content, whatever it is, has an equivalent in another language (it does not replace other extensions as Joomfish).
This is why using the Language Switcher Module to change language is set to redirect to another Content Language Home Page. To be able to implement the feature, 5 aspects have to be dealt with.
- The Content Language parameters in the Language Manager
- Assigning these Content languages to various items using the "Language" parameter.
- Defining a Default Home page Menu item per language
- The languagefilter System Plugin
- The mod_languages Module (also called Langswitcher)
The "Content" tab in Language Manager
There, one can create a "Content Language", even if the site language is not yet installed.
- Title = The name of the language as it will appear in the dropdown lists when assigning the language to an item. This Title will also be used by the langswitcher module in front-end when flags are not used.
- Title Native = A title in any language desired by the admin to be displayed in the Content Language list.
- URL Language Code= This Language Code will be appended to the site url. When SEF is enabled, one will get http://mysite.com/en/. If SEF is disabled the suffix &lang=en will be appended at the end of the URL. Note the Language Code must be unique among all the languages.
- Image Prefix = Prefix of the image file for this language when using the "Use image flags" Language Switcher basic option. Example: if 'en' is chosen, then the image shall be en.gif. Images and CSS for this module are in media/mod_languages/
- Language Tag = Enter here the language tag example: en-GB for English (UK). This should be the exact prefix used for the language installed or to be installed.
- Published = Whether this content language is published or not. If published, it will display as a choice in the Language Switcher module in frontend. To work OK, the specific site language must be installed. One can prepare contents in a specific Content Language without even installing the language concerned, and just do it when deciding to publish that language.
- Metadata = These metadata definitions will override Global Configuration Metadata in Multilanguage configuration for each language used.
The "Language" parameter in 1.6
Not only Articles but everything is taggable to a specific Content language. Modules obviously but also Categories, Banners, Weblinks, Newsfeeds, Menu Items...
Defining a Default Home page Menu item per language
As the Language Switcher Module is set to redirect to another Content Language Home Page, one has to be defined for each language. Important Note: A default Home page taggged to "All" should still exist, although the module displaying it does not have to be published.
The languagefilter System Plugin
This plugin filters the displayed content depending on language. This plugin is to be enabled -only- when the Language Switcher module is published.
The mod_languages Module (also called Langswitcher)
This module displays a list of available Content Languages (as defined and published in Language Manager Content tab) for switching between them when one wants to use Joomla! as a multilanguage site.
The plugin 'System - Language Filter' has to be published. When switching languages, the module redirects to the Home page defined for the chosen language. Thereafter, the navigation will be the one defined for that language. If the plugin 'System - Language Filter' is unpublished, this may have unwanted results. Method:
- Open Language Manager Content tab and make sure the Languages you want to use in contents are published and have a prefix for the URL as well as prefix for the image used in the module display.
- Create a Home page by assigning a language to a menu item and defining it as Default Home page for each published content language.
- Thereafter, you can assign a language to any Article, Category, Module, Newsfeed, Weblinks in Joomla.
- Assign the Langswitcher module to each Specific Default Language Content Home page and param it to use flags to text to display the choice in front-end.
- Make sure the module and the plugin are published.
How to Test
Obviously, Sample data is not the best way to demonstrate easily the power of this new Feature. But one can test a simple site with the following actions using the temporary test language xx-XX. One prerequisite is that it should remain a Home menu item tagged to "All" and defined as default Home, the module displaying it being unpublished or assigned to a non available position in the template
- Define CONTENT LANGUAGES in the Language Manager, prefix for the url and flag for each. Default available are en-GB and xx-XX (en-US should not be used now as we have no en-US site language available)
- Create a Parent Article Category tagged to en-GB and one tagged to xx-XX
- Create articles in each of these categories, tagging the articles to the same language as the category.
- If you like, create sub categories with articles, all tagged as should.
Tip for a fast test: [Tag the Park Home menu item to en-GB and as Default Home, same for the Fruitshop Welcome menu item tagged to xx-XX and set as default home for this language]
- Create one menu per language, tagged as should. This will create 2 menu modules. Tag them to the language concerned.
- Create menu items tagged to that language in each menu. For now variations of the Article menu items (blog, list, single...)
- Define one menu item per language/menu as the Home for this language.
- Publish the langswitcher module (tagged to language "All") and assign ONLY to each Content Language Home Menu Item (Parks Home and Fruitshop Welcome in the fast test)
- Publish the languagefilter plugin.