Actions

Difference between revisions of "Module Position"

From Joomla! Documentation

m (Tom Hutchison moved page Module positions to Module Position without leaving a redirect: name must match chunk name)
 
(32 intermediate revisions by 8 users not shown)
Line 1: Line 1:
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.
+
<noinclude><languages /></noinclude>
 +
<translate>
 +
{{Chunk:Module Position/en}}
 +
__TOC__
 +
==Understanding Module Positions== <!--T:1-->
 +
Joomla! Users and Administrators need to only understand the following:
 +
*Modules are set positions dictated by the [[template]] developer when they developed the template.
 +
*Modules can be turned on and off based on menu selection.
 +
*Modules can be reordered in their assigned position using the Module Manager.
  
For example the module position "Left" could be used in the left side of the template to display a site navigation menu.
+
===Visualization=== <!--T:2-->
So if that module is assigned to the "Left" position, it will be displayed there.
+
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>
 +
http://www.example.com/index.php?tp=1
 +
</pre>
  
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".
+
<!--T:3-->
 +
'''Joomla 2.5''' {{JVer|2.5}} and '''Joomla 3.x''' {{JVer|3.x}} will show the template positions with ?tp=1 or &tp=1 if the '''Preview Module Positions mode''' in the Template Manager has been '''Enabled''':
 +
*{{rarr|Extensions,Template Manager}} then click the Options button in the toolbar.  
 +
*Under the '''Templates Tab''', make sure <u>''Preview Module Positions''</u> is set to '''Enabled'''.
 +
 
 +
==Module Map== <!--T:4-->
 +
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]]
 +
 
 +
<!--T:5-->
 +
<noinclude>[[Category:Templates]]
 +
[[Category:Modules]]
 +
</noinclude>
 +
</translate>

Latest revision as of 22:57, 24 February 2014

Other languages: català 33% • ‎English 100% • ‎español 100% • ‎français 100% • ‎Bahasa Indonesia 100% • ‎日本語 100% • ‎Nederlands 100% • ‎Kiswahili 100%

A module position is a placeholder in a template. Placeholders 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.


Contents

Understanding Module Positions

Joomla! Users and Administrators need to only understand the following:

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

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

Joomla 2.5 Joomla 2.5 and Joomla 3.x Joomla 3.x will show the template positions with ?tp=1 or &tp=1 if the Preview Module Positions mode in the Template Manager has been Enabled:

  • Extensions  Template Manager then click the Options button in the toolbar.
  • Under the Templates Tab, make sure Preview Module Positions is set to Enabled.

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