| This attribute describes the type of the extension for the installer. Based on this type further requirements to sub-tags apply.

| This attribute describes the type of the extension for the installer. Based on this type further requirements to sub-tags apply.

|-

|-

Line 33:

Line 32:

| client

| client

| <code>site</code><br /><code>administrator</code> || Modules

| <code>site</code><br /><code>administrator</code> || Modules

−

| The client allows to specify for which application client the new module is available.

+

| The client attribute allows you to specify for which application client the new module is available.

|-

|-

| group

| group

Line 57:

Line 56:

<source lang="xml">

<source lang="xml">

−

<files folder="from-folder">

+

<files folder="from-folder">

−

<filename>example.php</filename>

+

<filename>example.php</filename>

−

<folder>examples</folder>

+

<folder>examples</folder>

−

</files>

+

</files>

</source>

</source>

Files to copy to the front-end directory should be placed in the <code><files></code> element. You can use the optional <code>folder</code> attribute to specify a directory '''in the ZIP package''' to copy '''from'''. Each file to copy must be represented by a <code><filename></code> element. If you want to copy an entire folder at once, you can define it as a <code><folder></code>.

Files to copy to the front-end directory should be placed in the <code><files></code> element. You can use the optional <code>folder</code> attribute to specify a directory '''in the ZIP package''' to copy '''from'''. Each file to copy must be represented by a <code><filename></code> element. If you want to copy an entire folder at once, you can define it as a <code><folder></code>.

+

+

=== Media files ===

+

+

<source lang="xml>

+

<media folder="media" destination="com_example">

+

<filename>com_example_logo.png</filename>

+

<folder>css</folder>

+

<folder>js</folder>

+

</media>

+

</source>

+

+

This example will copy the file(s) (<tt>/media/com_example_logo.png</tt>) and folders ( <tt>/media/css/</tt> and <tt>/media/js/</tt> ) listed to <tt>/media/com_example/</tt>, creating the <tt>com_example</tt> folder if required. You can use the optional <code>folder</code> attribute to specify a directory '''in the ZIP package''' to copy '''from''' (in this case, <tt>media</tt>).

+

+

Extensions should be storing assets they need to be web accessible (JS, CSS, images etc) in <code>media</code>. Amongst other things this feature was added as step in the progression to multi-site support and the eventual move of code files (PHP) out of the web accessible areas of the server.

| ''string'' || An URL parameter to add to the link. For example, <code><menu view="cpanel">COM_EXAMPLE</menu></code> in com_example's XML manifest would cause the URL of the menu item to be <tt>index.php?option=com_example&view=cpanel</tt>.

|-

|-

−

| alt ||

|}

|}

−

{{Needsinfo|what do the other attributes do?}}

+

The value inside the tag is the menu's label. Unlike Joomla! 1.5, you can not use a natural language string. For example, if you would enter "Example Component" instead of COM_EXAMPLE, it would result in your component name appearing as example-component in the menu and you would be unable to provide a translation. In order to provide a translation you need to create a file named en-GB.com_example.sys.ini in administrator/languages/en-GB (you can use the manifest's <code><languages></code> tag to copy it during installation) or in administrator/components/com_example/language/en-GB. In the latter case, you must not include the translation file in the <code><languages></code> tag. As long as you have placed the language directory in your <code><files></code> tag, it will be copied along when the component is being installed.

+

+

The contents of that file should be:

+

<source>

+

COM_EXAMPLE="Example Component"

+

COM_EXAMPLE_SUBMENU_ANOPTION="Another Option"

+

COM_EXAMPLE_SUBMENU_VIEWNAME="Another View"

+

+

</source>

+

+

Please note that the language string must be enclosed in double quotes, as per Joomla!'s translation standards. Important note: Joomla! 1.6 and later sorts the Component menu items based on the actual translation of the key you supply in your XML manifest. This means that the sorting order is correct no matter what you call your translation key and no matter which language the site is being displayed in. Essentially, Joomla! 1.6 fixed the wrong sorting of the Components menu for the majority (non-English speaking!) of Joomla! users experienced under Joomla! 1.5.

{{warning|Components '''do not support''' configuration definitions '''in the manifest'''. This is a way implemented in Joomla! 1.5. They can define configuration options for multiple levels using [[Component configuration metadata]].}}

