Actions

Difference between revisions of "Creating language packs for extensions in Joomla 2.5"

From Joomla! Documentation

(One click updates)
m
 
(6 intermediate revisions by one user not shown)
Line 4: Line 4:
 
Here you will find examples for file structure, XML and lang files content and an installation unit set of files.
 
Here you will find examples for file structure, XML and lang files content and an installation unit set of files.
 
* All of the language files could technically have been in the top directory, but this example will show how to set up files in folders in the language pack folder using the 'folder=' attribute in the XML <files> tag.  Also, putting them in folders as shown ensures that the installer can find them during installation to use them to display the name of the language pack as part of the installation confirmation.
 
* All of the language files could technically have been in the top directory, but this example will show how to set up files in folders in the language pack folder using the 'folder=' attribute in the XML <files> tag.  Also, putting them in folders as shown ensures that the installer can find them during installation to use them to display the name of the language pack as part of the installation confirmation.
 +
 +
See also http://docs.joomla.org/J2.5:Making_non-core_language_packs
  
 
== Example Plugin Language Pack ==
 
== Example Plugin Language Pack ==
Line 23: Line 25:
 
where the file 'ganymede_zz_zz_language_pack.xml' is the installation manifest file.   
 
where the file 'ganymede_zz_zz_language_pack.xml' is the installation manifest file.   
  
=== Special lang files for label ===
+
=== Special lang files for labels ===
Languages files for the set of files. You need to create one file for the lang pack, and a reference file for en-GB. They will be installed in Joomla admin language folder and the contents its displayed on the install screen and as label in extension manager
+
You need to create one file for the lang pack, and a reference language file for en-GB. They will be installed in Joomla admin language folder and the contents its displayed on the install screen and as label in extension manager
  
The file  'en-GB.files_ganymede_zz_zz_language_pack.sys.ini' would have this language keys in english:
+
The file  'en-GB.files_ganymede_zz_zz_language_pack.sys.ini' would have this language keys for english:
 
<pre>
 
<pre>
 
; package : plg_ganymede en-GB file for zz-ZZ language pack
 
; package : plg_ganymede en-GB file for zz-ZZ language pack
 
; translator : Galileu Galilei
 
; translator : Galileu Galilei
 +
; copyright    Copyright (c) 2006 - 2012. All rights reserved.
 
; License : GNU General Public License version 2 or later: http://www.gnu.org/copyleft/gpl.html
 
; License : GNU General Public License version 2 or later: http://www.gnu.org/copyleft/gpl.html
 
; Note : All ini files need to be saved as UTF-8 - No BOM
 
; Note : All ini files need to be saved as UTF-8 - No BOM
Line 37: Line 40:
 
</pre>
 
</pre>
  
The file 'zz-ZZ.files_ganymede_zz_zz_language_pack.sys.ini' would have similar contents only in zz-ZZ lang:
+
The file 'zz-ZZ.files_ganymede_zz_zz_language_pack.sys.ini' would have similar contents only for zz-ZZ lang:
 
<pre>
 
<pre>
 
; package : plg_ganymede zz-ZZ language pack
 
; package : plg_ganymede zz-ZZ language pack
 
; translator : Galileu Galilei
 
; translator : Galileu Galilei
 +
; copyright    Copyright (c) 2006 - 2012. All rights reserved.
 
; License : GNU General Public License version 2 or later: http://www.gnu.org/copyleft/gpl.html
 
; License : GNU General Public License version 2 or later: http://www.gnu.org/copyleft/gpl.html
 
; Note : All ini files need to be saved as UTF-8 - No BOM
 
; Note : All ini files need to be saved as UTF-8 - No BOM
Line 50: Line 54:
 
* Note that the name of the language key (to the left of the equals sign) must be identical to the name of the manifest file prefixed with 'files_' in order for the extension manager to find it.
 
* Note that the name of the language key (to the left of the equals sign) must be identical to the name of the manifest file prefixed with 'files_' in order for the extension manager to find it.
 
As in 'FILES_GANYMEDE_ZZ_ZZ_LANGUAGE_PACK' for XML file named 'ganymede_zz_zz_language_pack.xml' .
 
As in 'FILES_GANYMEDE_ZZ_ZZ_LANGUAGE_PACK' for XML file named 'ganymede_zz_zz_language_pack.xml' .
 
  
 
=== Example plugin manifest file ===
 
