Joomla! Documentation - User contributions [en]

J1.5:Plugin/Events/Content

2013-01-20T04:07:24Z

Griiettner: Closing unclosed code tag

{{incomplete}}
{{RightTOC}}
Content events are triggered during the content creation process. This may occur in views in the com_content component, or in other components or modules.

==onPrepareContent==
===Description===
This is the first stage in preparing content for output and is the most common point
for content orientated plugins to do their work. Since the article and related parameters
are passed by reference, event handlers can modify them prior to display.
===Parameters===
*<code>article</code> A reference to the article that is being rendered by the view.
*<code>params</code> A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.
*<code>limitstart</code> An integer that determines the "page" of the content that is to be generated. Note that in the context of views that might not generate HTML output, a page is a reasonably abstract concept that depends on the context.
===Return Value===
None. Results are returned by modifying the referenced arguments.
===Used in files===
*<tt>components/com_content/views/article/view.html.php</tt>
*<tt>components/com_content/views/article/view.pdf.php</tt>
*<tt>components/com_content/views/category/view.html.php</tt>
*<tt>components/com_content/views/frontpage/view.html.php</tt>
*<tt>components/com_content/views/section/view.html.php</tt>
*<tt>plugins/content/code.php</tt>
*<tt>plugins/content/emailcloak.php</tt>
*<tt>plugins/content/geshi.php</tt>
*<tt>plugins/content/image.php</tt>
*<tt>plugins/content/loadmodule.php</tt>
*<tt>plugins/content/pagebreak.php</tt>
*<tt>plugins/content/sef.php</tt>

==onAfterDisplayTitle==
===Description===
This is a request for information that should be placed between the content title and
the content body.
Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose.
===Parameters===
See the onPrepareContent event for additional discussion of these parameters.
*<code>article</code> The article that is being rendered by the view.
*<code>params</code> An associative array of relevant parameters.
*<code>limitstart</code> An integer that determines the "page" of the content that is to be generated.
===Return Value===
String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.
===Used in files===
*<tt>components/com_content/views/article/view.html.php</tt>
*<tt>components/com_content/views/category/view.html.php</tt>
*<tt>components/com_content/views/frontpage/view.html.php</tt>
*<tt>components/com_content/views/section/view.html.php</tt>
*<tt>modules/mod_newsflash/helper.php</tt>
===See Also===
*<tt>components/com_content/views/article/tmpl/default.php</tt>

==onBeforeDisplayContent==
===Description===
This is a request for information that should be placed immediately before the generated content. For views that generate XHTML/HTML, this might include the use of styles that are specified as part of the content or related parameters.
Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose.
===Parameters===
See the onPrepareContent event for additional discussion of these parameters. Note that
unlike onPrepareContent, these parameters are passed by value.
*<code>article</code> The article that is being rendered by the view.
*<code>params</code> An associative array of relevant parameters.
*<code>limitstart</code> An integer that determines the "page" of the content that is to be generated.
===Return Value===
String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.
===Used in files===
*<tt>components/com_content/views/article/view.html.php</tt>
*<tt>components/com_content/views/category/view.html.php</tt>
*<tt>components/com_content/views/frontpage/view.html.php</tt>
*<tt>components/com_content/views/section/view.html.php</tt>
*<tt>modules/mod_newsflash/helper.php</tt>

===See Also===
*<tt>components/com_content/views/article/tmpl/default.php</tt>

==onAfterDisplayContent==
===Description===
This is a request for information that should be placed immediately after the generated content. For views that generate XHTML/HTML, this might include the closure of styles that are specified as part of the content or related parameters.
Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose.
===Parameters===
See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.
*<code>article</code> The article that is being rendered by the view.
*<code>params</code> An associative array of relevant parameters.
*<code>limitstart</code> An integer that determines the "page" of the content that is to be generated.
===Return Value===
String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.
===Used in files===
*<tt>components/com_content/views/article/view.html.php</tt>
*<tt>components/com_content/views/category/view.html.php</tt>
*<tt>components/com_content/views/frontpage/view.html.php</tt>
*<tt>components/com_content/views/section/view.html.php</tt>
===See Also===
*<tt>components/com_content/views/article/tmpl/default.php</tt>

==onBeforeContentSave==
===Description===
This is an event that is called right before the content is saved into the database. Since the article object is passed by reference, you can make any changes you wish to the data. You can also abort the save by returning false. In this case the error set by calling $article->setError($message); will be displayed to user.
===Parameters===
*<code>article</code> A reference to the JTableContent object that is being saved which holds the article data.
*<code>isNew</code> A boolean which is set to true if the content is about to be created.
===Return Value===
Boolean. Result will affect the saving process. See description for details.
===Used in files===
*<tt>administrator/components/com_content/controller.php</tt>
*<tt>components/com_content/models/article.php</tt>

==onAfterContentSave==
===Description===
This is an event that is called after the content is saved into the database. Even though article object is passed by reference, changes will not be saved since storing data into database phase is past. An example use case would be redirecting user to the appropriate place after saving.
===Parameters===
*<code>article</code> A reference to the JTableContent object that is being saved which holds the article data.
*<code>isNew</code> A boolean which is set to true if the content is about to be created.
===Return Value===
None. Result will be omitted.
===Used in files===
*<tt>administrator/components/com_content/controller.php</tt>
*<tt>components/com_content/models/article.php</tt>

==onContentPrepareData==
===Description===
Called after the data for a JForm has been retrieved. It can be used to modify the data for a JForm object in memory before rendering.
===Parameters===
*<code>context</code> The context where this event was triggered (for example, 'com_users.profile'). Use this to check whether you are in the desired context for the plugin.
*<code>data</code> An object containing the data for the form.
===Return Value===
*<code>boolean</code> True if method succeeds.
===Used in files===
*<tt>administrator/components/com_admin/models/profile.php</tt>
*<tt>administrator/components/com_users/models/user.php</tt>
*<tt>components/com_contact/models/contact.php</tt>
*<tt>components/com_users/models/profile.php</tt>
*<tt>plugins/user/profile/profile.php</tt>

