https://docs.sandbox.joomla.org/api.php?action=feedcontributions&feedformat=atom&user=Cw86Joomla! Documentation - User contributions [en]2026-09-14T14:28:19ZUser contributionsMediaWiki 1.43.0https://docs.sandbox.joomla.org/index.php?title=Talk:Jdoc_statements&diff=14427Talk:Jdoc statements2009-06-05T11:35:49Z<p>Cw86: </p>
<hr />
<div>'''Regarding &lt;jdoc:include type="module" ... /&gt;'''<br />
<br />
It should be explained that the name attribute will take the value from the type column in the module manager list by cutting off from the start the letters "mod_" and that one must also give the title attribute a value - otherwise rendered content will be empty.<br />
<br />
So, let's say I have three menu modules of type "mod_mainmenu" with the following titles: "Menu One", "Menu Two", "Menu Three". I would need these elements in the template file to get their contents:<br />
<br />
<source lang="html4strict"><br />
<jdoc:include type="module" name="mainmenu" title="Menu One" /><br />
<jdoc:include type="module" name="mainmenu" title="Menu Two" /><br />
<jdoc:include type="module" name="mainmenu" title="Menu Three" /><br />
</source></div>Cw86https://docs.sandbox.joomla.org/index.php?title=Jdoc_statements&diff=14426Jdoc statements2009-06-05T11:35:27Z<p>Cw86: /* Module */</p>
<hr />
<div>{{DISPLAYTITLE:jdoc statements}}<br />
{{jdoc}}<br />
== jdoc:include ==<br />
The <code><jdoc:include /></code> statement is a Joomla! template's method of displaying content specific to the page being viewed. There are various <code><jdoc:include /></code> statements, each returning a different part of a Joomla! page.<br />
<br />
== The type attribute ==<br />
The <tt>type</tt> attribute specifies the type of content to be rendered in place of the <code><jdoc:include /></code> element. For example, the <code><jdoc:include '''''type="head"''''' /></code> statement uses the <code>type</code> attribute <code>head</code> (<code>type="head"</code>). (''Note: Jdoc expressions require double quotes around attributes, and won't work with single quotes.'')<br />
<br />
=== Component ===<br />
<source lang="html4strict"><br />
<jdoc:include type="component" /><br />
</source><br />
<br />
This element should only appear once in the <body> element of the Template to render the main content of the page with respect to the current page being viewed.<br />
<br />
=== Head ===<br />
<source lang="html4strict"><br />
<jdoc:include type="head" /><br />
</source><br />
<br />
This element should only appear once in the <head> element of the Template to render the content of the style, script and meta elements associated with the current page.<br />
<br />
=== Installation ===<br />
<source lang="html4strict"><br />
<jdoc:include type="installation" /><br />
</source><br />
<br />
This element is only used within the Joomla! Installer template and of no particular use in a Front-end or Back-end template. It's somewhat the equivalent to the 'component' type, rendering the main content of an installation step.<br />
<br />
=== Message ===<br />
<source lang="html4strict"><br />
<jdoc:include type="message" /><br />
</source><br />
<br />
This element should only appear once in the <body> element of the Template to render system and error messages that occurred in the request.<br />
<br />
CSS styles for system messages can be found in templates\system\css\system.css<br />
<br />
=== Module ===<br />
<source lang="html4strict"><br />
<jdoc:include type="module" name="breadcrumbs" /><br />
<jdoc:include type="module" name="menu" /><br />
<jdoc:include type="module" name="submenu" style="rounded" id="submenu-box" /><br />
</source><br />
<br />
This element renders a single module given by the <tt>name</tt> attribute. The module in question must be published and accessible by the current user in order to become visible. Additional attributes can be provided to control the layout and appearance of the module, if supported.<br />
<br />
=== Modules ===<br />
Modules are rendered on a page using one of the following code examples. The modules are separated into different areas of a template using template positions set in the <code>templatedetails.xml</code> file. Using the <code>jdoc:include</code>'s <code>name="''[template position name]''"</code> attribute, the various modules in their respective positions can be called, rendered, and styled separately. Additional attributes can be provided to control the layout and appearance of modules, if supported.<br />
<br />
Below are some examples of module statements with module positions used frequently by Joomla! theme developers.<br />
<br />
<source lang="html4strict"><br />
<jdoc:include type="modules" name="debug" /><br />
<jdoc:include type="modules" name="icon" /><br />
<jdoc:include type="modules" name="left" style="rounded" /><br />
<jdoc:include type="modules" name="left" style="xhtml" /><br />
<jdoc:include type="modules" name="right" style="xhtml" /><br />
<jdoc:include type="modules" name="status" /><br />
<jdoc:include type="modules" name="syndicate" /><br />
<jdoc:include type="modules" name="title" /><br />
<jdoc:include type="modules" name="toolbar" /><br />
<jdoc:include type="modules" name="top" /><br />
<jdoc:include type="modules" name="top" style="xhtml" /><br />
<jdoc:include type="modules" name="user1" style="xhtml" /><br />
<jdoc:include type="modules" name="user2" style="xhtml" /><br />
<jdoc:include type="modules" name="user3" /><br />
<jdoc:include type="modules" name="user4" /><br />
</source><br />
'''Note:''' The <code>name="user3"</code> module position is normally (by default) used for the top menu.<br />
<br />
==== The style attribute ====<br />
The optional <code>style=""</code> attribute is available for the <code>module</code> and <code>modules</code> types of <code><jdoc:include /></code> statements. The attribute value refers to the [[What is module chrome?|chrome]] style used to wrap the output generated by the Module. If no style is provided, a value of "<code>none</code>" is used by default.<br />
<br />
Template designers may add additional chrome names as described in [[Applying custom module chrome]].<br />
[[Category:Templates]]</div>Cw86https://docs.sandbox.joomla.org/index.php?title=Jdoc_statements&diff=14425Jdoc statements2009-06-05T11:35:07Z<p>Cw86: /* Module */</p>
<hr />
<div>{{DISPLAYTITLE:jdoc statements}}<br />
{{jdoc}}<br />
== jdoc:include ==<br />
The <code><jdoc:include /></code> statement is a Joomla! template's method of displaying content specific to the page being viewed. There are various <code><jdoc:include /></code> statements, each returning a different part of a Joomla! page.<br />
<br />
== The type attribute ==<br />
The <tt>type</tt> attribute specifies the type of content to be rendered in place of the <code><jdoc:include /></code> element. For example, the <code><jdoc:include '''''type="head"''''' /></code> statement uses the <code>type</code> attribute <code>head</code> (<code>type="head"</code>). (''Note: Jdoc expressions require double quotes around attributes, and won't work with single quotes.'')<br />
<br />
=== Component ===<br />
<source lang="html4strict"><br />
<jdoc:include type="component" /><br />
</source><br />
<br />
This element should only appear once in the <body> element of the Template to render the main content of the page with respect to the current page being viewed.<br />
<br />
=== Head ===<br />
<source lang="html4strict"><br />
<jdoc:include type="head" /><br />
</source><br />
<br />
This element should only appear once in the <head> element of the Template to render the content of the style, script and meta elements associated with the current page.<br />
<br />
=== Installation ===<br />
<source lang="html4strict"><br />
<jdoc:include type="installation" /><br />
</source><br />
<br />
This element is only used within the Joomla! Installer template and of no particular use in a Front-end or Back-end template. It's somewhat the equivalent to the 'component' type, rendering the main content of an installation step.<br />
<br />
=== Message ===<br />
<source lang="html4strict"><br />
<jdoc:include type="message" /><br />
</source><br />
<br />
This element should only appear once in the <body> element of the Template to render system and error messages that occurred in the request.<br />
<br />
CSS styles for system messages can be found in templates\system\css\system.css<br />
<br />
=== Module ===<br />
<source lang="html4strict"><br />
<jdoc:include type="modules" name="breadcrumbs" /><br />
<jdoc:include type="modules" name="menu" /><br />
<jdoc:include type="modules" name="submenu" style="rounded" id="submenu-box" /><br />
</source><br />
<br />
This element renders a single module given by the <tt>name</tt> attribute. The module in question must be published and accessible by the current user in order to become visible. Additional attributes can be provided to control the layout and appearance of the module, if supported.<br />
<br />
=== Modules ===<br />
Modules are rendered on a page using one of the following code examples. The modules are separated into different areas of a template using template positions set in the <code>templatedetails.xml</code> file. Using the <code>jdoc:include</code>'s <code>name="''[template position name]''"</code> attribute, the various modules in their respective positions can be called, rendered, and styled separately. Additional attributes can be provided to control the layout and appearance of modules, if supported.<br />
<br />
Below are some examples of module statements with module positions used frequently by Joomla! theme developers.<br />
<br />
<source lang="html4strict"><br />
<jdoc:include type="modules" name="debug" /><br />
<jdoc:include type="modules" name="icon" /><br />
<jdoc:include type="modules" name="left" style="rounded" /><br />
<jdoc:include type="modules" name="left" style="xhtml" /><br />
<jdoc:include type="modules" name="right" style="xhtml" /><br />
<jdoc:include type="modules" name="status" /><br />
<jdoc:include type="modules" name="syndicate" /><br />
<jdoc:include type="modules" name="title" /><br />
<jdoc:include type="modules" name="toolbar" /><br />
<jdoc:include type="modules" name="top" /><br />
<jdoc:include type="modules" name="top" style="xhtml" /><br />
<jdoc:include type="modules" name="user1" style="xhtml" /><br />
<jdoc:include type="modules" name="user2" style="xhtml" /><br />
<jdoc:include type="modules" name="user3" /><br />
<jdoc:include type="modules" name="user4" /><br />
</source><br />
'''Note:''' The <code>name="user3"</code> module position is normally (by default) used for the top menu.<br />
<br />
==== The style attribute ====<br />
The optional <code>style=""</code> attribute is available for the <code>module</code> and <code>modules</code> types of <code><jdoc:include /></code> statements. The attribute value refers to the [[What is module chrome?|chrome]] style used to wrap the output generated by the Module. If no style is provided, a value of "<code>none</code>" is used by default.<br />
<br />
Template designers may add additional chrome names as described in [[Applying custom module chrome]].<br />
[[Category:Templates]]</div>Cw86https://docs.sandbox.joomla.org/index.php?title=Talk:Jdoc_statements&diff=14424Talk:Jdoc statements2009-06-05T11:34:49Z<p>Cw86: </p>
<hr />
<div>'''Regarding &lt;jdoc:include type="modules" ... /&gt;'''<br />
<br />
It should be explained that the name attribute will take the value from the type column in the module manager list by cutting off from the start the letters "mod_" and that one must also give the title attribute a value - otherwise rendered content will be empty.<br />
<br />
So, let's say I have three menu modules of type "mod_mainmenu" with the following titles: "Menu One", "Menu Two", "Menu Three". I would need these elements in the template file to get their contents:<br />
<br />
<source lang="html4strict"><br />
<jdoc:include type="modules" name="mainmenu" title="Menu One" /><br />
<jdoc:include type="modules" name="mainmenu" title="Menu Two" /><br />
<jdoc:include type="modules" name="mainmenu" title="Menu Three" /><br />
</source></div>Cw86https://docs.sandbox.joomla.org/index.php?title=Talk:Jdoc_statements&diff=14423Talk:Jdoc statements2009-06-05T11:32:21Z<p>Cw86: </p>
<hr />
<div>'''Regarding &lt;jdoc:include type="module" ... /&gt;'''<br />
<br />
It should be explained that the name attribute will take the value from the type column in the module manager list by cutting off from the start the letters "mod_" and that one must also give the title attribute a value - otherwise rendered content will be empty.<br />
<br />
So, let's say I have three menu modules of type "mod_mainmenu" with the following titles: "Menu One", "Menu Two", "Menu Three". I would need these elements in the template file to get their contents:<br />
<br />
<source lang="html4strict"><br />
<jdoc:include type="modules" name="mainmenu" title="Menu One" /><br />
<jdoc:include type="modules" name="mainmenu" title="Menu Two" /><br />
<jdoc:include type="modules" name="mainmenu" title="Menu Three" /><br />
</source></div>Cw86