Difference between revisions of "Module Position"

From Joomla! Documentation
m (adding toc)
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
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.
+
__TOC__
 +
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.
+
{{Chunk:Module Position}}
−
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==
+
==Module Map==
−
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 image below shows an example of a module map when module mapping is enabled in template administration.
−
<pre>
+
:[[Image:Module_Map.jpg|600px|Module positions in a default Joomla! 1.5 template]]
−
<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>
 
−
</positions>
 
−
</pre>
 
−
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 <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==
 
−
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>
 
−
<jdoc:include type="modules" name="name of module position" style="xhtml" />
 
−
</pre>
 
  
−
==Visualization==
+
<noinclude>[[Category:Templates]]
−
It's possible to visualize all modules set on a template by calling the <code>"tp=1"</code> query string on the front-end.
+
[[Category:Modules]]
−
<pre>
+
</noinclude>
−
http://www.yourdomain.com/index.php?tp=1
 
−
</pre>
 
−
 
 
−
The default module positioning looks like the [[Module Map]]
 
−
 
 
−
<noinclude>[[Category:Templates]]</noinclude>
 

Revision as of 22:58, 29 September 2013

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.


<translate> 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. </translate>

Module Map[edit]

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
Retrieved from "https://docs.joomla.org/index.php?title=Module_Position&oldid=104056"