==onContentPrepareForm==
===Description===
Called before a JForm is rendered. It can be used to modify the JForm object in memory before rendering. For example, use JForm->loadFile() to add fields or JForm->removeField() to remove fields. Or use JForm->setFieldAttribute() or other JForm methods to modify fields for the form.
===Parameters===
*<code>form</code> The JForm object to be displayed. Use the $form->getName() method to check whether this is the form you want to work with.
*<code>data</code> An object containing the data for the form.
===Return Value===
*<code>boolean</code> True if method succeeds.
===Used in files===
*<tt>components/com_contact/models/contact.php</tt>
*<tt>libraries/joomla/application/component/modelform.php</tt>
*<tt>components/com_users/models/login.php</tt>
*<tt>plugins/user/profile/profile.php</tt>
<noinclude>[[Category:Plugin Development]][[Category:Specifications]]</noinclude>

J1.5:Plugin/Events/Content

2013-01-20T04:06:54Z

Griiettner: Closing unclosed code tag

{{incomplete}}
{{RightTOC}}
Content events are triggered during the content creation process. This may occur in views in the com_content component, or in other components or modules.

==onPrepareContent==
===Description===
This is the first stage in preparing content for output and is the most common point
for content orientated plugins to do their work. Since the article and related parameters
are passed by reference, event handlers can modify them prior to display.
===Parameters===
*<code>article</code> A reference to the article that is being rendered by the view.
*<code>params</code> A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.
*<code>limitstart</code> An integer that determines the "page" of the content that is to be generated. Note that in the context of views that might not generate HTML output, a page is a reasonably abstract concept that depends on the context.
===Return Value===
None. Results are returned by modifying the referenced arguments.
===Used in files===
*<tt>components/com_content/views/article/view.html.php</tt>
*<tt>components/com_content/views/article/view.pdf.php</tt>
*<tt>components/com_content/views/category/view.html.php</tt>
*<tt>components/com_content/views/frontpage/view.html.php</tt>
*<tt>components/com_content/views/section/view.html.php</tt>
*<tt>plugins/content/code.php</tt>
*<tt>plugins/content/emailcloak.php</tt>
*<tt>plugins/content/geshi.php</tt>
*<tt>plugins/content/image.php</tt>
*<tt>plugins/content/loadmodule.php</tt>
*<tt>plugins/content/pagebreak.php</tt>
*<tt>plugins/content/sef.php</tt>

==onAfterDisplayTitle==
===Description===
This is a request for information that should be placed between the content title and
the content body.
Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose.
===Parameters===
See the onPrepareContent event for additional discussion of these parameters.
*<code>article</code> The article that is being rendered by the view.
*<code>params</code> An associative array of relevant parameters.
*<code>limitstart</code> An integer that determines the "page" of the content that is to be generated.
===Return Value===
String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.
===Used in files===
*<tt>components/com_content/views/article/view.html.php</tt>
*<tt>components/com_content/views/category/view.html.php</tt>
*<tt>components/com_content/views/frontpage/view.html.php</tt>
*<tt>components/com_content/views/section/view.html.php</tt>
*<tt>modules/mod_newsflash/helper.php</tt>
===See Also===
*<tt>components/com_content/views/article/tmpl/default.php</tt>

==onBeforeDisplayContent==
===Description===
This is a request for information that should be placed immediately before the generated content. For views that generate XHTML/HTML, this might include the use of styles that are specified as part of the content or related parameters.
Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose.
===Parameters===
See the onPrepareContent event for additional discussion of these parameters. Note that
unlike onPrepareContent, these parameters are passed by value.
*<code>article</code> The article that is being rendered by the view.
*<code>params</code> An associative array of relevant parameters.
*<code>limitstart</code> An integer that determines the "page" of the content that is to be generated.
===Return Value===
String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.
===Used in files===
*<tt>components/com_content/views/article/view.html.php</tt>
*<tt>components/com_content/views/category/view.html.php</tt>
*<tt>components/com_content/views/frontpage/view.html.php</tt>
*<tt>components/com_content/views/section/view.html.php</tt>
*<tt>modules/mod_newsflash/helper.php</tt>

===See Also===
*<tt>components/com_content/views/article/tmpl/default.php</tt>

==onAfterDisplayContent==
===Description===
This is a request for information that should be placed immediately after the generated content. For views that generate XHTML/HTML, this might include the closure of styles that are specified as part of the content or related parameters.
Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose.
===Parameters===
See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.
*<code>article</code> The article that is being rendered by the view.
*<code>params</code> An associative array of relevant parameters.
*<code>limitstart</code> An integer that determines the "page" of the content that is to be generated.
===Return Value===
String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.
===Used in files===
*<tt>components/com_content/views/article/view.html.php</tt>
*<tt>components/com_content/views/category/view.html.php</tt>
*<tt>components/com_content/views/frontpage/view.html.php</tt>
*<tt>components/com_content/views/section/view.html.php</tt>
===See Also===
*<tt>components/com_content/views/article/tmpl/default.php</tt>

==onBeforeContentSave==
===Description===
This is an event that is called right before the content is saved into the database. Since the article object is passed by reference, you can make any changes you wish to the data. You can also abort the save by returning false. In this case the error set by calling $article->setError($message); will be displayed to user.
===Parameters===
*<code>article</code> A reference to the JTableContent object that is being saved which holds the article data.
*<code>isNew</code> A boolean which is set to true if the content is about to be created.
===Return Value===
Boolean. Result will affect the saving process. See description for details.
===Used in files===
*<tt>administrator/components/com_content/controller.php</tt>
*<tt>components/com_content/models/article.php</tt>

