Jdoc statements
From Joomla! Documentation
Revision as of 11:34, 19 January 2008 by Shantanubala (talk | contribs)
jdoc:include[edit]
The <jdoc:include> statement is a Joomla! template's method of returning content specific to the page being viewed. There are various uses for the <jdoc:include> statement, each returning a different part of a Joomla! page.
The type attribute[edit]
The %%type%% attribute specifies the type of content to be rendered in place of the <jdoc:include /> element.
component[edit]
<jdoc:include type="component" />
This element should only appear once in the <body> element of the Template to render the main content of the page.
head[edit]
<jdoc:include type="head" />
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[edit]
<jdoc:include type="installation" />
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.
message[edit]
<jdoc:include type="message" />
This element should only appear once in the <body> element of the Template to render system and error messages that occurred in the request.
module[edit]
<jdoc:include type="module" name="breadcrumbs" />
<jdoc:include type="module" name="menu" />
<jdoc:include type="module" name="submenu" style="rounded" id="submenu-box" />
This element renders a single module given by the %%name%% 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.
modules[edit]
<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" />
This element renders all modules assigned to the template position given by the %%name%% attribute. Modules must be published and accessible by the current user to be visible. Additional attributes can be provided to control the layout and appearance of modules, if supported.
The style attribute[edit]
The optional %%style%% attribute is available for the module and modules types. The attribute value refers to the "chrome" style used to wrap the output generated by a module. If no style is provided, a value of "none" is used per default.
Standard module chrome names provided by the Joomla! Core are declared in %%/templates/system/html/modules.php%%
* table * horz * xhtml * rounded * outline
Template designers may invent additional chrome names by adding a custom version of this file to %%/user-template/html/modules.php%%.