The <code><config></code> element, a child of the root, describes the configuration options for the extension. If applicable, the options will be shown by the appropriate Manager (Plugin Manager, Module Manager or Template Manager). '''Configuration options can also be defined in a separate file named <code>config.xml</code>. Its root element should be <code><config></code>.'''

The <code><config></code> element, a child of the root, describes the configuration options for the extension. If applicable, the options will be shown by the appropriate Manager (Plugin Manager, Module Manager or Template Manager). '''Configuration options can also be defined in a separate file named <code>config.xml</code>. Its root element should be <code><config></code>.'''

Line 112:

Line 146:

<source lang="xml">

<source lang="xml">

−

<install>

+

<install folder="admin">

<sql>

<sql>

−

<file driver="mysql" charset="utf8">example.install.sql</file>

+

<file driver="mysql" charset="utf8">sql/example.install.sql</file>

</sql>

</sql>

</install>

</install>

−

<uninstall>

+

<uninstall folder="admin">

<sql>

<sql>

−

<file driver="mysql" charset="utf8">example.uninstall.sql</file>

+

<file driver="mysql" charset="utf8">sql/example.uninstall.sql</file>

</sql>

</sql>

</uninstall>

</uninstall>

</source>

</source>

+

+

In above example, we put sql files in "admin/sql" folder of installation package. You have to include "sql" folder in administration files.

You can execute SQL during installation and/or uninstallation using the <code><install></code> and <code><uninstall></code> elements, respectively. An <code><sql></code> element should appear as a child of these elements. <code><sql></code> can contain any number of <code><file></code> elements, each defining a single SQL file to execute. Their database driver types are described by the <code>driver</code> attribute, their character sets by the <code>charset</code> attribute.

You can execute SQL during installation and/or uninstallation using the <code><install></code> and <code><uninstall></code> elements, respectively. An <code><sql></code> element should appear as a child of these elements. <code><sql></code> can contain any number of <code><file></code> elements, each defining a single SQL file to execute. Their database driver types are described by the <code>driver</code> attribute, their character sets by the <code>charset</code> attribute.

+

+

==== Update of the SQL schema ====

+

+

<source lang="xml">

+

<update>

+

<schemas>

+

<schemapath type="mysql">sql/updates/mysql</schemapath>

+

<schemapath type="sqlsrv">sql/updates/sqlsrv</schemapath>

+

</schemas>

+

</update>

+

</source>

+

+

Since 1.6, there is also an <code><update></code> tag, which allows to provide a series of SQL files to update the current schema.

+

+

=== Language files ===

+

In Joomla! 1.5, we put extension language files in Joomla! main language file, using <languages>..</languages> tag as shown below. This tag considered to be deprecated since Joomla! 1.6. We encourage you to put extension 's language files in extension folder and Joomla! is responsible for loading of required language files.

+

+

<source lang="xml">

+

<!-- Joomla! 1.5 language tag, deprecated since Joomla! 1.6 -->

+

<languages folder="langfiles">

+

<language tag="en-GB">en-GB.com_example.ini</language>

+

</languages>

+

</source>

+

+

Storing extension language files in extension folder, you gain benefit when removing some language from Joomla! installation. As your language files were not removed, when reinstall the language again you can use that files without install them again.

+

+

The structure of language folder for frontend and backend is the same. You put them in language/<tag> of your folder e.g. language/en-GB/. You have to specify these folders in frontend and backend files too.

+

+

During development you can turn on language debuggin in Joomla! global configuration. So you can investigate if the problems exists.

=== Script file ===

=== Script file ===

Line 132:

Line 197:

</source>

</source>

−

A '''script file''' (PHP code that is run before, during and/or after installation, uninstallation and upgrading) can be defined using a <code><scriptfile></code> element.

+

An optional '''script file''' (PHP code that is run before, during and/or after installation, uninstallation and upgrading) can be defined using a <code><scriptfile></code> element. This file should contain a class named "<element_name>IntallerScript" where <element_name> is the name of your extension (e.g. com_componentname, mod_modulename, etc.). Plugins requires to state the group (e.g. plgsystempluginname). The structure of the class is as follows:

Introduction

Within Joomla there are manifest files for all of the extensions. These files include the general installation information as well as parameters for the configuration of the extension itself. Since Joomla! 1.6 , there are very few differences between the manifest file formats for the different types of extensions, allowing each type to access the full power of the Joomla! installer.

Naming conventions