==onAfterContentSave==
===Description===
This is an event that is called after the content is saved into the database. Even though article object is passed by reference, changes will not be saved since storing data into database phase is past. An example use case would be redirecting user to the appropriate place after saving.
===Parameters===
*<code>article</code> A reference to the JTableContent object that is being saved which holds the article data.
*<code>isNew</code> A boolean which is set to true if the content is about to be created.
===Return Value===
None. Result will be omitted.
===Used in files===
*<tt>administrator/components/com_content/controller.php</tt>
*<tt>components/com_content/models/article.php</tt>

==onContentPrepareData==
===Description===
Called after the data for a JForm has been retrieved. It can be used to modify the data for a JForm object in memory before rendering.
===Parameters===
*<code>context</code> The context where this event was triggered (for example, 'com_users.profile'). Use this to check whether you are in the desired context for the plugin.
*<code>data</code> An object containing the data for the form.
===Return Value===
*<code>boolean</code> True if method succeeds.
===Used in files===
*<tt>administrator/components/com_admin/models/profile.php</tt>
*<tt>administrator/components/com_users/models/user.php</tt>
*<tt>components/com_contact/models/contact.php</tt>
*<tt>components/com_users/models/profile.php</tt>
*<tt>plugins/user/profile/profile.php</tt>

==onContentPrepareForm==
===Description===
Called before a JForm is rendered. It can be used to modify the JForm object in memory before rendering. For example, use JForm->loadFile() to add fields or JForm->removeField() to remove fields. Or use JForm->setFieldAttribute() or other JForm methods to modify fields for the form.
===Parameters===
*<code>form</code> The JForm object to be displayed. Use the $form->getName() method to check whether this is the form you want to work with.
*<code>data</code> An object containing the data for the form.
===Return Value===
*<code>boolean<code> True if method succeeds.
===Used in files===
*<tt>components/com_contact/models/contact.php</tt>
*<tt>libraries/joomla/application/component/modelform.php</tt>
*<tt>components/com_users/models/login.php</tt>
*<tt>plugins/user/profile/profile.php</tt>
<noinclude>[[Category:Plugin Development]][[Category:Specifications]]</noinclude>

J1.5:Plugin/Events/Content

2013-01-20T04:05:26Z

Griiettner: Closing unclosed code tag

{{incomplete}}
{{RightTOC}}
Content events are triggered during the content creation process. This may occur in views in the com_content component, or in other components or modules.

==onPrepareContent==
===Description===
This is the first stage in preparing content for output and is the most common point
for content orientated plugins to do their work. Since the article and related parameters
are passed by reference, event handlers can modify them prior to display.
===Parameters===
*<code>article</code> A reference to the article that is being rendered by the view.
*<code>params</code> A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.
*<code>limitstart</code> An integer that determines the "page" of the content that is to be generated. Note that in the context of views that might not generate HTML output, a page is a reasonably abstract concept that depends on the context.
===Return Value===
None. Results are returned by modifying the referenced arguments.
===Used in files===
*<tt>components/com_content/views/article/view.html.php</tt>
*<tt>components/com_content/views/article/view.pdf.php</tt>
*<tt>components/com_content/views/category/view.html.php</tt>
*<tt>components/com_content/views/frontpage/view.html.php</tt>
*<tt>components/com_content/views/section/view.html.php</tt>
*<tt>plugins/content/code.php</tt>
*<tt>plugins/content/emailcloak.php</tt>
*<tt>plugins/content/geshi.php</tt>
*<tt>plugins/content/image.php</tt>
*<tt>plugins/content/loadmodule.php</tt>
*<tt>plugins/content/pagebreak.php</tt>
*<tt>plugins/content/sef.php</tt>

==onAfterDisplayTitle==
===Description===
This is a request for information that should be placed between the content title and
the content body.
Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose.
===Parameters===
See the onPrepareContent event for additional discussion of these parameters.
*<code>article</code> The article that is being rendered by the view.
*<code>params</code> An associative array of relevant parameters.
*<code>limitstart</code> An integer that determines the "page" of the content that is to be generated.
===Return Value===
String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.
===Used in files===
*<tt>components/com_content/views/article/view.html.php</tt>
*<tt>components/com_content/views/category/view.html.php</tt>
*<tt>components/com_content/views/frontpage/view.html.php</tt>
*<tt>components/com_content/views/section/view.html.php</tt>
*<tt>modules/mod_newsflash/helper.php</tt>
===See Also===
*<tt>components/com_content/views/article/tmpl/default.php</tt>

==onBeforeDisplayContent==
===Description===
This is a request for information that should be placed immediately before the generated content. For views that generate XHTML/HTML, this might include the use of styles that are specified as part of the content or related parameters.
Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose.
===Parameters===
See the onPrepareContent event for additional discussion of these parameters. Note that
unlike onPrepareContent, these parameters are passed by value.
*<code>article</code> The article that is being rendered by the view.
*<code>params</code> An associative array of relevant parameters.
*<code>limitstart</code> An integer that determines the "page" of the content that is to be generated.
===Return Value===
String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.
===Used in files===
*<tt>components/com_content/views/article/view.html.php</tt>
*<tt>components/com_content/views/category/view.html.php</tt>
*<tt>components/com_content/views/frontpage/view.html.php</tt>
*<tt>components/com_content/views/section/view.html.php</tt>
*<tt>modules/mod_newsflash/helper.php</tt>

===See Also===
*<tt>components/com_content/views/article/tmpl/default.php</tt>

