Actions

Difference between revisions of "Jdoc statements"

From Joomla! Documentation

(New page: ====== jdoc:include ====== <code> <jdoc:include type="component" /> <jdoc:include type="head" /> <jdoc:include type="installation" /> <jdoc:include type="message" /> <jdoc:include type="mo...)
 
Line 46: Line 46:
  
 
==== modules ====
 
==== modules ====
This element renderes 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.
+
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.
  
  

Revision as of 23:16, 18 January 2008

Contents

jdoc:include

<jdoc:include type="component" /> <jdoc:include type="head" /> <jdoc:include type="installation" /> <jdoc:include type="message" /> <jdoc:include type="module" name="breadcrumbs" /> <jdoc:include type="module" name="menu" /> <jdoc:include type="module" name="submenu" style="rounded" id="submenu-box" /> <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" />


The type attribute

The %%type%% attribute specifies the type of content to be rendered in place of the <jdoc:include /> element.

component

This element should only appear once in the <body> element of the Template to render the main content of the page.

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

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

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

module

This element renderes 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

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

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%%.