Actions

J1.5

Difference between revisions of "Technical Guidelines for Translation"

From Joomla! Documentation

m
(One intermediate revision by one user not shown)
Line 1: Line 1:
 
Translations for Joomla! have a number of technical requirements and guidelines.
 
Translations for Joomla! have a number of technical requirements and guidelines.
 +
 +
'''For Joomla 2.5.x''' see http://docs.joomla.org/Making_a_Language_Pack_for_Joomla_1.6
  
 
==Requirements and Guidelines for Language Packs==
 
==Requirements and Guidelines for Language Packs==
Line 17: Line 19:
 
Sample data are created by exporting tables from a Joomla! database to a file called sample_data.sql.
 
Sample data are created by exporting tables from a Joomla! database to a file called sample_data.sql.
 
==Requirements and Guidelines for Help Screens==
 
==Requirements and Guidelines for Help Screens==
Help Screens are [http://www.diamondlinks.net the] screens that will be displayed after pushing [http://www.diamondlinks.net the] 'Help' button at [http://www.diamondlinks.net the] Back-end screens. [http://www.diamondlinks.net the] official Help Screens are hosted from http://help.joomla.org.  
+
Help Screens are the screens that will be displayed after pushing the 'Help' button at the Back-end screens. The official Help Screens are hosted from http://help.joomla.org.  
You can set up your own helpserver, in order to provide [http://www.diamondlinks.net the] Help Screens in your own language at [http://www.diamondlinks.net the] following way:
+
You can set up your own helpserver, in order to provide the Help Screens in your own language at the following way:
*Download [http://www.diamondlinks.net the] Help Screens sql package from JoomlaCode here: http://joomlacode.org/gf/project/joomla/docman/?subdir=6
+
*Download the Help Screens sql package from JoomlaCode here: http://joomlacode.org/gf/project/joomla/docman/?subdir=6
**Choose [http://www.diamondlinks.net the] newest sql file for Joomla! 1.5, probably Joomla15HelpScreens2008-07-14.zip.
+
**Choose the newest sql file for Joomla! 1.5, probably Joomla15HelpScreens2008-07-14.zip.
**Apply [http://www.diamondlinks.net the] sql file to [http://www.diamondlinks.net the] Joomla! site which will act like [http://www.diamondlinks.net the] helpserver
+
**Apply the sql file to the Joomla! site which will act like the helpserver
 
**'''Note: it is not possible to create a helpserver of a non-Joomla! site, eg a MediaWiki site. However, this will be possible in Joomla! 1.6.'''
 
**'''Note: it is not possible to create a helpserver of a non-Joomla! site, eg a MediaWiki site. However, this will be possible in Joomla! 1.6.'''
*Translate [http://www.diamondlinks.net the] Help Screen files from [http://www.diamondlinks.net the] package
+
*Translate the Help Screen files from the package
*To set [http://www.diamondlinks.net the] helpserver, search [http://www.diamondlinks.net the] file /administrator/help/helpsites-15.xml, which looks like this:
+
*To set the helpserver, search the file /administrator/help/helpsites-15.xml, which looks like this:
 
<source lang="xml"><joshelp>
 
<source lang="xml"><joshelp>
 
<sites>
 
<sites>
Line 30: Line 32:
 
</sites>
 
</sites>
 
</joshelp></source>
 
</joshelp></source>
*Add an extra line with [http://www.diamondlinks.net the] information of your own helpserver, like this:
+
*Add an extra line with the information of your own helpserver, like this:
 
<source lang="xml"><joshelp>
 
<source lang="xml"><joshelp>
 
<sites>
 
<sites>
Line 38: Line 40:
 
</joshelp></source>
 
</joshelp></source>
 
*Where:
 
*Where:
**''languagetag'' should be replaced by [http://www.diamondlinks.net the] language tag of your language. Examples: en-GB, de-DE, nl-NL
+
**''languagetag'' should be replaced by the language tag of your language. Examples: en-GB, de-DE, nl-NL
**''http://yourhelpserver.com'' should be replaced by [http://www.diamondlinks.net the] URL to your Joomla! site which acts like [http://www.diamondlinks.net the] helpserver
+
**''http://yourhelpserver.com'' should be replaced by the URL to your Joomla! site which acts like the helpserver
**''Language (Shortened version of language)'' should be replaced by [http://www.diamondlinks.net the] full name of [http://www.diamondlinks.net the] language, followed by [http://www.diamondlinks.net the] last 2 letters of [http://www.diamondlinks.net the] language tag. Examples: English (GB), Deutsch (DE), Nederlands (NL)
+
**''Language (Shortened version of language)'' should be replaced by the full name of the language, followed by the last 2 letters of the language tag. Examples: English (GB), Deutsch (DE), Nederlands (NL)
**''Site URL'' should be replaced by [http://www.diamondlinks.net the] URL to [http://www.diamondlinks.net the] creator or community which maintains [http://www.diamondlinks.net the] helpserver. This does not have to be [http://www.diamondlinks.net the] same as [http://www.diamondlinks.net the] helpserver URL.
+
**''Site URL'' should be replaced by the URL to the creator or community which maintains the helpserver. This does not have to be the same as the helpserver URL.
*Save [http://www.diamondlinks.net the] file afterwards
+
*Save the file afterwards
  
You can provide this file (or include it in a patch) to [http://www.diamondlinks.net the] potentional users of [http://www.diamondlinks.net the] helpserver.
+
You can provide this file (or include it in a patch) to the potentional users of the helpserver.
[http://www.diamondlinks.net the]y can set [http://www.diamondlinks.net the] helpserver to your translated version at [http://www.diamondlinks.net the] Back-end of [http://www.diamondlinks.net the]ir Joomla! site, at [http://www.diamondlinks.net the] Global Configurations. Go to [http://www.diamondlinks.net the] System tab and select [http://www.diamondlinks.net the] correct helpserver from [http://www.diamondlinks.net the] dropdown at Helpserver. Note that pushing [http://www.diamondlinks.net the] 'refresh' button causes that [http://www.diamondlinks.net the] helpserver xml file will be resetted, and thus [http://www.diamondlinks.net the] added helpserver be deleted.
+
They can set the helpserver to your translated version at the Back-end of their Joomla! site, at the Global Configurations. Go to the System tab and select the correct helpserver from the dropdown at Helpserver. Note that pushing the 'refresh' button causes that the helpserver xml file will be resetted, and thus the added helpserver be deleted.
  
  
Line 51: Line 53:
  
 
===Help Screens===
 
===Help Screens===
If you want to include your helpserver and set it as default, you should perform [http://www.diamondlinks.net the] following actions.
+
If you want to include your helpserver and set it as default, you should perform the following actions.
*Edit [http://www.diamondlinks.net the] helpserver-15.xml file as described at Requirements and Guidelines for Help Screens
+
*Edit the helpserver-15.xml file as described at Requirements and Guidelines for Help Screens
*Change [http://www.diamondlinks.net the] default $helpurl at [http://www.diamondlinks.net the] configuration.php-dist to your helpserver URL.
+
*Change the default $helpurl at the configuration.php-dist to your helpserver URL.
 
**Like this: change var $helpurl = 'http://help.joomla.org'; to var $helpurl = 'http://yourhelpserver.com';
 
**Like this: change var $helpurl = 'http://help.joomla.org'; to var $helpurl = 'http://yourhelpserver.com';
*Search for this file \installation_\localise.xml and add your own helpserver between [http://www.diamondlinks.net the] <helpurl> and </helpurl> tags.
+
*Search for this file \installation_\localise.xml and add your own helpserver between the <helpurl> and </helpurl> tags.

Revision as of 02:03, 24 April 2012

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Translations for Joomla! have a number of technical requirements and guidelines.

For Joomla 2.5.x see http://docs.joomla.org/Making_a_Language_Pack_for_Joomla_1.6

Contents

Requirements and Guidelines for Language Packs

All ini files need to be saved as UTF-8 - No BOM.

See http://docs.joomla.org/How_to_create_a_language_pack

See Joomla Translation Policy http://community.joomla.org/translations/translation-policy.html

See also http://community.joomla.org/translations/typical-language-file-headers.html

Requirements and Guidelines for Sample Data

Sample data are created by exporting tables from a Joomla! database to a file called sample_data.sql.

Requirements and Guidelines for Help Screens

Help Screens are the screens that will be displayed after pushing the 'Help' button at the Back-end screens. The official Help Screens are hosted from http://help.joomla.org. You can set up your own helpserver, in order to provide the Help Screens in your own language at the following way:

  • Download the Help Screens sql package from JoomlaCode here: http://joomlacode.org/gf/project/joomla/docman/?subdir=6
    • Choose the newest sql file for Joomla! 1.5, probably Joomla15HelpScreens2008-07-14.zip.
    • Apply the sql file to the Joomla! site which will act like the helpserver
    • Note: it is not possible to create a helpserver of a non-Joomla! site, eg a MediaWiki site. However, this will be possible in Joomla! 1.6.
  • Translate the Help Screen files from the package
  • To set the helpserver, search the file /administrator/help/helpsites-15.xml, which looks like this:
<joshelp>
<sites>
<site tag="en-GB" url="http://help.joomla.org">English (GB) - help.joomla.org</site>
</sites>
</joshelp>
  • Add an extra line with the information of your own helpserver, like this:
<joshelp>
<sites>
<site tag="en-GB" url="http://help.joomla.org">English (GB) - help.joomla.org</site>
<site tag="languagetag" url="http://yourhelpserver.com">Language (Shortened version of language) - Site URL</site>
</sites>
</joshelp>
  • Where:
    • languagetag should be replaced by the language tag of your language. Examples: en-GB, de-DE, nl-NL
    • http://yourhelpserver.com should be replaced by the URL to your Joomla! site which acts like the helpserver
    • Language (Shortened version of language) should be replaced by the full name of the language, followed by the last 2 letters of the language tag. Examples: English (GB), Deutsch (DE), Nederlands (NL)
    • Site URL should be replaced by the URL to the creator or community which maintains the helpserver. This does not have to be the same as the helpserver URL.
  • Save the file afterwards

You can provide this file (or include it in a patch) to the potentional users of the helpserver. They can set the helpserver to your translated version at the Back-end of their Joomla! site, at the Global Configurations. Go to the System tab and select the correct helpserver from the dropdown at Helpserver. Note that pushing the 'refresh' button causes that the helpserver xml file will be resetted, and thus the added helpserver be deleted.


Requirements and Guidelines for Localised Distributions

Help Screens

If you want to include your helpserver and set it as default, you should perform the following actions.

  • Edit the helpserver-15.xml file as described at Requirements and Guidelines for Help Screens
  • Change the default $helpurl at the configuration.php-dist to your helpserver URL.
  • Search for this file \installation_\localise.xml and add your own helpserver between the <helpurl> and </helpurl> tags.