The file must be named manifest.xml or <extension_name>.xml and located in the root directory of the installation package.

Syntax

Root element

The primary tag of the installation file is:

<extension></extension>

This starting and closing tags are now valid for all extensions. The new tag <extension> replaces the old <install></install> from Joomla . The following attributes are allowed within the tag:

Attribute

Values

Applicable to

Description

type

componentfilelanguagelibrarymodulepackageplugintemplate

All extensions

This attribute describes the type of the extension for the installer. Based on this type further requirements to sub-tags apply.

version

1.6

All extensions

String that identifies the version of Joomla for which this extension is developed. For Joomla 1.6 a version higher than 1.5 is required.

method

newupgrade

All extensions

The default value install will be also used if the method attribute is not used. In these cases the installer will gracefully stop if he finds any existing file/folder of the new extension

client

siteadministrator

Modules

The client attribute allows you to specify for which application client the new module is available.

group

string

Plugins

The group name specifies for which group of plugins the new plugin is available. The existing groups are the folder names within the directory /plugins. The installer will create new folder names for group names that do not exist yet.

Metadata

The following elements can be used to insert metadata. None of these elements are required; if they are present, they must be a child of the root element.

Front-end files

Files to copy to the front-end directory should be placed in the <files> element. You can use the optional folder attribute to specify a directory in the ZIP package to copy from. Each file to copy must be represented by a <filename> element. If you want to copy an entire folder at once, you can define it as a <folder>.

Media files

This example will copy the file(s) (/media/com_example_logo.png) and folders ( /media/css/ and /media/js/ ) listed to /media/com_example/, creating the com_example folder if required. You can use the optional folder attribute to specify a directory in the ZIP package to copy from (in this case, media).

Extensions should be storing assets they need to be web accessible (JS, CSS, images etc) in media. Amongst other things this feature was added as step in the progression to multi-site support and the eventual move of code files (PHP) out of the web accessible areas of the server.

Administration section

The administration section is defined in the <administration> element. Since only components apply to both the site and the administrator, only component manifests can include this element.

Back-end files

Files to copy to the back-end directory should be placed in the <files> element under the <administration>. You can use the optional folder attribute to specify a directory in the ZIP package to copy from. See Front-end files for further rules.

Menu links and submenus

The text for the main menu item for the component is defined in the <menu> item, a child of <administration>. A <submenu> element may also be present (also a child of <administration>), which may contain more menu items defined by <menu>.

Additionally, each <menu> item can define the following attributes:

Attribute

Description

link

A link to send the user to when the menu item is clicked

img

The (relative) path to an image (16x16 pixels) to appear beside the menu item.

Must be an url compatible as a file too (e.g. no spaces) !

alt

string

An URL parameter to add to the link. For example, <menu view="cpanel">COM_EXAMPLE</menu> in com_example's XML manifest would cause the URL of the menu item to be index.php?option=com_example&view=cpanel.

The value inside the tag is the menu's label. Unlike Joomla! 1.5, you can not use a natural language string. For example, if you would enter "Example Component" instead of COM_EXAMPLE, it would result in your component name appearing as example-component in the menu and you would be unable to provide a translation. In order to provide a translation you need to create a file named en-GB.com_example.sys.ini in administrator/languages/en-GB (you can use the manifest's

tag as shown below. This tag considered to be deprecated since Joomla! 1.6. We encourage you to put extension 's language files in extension folder and Joomla! is responsible for loading of required language files.

Storing extension language files in extension folder, you gain benefit when removing some language from Joomla! installation. As your language files were not removed, when reinstall the language again you can use that files without install them again.

The structure of language folder for frontend and backend is the same. You put them in language/<tag> of your folder e.g. language/en-GB/. You have to specify these folders in frontend and backend files too.

During development you can turn on language debuggin in Joomla! global configuration. So you can investigate if the problems exists.

Script file

<scriptfile>example.script.php</scriptfile>

An optional script file (PHP code that is run before, during and/or after installation, uninstallation and upgrading) can be defined using a <scriptfile> element. This file should contain a class named "<element_name>IntallerScript" where <element_name> is the name of your extension (e.g. com_componentname, mod_modulename, etc.). Plugins requires to state the group (e.g. plgsystempluginname). The structure of the class is as follows:

Update servers can be defined in the <updateservers> element, a child of the root. This element may contain one or more <server> element, each describing a location to fetch updates from. Each <server> item can define the following attributes: