Actions

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

From Joomla! Documentation

Line 6: Line 6:
 
== Example Plugin Language Pack ==
 
== Example Plugin Language Pack ==
  
Suppose you have a content plugin named 'alpha' that you want to create a new language pack for language zz-ZZ.  Here is what your language pack files in the folder 'alpha_zz_zz_language_pack' might look like:
+
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:
  
 
<pre>
 
<pre>
── alpha_zz_zz_language_pack
+
── ganymede_zz_zz_language_pack
 
   ├── index.html
 
   ├── index.html
   ├── alpha_zz_zz_language_pack.xml
+
   ├── ganymede_zz_zz_language_pack.xml
   ├── zz-ZZ.plg_content_alpha.ini
+
   ├── zz-ZZ.plg_content_ganymede.ini
   ├── zz-ZZ.plg_content_alpha.sys.ini
+
   ├── zz-ZZ.plg_content_ganymede.sys.ini
 
   └── language
 
   └── language
 
       ├── en-GB
 
       ├── en-GB
       │  └── en-GB.files_alpha_zz_zz_language_pack.sys.ini
+
       │  └── en-GB.files_ganymede_zz_zz_language_pack.sys.ini
 
       └── zz-ZZ
 
       └── zz-ZZ
           └── zz-ZZ.files_alpha_zz_zz_language_pack.sys.ini
+
           └── zz-ZZ.files_ganymede_zz_zz_language_pack.sys.ini
 
</pre>
 
</pre>
where the file 'alpha_zz_zz_language_pack.xml' is the installation manifest file.   
+
where the file 'ganymede_zz_zz_language_pack.xml' is the installation manifest file.   
  
 
The manifest file would look something like this:
 
The manifest file would look something like this:
Line 26: Line 26:
 
     <?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>alpha_zz_zz_language_pack</name>
+
       <name>ganymede_zz_zz_language_pack</name>
 
       <version>1.0.0</version>
 
       <version>1.0.0</version>
 
       <creationDate></creationDate>
 
       <creationDate></creationDate>
Line 32: Line 32:
 
       <authorEmail></authorEmail>
 
       <authorEmail></authorEmail>
 
       <authorUrl></authorUrl>
 
       <authorUrl></authorUrl>
       <copyright>Copyright (C) 2011 ???. All rights reserved.</copyright>
+
       <copyright>Copyright (C) 2011 - 2012. All rights reserved.</copyright>
       <license>http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL</license>
+
       <license>GNU/GPL http://www.gnu.org/licenses/gpl-2.0.html</license>
       <description>ALPHA_ZZ_ZZ_LANGUAGE_PACK</description>
+
       <description>GANYMEDE_ZZ_ZZ_LANGUAGE_PACK</description>
 
       <fileset>
 
       <fileset>
 
         <!-- Language files for the plugin -->
 
         <!-- Language files for the plugin -->
         <files target="plugins/content/alpha/language/zz-ZZ">
+
         <files target="plugins/content/ganymede/language/zz-ZZ">
 
           <filename>index.html</filename>
 
           <filename>index.html</filename>
           <filename>zz-ZZ.plg_content_alpha.ini</filename>
+
           <filename>zz-ZZ.plg_content_ganymede.ini</filename>
           <filename>zz-ZZ.plg_content_alpha.sys.ini</filename>
+
           <filename>zz-ZZ.plg_content_ganymede.sys.ini</filename>
 
         </files>
 
         </files>
 
         <!-- Languages files for this set of files (for label in extension manager) -->
 
         <!-- Languages files for this set of files (for label in extension manager) -->
 
         <files folder="language/en-GB" target="language/en-GB">
 
         <files folder="language/en-GB" target="language/en-GB">
           <filename>en-GB.files_alpha_zz_zz_language_pack.sys.ini</filename>
+
           <filename>en-GB.files_ganymede_zz_zz_language_pack.sys.ini</filename>
 
         </files>
 
         </files>
 
         <files folder="language/zz-ZZ" target="language/zz-ZZ">
 
         <files folder="language/zz-ZZ" target="language/zz-ZZ">
           <filename>zz-ZZ.files_alpha_zz_zz_language_pack.sys.ini</filename>
+
           <filename>zz-ZZ.files_ganymede_zz_zz_language_pack.sys.ini</filename>
 
         </files>
 
         </files>
 
       </fileset>
 
       </fileset>
Line 57: Line 57:
  
 
Special note:
 
Special note:
This example includes also the update servers statment for languages updates using the discovery feature on Joomla Extensions manager
+
This example includes also the update servers statement for languages updates using the discovery feature on Joomla Extensions manager
  
  
Line 63: Line 63:
 
* Once this installed, the pseudo-language pack will be listed in the Extension manager (not the language manager).
 