==onAfterDisplayContent==
===Description===
This is a request for information that should be placed immediately after the generated content. For views that generate XHTML/HTML, this might include the closure of styles that are specified as part of the content or related parameters.
Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose.
===Parameters===
See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.
*<code>article</code> The article that is being rendered by the view.
*<code>params</code> An associative array of relevant parameters.
*<code>limitstart</code> An integer that determines the "page" of the content that is to be generated.
===Return Value===
String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.
===Used in files===
*<tt>components/com_content/views/article/view.html.php</tt>
*<tt>components/com_content/views/category/view.html.php</tt>
*<tt>components/com_content/views/frontpage/view.html.php</tt>
*<tt>components/com_content/views/section/view.html.php</tt>
===See Also===
*<tt>components/com_content/views/article/tmpl/default.php</tt>

==onBeforeContentSave==
===Description===
This is an event that is called right before the content is saved into the database. Since the article object is passed by reference, you can make any changes you wish to the data. You can also abort the save by returning false. In this case the error set by calling $article->setError($message); will be displayed to user.
===Parameters===
*<code>article</code> A reference to the JTableContent object that is being saved which holds the article data.
*<code>isNew</code> A boolean which is set to true if the content is about to be created.
===Return Value===
Boolean. Result will affect the saving process. See description for details.
===Used in files===
*<tt>administrator/components/com_content/controller.php</tt>
*<tt>components/com_content/models/article.php</tt>

==onAfterContentSave==
===Description===
This is an event that is called after the content is saved into the database. Even though article object is passed by reference, changes will not be saved since storing data into database phase is past. An example use case would be redirecting user to the appropriate place after saving.
===Parameters===
*<code>article</code> A reference to the JTableContent object that is being saved which holds the article data.
*<code>isNew</code> A boolean which is set to true if the content is about to be created.
===Return Value===
None. Result will be omitted.
===Used in files===
*<tt>administrator/components/com_content/controller.php</tt>
*<tt>components/com_content/models/article.php</tt>

==onContentPrepareData==
===Description===
Called after the data for a JForm has been retrieved. It can be used to modify the data for a JForm object in memory before rendering.
===Parameters===
*<code>context</code> The context where this event was triggered (for example, 'com_users.profile'). Use this to check whether you are in the desired context for the plugin.
*<code>data</code> An object containing the data for the form.
===Return Value===
*<code>boolean<code> True if method succeeds.
===Used in files===
*<tt>administrator/components/com_admin/models/profile.php</tt>
*<tt>administrator/components/com_users/models/user.php</tt>
*<tt>components/com_contact/models/contact.php</tt>
*<tt>components/com_users/models/profile.php</tt>
*<tt>plugins/user/profile/profile.php</tt>

==onContentPrepareForm==
===Description===
Called before a JForm is rendered. It can be used to modify the JForm object in memory before rendering. For example, use JForm->loadFile() to add fields or JForm->removeField() to remove fields. Or use JForm->setFieldAttribute() or other JForm methods to modify fields for the form.
===Parameters===
*<code>form</code> The JForm object to be displayed. Use the $form->getName() method to check whether this is the form you want to work with.
*<code>data</code> An object containing the data for the form.
===Return Value===
*<code>boolean<code> True if method succeeds.
===Used in files===
*<tt>components/com_contact/models/contact.php</tt>
*<tt>libraries/joomla/application/component/modelform.php</tt>
*<tt>components/com_users/models/login.php</tt>
*<tt>plugins/user/profile/profile.php</tt>
<noinclude>[[Category:Plugin Development]][[Category:Specifications]]</noinclude>

Manifest files

2013-01-18T03:28:49Z

Griiettner: Closing unclosed code tag

{{incomplete}}
{{RightTOC}}
==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 {{JVer|1.6}}, there are very few differences between the manifest file formats for the different [[Extension types (technical definitions)|types of extensions]], allowing each type to access the full power of the Joomla! installer.

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

==Syntax==

=== Root element ===
The primary tag of the installation file is:
<source lang=xml><extension></extension></source>

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

