View source for Developer Area/Core Subsystems/Page Title Template

<div class="wikitext">

All templating in Mahara is done with Dwoo ([http://dwoo.org/ <span style="white-space: nowrap">[[Image:http.png]]http://dwoo.org/</span>]). Each page that requires templating (which should be all pages that return HTML) will do so by fetching a smarty object via the [http://mahara.eduforge.org/api/mahara/core/_lib---web.php.html#functionsmarty <span style="white-space: nowrap">[[Image:http.png]]smarty()</span>] function (in lib/web.php).

<div id="section_1">

=== Template Locations ===

The smarty object returned searches for templates in /theme//templates/ where  starts at the current theme, and walks up parents until it finds a file (or a theme with no parent and no file causing an error).

Templates for artefacts in Mahara are accessed via a separate resource plugin. Where normal plugins are accessed just with a relative path (e.g. "mycontacts/index.tpl") artefact plugins will use their plugin name in the path (e.g. "arteface:internal:profile/index.tpl"). The template files themselves should be placed in /artefact//theme//

Also, templates for the render() method of an artefact should be placed in the 'render' subdirectory of the artefact plugin's template directory, and should follow the naming convention _.tpl

e.g., /artefact/blog/theme/default/render/blog_listchildren.tpl

</div><div id="section_2">

=== Template variables ===

The following variables are set by the smarty() function for every page and template.

* '''THEMEURL'''<nowiki>: The base url for static content</nowiki>
* '''WWWROOT'''<nowiki>: The base url for the mahara system</nowiki>
* '''USER'''<nowiki>: The user object</nowiki>
* '''JAVASCRIPT'''<nowiki>: A list of javascript files to include in the header. This list is passed into this function (see below).</nowiki>
* '''HEADERS'''<nowiki>: An array of any further headers to set. Each header is just straight HTML (see below).</nowiki>
* '''PUBLIC'''<nowiki>: Set true if this page is a public page</nowiki>
* '''MAINNAV'''<nowiki>: Array defining the main navigation</nowiki>

</div><div id="section_3">

=== Template functions ===

The following functions are available for every page and template.

<div id="section_4">

==== str ====

str is a custom function that looks up tags and returns an internationalised string.

{| class="wiki-dl-table" border="1" cellpadding="6"
|- class="tightenable bottom"
! Attribute Name
! Type
! Required
! Default
| '''Description'''
|- class="tightenable top bottom"
! tag
! String
! Yes
! n/a
| The tag to look up.
|- class="tightenable top bottom"
! section
! String
! No
! mahara
| Section to look up the tag in.
|- class="tightenable top"
! assign
! String
! No
! ''empty''
| If specified, rather than putting the string inline, will put it in this variable.
|}

</div></div></div>