Joomla! Documentation - User contributions [en]

Plugin/Events/Content

2017-12-18T23:24:54Z

Chiessyer: fix broken link

{{version/tutor|2.5,3.x|alt=1.5|altlink=J1.5:Plugin/Events/Content|alttitle=this guide for old event names}}
Content events are triggered during the content creation process. The majority of these events are called in many views many components and modules - they are generally not specific for the com_content component. This list gives a brief description of each event, what their parameters are, and some examples of their use in core plugins.

==onContentPrepare==
===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>context</code> The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
*<code>&article</code> A reference to the article that is being rendered by the view (For example: the text of a com_content article can be found with $article->text).
*<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>page</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. Sometimes a boolean might be returned to check for success or failure of the event.

===Example===
*<tt>[https://github.com/joomla/joomla-cms/blob/staging/plugins/content/emailcloak/emailcloak.php plugins/content/emailcloak/emailcloak.php]</tt>

==onContentAfterTitle==
===Description===
This event only exists in Joomla {{JVer|3.x}}. 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 onContentPrepare for that purpose. Note this event has special purpose in com_content for use in handling the introtext.

===Parameters===
See the onContentPrepare event for additional discussion of these parameters.
*<code>context</code> The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
*<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.

==onContentBeforeDisplay==
===Description===
This is a request for information that should be placed immediately before the generated content. For views that generate 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 onContentPrepare for that purpose.

===Parameters===
See the onContentPrepare event for additional discussion of these parameters. Note that unlike onContentPrepare, these parameters are passed by value.
*<code>context</code> The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
*<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.

===Example===
*<tt>[https://github.com/joomla/joomla-cms/blob/master/plugins/content/vote/vote.php#L29 plugins/content/vote/vote.php]</tt>

==onContentAfterDisplay==
===Description===
This is a request for information that should be placed immediately after the generated content. For views that generate 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 onContentPrepare for that purpose.

===Parameters===
See the onContentPrepare event for additional discussion of these parameters. Note that unlike onContentPrepare, these parameters are passed by value.
*<code>context</code> The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
*<code>&article</code> The article that is being rendered by the view.
*<code>&params</code> A JRegistry object of merged article and menu item params.
*<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.

==onContentBeforeSave==
===Description===
This is an event that is called right before the content is saved into the database. You can abort the save by returning false. In the case of <code>JModelLegacy</code> for example the error will then be set by calling <code>$this->setError($table->getError);</code> to be displayed to user.

===Parameters===
*<code>context</code> The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
*<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.

==onContentAfterSave==
===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>context</code> The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
*<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.

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

===Example===
*[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L168 plugins/user/profile/profile.php]

==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. This is usually used in tandem with the onContentPrepareForm method - this event adds the data to the already altered JForm.

===Parameters===
*<code>context</code> The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). 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.

===Example===
*[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L51 plugins/user/profile/profile.php]

==onContentBeforeDelete==
===Description===
This is an event that is called right before the content is deleted from the database. You can abort the delete by returning false. In the case of <code>JModelLegacy</code> for example the error will then be set by calling <code>$this->setError($table->getError);</code> to be displayed to user.

===Parameters===
*<code>context</code> The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
*<code>data</code> A reference to the JTableContent object that is being deleted which holds the article data.

===Return Value===
Boolean. Result will affect the saving process. See description for details.

===Example===
*[https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/joomla/joomla.php#L89 plugins/content/joomla/joomla.php]

==onContentAfterDelete==
===Description===
This is an event that is called after the content is deleted from the database. An example use case would be redirecting user to the appropriate place after deleting.

===Parameters===
*<code>context</code> The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
*<code>article</code> A reference to the JTableContent object that has been deleted which holds the article data.

===Return Value===
None. Result will be omitted.

===Example===
[https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L61 content/finder/finder.php]

==onContentChangeState==
===Description===
This is an event that is called after content has its state change (e.g. Published to Unpublished).

===Parameters===
*<code>context</code> The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
*<code>$pks</code> An array of primary key ids of the content that has changed state.
*<code>$value</code> The value of the state that the content has been changed to.

===Return Value===
None. Result will be omitted.

===Example===
[https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L80 content/finder/finder.php]

==onContentSearch==
===Description===

This event is triggered by a variety of search related operations. It is a request for a
plugin to return the result of a search request. The rows must return the following fields, which are used in a common display routine:

* browsernav
* catslug
* created
* href
* section
* slug
* text
* title

===Parameters===

* <code>$text</code> The target search string.
* <code>$phrase</code> A string matching option (exact|any|all). Default is "any".
* <code>$ordering</code> A string ordering option (newest|oldest|popular|alpha|category). Default is "newest".
* <code>$areas</code> An array if restricted to areas, null if search all.

===Return Value===

Array of stdClass objects with members as described above.

===Used in files===

* <tt>[https://github.com/joomla/joomla-cms/blob/master/administrator/components/com_search/models/searches.php#L158 administrator/components/com_search/models/searches.php]</tt>
* <tt>[https://github.com/joomla/joomla-cms/blob/master/components/com_search/models/search.php#L154 components/com_search/models/search.php]</tt>
* <tt>[https://github.com/joomla/joomla-cms/blob/master/plugins/search/categories/categories.php#L62 plugins/search/categories/categories.php]</tt>
* <tt>[https://github.com/joomla/joomla-cms/blob/master/plugins/search/contacts/contacts.php#L60 plugins/search/contacts/contacts.php]</tt>
* <tt>[https://github.com/joomla/joomla-cms/blob/master/plugins/search/content/content.php#L53 plugins/search/content/content.php]</tt>
* <tt>[https://github.com/joomla/joomla-cms/blob/master/plugins/search/newsfeeds/newsfeeds.php#L60 plugins/search/newsfeeds/newsfeeds.php]</tt>
* <tt>[https://github.com/joomla/joomla-cms/blob/master/plugins/search/tags/tags.php#L60 plugins/search/tags/tags.php]</tt>
* <tt>[https://github.com/joomla/joomla-cms/blob/master/plugins/search/weblinks/weblinks.php#L62 plugins/search/weblinks/weblinks.php]</tt>

==onContentSearchAreas==
===Description===

This appears to be a request for plugins to identify which "areas" they provide
search facilities for.

===Parameters===

None.

===Return Value===

An associative array of area names, indexed by the area identifier. For example, array( 'categories' => 'Categories' ).

===Used in files===

* <tt>components/com_search/models/search.php</tt>
* <tt>plugins/search/categories.php</tt>
* <tt>plugins/search/contacts.php</tt>
* <tt>plugins/search/content.php</tt>
* <tt>plugins/search/newsfeeds.php</tt>
* <tt>plugins/search/tags/tags.php</tt>
* <tt>plugins/search/weblinks.php</tt>

<noinclude>[[Category:Plugin Development]][[Category:Specifications]]</noinclude>

Manifest files

2017-06-02T20:16:28Z

Chiessyer: grammar

<noinclude><languages /></noinclude>
<noinclude>{{page|needs updating|}}</noinclude>
<noinclude>
{{Joomla version|version=3.x}} {{Joomla version|version=2.5|status=eos}}
</noinclude>
<translate>
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 [[S:MyLanguage/extension|extension]] itself. Since Joomla! 2.5, there are very few differences between the manifest file formats for the different [[S:MyLanguage/Extension types (technical definitions)|types of extensions]], allowing each type to access the full power of the Joomla! installer.</translate>

<translate>
==Naming conventions== 
</translate>
<translate>
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.</translate>

<translate>
==Syntax== 
</translate>

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

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

{|class="wikitable"
|-
! style="width: 150px" | <translate>
Attribute</translate> || style="width: 150px" | <translate>
Values</translate> || <translate>
Applicable to</translate> || <translate>
Description</translate>
|-
| type || <code>component</code><br /><code>file</code><br /><code>language</code><br /><code>library</code><br /><code>module</code><br /><code>package</code><br /><code>plugin</code><br /><code>template</code> || <translate>
All extensions</translate>
| <translate>
This attribute describes the type of the extension for the installer. Based on this type further requirements to sub-tags apply.</translate>
|-
| version
| <code>2.5</code><br /><code>3.0</code> || <translate>
All extensions</translate>
| <translate>
String that identifies the version of Joomla for which this extension is developed.</translate>
|-
| method
| <code>install</code><br /><code>upgrade</code> || <translate>
All extensions</translate>
| <translate>
The default value <code>install</code> will be also used if the method attribute is not used. The <code>install</code> value means the installer will gracefully stop if it finds any existing file/folder of the new extension.</translate>
|-
| client
| <code>site</code><br /><code>administrator</code> || <translate>
Modules</translate>
| <translate>
The client attribute allows you to specify for which application client the new module is available.</translate>
|-
| group
| ''string'' || <translate>
Plugins</translate>
| <translate>
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.</translate>
|}

<translate>

=== Metadata === 
</translate>

<translate>
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.</translate>

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

<translate>
Note: The <name> and <description> tags are also translatable fields so that the name and description of the extension can be shown to the user in their native language.</translate>

<translate>=== Front-end files === </translate>

<source lang="xml">
<files folder="from-folder">
<filename>example.php</filename>
<folder>examples</folder>
</files>
</source>

<translate>
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>.</translate>

<translate>

For '''plugins''', the raw name of the plugin should be placed in the <code>plugin</code> attribute on the <code><filename></code> element that points to the file containing the plugin's class. For example, in the case of a system plugin called "example" (full name <code>plg_system_example</code>), use <code><filename plugin="example">example.php</filename></code>.</translate>

<translate>=== Media files === </translate>

<source lang="xml>
<media folder="media" destination="com_example">
<filename>com_example_logo.png</filename>
<folder>css</folder>
<folder>js</folder>
</media>
</source>

<translate>
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>).</translate>

<translate>
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.<br />
Note: the media section is not parsed for 'package' type extensions.</translate>

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]

<translate>
=== Administration section === 
</translate>

<source lang="xml">
<administration>

</administration>
</source>

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

<translate>
==== Back-end files ==== 
</translate>

<translate>
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.</translate>

<translate>
==== Menu links and submenus ==== 
</translate>
{{dablink|<translate>
'''Version Note:''' Prior to Joomla 3.4, not having a <code><nowiki><menu></nowiki></code> tag in your manifest XML file still led to a menu item being created. This bug was fixed in Joomla 3.4, so if there is no <code><nowiki><menu></nowiki></code> tag in your manifest file, then no admin menu item is created for the component.</translate>}}

<source lang="xml">
<menu>COM_EXAMPLE</menu>
<submenu>

<menu link="anoption=avalue&anoption1=avalue1">COM_EXAMPLE_SUBMENU_ANOPTION</menu>
<menu view="viewname">COM_EXAMPLE_SUBMENU_VIEWNAME</menu>
</submenu>
</source>

<translate>
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>.</translate>

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

{| class="wikitable"
! style="width: 150px" | <translate>
Attribute</translate> || <translate>
Description</translate>
|-
| link || <translate>
A link to send the user to when the menu item is clicked</translate>
|-
| img || <translate>
The (relative) path to an image (16x16 pixels) to appear beside the menu item.
<u>Must be an url compatible as a file too (e.g. no spaces) !</u></translate>
|-
| alt ||
|-
| ''string'' || <translate>
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>.</translate>
|-
|}

<translate>
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.</translate>

<translate>
The contents of that file should be:</translate>

<source>
COM_EXAMPLE="Example Component"
COM_EXAMPLE_SUBMENU_ANOPTION="Another Option"
COM_EXAMPLE_SUBMENU_VIEWNAME="Another View"
</source>

<translate>
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 experienced under Joomla! 1.5 for the majority (non-English speaking!) of Joomla! users.</translate>

<translate>
=== Configuration === 
</translate>
{{warning|<translate>
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 [[S:MyLanguage/Component configuration metadata|Component configuration metadata]].</translate>}}
<translate>
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>.'''</translate>

<translate>
Each fieldset must contain one or more <code><field></code> elements, each representing a single [[S:MyLanguage/form field|form field]] with a label. See [[S:MyLanguage/Standard form field types|Standard form field types]] for a list of allowed form field types and example XML form field definitions.</translate>

<translate>
=== SQL === 
</translate>

<source lang="xml">
<install>
<sql>
<file driver="mysql" charset="utf8">sql/example.install.sql</file>
</sql>
</install>
<uninstall>
<sql>
<file driver="mysql" charset="utf8">sql/example.uninstall.sql</file>
</sql>
</uninstall>
</source>

<translate>
In the above example, we put the SQL files in the <tt>admin/sql</tt> folder of the installation package. You have to include the <tt>sql</tt> folder in the administration files (as described in ''Back-end files'').</translate>

<translate>
You can execute SQL during the installation and/or uninstallation using the <code><install></code> and <code><uninstall></code> elements, respectively. A <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.</translate>

<translate>
==== Update of the SQL schema ==== 
</translate>

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

<source lang="xml">
<update>
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
<schemapath type="sqlsrv">sql/updates/sqlsrv</schemapath>
</schemas>
</update>
</source>

<translate>
For example, in order to go from version <code>1.0.0</code> to version <code>1.0.1</code> in a '''MySQL''' database, a <code>1.0.1.sql</code> file must be created inside the <code>sql/updates/mysql</code> folder and the <code><version></code> tag of the manifest must be updated to</translate>
<source lang="xml">
<version>1.0.1</version></source>

<translate>
The final structure of the sql folder will look like this (assuming a '''MySQL''' database)</translate>
<source lang="xml">
sql
|-->example.install.sql
|-->example.uninstall.sql
|-->updates
|-->mysql
|-->1.0.1.sql</source>

<translate>
Similar files must be created for subsequent versions.</translate>

<translate>
=== Language files === 
</translate>
<translate>
In Joomla! 1.5, extension developers had to put extension language files in the Joomla! main language folder, using the <languages>...</languages> tag as shown below. '''This method can still be used in Joomla!''' {{JVer|3.x}}.</translate>

<source lang="xml">

<languages folder="langfiles">
<language tag="en-GB">en-GB.com_example.ini</language>
</languages>
</source>

<translate>
Since Joomla! 1.6 it has been encouraged placing your extension's language files in your extension folder. Joomla! will then automatically load your extension's language files.</translate>

<translate>
By storing extension language files in the extension folder, you gain the benefit of isolating and protecting your extension's language files. For example, an administrator removes a language from their Joomla! installation. Your extension's language files will not be removed. They will remain in place and will be available if the language is installed again.</translate>

<translate>
The structure of the language folder for frontend and backend is the same. You put them in the language tag (e.g. '''en-GB''' ) of each language in your language folder i.e. '''language/en-GB/'''. You have to specify those folders in the front-end and back-end files too.</translate>

<translate>
In your manifest you simply include the ''''language'''' folder in your files section, the sub-directories for each language automatically be copied. Inside the <files> group you simply add a <folder> element alongside the items in the '''<files>''' group as shown in this example:</translate>

<source lang="xml">
<files>
<filename plugin="alpha">alpha.php</filename>
<folder>sql</folder>
<folder>language</folder>
</files>
</source>

<translate>
It is also notable that both ways can work together. Here is an example from core:</translate>

<source lang="xml">
<files>
<filename plugin="languagecode">languagecode.php</filename>
<filename>index.html</filename>
<folder>language</folder>
</files>
<languages>
<language tag="en-GB">language/en-GB/en-GB.plg_system_languagecode.ini</language>
<language tag="en-GB">language/en-GB/en-GB.plg_system_languagecode.sys.ini</language>
</languages>
</source>

<translate>
The advantages of this solution are the following:</translate>

<translate>
All ini files present in the core folder have precedence over the files in the extension language/ folder.
For example a sys.ini file will always be loaded from core folders in back-end if it exists, except when installing an extension which contains a sys.ini file in a language folder. In that case and only that case, the sys.ini file in the extension folder will display its translated content at install time. This is very handy as a developer can have 2 sys.ini files with different contents. A description of the successful install as well as a tutorial in back-end for example.</translate>

<translate>
Also, it is much easier for a user needing an ini file for an extension that does not provide it in the language desired, to add it in the main folders. No risk for it to be deleted in case of uninstalling the extension by mistake or any other reason.</translate>

<translate>
See also:
*[[S:MyLanguage/J2.5:Making non-core language packs|Making non-core language packs]]
*[[S:MyLanguage/Creating language packs for extensions in Joomla 2.5|Creating language packs for extensions in Joomla 2.5]]</translate>

<translate>
During development you can turn on language debugging in the Joomla! global configuration. So you can investigate if a problems arises. As of 3.2, this is necessary to help debug as en-GB is '''always''' loaded first when not in debug mode to prevent displaying Constants.</translate>

<translate>
=== Script file === 
</translate>

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

<translate>
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>InstallerScript" 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). Library packages do not support scriptfiles. The structure of the class is as follows:</translate>

<source lang="php">

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

/**
* Called before any type of action
*
* @param string $route Which action is happening (install|uninstall|discover_install|update)
* @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|update)
* @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>

<translate>
=== Update servers === 
</translate>

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

<translate>
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:</translate>

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

<translate>
More info:
* [[S:MyLanguage/J2.5:Developing a MVC Component/Adding an update server|Building a Joomla! Extension - Adding an update server]]
* [[S:MyLanguage/J2.5:Managing Component Updates|Managing Component Updates in Joomla 2.5]]</translate>

<translate>
== Examples == 
</translate>
<translate>
For a real-life example, see [https://github.com/joomla/joomla-cms/blob/3.6.4/administrator/components/com_banners/banners.xml the manifest of the Banner component in the latest version of Joomla! 3.6.4].</translate>

<translate>
Some more examples can be found in the standalone weblinks repo:</translate>

<translate>
* [https://github.com/joomla-extensions/weblinks/blob/master/src/administrator/components/com_weblinks/weblinks.xml com_weblinks manifest]
* [https://github.com/joomla-extensions/weblinks/blob/master/src/modules/mod_weblinks/mod_weblinks.xml mod_weblinks manifest]
* [https://github.com/joomla-extensions/weblinks/blob/master/src/plugins/search/weblinks/weblinks.xml plg_search_weblinks manifest]
* [https://github.com/joomla/joomla-cms/blob/3.6.4/templates/protostar/templateDetails.xml tpl_protostar manifest (3.6.4)]
* [https://github.com/joomla/joomla-cms/blob/3.6.4/administrator/language/en-GB/en-GB.xml en-GB manifest (3.6.4)]</translate>

<noinclude>
<translate>

[[Category:Development]]
[[Category:Extension development]]
[[Category:Specifications]]
</translate>
</noinclude>

J3.x talk:Developing an MVC Component/Adding a variable request in the menu type

2017-06-02T19:37:19Z

Chiessyer: /* == */

If I try and update the copyright year on this page the formatting of the first xml block gets messed up even though I haven't edited it.
== Adding a variable request in the menu type ==
"the request group of fields indicates mandatory fields."

What is it that makes this group mandatory?

[[User:Chiessyer|Chiessyer]] ([[User talk:Chiessyer|talk]]) 14:37, 2 June 2017 (CDT)

== <blank> ==
Maybe due to the highlights but we don't need the Copyright to be changed here as it's a Tuto and this impacts the translation process for very minor fix.<br />([[User:MATsxm|MATsxm]] ([[User talk:MATsxm|talk]]) 11:41, 10 January 2016 (CST))

J3.x talk:Developing an MVC Component/Adding a menu type to the site part

2017-06-02T18:27:16Z

Chiessyer: /* Updating the Hello World! Component */

== page edit links ==

All of the edit links on this page open an editor window into the following section. It seems to have something to do with the way the translation tags around headers are set.

[[User:Chiessyer|Chiessyer]] ([[User talk:Chiessyer|talk]]) 13:27, 2 June 2017 (CDT)

J3.x:Developing an MVC Component/Adding a menu type to the site part

2017-06-02T18:24:47Z

Chiessyer: Rewrite instructions for adding a menu item pointing to the component

<noinclude><languages /></noinclude>
{{:J3.1:Developing an MVC Component/<translate>
en</translate>}}

<translate>==Note== </translate>
<translate>
* This tutorial is part of the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Developing a MVC Component for Joomla! 3.x]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.</translate>

<translate>
* You can follow the steps below to add a menu item to the Hello World! component, or you can directly download the [https://github.com/scionescire/Joomla-3.2-Hello-World-Component/archive/step-3-adding-a-site-menu.zip archive]</translate>

<translate>
== Adding a Menu Item to Hello World == 
</translate>
<translate>
In this article we will cover how to add a menu item to a basic Joomla! component. For this example we will be continuing our work on the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Developing_a_Basic_Component| Hello World!]] component.</translate>

<translate>
There are several ways to update a Joomla! component. As with the last tutorial, we will focus option 2.</translate>
{| border=1
| 1
| <translate>
Manually add the files into</translate> <tt><path_to_joomla>/</tt>
|-
| 2
| <translate>
Update using the Joomla! Extension Manager and the original directory, non-compressed, used for the component install</translate>
|-
|3
| <translate>
Update using the Joomla! Extension Manager and an [[S:MyLanguage/Deploying_an_Update_Server| Update Server]]</translate>
|}

<translate>
To add a menu item you will need to navigate to <tt>com_helloworld</tt>, which is the original directory we made for our component. You must use the updated directory structure from the last [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_a_view_to_the_site_part | tutorial]]. Using your preferred file manager, create or update the following files; as you create or update the files, add the source code for each file which is found in [[#File Details|File Details]].</translate>

{| border=1
| 1
| <translate>
Create:</translate> [[#site/views/helloworld/tmpl/default.xml| default.xml]]
| <tt><path_to_com_helloworld/site/views/helloworld/tmpl/default.xml<tt>
|-
| 2
| <translate>
Update:</translate> [[#helloworld.xml| helloworld.xml]]
| <tt><path_to_com_helloworld/helloworld.xml</tt>
|}

<translate>
=== Updating the Hello World! Component === 
</translate>
<translate>
To update the Hello World! Component in the Joomla! website, please follow the same steps for the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Developing_a_Basic_Component#Installing the Hello World! Component |original installation]].</translate>

<translate>
After the component has been updated, we will be able to add a Menu Item to it. This will allow us to access our component a menu rather than having to remember what to type into the address bar. We'll do this using the Menu Manager of Joomla!.</translate>

<translate>
*Using your preferred web browser, navigate to the Administrator panel of your Joomla! site. The address would be <tt><yoursite>/joomla/administrator/index.php</tt>. For this example we will navigate to <tt>localhost/joomla/administrator/index.php</tt>.</translate>
<translate>
*Add a new menu item by clicking on Menu {{rarr}} <existing menu> {{rarr}} Add New Menu Item. A new screen will appear.</translate>
<translate>
*In the "Menu Title" field, enter "Hello World!"</translate>
<translate>
*In the "Menu Type" field, click on the "Select" button and choose Hello World! {{rarr}} Hello World from the selection screen.</translate>
<translate>
*Click Save & Close</translate>

You should now be able to access the component through the menu that you just created.

<translate>
== File Details == 
</translate>
{{vanchor|site/views/helloworld/tmpl/default.xml}}
<source lang="xml>
<?xml version="1.0" encoding="utf-8"?>
<metadata>
<layout title="COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_TITLE">
<message>COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_DESC</message>
</layout>
</metadata>
</source>

{{vanchor|helloworld.xml}}
<source lang="xml" highlight="13">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" method="upgrade">

<name>Hello World!</name>

<creationDate>January 2014</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>

<version>0.0.3</version>

<description>Description of the Hello World component ...</description>

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



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
</files>

<administration>

<menu link='index.php?option=com_helloworld'>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>
</extension>
</source>

<translate>
== Code Explanation == 
</translate>
<translate>
In case you were curious as to why this works the way it does.</translate>

=== default.xml ===

<translate>
Note - For the moment the strings won't be translated in the administrator interface. We will see in a later article how translation is performed.</translate>

=== helloworld.xml===

<source lang="xml">
<version>0.0.3</version>
</source>

<translate>
Updates the version number.</translate>

<translate>
== Component Contents == 
</translate>
<translate>
At this point in the tutorial, your component should contain the following files:</translate>
{| border=1
| 1
| ''[[#helloworld.xml|helloworld.xml]]''
| <translate>
this is an XML (manifest) file that tells Joomla! how to install our component.</translate>
|-
| 2
| ''[[#site/helloworld.php|site/helloworld.php]]''
| <translate>
this is the site entry point to the Hello World! component</translate>
|-
| 3
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 4
| ''[[#site/controller.php|site/controller.php]]''
| <translate>
file representing the controller</translate>
|-
| 5
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 6
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 7
| ''[[#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
| <translate>
file representing the view</translate>
|-
| 8
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 9
| ''[[#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
| <translate>
the default view</translate>
|-
| 10
| ''[[#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
| <translate>
file that adds menu item</translate>
|-
| 11
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 12
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#admin/helloworld.php|admin/helloworld.php]]''
| <translate>
this is the administrator entry point to the Hello World! component</translate>
|-
| 13
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 14
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 15
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 16
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
| <translate>
file allowing to initialise schema version of the com_helloworld component.</translate>
|}

<div class="row">
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_a_view_to_the_site_part|Prev: Adding a view to the site part</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_a_model_to_the_site_part|Next: Adding a model to the site part</translate>|class=expand}}</div>
</div>
__NOTOC__
<noinclude>
<translate>

[[Category:Joomla! 3.x]]
[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Joomla! 3.3]]
[[Category:Joomla! 3.4]]
[[Category:Beginner Development]]
[[Category:Component Development]]
[[Category:Tutorials]]
[[Category:Tutorials in a Series]]
</translate>
</noinclude>

J3.x:Developing an MVC Component/Adding a menu type to the site part

2017-06-02T18:06:36Z

Chiessyer: fix typo

<noinclude><languages /></noinclude>
{{:J3.1:Developing an MVC Component/<translate>
en</translate>}}

<translate>==Note== </translate>
<translate>
* This tutorial is part of the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Developing a MVC Component for Joomla! 3.x]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.</translate>

<translate>
* You can follow the steps below to add a menu item to the Hello World! component, or you can directly download the [https://github.com/scionescire/Joomla-3.2-Hello-World-Component/archive/step-3-adding-a-site-menu.zip archive]</translate>

<translate>
== Adding a Menu Item to Hello World == 
</translate>
<translate>
In this article we will cover how to add a menu item to a basic Joomla! component. For this example we will be continuing our work on the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Developing_a_Basic_Component| Hello World!]] component.</translate>

<translate>
There are several ways to update a Joomla! component. As with the last tutorial, we will focus option 2.</translate>
{| border=1
| 1
| <translate>
Manually add the files into</translate> <tt><path_to_joomla>/</tt>
|-
| 2
| <translate>
Update using the Joomla! Extension Manager and the original directory, non-compressed, used for the component install</translate>
|-
|3
| <translate>
Update using the Joomla! Extension Manager and an [[S:MyLanguage/Deploying_an_Update_Server| Update Server]]</translate>
|}

<translate>
To add a menu item you will need to navigate to <tt>com_helloworld</tt>, which is the original directory we made for our component. You must use the updated directory structure from the last [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_a_view_to_the_site_part | tutorial]]. Using your preferred file manager, create or update the following files; as you create or update the files, add the source code for each file which is found in [[#File Details|File Details]].</translate>

{| border=1
| 1
| <translate>
Create:</translate> [[#site/views/helloworld/tmpl/default.xml| default.xml]]
| <tt><path_to_com_helloworld/site/views/helloworld/tmpl/default.xml<tt>
|-
| 2
| <translate>
Update:</translate> [[#helloworld.xml| helloworld.xml]]
| <tt><path_to_com_helloworld/helloworld.xml</tt>
|}

<translate>
=== Updating the Hello World! Component === 
</translate>
<translate>
To update the Hello World! Component in the Joomla! website, please follow the same steps for the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Developing_a_Basic_Component#Installing the Hello World! Component |original installation]].</translate>

<translate>
With the component successfully updated, we need to add the Menu Item. This will be done by using the Menu Manager of Joomla!.</translate>

<translate>
*Using your preferred web browser, navigate to the Administrator panel of your Joomla! site. The address would be <tt><yoursite>/joomla/administrator/index.php</tt>. For this example we will navigate to <tt>localhost/joomla/administrator/index.php</tt>.</translate>
<translate>
*Click Menu {{rarr}} Manage {{rarr}} Menu Items {{rarr}} New {{rarr}} Select</translate>
<translate>
*Navigate and Choose <tt>Hello World!</tt></translate>
<translate>
*Navigate and Choose</translate> <tt>COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_TITLE</tt>
<translate>
*Click Menu Title and enter <tt>Hello World!</tt></translate>
<translate>
*Click Save & Close</translate>

<translate>
== File Details == 
</translate>
{{vanchor|site/views/helloworld/tmpl/default.xml}}
<source lang="xml>
<?xml version="1.0" encoding="utf-8"?>
<metadata>
<layout title="COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_TITLE">
<message>COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_DESC</message>
</layout>
</metadata>
</source>

{{vanchor|helloworld.xml}}
<source lang="xml" highlight="13">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" method="upgrade">

<name>Hello World!</name>

<creationDate>January 2014</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>

<version>0.0.3</version>

<description>Description of the Hello World component ...</description>

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



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
</files>

<administration>

<menu link='index.php?option=com_helloworld'>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>
</extension>
</source>

<translate>
== Code Explanation == 
</translate>
<translate>
In case you were curious as to why this works the way it does.</translate>

=== default.xml ===

<translate>
Note - For the moment the strings won't be translated in the administrator interface. We will see in a later article how translation is performed.</translate>

=== helloworld.xml===

<source lang="xml">
<version>0.0.3</version>
</source>

<translate>
Updates the version number.</translate>

<translate>
== Component Contents == 
</translate>
<translate>
At this point in the tutorial, your component should contain the following files:</translate>
{| border=1
| 1
| ''[[#helloworld.xml|helloworld.xml]]''
| <translate>
this is an XML (manifest) file that tells Joomla! how to install our component.</translate>
|-
| 2
| ''[[#site/helloworld.php|site/helloworld.php]]''
| <translate>
this is the site entry point to the Hello World! component</translate>
|-
| 3
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 4
| ''[[#site/controller.php|site/controller.php]]''
| <translate>
file representing the controller</translate>
|-
| 5
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 6
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 7
| ''[[#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
| <translate>
file representing the view</translate>
|-
| 8
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 9
| ''[[#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
| <translate>
the default view</translate>
|-
| 10
| ''[[#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
| <translate>
file that adds menu item</translate>
|-
| 11
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 12
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#admin/helloworld.php|admin/helloworld.php]]''
| <translate>
this is the administrator entry point to the Hello World! component</translate>
|-
| 13
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 14
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 15
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 16
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
| <translate>
file allowing to initialise schema version of the com_helloworld component.</translate>
|}

<div class="row">
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_a_view_to_the_site_part|Prev: Adding a view to the site part</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_a_model_to_the_site_part|Next: Adding a model to the site part</translate>|class=expand}}</div>
</div>
__NOTOC__
<noinclude>
<translate>

[[Category:Joomla! 3.x]]
[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Joomla! 3.3]]
[[Category:Joomla! 3.4]]
[[Category:Beginner Development]]
[[Category:Component Development]]
[[Category:Tutorials]]
[[Category:Tutorials in a Series]]
</translate>
</noinclude>

J3.x talk:Developing an MVC Component/Adding a menu type to the site part

2017-06-02T18:04:47Z

Chiessyer: Created page with "== Updating the Hello World! Component == It isn't clear what to do in this section ~~~~"

== Updating the Hello World! Component ==

It isn't clear what to do in this section

[[User:Chiessyer|Chiessyer]] ([[User talk:Chiessyer|talk]]) 13:04, 2 June 2017 (CDT)

Talk:Absolute Basics of How a Component Functions

2017-06-02T16:04:14Z

Chiessyer: /* Up to date? */

== Up to date? ==

Would someone who is well-versed in writing components for Joomla comment on whether this article is up-to-date? The section on where files should go isn't clear to me, and I wonder if things may have been different prior to Joomla 3.

[[User:Chiessyer|Chiessyer]] ([[User talk:Chiessyer|talk]]) 11:03, 2 June 2017 (CDT)

== Great Topic ==

Just want to say this is a great topic and an article from which I learnt a lot. Perhaps it should feature more prominently.

Over recent weeks I've been struggling with understanding how it all hangs together grabbing snippets all over the place, reading through loads of the php source, slow & difficult progress.

I have no doubt it would have taken me several more days to workout that the 'task' was defaulting to display and that I could name my own controller methods (like jump) and have them activated by a URL parameter. (The sort of stuff I imagine every PHP developer coming to Joomla would want to know).

The article may also be a bit dated now with 1.7 I see the demo Hello World MVC component involves 4 files ?? (Basefile + M+V+C) ?
Anyway, well done great article and lots of gems of knowledge about how Joomla works. Thanks

== Missing in Instructions ==

<source lang="php">//Hi, I have tried to follow these instructions, and found a few missing things.
Setting up my controller.php was missing the following statement in the display class:

return parent::display();

//Without this, the instructions don't work.
</source>
[[User:Cwurtz|Cwurtz]] ([[User talk:Cwurtz|talk]]) 03:07, 14 December 2013 (CST)
:Feel free to correct it. [[User:Tom Hutchison|Tom Hutchison]] ([[User talk:Tom Hutchison|talk]]) 10:57, 14 December 2013 (CST)

== Updated article: ==

Hello all,

I am a new Joomla! student, I am going through and updating several of the tutorials, those that are geared towards beginners, with current information. My main focus is to update [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Developing a Model-View-Controller Component/3.x]], so that it is geared toward beginners.

This article itself seemed designed originally for Joomla 1.5. For this article, I removed the sections that displayed specific code; this was due to the code differences between 1.5, 2.5, and 3.x. To compensate for this change, I added the links to the specific tutorials for those versions. I also added new sections with information that I have found dispersed throughout the Joomla! documentation.

If you can think of any other additions or revisions that I can make to this article, please let me know.

Warm Regards,

[[User:Kevinkabatra|Kevinkabatra]] ([[User talk:Kevinkabatra|talk]]) 08:18, 17 September 2015 (CDT)

Talk:Absolute Basics of How a Component Functions

2017-06-02T16:03:33Z

Chiessyer:

== Up to date? ==

Would someone who is well-versed in writing components for Joomla comment on whether this article is up-to-date? The section on where files should go isn't clear to me, and I wonder if things may have been different prior to Joomla 3.
[[User:Chiessyer|Chiessyer]] ([[User talk:Chiessyer|talk]]) 11:03, 2 June 2017 (CDT)

== Great Topic ==

Just want to say this is a great topic and an article from which I learnt a lot. Perhaps it should feature more prominently.

Over recent weeks I've been struggling with understanding how it all hangs together grabbing snippets all over the place, reading through loads of the php source, slow & difficult progress.

I have no doubt it would have taken me several more days to workout that the 'task' was defaulting to display and that I could name my own controller methods (like jump) and have them activated by a URL parameter. (The sort of stuff I imagine every PHP developer coming to Joomla would want to know).

The article may also be a bit dated now with 1.7 I see the demo Hello World MVC component involves 4 files ?? (Basefile + M+V+C) ?
Anyway, well done great article and lots of gems of knowledge about how Joomla works. Thanks

== Missing in Instructions ==

<source lang="php">//Hi, I have tried to follow these instructions, and found a few missing things.
Setting up my controller.php was missing the following statement in the display class:

return parent::display();

//Without this, the instructions don't work.
</source>
[[User:Cwurtz|Cwurtz]] ([[User talk:Cwurtz|talk]]) 03:07, 14 December 2013 (CST)
:Feel free to correct it. [[User:Tom Hutchison|Tom Hutchison]] ([[User talk:Tom Hutchison|talk]]) 10:57, 14 December 2013 (CST)

== Updated article: ==

Hello all,

I am a new Joomla! student, I am going through and updating several of the tutorials, those that are geared towards beginners, with current information. My main focus is to update [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Developing a Model-View-Controller Component/3.x]], so that it is geared toward beginners.

This article itself seemed designed originally for Joomla 1.5. For this article, I removed the sections that displayed specific code; this was due to the code differences between 1.5, 2.5, and 3.x. To compensate for this change, I added the links to the specific tutorials for those versions. I also added new sections with information that I have found dispersed throughout the Joomla! documentation.

If you can think of any other additions or revisions that I can make to this article, please let me know.

Warm Regards,

[[User:Kevinkabatra|Kevinkabatra]] ([[User talk:Kevinkabatra|talk]]) 08:18, 17 September 2015 (CDT)

User:Chiessyer

2017-06-02T15:55:01Z

Chiessyer: initial introduction

I have maintained a few simple Joomla websites for some time. Recently I inherited maintenance of one that is not so simple. This forced me to quickly learn more about how Joomla is put together. I'll update documentation as I learn.

Archived talk:Joomla! Development for Beginners

2017-06-02T15:32:33Z

Chiessyer: Created page with "I'd like to get started in understanding how to develop custom modules for Joomla. This page says that a FAQ section is coming soon. Is there such a page in the works? If so I..."

I'd like to get started in understanding how to develop custom modules for Joomla. This page says that a FAQ section is coming soon. Is there such a page in the works? If so I'd like to take a look at it, and offer some suggestions.
- [[User:Chiessyer|Chiessyer]] ([[User talk:Chiessyer|talk]]) 10:32, 2 June 2017 (CDT)

Archived:Joomla! Development for Beginners/Tutorials

2017-06-02T15:28:38Z

Chiessyer: remove duplicate line

* [[Setting up your workstation for PHP development]]: Learn how to set up a brand new workstation from scratch in a semiprofessional way to start learning about PHP development in general also learn the existence of many tools that will make your work lot easier in your future as developer.* [[Basic Internet communications tutorial]]: This is a very basic and straightforward tutorial to understand how computers transmit information on Internet.
* [[Basic HTML tutorial]]: This is a very basic and straightforward tutorial to learn how to deal with HTML.
* [[Basic CSS tutorial]]: This is a very basic and straightforward tutorial to learn how to deal with cascading style sheets (CSS).
* [[Basic Javascript tutorial]]: This is a very basic and straightforward tutorial to learn how to deal with javascript.
* [[Basic PHP tutorial]]: This is a very basic and straightforward tutorial to learn how to deal with PHP.
* [[Basic SQL tutorial]]: This is a very basic and straightforward tutorial to learn how to deal with SQL.
* [[Basic XML tutorial]]: This is a very basic and straightforward tutorial to learn how to deal with XML.
* [[Basic AJAX tutorial]]: This is a very basic and straightforward tutorial to learn how to deal with AJAX.
* [[Basic JSON tutorial]]: This is a very basic and straightforward tutorial to learn how to deal with JSON.

JDOC talk:Developer Tutorials Project

2017-05-31T15:42:18Z

Chiessyer:

==Developer Tutorials Project==
* [[User:Hutchy68|Tom Hutchison]] ([[User talk:Hutchy68|talk]]) 09:37, 11 February 2013 (CST) - page categorisation, wiki markup help, layout, wikification of related pages
* [[User:Kevinkabatra|Kevinkabatra]] ([[User talk:Kevinkabatra|talk]]) 13:32, 18 September 2015 (CDT) - updating current beginner tutorials to be actually geared toward beginners, anything else that is needed
* [[User:Chiessyer|Chiessyer]] ([[User talk:Chiessyer|talk]]) 10:42, 31 May 2017 (CDT) - small updates to existing tutorials as I learn how to author a component

== Feedback and ideas ==



* [[User:Poproar|popROAR]] ([[User talk:Poproar|talk]]) 12:22, 4 August 2013 (CDT) - walkthroughs?
* [[User:Poproar|popROAR]] ([[User talk:Poproar|talk]]) 19:27, 3 October 2015 (CDT) - Where can we find the github example pages?

JDOC talk:Developer Tutorials Project

2017-05-31T15:38:26Z

Chiessyer: /* Developer Tutorials Project */ formatting

==Developer Tutorials Project==
* [[User:Hutchy68|Tom Hutchison]] ([[User talk:Hutchy68|talk]]) 09:37, 11 February 2013 (CST) - page categorisation, wiki markup help, layout, wikification of related pages
* [[User:Kevinkabatra|Kevinkabatra]] ([[User talk:Kevinkabatra|talk]]) 13:32, 18 September 2015 (CDT) - updating current beginner tutorials to be actually geared toward beginners, anything else that is needed
* [[User:Chiessyer|Chiessyer]] ([[User talk:Chiessyer|talk]]) 10:38, 31 May 2017 (CDT) - small updates to existing tutorials as I learn how to author a component

== Feedback and ideas ==



* [[User:Poproar|popROAR]] ([[User talk:Poproar|talk]]) 12:22, 4 August 2013 (CDT) - walkthroughs?
* [[User:Poproar|popROAR]] ([[User talk:Poproar|talk]]) 19:27, 3 October 2015 (CDT) - Where can we find the github example pages?

JDOC talk:Developer Tutorials Project

2017-05-31T15:38:10Z

Chiessyer: /* Developer Tutorials Project */

==Developer Tutorials Project==
* [[User:Hutchy68|Tom Hutchison]] ([[User talk:Hutchy68|talk]]) 09:37, 11 February 2013 (CST) - page categorisation, wiki markup help, layout, wikification of related pages
* [[User:Kevinkabatra|Kevinkabatra]] ([[User talk:Kevinkabatra|talk]]) 13:32, 18 September 2015 (CDT) - updating current beginner tutorials to be actually geared toward beginners, anything else that is needed
[[User:Chiessyer|Chiessyer]] ([[User talk:Chiessyer|talk]]) 10:38, 31 May 2017 (CDT) - small updates to existing tutorials as I learn how to author a component

== Feedback and ideas ==



* [[User:Poproar|popROAR]] ([[User talk:Poproar|talk]]) 12:22, 4 August 2013 (CDT) - walkthroughs?
* [[User:Poproar|popROAR]] ([[User talk:Poproar|talk]]) 19:27, 3 October 2015 (CDT) - Where can we find the github example pages?

J3.x:Creating a simple module/Developing a Basic Module

2017-05-31T15:18:31Z

Chiessyer: grammar

<noinclude><languages /></noinclude>
{{J3.x:Creating_a_simple_module/<translate>
en</translate>}}
<translate>
Modules are lightweight and flexible extensions. They are used for small bits of the page that are generally less complex and are able to be seen across different components.</translate>

<translate>
You can see many examples of modules in the standard Joomla! install: - menus - Latest News - Login form - and many more.</translate>

<translate>
This tutorial will explain how to go about creating a simple Hello World module. Through this tutorial you will learn the basic file structure of a module. This basic structure can then be expanded to produce more elaborate modules.</translate>

<translate>== File Structure == </translate>

<translate>
There are four basic files that are used in the standard pattern of module development:</translate>
<translate>
* <code>mod_helloworld.php</code> - This file is the main entry point for the module. It will perform any necessary initialization routines, call helper routines to collect any necessary data, and include the template which will display the module output.</translate>

* <translate>
<code>mod_helloworld.xml</code> - This file contains information about the module. It defines the files that need to be installed by the Joomla! installer and specifies configuration parameters for the module.</translate>

<translate>
* <code>helper.php</code> - This file contains the helper class which is used to do the actual work in retrieving the information to be displayed in the module (usually from the database or some other source).</translate>

<translate>
* <code>tmpl/default.php</code> - This is the module template. This file will take the data collected by mod_helloworld.php and generate the HTML to be displayed on the page.</translate>

<translate>== Creating mod_helloworld.php == </translate>

<translate>
The <tt>mod_helloworld.php</tt> file will perform three tasks:
* include the helper.php file which contains the class to be used to collect the necessary data
* invoke the appropriate helper class method to retrieve the data
* include the template to display the output.</translate>

<translate>
The helper class is defined in our helper.php file. This file is included with a require_once statement:</translate>

<source lang="php">require_once dirname(__FILE__) . '/helper.php';</source>

<translate>
<code>require_once</code> is used because our helper functions are defined within a class, and we only want the class defined once.</translate>

<translate>
Our helper class has not been defined yet, but when it is, it will contain one method: getHello(). For our basic example, it is not really necessary to do this - the “Hello, World” message that this method returns could simply be included in the template. We use a helper class here to demonstrate this basic technique.</translate>

<translate>
Our module currently does not use any parameters, but we will pass them to the helper method anyway so that it can be used later if we decide to expand the functionality of our module.</translate>

<translate>
The helper class method is invoked in the following way:</translate>

<source lang="php">$hello = modHelloWorldHelper::getHello($params);</source>

<translate>=== Completed mod_helloworld.php file === </translate>

<translate>
The complete <tt>mod_helloworld.php</tt> file is as follows:</translate>

<source lang="php"><?php
/**
* Hello World! Module Entry Point
*
* @package Joomla.Tutorials
* @subpackage Modules
* @license GNU/GPL, see LICENSE.php
* @link http://docs.joomla.org/J3.x:Creating_a_simple_module/Developing_a_Basic_Module
* mod_helloworld is free software. This version may have been modified pursuant
* to the GNU General Public License, and as distributed it includes or
* is derivative of works licensed under the GNU General Public License or
* other free or open source software licenses.
*/

// No direct access
defined('_JEXEC') or die;
// Include the syndicate functions only once
require_once dirname(__FILE__) . '/helper.php';

$hello = modHelloWorldHelper::getHello($params);
require JModuleHelper::getLayoutPath('mod_helloworld');

</source>

<translate>
The one line that we haven’t explained so far is the first line. This line checks to make sure that this file is being included from the Joomla! application. This is necessary to prevent variable injection and other potential security concerns.</translate>

<translate>== Creating helper.php == </translate>

<translate>
The <tt>helper.php</tt> file contains the helper class that is used to retrieve the data to be displayed in the module output. As stated earlier, our helper class will have one method: getHello(). This method will return the ‘Hello, World’ message.</translate>

<translate>
Here is the code for the helper.php file:</translate>

<source lang="php"><?php
/**
* Helper class for Hello World! module
*
* @package Joomla.Tutorials
* @subpackage Modules
* @link http://docs.joomla.org/J3.x:Creating_a_simple_module/Developing_a_Basic_Module
* @license GNU/GPL, see LICENSE.php
* mod_helloworld is free software. This version may have been modified pursuant
* to the GNU General Public License, and as distributed it includes or
* is derivative of works licensed under the GNU General Public License or
* other free or open source software licenses.
*/
class ModHelloWorldHelper
{
/**
* Retrieves the hello message
*
* @param array $params An object containing the module parameters
*
* @access public
*/
public static function getHello($params)
{
return 'Hello, World!';
}
}

</source>

<translate>
There is no rule stating that we must name our helper class as we have, but it is helpful to do this so that it is easily identifiable and locatable. Note that it is required to be in this format if you plan to use the com_ajax plugin.</translate>

<translate>
More advanced modules might include database requests or other functionality in the helper class method.</translate>

<translate>== Creating tmpl/default.php == </translate>

<translate>
The <tt>default.php</tt> file is the template which displays the module output.


The code for the default.php file is as follows:</translate>

<source lang="php">
<?php
// No direct access
defined('_JEXEC') or die; ?>
<?php echo $hello; ?>
</source>

<translate>
An important point to note is that the template file has the same scope as the mod_helloworld.php file. What this means is that the variable $hello can be defined in the mod_helloworld.php file and then used in the template file without any extra declarations or function calls.</translate>

<translate>== Creating mod_helloworld.xml == </translate>

<translate>
The <tt>mod_helloworld.xml</tt> is used to specify which files the installer needs to copy and is used by the Module Manager to determine which parameters are used to configure the module. Other information about the module is also specified in this file.</translate>

<translate>
The code for <tt>mod_helloworld.xml</tt> is as follows:</translate>

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="module" version="3.1.0" client="site" method="upgrade">
<name>Hello, World!</name>
<author>John Doe</author>
<version>1.0.0</version>
<description>A simple Hello, World! module.</description>
<files>
<filename>mod_helloworld.xml</filename>
<filename module="mod_helloworld">mod_helloworld.php</filename>
<filename>index.html</filename>
<filename>helper.php</filename>
<filename>tmpl/default.php</filename>
<filename>tmpl/index.html</filename>
</files>
<config>
</config>
</extension>
</source>

<translate>
[[S:MyLanguage/Manifest files|Manifest files]] explains the technical details of the elements used in the XML file.</translate>

<translate>
You will notice that there are two additional files that we have not yet mentioned: index.html and tmpl/index.html. These files are included so that these directories cannot be browsed. If a user attempts to point their browser to these folders, the index.html file will be displayed. These files can be left empty or can contain the simple line:</translate>

<source lang="html4strict"><html><body bgcolor="#FFFFFF"></body></html></source>

<translate>
which will display an empty page.


Since our module does not use any [[S:MyLanguage/Form_field|form fields]], the config section is empty.</translate>

<translate>== Conclusion == 


Module development for Joomla! is a fairly simple, straightforward process. Using the techniques described in this tutorial, an endless variety of modules can be developed with little hassle.</translate>

<div class="row">
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Creating_a_simple_module/Introduction|Prev: Introduction</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Creating_a_simple_module/Using_the_Database|Next: Using the Database</translate>|class=expand}}</div>
</div>
__NOTOC__
<noinclude>
<translate>

[[Category:Tutorials]]
[[Category:Tutorials in a Series]]
[[Category:Module Development]]
[[Category:Beginner Development]]
[[Category:Joomla! 3.x]]
[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Joomla! 3.3]]
[[Category:Joomla! 3.4]]
</translate>
</noinclude>

Developers/Modules

2017-05-31T00:31:37Z

Chiessyer: fix broken redirect

#REDIRECT [[Portal:Module_Development]]

Help310:Extensions Module Manager Custom HTML

2017-05-30T23:53:40Z

Chiessyer: /* How to Access */ rename "Custom HTML" to "Custom"

==Description==
This allows you to create a Module that contains any valid HTML code. There are many cases where you might want to put free-form HTML inside a web page. For example, you might want to create an HTML Image Map or you might want to copy HTML code from PayPal, Amazon, or some other site.

The Custom Module allows you to create a self-contained HTML unit and then put it in any valid location on a page.

==How to Access==
{{Chunk30:ModuleManager-How-to-acces-module|module=Custom}}

{{Chunk30:Help-3x-module-site-custom-html}}

===Common Details===
{{Chunk30:Module Details}}

===Common Tabs===
{{Chunk30:Help-3x-module-site-common-tabs}}

==Toolbar==
{{Chunk30:Help_screen_module_manager_edit_toolbar/en}}

{{warning|The editor does not allow you to enter certain HTML tags. To work around this, you can temporarily change your User's editor to "No Editor", create the Custom HTML Module, and then change the editor back to TinyMCE. Another option is to use an editor from an Extension that allows HTML code to be entered. Another possibility is (if the editor has this option) to switch to the HTML mode, enter the code, save and switch back to normal view.}}

==Front End View==

An example of a Custom HTML editor session is shown below. Note that the "No Editor" option is being used.

[[Image:Help30-Extensions-Module-Manager-Custom-Html-output.jpg]]

<noinclude>{{cathelp|3.0,3.1,3.2,3.3|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Help310:Extensions Module Manager Custom HTML

2017-05-30T23:51:10Z

Chiessyer: /* Description */ rename "Custom HTML" to "Custom"

==Description==
This allows you to create a Module that contains any valid HTML code. There are many cases where you might want to put free-form HTML inside a web page. For example, you might want to create an HTML Image Map or you might want to copy HTML code from PayPal, Amazon, or some other site.

The Custom Module allows you to create a self-contained HTML unit and then put it in any valid location on a page.

==How to Access==
{{Chunk30:ModuleManager-How-to-acces-module|module=Custom HTML}}

{{Chunk30:Help-3x-module-site-custom-html}}

===Common Details===
{{Chunk30:Module Details}}

===Common Tabs===
{{Chunk30:Help-3x-module-site-common-tabs}}

==Toolbar==
{{Chunk30:Help_screen_module_manager_edit_toolbar/en}}

{{warning|The editor does not allow you to enter certain HTML tags. To work around this, you can temporarily change your User's editor to "No Editor", create the Custom HTML Module, and then change the editor back to TinyMCE. Another option is to use an editor from an Extension that allows HTML code to be entered. Another possibility is (if the editor has this option) to switch to the HTML mode, enter the code, save and switch back to normal view.}}

==Front End View==

An example of a Custom HTML editor session is shown below. Note that the "No Editor" option is being used.

[[Image:Help30-Extensions-Module-Manager-Custom-Html-output.jpg]]

<noinclude>{{cathelp|3.0,3.1,3.2,3.3|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Module

2017-05-30T23:46:59Z

Chiessyer: rename "Custom HTML" to "Custom"

<noinclude><languages /></noinclude>
<translate>

{{Chunk:Module/en}}

==Learning More== 

===Module Positions=== 
{{Chunk:Module Position/en}}

==Recommended Reading== 
Modules are one of the simplest parts of Joomla and a great entry point for people learning to use the system (the equivalent of widgets in wordpress). They can be displayed just about [[Module_positions|anywhere on a page]] (in all the positions a template allows as well as in the main content area using the [[How do you put a module inside an article?|loadmodule plugin]] for the com_content component).

=== Beginner === 
To understand how to install and use a module in Joomla it is recommended to read [[S:MyLanguage/Help34:Extensions_Module_Manager|Module Manager]].
You can read also [[Help33:Extensions_Module_Manager_Custom_HTML|Module Manager Custom HTML]] for an example.

=== Beginner/Intermediate === 
Creating a simple module for Joomla is one of the simplest development steps you can do - and the [[Creating a simple module|creating a simple module]] tutorial is designed to take you through this. It starts with a simple module and then shows a few things you can then do with the module.

=== Advanced === 
Introduced into Joomla 3.2 is a hidden component that allows modules to create AJAX requests. You can find documentation about [[Using_Joomla_Ajax_Interface|Using Joomla Ajax Interface]] to help you create even better modules.

==Joomla! Default Modules== 
Joomla! is packaged with many modules, more are available on the JED([http://extensions.joomla.org Joomla! Extension Directory]). Here are the standard modules available in a new Joomla! installation.
*[[S:MyLanguage/{{RVer|help}}:Extensions_Module_Manager_Articles_Archive|Archived Articles]] {{Rarr}} This Module shows a list of the calendar months containing Archived Articles.
</translate>
<translate>

*Articles - Newsflash {{Rarr}} The Newsflash Module will display a fixed number of articles from a specific category.
*Articles - Related Articles {{Rarr}} This Module displays other Articles that are related to the one currently being viewed....
*Articles Categories {{Rarr}} This module displays a list of categories from one parent category.
*Articles Category {{Rarr}} This module displays a list of articles from one or more categories.
*Banners {{Rarr}} The Banner Module displays the active Banners from the Component.
</translate>
<translate>

*[[S:MyLanguage/{{RVer|help}}:Extensions_Module_Manager_Breadcrumbs|Breadcrumbs]] {{Rarr}} This Module displays the Breadcrumbs
*[[S:MyLanguage/{{RVer|help}}:Extensions_Module_Manager_Custom_HTML|Custom]] {{Rarr}} This Module allows you to create your own HTML Module using a WYSIWYG editor.
*Feed Display {{Rarr}} This module allows the displaying of a syndicated feed
*Footer {{Rarr}} This module shows the Joomla! copyright information.
*Language Switcher {{Rarr}} This module displays a list of available Content Languages (as defined and published in...)
*Latest News {{Rarr}} This Module shows a list of the most recently published and current Articles. Some that...
*Latest Users {{Rarr}} This module displays the latest registered users
</translate>
<translate>

*[[S:MyLanguage/{{RVer|help}}:Extensions_Module_Manager_Login|Login]] {{Rarr}} This module displays a username and password login form. It also displays a link to...
*[[S:MyLanguage/{{RVer|help}}:Extensions_Module_Manager_Menu|Menu]] {{Rarr}} This module displays a menu on the frontend.
*Most Read Content {{Rarr}} This Module shows a list of the currently published Articles which have the highest...
*[[S:MyLanguage/{{RVer|help}}:Extensions_Module_Manager_Tags_Popular|Popular Tags]] {{Rarr}} The Popular Tags Module displays the most commonly used tags, optionally within specific...
*Random Image {{Rarr}} This Module displays a random image from your chosen directory.
*Search {{Rarr}} This module will display a search box.
*Similar Tags {{Rarr}} The Similar Tags Module displays links to other items with similar tags. The closeness...
*Smart Search Module {{Rarr}} This is a search module for the Smart Search system.
</translate>
<translate>

*Statistics {{Rarr}} The Statistics Module shows information about your server installation together with...
*Syndication Feeds {{Rarr}} Smart Syndication Module that creates a Syndicated Feed for the page where the Module is...
*Weblinks {{Rarr}} This modules displays Web Links from a category defined in the Weblinks component.
*Who's Online {{Rarr}} The Who's Online Module displays the number of Anonymous Users (e.g. Guests) and...
*Wrapper {{Rarr}} This Module shows an iframe window to specified location.


[[Category:Extensions| Module]][[Category:Landing Pages]][[Category:Glossary]]
</translate>