Joomla! 1.5 Templates - Include Statements

Submitted by admin on 16 June, 2008 - 17:58
jdoc:includes What They Do
<jdoc:include type="head" /> Includes default header section xhtml in template's index.php file
<jdoc:include type="modules" name="nnn" style="sss" /> Includes all active modules assigned to a position in template's index.php file
<jdoc:include type="module" name="nnn" style="sss" /> Includes one particular active module assigned to a position in template's index.php file
&<jdoc:include type="component" /> Includes component position in template's index.php file
&<jdoc:include type="message" /> Includes system and error messages in template's index.php file
Examples of Include Usage
<jdoc:include type="head" /> – inserts the following xhtml statements within <head></head> in the template's index.php file:
<base href="http://domain-name.domain-sufffix/" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="robots" content="index, follow" />
<meta name="keywords" content="joomla, Joomla" />
<meta name="description" content="Joomla! - the dynamic portal engine and content management system" />
<meta name="generator" content="Joomla! 1.5 - Open Source Content Management" />
<title>>Welcome to the Frontpage</title>
<script type="text/javascript" src="/media/system/js/mootools.js"></script>
<script type="text/javascript" src="/media/system/js/caption.js"></script>
<jdoc:include type="modules" name="left" style="xhtml"/> – defines where the "left" module position will be placed in template's index.php file layout and use of the "xhtml" module encapsulation style for all modules assigned to the "left" position:
<div id="leftbox"> <!-- left module display -->
     <jdoc:include type="modules" name="left" style="xhtml" />
</div> <!-- end leftbox display -->

More details about the <jdoc:include type="module" name="nnn" style="sss" />:

The name="nnn" is the name of the position the module lives in when it is active.  Joomla! has a number of pre-defined module positions and you also have the ability to add your own ( see the TemplateDetails.xml discussion).

The style="sss" tells Joomla! what kind of xHTML constructs to generate.  The choices are:

  • none (default) - no styles or encapsulatng
  • xhtml - module is encapsuiated by <div<
  • rounded - module is encapsuiated in multiple <div> statements to facilitate styling rounded corners
  • table - module uses nasty old tables for layout.
<jdoc:include type="component" /> – defines where the "component" position will appear in template's index.php file layout:
<div id="middlebox"> <!-- component display -->
     <jdoc:include type="component" />
</div> <!-- end component display -->
Tags: 
Joomla!