{|class="wikitable"
|-
! style="width: 150px" | Attribute || style="width: 150px" | Values || Applicable to || Description
|-
| type || <code>component</code> <code>file</code> <code>language</code> <code>library</code> <code>module</code> <code>package</code> <code>plugin</code> <code>template</code> || All extensions
| This attribute describes the type of the extension for the installer. Based on this type further requirements to sub-tags apply.
|-
| version
| <code>1.6</code> || 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
| <code>new</code> <code>upgrade</code> || 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
| <code>site</code> <code>administrator</code> || 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 <tt>/plugins</tt>. 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.

* <code><name></code> – raw component name (e.g. <code>com_banners</code>)
* <code><author></code> – author's name (e.g. <code>Joomla! Project</code>)
* <code><creationDate></code> – date of creation or release (e.g. <code>April 2006</code>)
* <code><copyright></code> – a copyright statement (e.g. <code>(C) 2005 - 2011 Open Source Matters. All rights reserved.</code>)
* <code><license></code> – a license statement (e.g. <code>NU General Public License version 2 or later; see LICENSE.txt</code>)
* <code><authorEmail></code> – author's email address (e.g. <code><nowiki>admin@joomla.org</nowiki></code>)
* <code><authorUrl></code> – URL to the author's website (e.g. <code><nowiki>www.joomla.org</nowiki></code>)
* <code><version></code> – the version number of the extension (e.g. <code>1.6.0</code>)
* <code><description></code> – the description of the component. This is a translatable field. (e.g. <code>COM_BANNERS_XML_DESCRIPTION</code>)

=== Front-end files ===

<source lang="xml">
<files folder="from-folder">
<filename>example.php</filename>
<folder>examples</folder>
</files>
</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>.

=== 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.

Ref:
* [https://groups.google.com/forum/#!msg/joomla-dev-cms/4CAASJqFY-k/PvPj14gP29EJ Google Groups - joomla-dev-cms thread]
* [https://groups.google.com/forum/#!msg/joomla-dev-cms/uNmhX98sKbE/p8p68Jke680J Google Groups - joomla-dev-cms thread]

=== Administration section ===

<source lang="xml">
<administration>

</administration>
</source>

The administration section is defined in the <code><administration></code> element. Since only [[Component|components]] apply to both the [[Site (Application)|site]] and the [[Administrator (Application)|administrator]], '''only component manifests can include this element'''.

==== Back-end files ====

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

==== Menu links and submenus ====

<source lang="xml">
<menu>COM_EXAMPLE</menu>
<submenu>
<menu link="anoption=avalue">COM_EXAMPLE_SUBMENU_ANOPTION</menu>
<menu view="viewname">COM_EXAMPLE_SUBMENU_VIEWNAME</menu>
</submenu>
</source>

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

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

{| class="wikitable"
! style="width: 150px" | 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, <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>.
|-
|}

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.

{{Needsinfo|In Platform 11.1 no alt attribute processed and if link provide in menu tag other provided attributes were ignore. The other tags are task, view, controller, act, layout, sub. Please confirm this, please.}}

=== Configuration ===
{{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>.'''

{{:XML JForm form definitions}}

=== SQL ===

<source lang="xml">
<install folder="admin">
<sql>
<file driver="mysql" charset="utf8">sql/example.install.sql</file>
</sql>
</install>
<uninstall folder="admin">
<sql>
<file driver="mysql" charset="utf8">sql/example.uninstall.sql</file>
</sql>
</uninstall>
</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.

==== 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">

<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 front-end and back-end files too.

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

=== Script file ===

<source lang="xml">
<scriptfile>example.script.php</scriptfile>
</source>

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:

<source lang="php">

class com_componentnameInstallerScript
{
/**
* Constructor
*
* @param JAdapterInstance $adapter The object responsible for running this script
*/
public function __constructor(JAdapterInstance $adapter);

/**
* Called before any type of action
*
* @param string $route Which action is happening (install|uninstall|discover_install)
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function preflight($route, JAdapterInstance $adapter);

/**
* Called after any type of action
*
* @param string $route Which action is happening (install|uninstall|discover_install)
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function postflight($route, JAdapterInstance $adapter);

/**
* Called on installation
*
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function install(JAdapterInstance $adapter);

/**
* Called on update
*
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function update(JAdapterInstance $adapter);

/**
* Called on uninstallation
*
* @param JAdapterInstance $adapter The object responsible for running this script
*/
public function uninstall(JAdapterInstance $adapter);
}

</source>

=== Update servers ===

<source lang="xml">
<updateservers>
<server type="extension" priority="1" name="Extension Update Site">http://example.com/extension.xml</server>
<server type="collection" priority="2" name="Collection Update Site">http://example.com/collection.xml</server>
</updateservers>
</source>

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

{| class="wikitable"
! style="width: 150px" | Attribute || style="width: 150px" | Values || Description
|-
| type || <code>extension</code> <code>collection</code> || The update server type
|-
| priority || ''integer'' || The priority of the update server
|-
| name || ''string'' || The name of the update server
|}

== Examples ==
For a real-life example, see [http://joomlacode.org/gf/project/joomla/scmsvn/?action=browse&path=%2Fdevelopment%2Ftags%2F1.6.x%2F1.6.5%2Fadministrator%2Fcomponents%2Fcom_banners%2Fbanners.xml&view=markup the manifest of the Banner component in version 1.6.5].

The Joomla testing process uses several extensions to test whether the installer works correctly. The latest versions of the manifests of these extensions are:

* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/com_alpha/alpha.xml com_alpha manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/mod_alpha/mod_alpha.xml mod_alpha manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/plg_system_alpha/alpha.xml plg_system_alpha manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/tpl_simple/templateDetails.xml tpl_simple manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/lng_xx-XX/xx-XX.xml lng_xx-XX manifest]

== Contributors ==
*[[User:akede|Alex Kempkens]]
*[[User:dperaza|Daniel Peraza]]
*[[User:nikosdion|Nicholas K. Dionysopoulos]]
*[[User:mrs.siam|Prasit Gebsaap]]
*[[User:cppl|Craig Phillips]]

[[Category:Extension development]]
[[Category:Specifications]]

Manifest files

2013-01-18T03:26:57Z

Griiettner: Closing unclosed code tag

{{incomplete}}
{{RightTOC}}
==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 {{JVer|1.6}}, there are very few differences between the manifest file formats for the different [[Extension types (technical definitions)|types of extensions]], allowing each type to access the full power of the Joomla! installer.

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

==Syntax==

=== Root element ===
The primary tag of the installation file is:
<source lang=xml><extension></extension></source>

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

{|class="wikitable"
|-
! style="width: 150px" | Attribute || style="width: 150px" | Values || Applicable to || Description
|-
| type || <code>component</code> <code>file</code> <code>language</code> <code>library</code> <code>module</code> <code>package</code> <code>plugin</code> <code>template</code> || All extensions
| This attribute describes the type of the extension for the installer. Based on this type further requirements to sub-tags apply.
|-
| version
| <code>1.6</code> || 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
| <code>new</code> <code>upgrade</code> || 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
| <code>site</code> <code>administrator</code> || 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 <tt>/plugins</tt>. 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.

* <code><name></code> – raw component name (e.g. <code>com_banners</code>)
* <code><author></code> – author's name (e.g. <code>Joomla! Project</code>)
* <code><creationDate></code> – date of creation or release (e.g. <code>April 2006</code>)
* <code><copyright></code> – a copyright statement (e.g. <code>(C) 2005 - 2011 Open Source Matters. All rights reserved.</code>)
* <code><license></code> – a license statement (e.g. <code>NU General Public License version 2 or later; see LICENSE.txt</code>)
* <code><authorEmail></code> – author's email address (e.g. <code><nowiki>admin@joomla.org</nowiki></code>)
* <code><authorUrl></code> – URL to the author's website (e.g. <code><nowiki>www.joomla.org</nowiki></code>)
* <code><version></code> – the version number of the extension (e.g. <code>1.6.0</code>)
* <code><description></code> – the description of the component. This is a translatable field. (e.g. <code>COM_BANNERS_XML_DESCRIPTION</code>)

=== Front-end files ===

<source lang="xml">
<files folder="from-folder">
<filename>example.php</filename>
<folder>examples</folder>
</files>
</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>.

=== 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.

Ref:
* [https://groups.google.com/forum/#!msg/joomla-dev-cms/4CAASJqFY-k/PvPj14gP29EJ Google Groups - joomla-dev-cms thread]
* [https://groups.google.com/forum/#!msg/joomla-dev-cms/uNmhX98sKbE/p8p68Jke680J Google Groups - joomla-dev-cms thread]

=== Administration section ===

<source lang="xml">
<administration>

</administration>
</source>

The administration section is defined in the <code><administration></code> element. Since only [[Component|components]] apply to both the [[Site (Application)|site]] and the [[Administrator (Application)|administrator]], '''only component manifests can include this element'''.

==== Back-end files ====

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

==== Menu links and submenus ====

<source lang="xml">
<menu>COM_EXAMPLE</menu>
<submenu>
<menu link="anoption=avalue">COM_EXAMPLE_SUBMENU_ANOPTION</menu>
<menu view="viewname">COM_EXAMPLE_SUBMENU_VIEWNAME</menu>
</submenu>
</source>

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

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

{| class="wikitable"
! style="width: 150px" | 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, <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>.
|-
|}

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.

{{Needsinfo|In Platform 11.1 no alt attribute processed and if link provide in menu tag other provided attributes were ignore. The other tags are task, view, controller, act, layout, sub. Please confirm this, please.}}

=== Configuration ===
{{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>.'''

{{:XML JForm form definitions}}

=== SQL ===

<source lang="xml">
<install folder="admin">
<sql>
<file driver="mysql" charset="utf8">sql/example.install.sql</file>
</sql>
</install>
<uninstall folder="admin">
<sql>
<file driver="mysql" charset="utf8">sql/example.uninstall.sql</file>
</sql>
</uninstall>
</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.

==== 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">

<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 front-end and back-end files too.

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

=== Script file ===

<source lang="xml">
<scriptfile>example.script.php</scriptfile>
</source>

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:

<source lang="php">

class com_componentnameInstallerScript
{
/**
* Constructor
*
* @param JAdapterInstance $adapter The object responsible for running this script
*/
public function __constructor(JAdapterInstance $adapter);

/**
* Called before any type of action
*
* @param string $route Which action is happening (install|uninstall|discover_install)
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function preflight($route, JAdapterInstance $adapter);

/**
* Called after any type of action
*
* @param string $route Which action is happening (install|uninstall|discover_install)
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function postflight($route, JAdapterInstance $adapter);

/**
* Called on installation
*
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function install(JAdapterInstance $adapter);

/**
* Called on update
*
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function update(JAdapterInstance $adapter);

/**
* Called on uninstallation
*
* @param JAdapterInstance $adapter The object responsible for running this script
*/
public function uninstall(JAdapterInstance $adapter);
}

</source>

=== Update servers ===

<source lang="xml">
<updateservers>
<server type="extension" priority="1" name="Extension Update Site">http://example.com/extension.xml</server>
<server type="collection" priority="2" name="Collection Update Site">http://example.com/collection.xml</server>
</updateservers>
</source>

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

{| class="wikitable"
! style="width: 150px" | Attribute || style="width: 150px" | Values || Description
|-
| type || <code>extension</code> <code>collection</code> || The update server type
|-
| priority || ''integer'' || The priority of the update server
|-
| name || ''string'' || The name of the update server
|}

== Examples ==
For a real-life example, see [http://joomlacode.org/gf/project/joomla/scmsvn/?action=browse&path=%2Fdevelopment%2Ftags%2F1.6.x%2F1.6.5%2Fadministrator%2Fcomponents%2Fcom_banners%2Fbanners.xml&view=markup the manifest of the Banner component in version 1.6.5].

The Joomla testing process uses several extensions to test whether the installer works correctly. The latest versions of the manifests of these extensions are:

* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/com_alpha/alpha.xml com_alpha manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/mod_alpha/mod_alpha.xml mod_alpha manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/plg_system_alpha/alpha.xml plg_system_alpha manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/tpl_simple/templateDetails.xml tpl_simple manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/lng_xx-XX/xx-XX.xml lng_xx-XX manifest]

== Contributors ==
*[[User:akede|Alex Kempkens]]
*[[User:dperaza|Daniel Peraza]]
*[[User:nikosdion|Nicholas K. Dionysopoulos]]
*[[User:mrs.siam|Prasit Gebsaap]]
*[[User:cppl|Craig Phillips]]

[[Category:Extension development]]
[[Category:Specifications]]

How to Organize a JoomlaDay™

2013-01-03T17:50:04Z

Griiettner: /* Logo usage */

Creating a Joomla!Day requires a combination of good leadership, teamwork, and lots of energy. A successful Joomla!Day isn't measured solely on the number of attendees, but rather the value of the information shared and the new connections made within the local community. This is a simple guide that Joomla!Day organizers can use in creating their own Joomla!Days. Even better, this page should be used by past Joomla!Day organizers to share their knowledge. The more information the better!

== First Steps and some Basics ==

The best way to start is building a small team. This team should meet regularly and the members of the team should be informed about all the things that are going on. Keep this team small, 3 or 4 people are a good size, if you have more than that, finding a meeting time will become more complicated and the meetings will take more time and become less focused.

Assign individual tasks. Nobody should have the weight of the entire event on their shoulders. Spreading the tasks out to others in the team will make everything easier in the end and promotes accountability within the team.

Document what you have discussed in the meetings, an easy way is to do that is within the meeting with a shared document. Google docs is quite good for that. Documenting the meeting minutes immediately after the meeting will ensure accuracy and accountability.

Start small with your event, you can extend it later but it is easier to extend then to reduce the size later.

== Legal, Organizational, and Fiscal Considerations ==
To make an official Joomla!Day you have to follow some rules. This can be quite simple or complicated depending on your decisions.

The first thing you should do when you consider organizing a Joomla!Day event is to read the Joomla!Day Charter at this link:
[http://events.joomla.org/joomla-day-charter.html]

===Requesting a Joomla!Day===
If you know the date and the city you will make your Joomla!day you should send in your request for a Joomla!day. You can do that over a simple form at the [http://opensourcematters.org/joomla-day-request.html OSM Website]

===Domain usage request===
When you make your first Joomla!Day you normally don't have a domain you can use for the Joomla!Day website. Something like joomladay followed by your top level domain is a good choice e.g joomladay.de or joomladay.nl. It is not the best idea to add the year or something else to the domain name, because you can not reuse the domain next year and you have to go to the approval process again. So keep it simple! It is necessary that you have a running website at the domain you'll use. If you don't have the website but some mockups or graphics then you should make this available. Here is the link to the [http://opensourcematters.org/domain-name-use-request.html domain request form]

===Logo usage===
The easy way is to use the conditional Joomla!Day Logos, you can use them without any approval process. If you like to use the Joomla! logo you have to send in a logo usage request and go thru that process. It is strongly recommended to use the conditional logos.

Conditial Logo Example Use:

[[File:Joomladay-logo-white.png]]

===Listed at joomla.org===
You can have your Joomla!day listed at [[http://community.joomla.org/events.html Joomla,org]]. The process for being listed is quite simple send an email to eventsteam at opensourcematters,org with your promotion text. Normally we have this small poster for the event, it speeds up the process when you send this with your promotion text, at least you have to send a picture we can use. Please make sure that the license for the picture allow such a usage.

== Building the Right Website ==
Don't forget to include prominent and appropriate places in your site for your sponsors and speakers.

A suggested site structure would include the following sitemap structure:

Home | Registration | Speakers | Sponsors | Venue | Contact Us | Hotels

There are also some great Event Registration extensions (both commercial and free) available for Joomla and if you would like to use one to manage your event registrations for your Joomla!Day you should consider contacting the developer (in case of a commercial offering) and ask them if they would donate their extension to your Joomla!Day for your registrations.

'''You have to put the following disclaimer on your Website:'''

:JoomlaDay™ events are officially recognized, but not organized, by the Joomla!® Project and Open Source Matters, Inc. Each event is managed independently by a local community.

== Choosing a City ==

The city where the event shall be should be easy to reach for the targeted audience. Public transportation should be available to the city and to the venue. There should also be enough hotels (check prices!).

Larger cities offer better infrastructure, but mostly the venues are more expensive. Don't forget to check smaller cities with good infrastructure.

'''Checklist:'''
* possibly in the centre of your country / region
* public transportation (airport, train, bus)
* Hotels / Hostels
* available locations for social events
* price range of available venues

The final decision for the city should be made together with the venue.

== Choosing a Venue ==

Before choosing the venue, some key facts should be planned:

* expected number of attendees (audience + team + speaker + sponsors)
* rough timetable (how many rooms?)
* catering
* BUDGET

There are a lot of different types of venues possible: conference hotels, companies, university, ... All of them have advantages and disadvantages. A venue at a university can be very cheap - but normally, you have to care for everything on your own (technical equipment, catering, cleaning, ...) while conference hotels offer full service, but are most expensive.

When you compare the prices for the venues, don't forget to include the technical equipment (Projector/Beamer, WiFi, Whiteboards, Sound, ...). If this is not included, this may be expensive to rent.

== Choosing a Date and Time ==

Check the following dates:

* vacation / holidays
* other large events in the selected city
* other events in the Joomla-Community (esp. if you plan to invite international speakers)
* other web/development related events

There should be at least 2 weeks between other similar events.

The event should be planned at least (!) 6 - 8 months in advance!

== Choosing the Schedule Structure ==

Lecture, breakout rooms, and unconference modes.

=== Lecture ===

=== Breakout Rooms ===

=== Unconference ===

== Choosing Speakers ==
Where possible you should aim to have local speakers. Having international speakers can be a great attraction for your event but try to avoid having too many speakers who are not presenting in the native language of the Joomla!Day.

== Finding Fiscal Support and Sponsors ==

===OSM===
As an approved Joomla!Day you can get fiscal support from OSM. The usually amount is $500.00 USD. This money is for covering the costs, if a Joomla!Day makes surplus then the Joomla Day organizers need to give the money back to OSM.

OSM can send the money to a PayPal account, send a check or transfer the money to a Bank account. For an international wire transfer OSM need the following information:

* Name of bank account holder
* Address of bank account holder
* Phone number of bank account holder
* Bank account number
* CHIP S/UID# or SWIFT/BIC
* Bank Name
* Bank address
* Bank City

Please contact OSM directly to request this support.

===Sponsors===
When you try to find sponsors, don't forget that you are dealing with companies. They expect professional and reliable information and agreements.

Before contacting sponsors, prepare

* sponsoring options (e.g. gold-sponsor, silver-sponsor, ...)
* sponsoring packages (what does the sponsor get)
* prices for options and packages
* sponsoring contract and invoice
* some information about Joomla, the event and the expected audience
* one person in the team should be responsible for the sponsors
* create a list of possible sponsors
* set up a webpage for sponsors
* set up an email address like sponsor@yourevent.tld

== Running an Efficient Give-Away ==
Giving away donated goods and services at the end of the day can be a very slow and boring process. Joseph LeBlanc created a Joomla extension that will make the whole process much faster and less painful http://extensions.joomla.org/extensions/miscellaneous/15024

''"This component allows you to award giveaways at random to the attendees of a Joomla!Day. There are mass import functions for attendees and giveaways, as well as a CSV export feature for downloading the final results. Winners can also be displayed on the frontend of the website."''

Another thing that has worked well for non-tangible products such as template and extension provider sponsors is to print business cards (or similar) with unique coupon codes/passwords and put these cards into goodie bags that would be handed out randomly during check-in. This will ensure that the giveaway coupons are distributed randomly and make a nice surprise for the attendees. Then just provide the sponsors with duplicate copies of the coupon codes you distributed so they can verify the winners when they get contacted later.
[[Category:Events Working Group]][[Category:Events]]

File:Joomladay-logo-white.png

2013-01-03T17:48:34Z

Griiettner: Griiettner uploaded a new version of "File:Joomladay-logo-white.png": New Logo examples with the TM mark on

== Summary ==
Joomla!day logo with a white background
== Licensing ==
{{CopyrightByOSM}}

How to determine if the user is viewing the front page

2011-03-15T01:34:24Z

Griiettner: Ading 1.6 conditional statement version

== Joomla 1.0 ==

In Joomla! 1.0.x it was possible to determine if the user was viewing the front page by using code like this:
<source lang="php">
<?php
if ($option == 'com_frontpage' || $option == '') {
echo 'This is the front page';
}
?>
</source>

== Joomla 1.5 ==

But in Joomla! 1.5.x the com_frontpage component is no longer present. This is how to achieve the same result in Joomla! 1.5.x
<source lang="php">
<?php
$menu = & JSite::getMenu();
if ($menu->getActive() == $menu->getDefault()) {
echo 'This is the front page';
}
?>
</source>
This works by checking to see if the current active menu item is the default one.

== Joomla 1.6 ==

For the 1.6 version, the conditional statement, became even shorter. This is the result for Joomla! 1.6.x
<source lang="php">
<?php
if(JRequest::getVar(‘view’) == “frontpage” ) :
echo 'This is the front page';
else :
echo 'This is the other pages';
endif;
?>
</source>
You can also use the default menu option to check the home page. If the menu is activated, the default item for menu would be home page.
<source lang="php">
<?php
$menu = &JSite::getMenu();
if (JRequest::getInt(‘Itemid’) == $menu->getDefault()) : ?>
echo 'This is the front page';
else :
echo 'This is the other pages';
endif;
?>
</source>
<noinclude>
[[Category:Development]]
[[Category:Tutorials]]
</noinclude>

Joomla info page/pt-BR

2010-08-26T18:47:08Z

Griiettner: New page: = Português Brasil = == O que é o Joomla? == Joomla é um gerenciador de conteúdos (CMS) ganhador de vários prêmios em sua categoria, que lhe permite construir Web sites e poderosas ...

= Português Brasil =

== O que é o Joomla? ==
Joomla é um gerenciador de conteúdos (CMS) ganhador de vários prêmios em sua categoria, que lhe permite construir Web sites e poderosas aplicações online. Muitos aspectos, incluindo sua facilidade de uso e extensibilidade, transformaram o Joomla no software de Web site disponível, mais popular. Melhor ainda, o Joomla é uma solução de código aberto (Open Source) que esta disponível para todos. Os benefícios do Joomla! incluem:

* Fácil Instalação
* Manutenção de websites bem simples
* Super seguro e estavel
* Poderosas extenções grátis e comerciais
* Templates em abundancia para facilmente mudar o visual do seu site

== Onde baixar o Joomla? ==
* Baixar o Joomla: http://www.joomla.org/download.html
* Baixar pacote de tradução Português Brasil (pt-BR): http://extensions.joomla.org/extensions/languages/translations-for-joomla/333

== Onde baixar extenções? ==
* Baixar extenções: http://extensions.joomla.org/
* Baixar pacote de tradução para pt-BR das extenções: {http://www.example.com/}

== Onde ver documentção do Joomla? ==
* Dcumentação em Inglês: http://docs.joomla.org/
* Documentação em Português: http://people.joomla.org/component/community/groups/viewgroup/614-Documenta%C3%A7%C3%A3o+em+Portugu%C3%AAs+do+Brasil.html

== Onde conseguir suporte ao Joomla? ==
* Suporte grátis em Inglês: http://forum.joomla.org/
* Suporte grátis em Português:
** http://forum.joomla.org/viewforum.php?f=23
** http://www.joomla.com.br/
** http://www.joomlaclube.com.br/
* Suporte Comercial: http://resources.joomla.org/ (website em Inglês)

== Eventos Regionais / Joomladays ==
Local communities worldwide organise Joomla Days. A Joomla Day is an event created exclusively for Joomla users and projects and usually draws a regional audience. More information: http://community.joomla.org/events/joomla-days.html

== Joomla User Groups (JUG) ==
Grupo local de usuários Joomla (JUG) é um ótimo caminho para conhecer novas pessoas, conseguir ajuda em projetos, ou dividir seus conhecimentos com outros usuários Joomla. O Joomla esta em todos os lugares, então verifique se já existe um JUG perto de você. Se não, talvez você considere formar um.

* JUGS no Brasil: http://community.joomla.org/user-groups/south-america/brazil.html
* JUGS em Portugal: http://community.joomla.org/user-groups/europe/portugal.html

* JUG FAQ: http://community.joomla.org/user-groups/jug-faq.html

== Como contribuir ao Joomla? ==
* Responder perguntas em qualquer Joomla! Forum (link para: Where to get support for Joomla?)
* Escrever ou Traduzir Tutoriais e ou Documentções (link para: Where to get documentation for Joomla?)
* Desenvolver Templates ou Extenções
* Testar ou Adicionar um Comentário para um relatório de problemas (bugg)
* Inscrever-se em um Grupo de Trabalho do Joomla!
* Ajudar no Eventos Joomla!t
* Contribuir com outras maneiras, veja http://contribute.joomla.org/