Actions

J1.5

Difference between revisions of "How to create a language pack"

From Joomla! Documentation

m (add ref to J1.5 Language pack forum)
m (Guidelines for developers: fix to link)
(8 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{review}}
+
{{review}} {{RightTOC}}
 
+
==CORE language packs==
 
Joomla! uses three language packages, one for the front end, one for the administrator and one for installation. Ideally you will create all three.
 
Joomla! uses three language packages, one for the front end, one for the administrator and one for installation. Ideally you will create all three.
  
A translation pack consists of an xml file, a blank index file and a set of *.ini files containing the language strings for your language. The easiest way to understand  this structure is to look at the files in the language/en-GB folder of your Joomla! installation.  
+
For practical information on the way to make core translation files:
 +
* '''For Joomla! 3.x, see '''[[Making a Language Pack for Joomla 3.x]]'''
 +
* '''For Joomla! 1.6.x and 2.5.x, see '''[[Making a Language Pack for Joomla 1.6]]'''
 +
* '''For Joomla! 1.5, see forum: [http://forum.joomla.org/viewtopic.php?f=11&t=254709 How to create a new 1.5 language pack].
  
This is an excerpt from en-GB.mod_login.ini
+
==Files encoding==
 +
* ALL FILES MUST BE SAVED AS UTF8 NO BOM (for non-ascii glyphs as in accented letters, etc.)
  
<code>
 
  
 +
==Tools==
 +
Many people find it helpful to use the [http://joomlacode.org/gf/project/trans_mngr/frs/ Translation manager extension]. This helps by automating the creation of the files.
 +
 +
 +
==Translation pack==
 +
A translation pack consists of an xml file, a blank index file and a set of *.ini files containing the language strings for your language. The easiest way to understand this structure is to look at the files in the language/en-GB folder of your Joomla! installation.
 +
 +
This is an excerpt from en-GB.mod_login.ini
 +
<source lang="php">
 
  BUTTON_LOGIN=Login
 
  BUTTON_LOGIN=Login
 
  BUTTON_LOGOUT=Logout
 
  BUTTON_LOGOUT=Logout
DESCLOGINFORM=This Module displays a username and password Login form. It also displays a link to retrieve a forgotten password.  If User registration is enabled, (refer to the Global Configuration settings), then another link will be shown to invite Users to  self-register.
 
 
  ENCRYPT LOGIN FORM=Encrypt Login Form
 
  ENCRYPT LOGIN FORM=Encrypt Login Form
 
  FORGOT_YOUR_PASSWORD=Forgot your password?
 
  FORGOT_YOUR_PASSWORD=Forgot your password?
 
  FORGOT_YOUR_USERNAME=Forgot your username?
 
  FORGOT_YOUR_USERNAME=Forgot your username?
 
  GREETING=Greeting
 
  GREETING=Greeting
</code>
+
</source>
 
+
To create a package for your language you change the strings to the right of the =.
+
 
+
  
Many people find it helpful to use the [http://extensions.joomla.org/component/option,com_mtree/task,viewlink/link_id,1776/Itemid,35/  translation manager extension]. This helps by automating the creation of the files.
+
To create a package for your language you change the strings to the right of the = signal.
  
Language naming convention in Joomla are
 
language and ISO code. Use 2 letters when available. [http://www.loc.gov/standards/iso639-2/php/code_list.php The list is available here.]
 
  
[http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm  This reference concerns country codes]
+
==Language naming convention==
 +
Language naming convention in Joomla are: language + ISO code.
 +
* Use 2 letters when available. [http://www.loc.gov/standards/iso639-2/php/code_list.php The list is available here.]
 +
* [http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm  This reference concerns country codes]
  
Because language strings may change it is best to create your packages using either [http://developer.joomla.org/code.html  the nightly build or subversion].
+
Name of package should start with your language's ISO code + description + version:
 +
* fr-FR_joomla_lang_full_3.0.2v1.zip
  
Name of package should be: xx-XX //using your language's ISO code.
 
  
Locale:
+
==Locale==
 +
The locale is used to sort translated lists when present on the server.
 
[http://forum.joomla.org/viewtopic.php?t=25077  Information on available locales may be found here.]
 
[http://forum.joomla.org/viewtopic.php?t=25077  Information on available locales may be found here.]
  
If, for any reason, ini or xml  language files are edited manually with a text editor, they have to be saved with the encoding UTF8 NO BOM.
 
  
For practical information on the way to make core Translation files for Joomla 1.0, please see forum: http://forum.joomla.org/viewtopic.php?f=11&t=254709.
+
==Guidelines for developers==
 +
Guidelines for developers to facilitate translation: [[Language Guidelines for 3rd Party Extensions]]
 +
* '''For Joomla 1.5 see the forum: [http://forum.joomla.org/viewtopic.php?f=11&t=88326&start=0 Building Extension's Language Pack for J1.5]
  
And for Jommla 1.5 see:
+
<noinclude>
[http://forum.joomla.org/viewtopic.php?f=11&t=88326&start=0 Building Extension's Language Pack for J1.5]
+
[[Category:Languages]][[Category:Tutorials]][[Category:Language Development]]
<noinclude>[[Category:Languages]]</noinclude>
+
</noinclude>

Revision as of 10:00, 16 April 2013

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.
Copyedit.png
This Page Needs Your Help

This page is tagged because it NEEDS REVIEW. You can help the Joomla! Documentation Wiki by contributing to it.
More pages that need help similar to this one are here. NOTE-If you feel the need is satistified, please remove this notice.

Contents

CORE language packs

Joomla! uses three language packages, one for the front end, one for the administrator and one for installation. Ideally you will create all three.

For practical information on the way to make core translation files:

Files encoding

  • ALL FILES MUST BE SAVED AS UTF8 NO BOM (for non-ascii glyphs as in accented letters, etc.)


Tools

Many people find it helpful to use the Translation manager extension. This helps by automating the creation of the files.


Translation pack

A translation pack consists of an xml file, a blank index file and a set of *.ini files containing the language strings for your language. The easiest way to understand this structure is to look at the files in the language/en-GB folder of your Joomla! installation.

This is an excerpt from en-GB.mod_login.ini

 BUTTON_LOGIN=Login
 BUTTON_LOGOUT=Logout
 ENCRYPT LOGIN FORM=Encrypt Login Form
 FORGOT_YOUR_PASSWORD=Forgot your password?
 FORGOT_YOUR_USERNAME=Forgot your username?
 GREETING=Greeting

To create a package for your language you change the strings to the right of the = signal.


Language naming convention

Language naming convention in Joomla are: language + ISO code.

Name of package should start with your language's ISO code + description + version:

  • fr-FR_joomla_lang_full_3.0.2v1.zip


Locale

The locale is used to sort translated lists when present on the server. Information on available locales may be found here.


Guidelines for developers

Guidelines for developers to facilitate translation: Language Guidelines for 3rd Party Extensions