=== Example plugin manifest file ===
Line 81: Line 84:
 
         </files>
 
         </files>
 
       </fileset>
 
       </fileset>
 +
    <!-- Lang pack updates -->
 
     <updateservers>
 
     <updateservers>
 
         <server type="collection" priority="1" name="zz-ZZ Language Updates">http://update.zzZZ.com/translationlist.xml</server>
 
         <server type="collection" priority="1" name="zz-ZZ Language Updates">http://update.zzZZ.com/translationlist.xml</server>
Line 88: Line 92:
  
 
Special note:
 
Special note:
This example includes also the update servers statement for languages updates using the discovery feature on Joomla Extensions manager
+
This example includes also the update servers statement for one click languages updates using the discovery feature on Joomla Extensions manager
  
  
Line 137: Line 141:
 
   <?xml version="1.0" encoding="utf-8"?>
 
   <?xml version="1.0" encoding="utf-8"?>
 
   <extension version="2.5" type="file" method="upgrade">
 
   <extension version="2.5" type="file" method="upgrade">
       <name>JUPITER_ZZ_ZZ_LANGUAGE_PACK</name>
+
       <name>FILES_JUPITER_ZZ_ZZ_LANGUAGE_PACK</name>
 
       <version>1.0.0</version>
 
       <version>1.0.0</version>
 
       <creationDate>07 January 1609</creationDate>
 
       <creationDate>07 January 1609</creationDate>
Line 145: Line 149:
 
       <copyright>Copyright (C) 2011 ???. All rights reserved.</copyright>
 
       <copyright>Copyright (C) 2011 ???. All rights reserved.</copyright>
 
       <license>http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL</license>
 
       <license>http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL</license>
       <description>JUPITER_ZZ_ZZ_LANGUAGE_PACK_DESC</description>
+
       <description>FILES_JUPITER_ZZ_ZZ_LANGUAGE_PACK_DESC</description>
 
       <fileset>
 
       <fileset>
 
           <!-- Admin component language folder -->
 
           <!-- Admin component language folder -->
Line 170: Line 174:
 
           <!-- Lang pack languages -->
 
           <!-- Lang pack languages -->
 
           <files folder="language/en-GB" target="language/en-GB">
 
           <files folder="language/en-GB" target="language/en-GB">
 +
              <filename>index.html</filename>
 
               <filename>en-GB.files_jupiter_zz_zz_language_pack.sys.ini</filename>
 
               <filename>en-GB.files_jupiter_zz_zz_language_pack.sys.ini</filename>
 
           </files>
 
           </files>
Line 191: Line 196:
 
== One click updates ==
 
== One click updates ==
 
Joomla has the ability to install language packs updates with just one click. This can be done for language core files but also for extensions languages files.
 
Joomla has the ability to install language packs updates with just one click. This can be done for language core files but also for extensions languages files.
Read here:  [[ One_click_updates_for_language_packs One click updates for language packs ]]
+
 
 +
Read here:  [[One_click_updates_for_language_packs|One click updates for language packs]]
  
  
 
[[Category:Joomla! 2.5]] [[Category:Component Development]]
 
[[Category:Joomla! 2.5]] [[Category:Component Development]]

Latest revision as of 06:11, 15 January 2014

Contents

Although Joomla 2.5 supports installing language files for the front end (site) or back end (admin), it has no dedicated way to install language files for extensions (components, plugins, modules) unless they are installed with the extension itself.

Fortunately, since Joomla 1.6, Joomla! supports a powerful way to install an arbitrary set of files called a 'files' installation unit. Here you will find examples for file structure, XML and lang files content and an installation unit set of files.

  • All of the language files could technically have been in the top directory, but this example will show how to set up files in folders in the language pack folder using the 'folder=' attribute in the XML <files> tag. Also, putting them in folders as shown ensures that the installer can find them during installation to use them to display the name of the language pack as part of the installation confirmation.

See also http://docs.joomla.org/J2.5:Making_non-core_language_packs

Example Plugin Language Pack

Suppose you have a content plugin named 'ganymede' that you want to create a new language pack for language zz-ZZ. Here is what your language pack files in the folder 'ganymede_zz_zz_language_pack' might look like:

── ganymede_zz_zz_language_pack
   ├── index.html
   ├── ganymede_zz_zz_language_pack.xml
   ├── zz-ZZ.plg_content_ganymede.ini
   ├── zz-ZZ.plg_content_ganymede.sys.ini
   └── language
       ├── en-GB
       │   └── en-GB.files_ganymede_zz_zz_language_pack.sys.ini
       └── zz-ZZ
           └── zz-ZZ.files_ganymede_zz_zz_language_pack.sys.ini

