View source for Jdoc statements/en

=== The type attribute ===
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. The space before the closing /> is also mandatory''.)

==== Component ====
<source lang="html4strict">
<jdoc:include type="component" />
</source>

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.

==== Head ====
<source lang="html4strict">
<jdoc:include type="head" />
</source>

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.

==== Installation ====
<source lang="html4strict">
<jdoc:include type="installation" />
</source>

This element is only used within the Joomla! Installer template for Joomla {{JVer|2.5}} and below and is 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.

==== Message ====
<source lang="html4strict">
<jdoc:include type="message" />
</source>

This element should only appear once in the <body> element of the Template to render system and error messages that occurred in the request.

CSS styles for system messages can be found in templates\system\css\system.css

==== Module ====
<source lang="html4strict">
<jdoc:include type="module" name="breadcrumbs" title="Breadcrumbs" />
<jdoc:include type="module" name="mainmenu" title="Main Menu" />
</source>

This element renders a single module given by the <tt>name</tt> and <tt>title</tt> attributes: <tt>name</tt> should match module type (mod_breadcrumbs and mod_menu in the examples above) while <tt>title</tt> should be the module name of the desired module.
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.

==== Modules ====
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.

Below are some examples of module statements with module positions used frequently by Joomla! theme developers.

<source lang="html4strict">
<jdoc:include type="modules" name="debug" />
<jdoc:include type="modules" name="icon" />
<jdoc:include type="modules" name="left" style="rounded" />
<jdoc:include type="modules" name="left" style="xhtml" />
<jdoc:include type="modules" name="right" style="xhtml" />
<jdoc:include type="modules" name="status"  />
<jdoc:include type="modules" name="syndicate" />
<jdoc:include type="modules" name="title" />
<jdoc:include type="modules" name="toolbar" />
<jdoc:include type="modules" name="top" />
<jdoc:include type="modules" name="top" style="xhtml" />
<jdoc:include type="modules" name="user1" style="xhtml" />
<jdoc:include type="modules" name="user2" style="xhtml" />
<jdoc:include type="modules" name="user3" />
<jdoc:include type="modules" name="user4" />
</source>
'''Note:''' The <code>name="user3"</code> module position is normally (by default) used for the top menu.