DESCRIPTION

This page documents most of the templates used.

The page is built by several template parts. Each part can be replaced by a custom implementation. All the standard parts can be found in inc/html/c/ and/or the language specific dirs.

To override a part of the header or footer for a specific part of the web site, create a inc directory in that part.

To insert extra parts; copy one of the parts and insert an extra include in your desired place.

Meta::Interpolate is a TT plugin. app_components.tt is the place for the app to define it's own TT components that should be loaded by every page.

OVERVIEW

These are the parts called:

/header_prepare.tt
Para::Frame::Template::Plugin::Meta::Interpolate
components.tt
/app_components.tt
/header.tt
<html><head><title>
/title.tt
</title>
Para::Frame::css_header
favicon, description, keywords, robots
/header_extra.tt (empty)
/js.tt
/js_extra.tt (empty)
</head><body>
/border_top.tt
/form_start.tt
<form>
The "run" hidden form field
/menu_top.tt
The default menu
/headline.tt
/info_box.tt

/your/selected/template.tt

/footer.tt
/border_bottom.tt (empty)
</form>
/debug.tt
</body></html>

header_prepare.tt

This part doesn't return any HTML.

Sets up some of the template variables.

Check to see that you are authorized to access the selected page.

Processes app_components.tt if it's found.

app_components.tt

This is the place to put your global TT blocks, TT macros and TT variables. RitFrame default is empty.

title.tt

Just [% otitle %]. Replace this template if you want to compute the page (head) title in some other way.

header_extra.tt

Replace this template to add custom fields to the HTML HEAD. It could be additional CSS, javascript or anything else. But see if what you want can be done by META params to the Para::Frame::Template::header.

js.tt

This is the RitFrame standard javascript functions used for the HTML form and site navigation.

border_top.tt

Replace this template to give your site its design. It should contain all the body HTML to be placed before the main content of each page. Insert calls to add your own menues et al.

Your border_top.tt template should include these three parts in the order and place of your desire, mixed in with your custom HTML code:

  [% PROCESS form_start.tt %]
  [% PROCESS headline.tt %]
  [% PROCESS info_box.tt %]

The default template includes /form_start.tt and /top_menu.tt.

You may want to insert a separate HTML form section in the top of the page. That should be done before the /form_start.tt, that starts the main RitFrame standard form.

menu_top.tt

The default top_,emu.tt is language specific, outputs a simple menu that let's you log in. This is followed by the inclusion of /headline.tt and /info_box.tt.

You may want to replace this tempalte with your own version, or bypass this template eniarly by not calling it in your replacement for /border_top.tt.

This template may change name or dissapear in a future version.

headline.tt

This template just outputs a <h1>[% title %]</h1> if that variable exists. Replace this template if you want to do special manipulation or formatting of the title as given in the META directive.

info_box.tt

This tempalte outputs the resulting messages from performed actions and any error messages encounterd.

footer.tt

Output the last part of the HTML page, including /border_bottom.tt corresponding to /border_top.tt. /debug.tt is included last in the page.

Replace this template if you want to add special conditions for displaying the debug template or if you want to add an extra HTML form after the main RitFrame standard form.

border_bottom.tt

This corresponds to /border_top.tt.

Replace this template to give your site its design. It should contain all the body HTML to be placed before the end of the HTML BODY, but inside the main RitFrame standard form.

The default template is empty.

debug.tt

Outputs some debug data.

Lists the query parameters as they are at the time of generating this part. They could have been changed by RitFrame, the Actions or during the process of the template.

Outputs the active route and lists the parts generated in this request response.

SEE ALSO

Para::Frame