Actions

Manifest files

From Joomla! Documentation

Revision as of 11:58, 16 April 2010 by Akede (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Quill icon.png
Content is Incomplete

This article or section is incomplete, which means it may be lacking information. You are welcome to assist in its completion by editing it as well. If this article or section has not been edited in several days, please consider helping complete the content.
This article was last edited by Akede (talk| contribs) 4 years ago. (Purge)

Quill icon.png
Page Actively Being Edited!

This article is actively undergoing a major edit for a short while.
As a courtesy, please do not edit this page while this message is displayed. The user who added this notice will be listed in the page history. This message is intended to help reduce edit conflicts; please remove it between editing sessions to allow others to edit the page. If this page has not been edited for several hours, please remove this template, or replace it with {{underconstruction}} or {{incomplete}}.

Contents

Template:Future

General information

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. The general structure of these files is similar for types extensions.

The article here will describe the general structure and elements of all manifest files. In the following special articles you will find detailed information about the related topics:

  • [Component manifest files]
  • [Module manifest files]
  • [Plugin manifest files]
  • [Template manifest files]
  • [Language manifest files]

Naming conventions

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

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 Joomla 1.5. The following attributes are allowed within the tag:

Attribute Values Description
type component
module
plugin
template
This attribute describes the type of the extension for the installer. Based on this type further requirements to sub-tags apply.
version 1.6 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 new
upgrade
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 site
administrator
Applicable for modules The client allows to specify for which application client the new module is available.
group <free name> "Applicable for 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.


Contributors