Creating language packs for extensions in Joomla 1.6/1.7 - Revision history

Horus 68 at 03:22, 16 March 2012

2012-03-16T03:22:15Z

Jmcameron: moved Creating language packs for extensions in Joomla 1.6 to Creating language packs for extensions in Joomla 1.6/1.7: Applies to both 1.6 and 1.6

2011-09-11T02:13:27Z

moved Creating language packs for extensions in Joomla 1.6 to Creating language packs for extensions in Joomla 1.6/1.7: Applies to both 1.6 and 1.6

Jmcameron at 02:12, 11 September 2011

2011-09-11T02:12:13Z

Jmcameron: Request reveiw

2011-07-13T14:03:14Z

Request reveiw

Jmcameron: /* Example Plugin Language Pack */

2011-07-11T04:05:07Z

‎Example Plugin Language Pack

Jmcameron: /* Creating a language pack for several extensions in one file */

2011-07-11T02:49:56Z

‎Creating a language pack for several extensions in one file

Jmcameron: /* Creating a language pack for several extensions in one file */

2011-07-11T02:48:59Z

‎Creating a language pack for several extensions in one file

Jmcameron: /* Creating a language pack for several extensions in one file */

2011-07-11T02:46:57Z

‎Creating a language pack for several extensions in one file

Jmcameron: /* Creating a language pack for several extensions in one file */

2011-07-11T02:46:08Z

‎Creating a language pack for several extensions in one file

Jmcameron: /* Creating a language pack for several extensions in one file */

2011-07-11T02:43:24Z

‎Creating a language pack for several extensions in one file

@@ Line 1: / Line 1: @@
-{{review}}
+{{RightTOC}}Although Joomla 1.6 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.
 Although Joomla 1.6 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, Joomla 1.6 supports a powerful way to install an arbitrary set of files called a 'files' installation unit.  (See [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']).
@@ Line 10: / Line 9: @@
 <pre>
 ── alpha_zz_zz_language_pack
-   ├── index.html
+   ├── index.html
     ├── alpha_zz_zz_language_pack.xml
-   ├── zz-ZZ.plg_content_alpha.ini
+   ├── zz-ZZ.plg_content_alpha.ini
-   ├── zz-ZZ.plg_content_alpha.sys.ini
+   ├── zz-ZZ.plg_content_alpha.sys.ini
     └── language
-       ├── en-GB
+       ├── en-GB
-       │   └── en-GB.files_alpha_zz_zz_language_pack.sys.ini
+       │   └── en-GB.files_alpha_zz_zz_language_pack.sys.ini
-       └── zz-ZZ
+       └── zz-ZZ
-           └── zz-ZZ.files_alpha_zz_zz_language_pack.sys.ini
+           └── zz-ZZ.files_alpha_zz_zz_language_pack.sys.ini
 </pre>
 where the file 'alpha_zz_zz_language_pack.xml' is the installation manifest file.
@@ Line 62: / Line 61: @@
 The file 'zz-ZZ.files_alpha_zz_zz_language_pack.sys.ini' might have only one line like this:
 <pre>
-FILES_ALPHA_ZZ_ZZ_LANGUAGE_PACK=="Plugin Alpha zz-ZZ Language Pack"
+FILES_ALPHA_ZZ_ZZ_LANGUAGE_PACK="Plugin Alpha zz-ZZ Language Pack"
 </pre>
 * The English version would have similar contents.
@@ Line 101: / Line 100: @@
 The corresponding manifest file, extension_zz_zz_language_pack.xml, would like something like this:
-<code lang="xml">
+<source lang="php">
    <?xml version="1.0" encoding="utf-8"?>
    <extension version="1.6" type="file" method="upgrade">
@@ Line 144: / Line 143: @@
        </fileset>
    </extension>
-</code>
+</source>
 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.

← Older revision		Revision as of 02:12, 11 September 2011
Line 149:		Line 149:


−	[[Category:Joomla! 1.6]]	+	[[Category:Joomla! 1.6]][[Category:Joomla! 1.7]]

← Older revision		Revision as of 14:03, 13 July 2011
Line 1:		Line 1:
		+	{{review}}
	Although Joomla 1.6 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.		Although Joomla 1.6 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.

@@ Line 57: / Line 57: @@
 * 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 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 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.
+* 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:

@@ Line 98: / Line 98: @@
 </pre>
-The corresponding manifest file
+The corresponding manifest file, extension_zz_zz_language_pack.xml, would like something like this:
 <code lang="xml">

@@ Line 101: / Line 101: @@
 <code lang="xml">
-<?xml version="1.0" encoding="utf-8"?>
-<extension version="1.6" type="file" method="upgrade">
-    <name>extension_zz_zz_language_pack</name>
-    <version>1.6</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>
-        <!-- Admin beta component language folder -->
-        <files folder="com_beta/admin" target="administrator/components/com_beta/language/zz-ZZ">
-            <filename>index.html</filename>
-            <filename>zz-ZZ.com_beta.ini</filename>
-            <filename>zz-ZZ.com_beta.sys.ini</filename>
-        </files>
-        <!-- Admin component zz language help folder -->
-        <files folder="com_beta/admin/help/" target="administrator/components/com_beta/help">
-            <folder>zz-ZZ</folder>
-        </files>
-        <!-- Site component language folder -->
-        <files folder="com_beta/site" target="components/com_beta/language/zz-ZZ">
-            <filename>index.html</filename>
-            <filename>zz-ZZ.com_beta.ini</filename>
-        </files>
-        <!-- Alpha plugin language files -->
-        <files folder="plg_alpha" target="plugins/content/alpha/language/zz-ZZ">
-            <filename>index.html</filename>
-            <filename>zz-ZZ.plg_content_alpha.ini</filename>
-            <filename>zz-ZZ.plg_content_alpha.sys.ini</filename>
-        </files>
-        <!-- Languages files for this set of files (for label in extension manager) -->
-        <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>
 </code>