where the file 'ganymede_zz_zz_language_pack.xml' is the installation manifest file.

Special lang files for labels

You need to create one file for the lang pack, and a reference language file for en-GB. They will be installed in Joomla admin language folder and the contents its displayed on the install screen and as label in extension manager

The file 'en-GB.files_ganymede_zz_zz_language_pack.sys.ini' would have this language keys for english:

; package : plg_ganymede en-GB file for zz-ZZ language pack
; translator : Galileu Galilei
; copyright    Copyright (c) 2006 - 2012. All rights reserved.
; License : GNU General Public License version 2 or later: http://www.gnu.org/copyleft/gpl.html
; Note : All ini files need to be saved as UTF-8 - No BOM

FILES_GANYMEDE_ZZ_ZZ_LANGUAGE_PACK="Plugin Ganymede zz-ZZ Language Pack"
FILES_GANYMEDE_ZZ_ZZ_LANGUAGE_PACK_DESC="Plugin Ganymede zz-ZZ Language Pack created by zz-ZZ Team"

The file 'zz-ZZ.files_ganymede_zz_zz_language_pack.sys.ini' would have similar contents only for zz-ZZ lang:

; package : plg_ganymede zz-ZZ language pack
; translator : Galileu Galilei
; copyright    Copyright (c) 2006 - 2012. All rights reserved.
; License : GNU General Public License version 2 or later: http://www.gnu.org/copyleft/gpl.html
; Note : All ini files need to be saved as UTF-8 - No BOM

FILES_GANYMEDE_ZZ_ZZ_LANGUAGE_PACK="Plugin Ganymede zz-ZZ Language Pack"
FILES_GANYMEDE_ZZ_ZZ_LANGUAGE_PACK_DESC="Plugin Ganymede zz-ZZ Language Pack created by zz-ZZ Team"
  • Note that the name of the language key (to the left of the equals sign) must be identical to the name of the manifest file prefixed with 'files_' in order for the extension manager to find it.

As in 'FILES_GANYMEDE_ZZ_ZZ_LANGUAGE_PACK' for XML file named 'ganymede_zz_zz_language_pack.xml' .

Example plugin manifest file

The manifest file would look something like this:

    <?xml version="1.0" encoding="utf-8"?>
    <extension version="2.5" type="file" method="upgrade">
      <name>GANYMEDE_ZZ_ZZ_LANGUAGE_PACK</name>
      <version>1.0.0</version>
      <creationDate>07 January 1609</creationDate>
      <author>Galileu Galilei</author>
      <authorEmail></authorEmail>
      <authorUrl></authorUrl>
      <copyright>Copyright (C) 2011 - 2012. All rights reserved.</copyright>
      <license>GNU/GPL http://www.gnu.org/licenses/gpl-2.0.html</license>
      <description>GANYMEDE_ZZ_ZZ_LANGUAGE_PACK_DESC</description>
      <fileset>
        <!-- Language files for the plugin -->
        <files target="plugins/content/ganymede/language/zz-ZZ">
          <filename>index.html</filename>
          <filename>zz-ZZ.plg_content_ganymede.ini</filename>
          <filename>zz-ZZ.plg_content_ganymede.sys.ini</filename>
        </files>
        <!-- Lang pack languages -->
        <files folder="language/en-GB" target="language/en-GB">
          <filename>en-GB.files_ganymede_zz_zz_language_pack.sys.ini</filename>
        </files>
        <files folder="language/zz-ZZ" target="language/zz-ZZ">
          <filename>zz-ZZ.files_ganymede_zz_zz_language_pack.sys.ini</filename>
        </files>
      </fileset>
    <!-- Lang pack updates -->
    <updateservers>
        <server type="collection" priority="1" name="zz-ZZ Language Updates">http://update.zzZZ.com/translationlist.xml</server>
    </updateservers>
    </extension>

Special note: This example includes also the update servers statement for one click languages updates using the discovery feature on Joomla Extensions manager


A few notes and warnings:

  • Once this installed, the pseudo-language pack will be listed in the Extension manager (not the language manager).
  • This approach installs the plugin language files into the correct location inside the plugin folder. This is the new approach for the location of extension language files in Joomla 1.6+.
  • The language files 'zz-ZZ.files_ganymede_zz_zz_language_pack.sys.ini' (and its English counterpart) will be put into the top-level (site) language/ folder. They are only needed for displaying the name of this pseudo-language pack in the Extension manager.
  • The English version of the language pack file need to be included. This is not only for convenience even if English is often a second language for many sites.


