Module Position: Difference between revisions

From Joomla! Documentation

Newbee (talk | contribs)
No edit summary
Cmb (talk | contribs)
Clarified Visualization instructions.
 
(35 intermediate revisions by 10 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.
*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 when a module is assigned to the "Left" position the module will be displayed there.
It's possible to visualize all modules positions in a template by adding the <code>"tp=1"</code> query string to the URL.
<pre>
https://www.example.com/?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}}, '''Joomla 3.x''' {{JVer|3.x}} and '''Joomla 4.x''' {{JVer|4.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''':
*For Joomla 3 and earlier, {{rarr|Extensions,Templates,Options,Templates tab}}.
*For Joomla 4, {{rarr|System,Site Templates (or Administrator Templates),Options,Templates tab}}.
*Set ''Preview Module Positions'' to '''Enabled'''. Then select ''Save & Close''.
 
==Module Map== <!--T:4-->
The image below shows a module map when visualization is enabled.
:[[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 17:29, 13 July 2022

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.

Understanding Module Positions

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.

Visualization

It's possible to visualize all modules positions in a template by adding the "tp=1" query string to the URL.

https://www.example.com/?tp=1

Joomla 2.5 Joomla 2.5, Joomla 3.x Joomla 3.x and Joomla 4.x Joomla 4.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:

  • For Joomla 3 and earlier, Extensions  Templates  Options  Templates tab.
  • For Joomla 4, System  Site Templates (or Administrator Templates)  Options  Templates tab.
  • Set Preview Module Positions to Enabled. Then select Save & Close.

Module Map

The image below shows a module map when visualization is enabled.

Module positions in a default Joomla! 1.5 template