From f91b1b9d13b3b13b025e9bf7245553e04daa38bd Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Fri, 28 Apr 2006 17:04:23 +0000 Subject: [PATCH] Template docs updated for 6.99 --- lib/WebGUI/Help/Asset_Template.pm | 10 ++++++ lib/WebGUI/i18n/English/Asset_Template.pm | 44 ++++++++++++++--------- 2 files changed, 37 insertions(+), 17 deletions(-) diff --git a/lib/WebGUI/Help/Asset_Template.pm b/lib/WebGUI/Help/Asset_Template.pm index 9b9d3d3c8..6cc2d4a33 100644 --- a/lib/WebGUI/Help/Asset_Template.pm +++ b/lib/WebGUI/Help/Asset_Template.pm @@ -21,6 +21,16 @@ our $HELP = { description => 'template description', namespace => 'Asset_Template', }, + { + title => 'head block', + description => 'head block description', + namespace => 'Asset_Template', + }, + { + title => 'parser', + description => 'parser description', + namespace => 'Asset_Template', + }, ], related => [ ] diff --git a/lib/WebGUI/i18n/English/Asset_Template.pm b/lib/WebGUI/i18n/English/Asset_Template.pm index 1f38c7f6b..bf4e3d0ad 100644 --- a/lib/WebGUI/i18n/English/Asset_Template.pm +++ b/lib/WebGUI/i18n/English/Asset_Template.pm @@ -214,8 +214,11 @@ Loops come with special condition variables of their own. They are __FIRST__, __ </TMPL_LOOP> -

|, - lastUpdated =>1130959765, +

+

NOTE: This only documents WebGUI's default template language, HTML::Template. If the Template Type +has been set to some other language you will need to consult the documentation for it.

. +|, + lastUpdated =>1146243644, }, 'template variable title' => { @@ -233,37 +236,44 @@ The version of WebGUI on your site. The release status for this version of WebGUI, stable, beta, gamma, etc.

-

-Session Variables
-In addition to any variables defined in a given template, the session variables are made available to you with this syntax: +

session.user.username
+The current user's username.

-

<tmpl_var session.section.variable>

+

session.user.firstDayOfWeek
+From the current user's profile, the day they selected to be the first day of the week. +

-

Some common, useful session variables are:

+

session.config.extrasurl
+From the WebGUI config, the URL for the extras directory. +

session.var.adminOn
This variable will be true if the user is in Admin mode.

-

session.var.userId
-The userId for the current user. +

session.setting.companyName
+From the WebGUI settings, the company name.

-

session.user.username
-The current user's username. +

session.setting.anonymousRegistration
+From the WebGUI settings, whether or not anonymous registration has been enabled.

-

session.user.language
-The current user's preferred language (the default is English). +

+Session Form Variables
+Any form variables will be available in the template with this syntax:

-

session.user.karma
-The user's karma. -

+

<tmpl_var session.form.variable>

+ +

If there is more than 1 value in a form variable, only the last will be returned

+ +

NOTE: The syntax for these variables is shown in WebGUI's default template language, HTML::Template. If the Template Type +has been set to some other language you will need to consult the documentation for the appropriate syntax for its variables.

. |, - lastUpdated => 1130978466, + lastUpdated => 1146243514, }, };