Creating a language pack for several extensions in one file

This same a approach can be used to create a single language pack for several extensions at once. Just create a language pack as shown above for a plugin and add additional <files> sections for each component, plugin, and module. An additional benefit is that language-specific versions of the help file can be installed in their correct locations as well.

For example suppose we have an extension composed by a plugin 'ganymede' and a component 'jupiter'. To create the zz-ZZ language pack, set up files in the following directory structure:

── jupiter_zz_zz_language_pack
   ├── jupiter_zz_zz_language_pack.xml
   ├── com_jupiter
   │   ├── administrator
   │   │   ├── help
   │   │   │   └── zz-ZZ
   │   │   │       ├── help.css
   │   │   │       ├── help.html
   │   │   │       └── index.html
   │   │   ├── index.html
   │   │   ├── zz-ZZ.com_jupiter.ini
   │   │   └── zz-ZZ.com_jupiter.sys.ini
   │   └── language
   │       ├── index.html
   │       └── zz-ZZ.com_jupiter.ini
   ├── plg_ganymede
   │   ├── index.html
   │   ├── zz-ZZ.plg_content_ganymede.ini
   │   └── zz-ZZ.plg_content_ganymede.sys.ini
   └── language
       ├── en-GB
       │   └── en-GB.files_jupiter_zz_zz_language_pack.sys.ini
       └── zz-ZZ
           └── zz-ZZ.files_jupiter_zz_zz_language_pack.sys.ini


Manifest file for component and plugin

The corresponding manifest file for jupiter_zz_zz_language_pack.xml, would like something like this:


  <?xml version="1.0" encoding="utf-8"?>
  <extension version="2.5" type="file" method="upgrade">
      <name>FILES_JUPITER_ZZ_ZZ_LANGUAGE_PACK</name>
      <version>1.0.0</version>
      <creationDate>07 January 1609</creationDate>
      <author>Galileu Galilei</author>
      <authorEmail></authorEmail>
      <authorUrl></authorUrl>
      <copyright>Copyright (C) 2011 ???. All rights reserved.</copyright>
      <license>http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL</license>
      <description>FILES_JUPITER_ZZ_ZZ_LANGUAGE_PACK_DESC</description>
      <fileset>
          <!-- Admin component language folder -->
          <files folder="com_jupiter/administrator" target="administrator/components/com_jupiter/language/zz-ZZ">
              <filename>index.html</filename>
              <filename>zz-ZZ.com_jupiter.ini</filename>
              <filename>zz-ZZ.com_jupiter.sys.ini</filename>
          </files>
          <!-- Admin component zz language help folder -->
          <files folder="com_jupiter/administrator/help/" target="administrator/components/com_jupiter/help">
              <folder>zz-ZZ</folder>
          </files>
          <!-- Site component language folder -->
          <files folder="com_jupiter/language" target="components/com_jupiter/language/zz-ZZ">
              <filename>index.html</filename>
              <filename>zz-ZZ.com_jupiter.ini</filename>
          </files>
          <!-- Ganymede plugin language files -->
          <files folder="plg_ganymede" target="plugins/content/ganymede/language/zz-ZZ">
              <filename>index.html</filename>
              <filename>zz-ZZ.plg_content_ganymede.ini</filename>
              <filename>zz-ZZ.plg_content_ganymede.sys.ini</filename>
          </files>
          <!-- Lang pack languages -->
          <files folder="language/en-GB" target="language/en-GB">
              <filename>index.html</filename>
              <filename>en-GB.files_jupiter_zz_zz_language_pack.sys.ini</filename>
          </files>
          <files folder="language/zz-ZZ" target="language/zz-ZZ">
              <filename>zz-ZZ.files_jupiter_zz_zz_language_pack.sys.ini</filename>
          </files>
      </fileset>
    <updateservers>
        <server type="collection" priority="1" name="zz-ZZ Language Updates">http://update.zzZZ.com/translationlist.xml</server>
    </updateservers>
  </extension>

Note that we have created several different <files> sections for the admin language files, the admin help files, the site language files, the plugin language files, and the language files for the language pack itself.


Example installation unit

SVN 'files' for: Installation unit for an arbitrary set of files named 'files_test1').


One click updates

Joomla has the ability to install language packs updates with just one click. This can be done for language core files but also for extensions languages files.

Read here: One click updates for language packs