* 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+.
 
* 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_alpha_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 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 was included for convenience since English is often a second language for many sites.
 
* The English version of the language pack file was included for convenience since English is often a second language for many sites.
 
* All of the language files could technically have been in the top directory, but this example shows how to set up files in folders in the language pack folder using the 'folder=' attribute in the XML <files> tag as shown.  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 shows how to set up files in folders in the language pack folder using the 'folder=' attribute in the XML <files> tag as shown.  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.
  
The file 'zz-ZZ.files_alpha_zz_zz_language_pack.sys.ini' might have only one line like this:
+
The file 'zz-ZZ.files_ganymede_zz_zz_language_pack.sys.ini' might have only one line like this:
 
<pre>
 
<pre>
FILES_ALPHA_ZZ_ZZ_LANGUAGE_PACK=="Plugin Alpha zz-ZZ Language Pack"
+
FILES_GANYMEDE_ZZ_ZZ_LANGUAGE_PACK="Plugin Ganymede zz-ZZ Language Pack"
 
</pre>
 
</pre>
 
* The English version would have similar contents.  
 
* The English version would have similar contents.  
* Note that both the XML items 'name' and 'description' use the same term here (ALPHA_ZZ_ZZ_LANGUAGE_PACK) for convenience.  If you use different terms, be sure to add separate entries for each in the file 'zz-ZZ.files_alpha_zz_zz_language_pack.sys.ini'.
+
* Note that both the XML items 'name' and 'description' use the same term here (GANYMEDE_ZZ_ZZ_LANGUAGE_PACK) for convenience.  If you use different terms, be sure to add separate entries for each in the file 'zz-ZZ.files_ganymede_zz_zz_language_pack.sys.ini'.
 
* 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.
  
Line 78: Line 78:
 
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.   
 
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 a plugin 'alpha' and a component 'beta'.  To create the zz-ZZ language pack, set up files in the following directory structure:
+
For example suppose we have an extension composed a plugin 'ganymede' and a component 'jupiter'.  To create the zz-ZZ language pack, set up files in the following directory structure:
 
<pre>
 
<pre>
 
── extension_zz_zz_language_pack
 
── extension_zz_zz_language_pack
 
   ├── extension_zz_zz_language_pack.xml
 
   ├── extension_zz_zz_language_pack.xml
   ├── com_beta
+
   ├── com_jupiter
   │  ├── admin
+
   │  ├── administrator
 
   │  │  ├── help
 
   │  │  ├── help
 
   │  │  │  └── zz-ZZ
 
   │  │  │  └── zz-ZZ
Line 90: Line 90:
 
   │  │  │      └── index.html
 
   │  │  │      └── index.html
 
   │  │  ├── index.html
 
   │  │  ├── index.html
   │  │  ├── zz-ZZ.com_beta.ini
+
   │  │  ├── zz-ZZ.com_jupiter.ini
   │  │  └── zz-ZZ.com_beta.sys.ini
+
   │  │  └── zz-ZZ.com_jupiter.sys.ini
 
   │  └── site
 
   │  └── site
 
   │      ├── index.html
 
   │      ├── index.html
   │      └── zz-ZZ.com_beta.ini
+
   │      └── zz-ZZ.com_jupiter.ini
   ├── plg_alpha
+
   ├── plg_ganymede
 
   │  ├── index.html
 
   │  ├── index.html
   │  ├── zz-ZZ.plg_content_alpha.ini
+
   │  ├── zz-ZZ.plg_content_ganymede.ini
   │  └── zz-ZZ.plg_content_alpha.sys.ini
+
   │  └── zz-ZZ.plg_content_ganymede.sys.ini
 
   └── language
 
   └── language
 
       ├── en-GB
 
       ├── en-GB
Line 121: Line 121:
 
       <description>EXTENSION_ZZ_ZZ_LANGUAGE_PACK</description>
 
       <description>EXTENSION_ZZ_ZZ_LANGUAGE_PACK</description>
 
       <fileset>
 
       <fileset>
           <!-- Admin beta component language folder -->
+
           <!-- Admin Jupiter component language folder -->
           <files folder="com_beta/admin" target="administrator/components/com_beta/language/zz-ZZ">
+
           <files folder="com_jupiter/administrator" target="administrator/components/com_jupiter/language/zz-ZZ">
 
               <filename>index.html</filename>
 
               <filename>index.html</filename>
               <filename>zz-ZZ.com_beta.ini</filename>
+
               <filename>zz-ZZ.com_jupiter.ini</filename>
               <filename>zz-ZZ.com_beta.sys.ini</filename>
