Actions

Difference between revisions of "Module Position"

From Joomla! Documentation

Line 27: Line 27:
 
A Joomla! template displays a set of modules added to a specific position using the <code><jdoc:include /></code> statement shown below (for further information about <code><jdoc:include /></code> see [[jdoc statements]]):
 
A Joomla! template displays a set of modules added to a specific position using the <code><jdoc:include /></code> statement shown below (for further information about <code><jdoc:include /></code> see [[jdoc statements]]):
 
<pre>
 
<pre>
<jdoc:include type="modules" name="name of module position" />
+
<jdoc:include type="modules" name="name of module position" style="xhtml" />
 
</pre>
 
</pre>

Revision as of 16:36, 21 January 2008

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 - not necessarily the left side of the page.

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. The addition of module positions, as displayed above, is implemented in between the <positions> and </positions> tags. In between those tags in the templateDetails.xml file, add the name of the module position in between a set of <position> and </position> tags.

Use and Implementation

A Joomla! template displays a set of modules added to a specific position using the <jdoc:include /> statement shown below (for further information about <jdoc:include /> see jdoc statements):

<jdoc:include type="modules" name="name of module position" style="xhtml" />