Difference between revisions of "Module Position"

From Joomla! Documentation

m (Update with J4.x information.)
(Clarified Visualization instructions.)
 
Line 5: Line 5:
 
==Understanding Module Positions== <!--T:1-->
 
==Understanding Module Positions== <!--T:1-->
 
Joomla! Users and Administrators need to only understand the following:
 
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 are set positions dictated by the [[template]] developer.
 
*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.
  
 
===Visualization=== <!--T:2-->
 
===Visualization=== <!--T:2-->
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 positions in a template by adding the <code>"tp=1"</code> query string to the URL.
 
<pre>
 
<pre>
http://www.example.com/index.php?tp=1
+
https://www.example.com/?tp=1
 
</pre>
 
</pre>
  
 
<!--T:3-->
 
<!--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''':  
 
'''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''':  
*{{rarr|Extensions,Template Manager}} then click the Options button in the toolbar.  
+
*For Joomla 3 and earlier, {{rarr|Extensions,Templates,Options,Templates tab}}.
*Under the '''Templates Tab''', make sure <u>''Preview Module Positions''</u> is set to '''Enabled'''.
+
*For Joomla 4, {{rarr|System,Site Templates (or Administrator Templates),Options,Templates tab}}.
*For Joomla 4.x the path to Templates is, from the sidebar menu, '''System''' then choose either '''Site Templates''' (frontend) or '''Administrator Templates''' (backend).
+
*Set ''Preview Module Positions'' to '''Enabled'''. Then select ''Save & Close''.
  
 
==Module Map== <!--T:4-->
 
==Module Map== <!--T:4-->
The image below shows an example of a module map when module mapping is enabled in template administration.
+
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]]
 
:[[Image:Module_Map.jpg|600px|Module positions in a default Joomla! 1.5 template]]
  

Latest revision as of 11:29, 13 July 2022

Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Kiswahili • ‎Nederlands • ‎català • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎português do Brasil • ‎русский • ‎日本語

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[edit]

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[edit]

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[edit]

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

Module positions in a default Joomla! 1.5 template