Actions

Difference between revisions of "Module Position"

From Joomla! Documentation

Line 1: Line 1:
 
{{inuse}}
 
{{inuse}}
Module positions are placeholders in a template.  They are used to identify positions within the template and to tell the Joomla! application where to place output from modules assigned to a particular position.
+
Module positions are placeholders in a template.  They identify positions within the template and tell the Joomla! application where to place output from modules assigned to a particular position. The template designer has complete control over module positions, creating variations between templates and  the respective Joomla! default positions assigned to modules in the installation sample data.
  
 
For example the module position "Left" could be used in the left side of the template to display a site navigation menu.
 
For example the module position "Left" could be used in the left side of the template to display a site navigation menu.
So if that module is assigned to the "Left" position, it will be displayed there.
+
So if a module is assigned the "Left" position, it will be displayed wherever the designer puts that "Left" module position.
  
Ultimately the template designer decides how to use a module position.  Therefore not all templates always support or use all module positions. If a module is assigned to a position that does not exist in a template, then the module will not be displayed. Common module positions are "Left", "Right", "Banner" and "Top".
+
==Templatedetails.xml==
 +
The <code>templatedetails.xml</code> file contains all the installation and core information for a template, including the module positions it utilizes and displays. Here is a brief list of the commonly used names for the various module positions.
 +
<pre>
 +
<positons>
 +
<position>top</position>
 +
<position>left</position>
 +
<position>right</position>
 +
<position>bottom</position>
 +
<position>banner</position>
 +
<position>syndicate</position>
 +
<position>footer</position>
 +
<position>user1</position>
 +
<position>user2</position>
 +
<position>user3</position>
 +
<position>user4</position>
 +
</positions>
 +
Although these are commonly used, it is up to the template developer to choose both a module position name and an accompanying display style.
 +
</pre>

Revision as of 17:08, 21 January 2008

Quill icon.png
Page Actively Being Edited!

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

Module positions are placeholders in a template. They identify positions within the template and tell the Joomla! application where to place output from modules assigned to a particular position. The template designer has complete control over module positions, creating variations between templates and the respective Joomla! default positions assigned to modules in the installation sample data.

For example the module position "Left" could be used in the left side of the template to display a site navigation menu. So if a module is assigned the "Left" position, it will be displayed wherever the designer puts that "Left" module position.

Templatedetails.xml

The templatedetails.xml file contains all the installation and core information for a template, including the module positions it utilizes and displays. Here is a brief list of the commonly used names for the various module positions.

<positons>
        <position>top</position>
        <position>left</position>
        <position>right</position>          
        <position>bottom</position>
        <position>banner</position>
        <position>syndicate</position>
        <position>footer</position>
        <position>user1</position>
        <position>user2</position>
        <position>user3</position>
        <position>user4</position>  
</positions>
Although these are commonly used, it is up to the template developer to choose both a module position name and an accompanying display style.