Actions

Difference between revisions of "Module Position"

From Joomla! Documentation

m (intro info)
m (update)
Line 3: Line 3:
 
*Modules can be turned on and off based on menu selection.
 
*Modules can be turned on and off based on menu selection.
 
*Modules can be reordered in their assigned position using the Module Manager.
 
*Modules can be reordered in their assigned position using the Module Manager.
 +
 
{{Chunk:Module Position}}
 
{{Chunk:Module Position}}
  
 +
==Module Map==
 +
The image below shows an example of a module map when module mapping is enabled in template administration.
 
:[[Image:Module_Map.jpg|600px|Module positions in a default Joomla! 1.5 template]]
 
:[[Image:Module_Map.jpg|600px|Module positions in a default Joomla! 1.5 template]]
  
  
==templateDetails.xml==
+
==Developer Information==
 +
{{notice|The rest of this article has general developer information which may be too advanced to understand unless you are a developer.|title=Developer Information Ahead!}}
 +
 
 +
===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.
 
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>
 
<pre>
Line 30: Line 36:
 
The addition of module positions, as displayed above, is implemented in between the <code><positions></code> and <code></positions></code> tags. In between those tags in the <code>templateDetails.xml</code> file, add the name of the module position in between a set of <code><position></code> and <code></position></code> tags.
 
The addition of module positions, as displayed above, is implemented in between the <code><positions></code> and <code></positions></code> tags. In between those tags in the <code>templateDetails.xml</code> file, add the name of the module position in between a set of <code><position></code> and <code></position></code> tags.
  
==Use and Implementation==
+
===Use and Implementation===
 
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>
Line 36: Line 42:
 
</pre>
 
</pre>
  
==Visualization==
+
===Visualization===
 
It's possible to visualize all modules set on a template by calling the <code>"tp=1"</code> query string on the front-end.
 
It's possible to visualize all modules set on a template by calling the <code>"tp=1"</code> query string on the front-end.
 
<pre>
 
<pre>
http://www.yourdomain.com/index.php?tp=1
+
http://www.example.com/index.php?tp=1
 
</pre>
 
</pre>
  

Revision as of 11:29, 29 September 2013

This article contains some development and advanced reading material. Joomla! Users and Administrators need to only understand the following:

  • Modules are set positions dictated by the template developer.
  • Modules can be turned on and off based on menu selection.
  • Modules can be reordered in their assigned position using the Module Manager.

<translate> A module position is a placeholder in a template. They identify one or several 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 defined to be on 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. </translate>


Contents

Module Map

The image below shows an example of a module map when module mapping is enabled in template administration.

Module positions in a default Joomla! 1.5 template


Developer Information

Info non-talk.png
Developer Information Ahead!

The rest of this article has general developer information which may be too advanced to understand unless you are a developer.

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.

<positions>
	<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>
	<position>debug</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" />

Visualization

It's possible to visualize all modules set on a template by calling the "tp=1" query string on the front-end.

http://www.example.com/index.php?tp=1

The default module positioning looks like the Module Map