+
               <filename>zz-ZZ.com_jupiter.sys.ini</filename>
 
           </files>
 
           </files>
 
           <!-- Admin component zz language help folder -->
 
           <!-- Admin component zz language help folder -->
           <files folder="com_beta/admin/help/" target="administrator/components/com_beta/help">
+
           <files folder="com_jupiter/administrator/help/" target="administrator/components/com_jupiter/help">
 
               <folder>zz-ZZ</folder>
 
               <folder>zz-ZZ</folder>
 
           </files>
 
           </files>
 
           <!-- Site component language folder -->
 
           <!-- Site component language folder -->
           <files folder="com_beta/site" target="components/com_beta/language/zz-ZZ">
+
           <files folder="com_jupiter/site" target="components/com_jupiter/language/zz-ZZ">
 
               <filename>index.html</filename>
 
               <filename>index.html</filename>
               <filename>zz-ZZ.com_beta.ini</filename>
+
               <filename>zz-ZZ.com_jupiter.ini</filename>
 
           </files>
 
           </files>
           <!-- Alpha plugin language files -->
+
           <!-- Ganymede plugin language files -->
           <files folder="plg_alpha" target="plugins/content/alpha/language/zz-ZZ">
+
           <files folder="plg_ganymede" target="plugins/content/ganymede/language/zz-ZZ">
 
               <filename>index.html</filename>
 
               <filename>index.html</filename>
               <filename>zz-ZZ.plg_content_alpha.ini</filename>
+
               <filename>zz-ZZ.plg_content_ganymede.ini</filename>
               <filename>zz-ZZ.plg_content_alpha.sys.ini</filename>
+
               <filename>zz-ZZ.plg_content_ganymede.sys.ini</filename>
 
           </files>
 
           </files>
 
           <!-- Languages files for this set of files (for label in extension manager) -->
 
           <!-- Languages files for this set of files (for label in extension manager) -->
Line 153: Line 153:
 
</code>
 
</code>
 
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.
 
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:
 +
[http://joomlacode.org/gf/project/joomla/scmsvn/?action=browse&path=%2Fdevelopment%2Ftrunk%2Ftests%2F_data%2Finstaller_packages%2Ffiles_test1%2F Installation unit for an arbitrary set of files named 'files_test1']).
  
 
[[Category:Joomla! 2.5]]
 
[[Category:Joomla! 2.5]]

Revision as of 21:07, 15 March 2012

Copyedit.png
This Article Needs Your Help

This article 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

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. (See Installation unit for an arbitrary set of files named 'files_test1').

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.

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></creationDate>
     <author></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</description>
     <fileset>
       <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>
       <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>
   <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 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 was included for convenience since English is often a second language for many sites.
  • All of the language files could technically have been in the top directory, but this example shows how to set up files in folders in the language pack folder using the 'folder=' attribute in the XML <files> tag as shown. 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.

The file 'zz-ZZ.files_ganymede_zz_zz_language_pack.sys.ini' might have only one line like this:

FILES_GANYMEDE_ZZ_ZZ_LANGUAGE_PACK="Plugin Ganymede zz-ZZ Language Pack"
  • The English version would have similar contents.
  • Note that both the XML items 'name' and 'description' use the same term here (GANYMEDE_ZZ_ZZ_LANGUAGE_PACK) for convenience. If you use different terms, be sure to add separate entries for each in the file 'zz-ZZ.files_ganymede_zz_zz_language_pack.sys.ini'.
  • 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.

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 a plugin 'ganymede' and a component 'jupiter'. To create the zz-ZZ language pack, set up files in the following directory structure:

── extension_zz_zz_language_pack
   ├── extension_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
   │   └── site
   │       ├── 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_extension_zz_zz_language_pack.sys.ini
       └── zz-ZZ
           └── zz-ZZ.files_extension_zz_zz_language_pack.sys.ini

The corresponding manifest file, extension_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>extension_zz_zz_language_pack</name>
     <version>1.0.0</version>
     <creationDate></creationDate>
     <author></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>EXTENSION_ZZ_ZZ_LANGUAGE_PACK</description>
     <fileset>
         <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>
         <files folder="com_jupiter/administrator/help/" target="administrator/components/com_jupiter/help">
             <folder>zz-ZZ</folder>
         </files>
         <files folder="com_jupiter/site" target="components/com_jupiter/language/zz-ZZ">
             <filename>index.html</filename>
             <filename>zz-ZZ.com_jupiter.ini</filename>
         </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>
         <files folder="language/en-GB" target="language/en-GB">
             <filename>en-GB.files_extension_zz_zz_language_pack.sys.ini</filename>
         </files>
         <files folder="language/zz-ZZ" target="language/zz-ZZ">
             <filename>zz-ZZ.files_extension_zz_zz_language_pack.sys.ini</filename>
         </files>
     </fileset>
 </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').