Cleaning up Template Asset Help, and all related files.

This commit is contained in:
Colin Kuskie 2007-07-19 23:20:29 +00:00
parent 6524a3c815
commit 38a10fe245
20 changed files with 3 additions and 427 deletions

View file

@ -95,10 +95,6 @@ our $HELP = {
}
],
related => [
{
tag => 'template language',
namespace => 'Asset_Template',
},
]
},

View file

@ -483,10 +483,6 @@ our $HELP = {
tag => 'pagination template variables',
namespace => 'WebGUI',
},
{
tag => 'template language',
namespace => 'Asset_Template',
},
],
},
@ -574,10 +570,6 @@ our $HELP = {
tag => 'event management system template',
namespace => 'Asset_EventManagementSystem',
},
{
tag => 'template language',
namespace => 'Asset_Template',
},
],
},
@ -608,10 +600,6 @@ our $HELP = {
tag => 'event management system add/edit',
namespace => 'Asset_EventManagementSystem',
},
{
tag => 'template language',
namespace => 'Asset_Template',
},
],
},
@ -642,10 +630,6 @@ our $HELP = {
tag => 'event management system add/edit',
namespace => 'Asset_EventManagementSystem',
},
{
tag => 'template language',
namespace => 'Asset_Template',
},
],
},
@ -743,10 +727,6 @@ our $HELP = {
tag => 'event management system add/edit',
namespace => 'Asset_EventManagementSystem',
},
{
tag => 'template language',
namespace => 'Asset_Template',
},
],
},
@ -921,10 +901,6 @@ our $HELP = {
tag => 'pagination template variables',
namespace => 'WebGUI',
},
{
tag => 'template language',
namespace => 'Asset_Template',
},
],
},

View file

@ -116,10 +116,6 @@ our $HELP = {
tag => 'folder add/edit',
namespace => 'Asset_Folder',
},
{
tag => 'template language',
namespace => 'Asset_Template',
},
]
},
@ -150,10 +146,6 @@ our $HELP = {
tag => 'folder add/edit',
namespace => 'Asset_Folder',
},
{
tag => 'template language',
namespace => 'Asset_Template',
},
]
},

View file

@ -37,10 +37,6 @@ our $HELP = {
},
],
related => [
{
tag => 'template language',
namespace => 'Asset_Template',
},
]
},

View file

@ -80,10 +80,6 @@ our $HELP = {
tag => 'layout add/edit',
namespace => 'Asset_Layout'
},
{
tag => 'template language',
namespace => 'Asset_Template'
},
]
},
@ -115,10 +111,6 @@ our $HELP = {
tag => 'layout add/edit',
namespace => 'Asset_Layout'
},
{
tag => 'template language',
namespace => 'Asset_Template'
},
]
},

View file

@ -72,10 +72,6 @@ our $HELP = {
tag => 'navigation template',
namespace => 'Asset_Navigation'
},
{
tag => 'template add/edit',
namespace => 'Asset_Template'
}
]
},
@ -288,10 +284,6 @@ our $HELP = {
tag => 'navigation add/edit',
namespace => 'Asset_Navigation'
},
{
tag => 'template language',
namespace => 'Asset_Template'
}
]
},
@ -347,10 +339,6 @@ our $HELP = {
tag => 'navigation add/edit',
namespace => 'Asset_Navigation'
},
{
tag => 'template language',
namespace => 'Asset_Template'
}
]
},

View file

@ -10,7 +10,7 @@ our $HELP = {
namespace => 'Asset_Collaboration'
},
{
tag => 'template language',
tag => 'template variables',
namespace => 'Asset_Template'
},
{
@ -282,10 +282,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'template language',
namespace => 'Asset_Template'
},
{
tag => 'collaboration template labels',
namespace => 'Asset_Collaboration'
@ -398,7 +394,7 @@ our $HELP = {
tag => "post template variables"
},
{
tag => 'template language',
tag => 'template variables',
namespace => 'Asset_Template'
},
],

View file

@ -536,10 +536,6 @@ our $HELP = {
tag => 'sql form add/edit',
namespace => 'Asset_SQLForm',
},
{
tag => 'template language',
namespace => 'Asset_Template',
},
],
},
@ -710,10 +706,6 @@ our $HELP = {
tag => 'sql form add/edit',
namespace => 'Asset_SQLForm',
},
{
tag => 'template language',
namespace => 'Asset_Template',
},
],
},
@ -799,10 +791,6 @@ our $HELP = {
tag => 'sql form add/edit',
namespace => 'Asset_SQLForm',
},
{
tag => 'template language',
namespace => 'Asset_Template',
},
],
},

View file

@ -39,10 +39,6 @@ our $HELP = {
tag => 'wobjects using',
namespace => 'Asset_Wobject'
},
{
tag => 'template language',
namespace => 'Asset_Template'
},
]
},

View file

@ -2,59 +2,6 @@ package WebGUI::Help::Asset_Template;
our $HELP = {
'template add/edit' => {
title => '684',
body => '639',
isa => [
{
tag => 'asset fields',
namespace => 'Asset'
},
],
fields => [
{
title => 'namespace',
description => 'namespace description',
namespace => 'Asset_Template',
},
{
title => 'show in forms',
description => 'show in forms description',
namespace => 'Asset_Template',
},
{
title => 'assetName',
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 => [
]
},
'template language' => {
title => '825',
body => '826',
fields => [
],
related => [
{
tag => 'template variables',
namespace => 'Asset_Template'
},
]
},
'template variables' => {
title => 'template variable title',
body => 'template variable body',
@ -96,65 +43,6 @@ our $HELP = {
]
},
'style wizard' => {
title => 'style wizard',
body => 'style wizard help',
fields => [
{
title => 'site name',
description => 'site name description',
namespace => 'Asset_Template',
},
{
title => 'logo',
description => 'logo description',
namespace => 'Asset_Template',
},
{
title => 'page background color',
description => 'page background color description',
namespace => 'Asset_Template',
},
{
title => 'header background color',
description => 'header background color description',
namespace => 'Asset_Template',
},
{
title => 'header text color',
description => 'header text color description',
namespace => 'Asset_Template',
},
{
title => 'body background color',
description => 'body background color description',
namespace => 'Asset_Template',
},
{
title => 'body text color',
description => 'body text color description',
namespace => 'Asset_Template',
},
{
title => 'menu background color',
description => 'menu background color description',
namespace => 'Asset_Template',
},
{
title => 'link color',
description => 'link color description',
namespace => 'Asset_Template',
},
{
title => 'visited link color',
description => 'visited link color description',
namespace => 'Asset_Template',
},
],
related => [
]
},
};
1;

View file

@ -6,7 +6,7 @@ our $HELP = {
body => 'thread template body',
isa => [
{
tag => 'template language',
tag => 'template variables',
namespace => 'Asset_Template'
},
{

View file

@ -96,10 +96,6 @@ our $HELP = {
tag => 'pagination template variables',
namespace => 'WebGUI'
},
{
tag => 'template language',
namespace => 'Asset_Template'
},
]
},
@ -130,10 +126,6 @@ our $HELP = {
},
],
related => [
{
tag => 'template language',
namespace => 'Asset_Template'
},
]
},

View file

@ -42,10 +42,6 @@ our $HELP = {
}
],
related => [
{
tag => 'template language',
namespace => 'Asset_Template',
},
]
},

View file

@ -13,10 +13,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'template language',
namespace => 'Asset_Template'
},
]
},
@ -72,10 +68,6 @@ our $HELP = {
},
],
related => [
{
tag => 'template language',
namespace => 'Asset_Template'
},
],
},
@ -110,10 +102,6 @@ our $HELP = {
}
],
related => [
{
tag => 'template language',
namespace => 'Asset_Template'
},
]
},
@ -159,10 +147,6 @@ our $HELP = {
}
],
related => [
{
tag => 'template language',
namespace => 'Asset_Template'
},
]
},

View file

@ -35,10 +35,6 @@ our $HELP = {
}
],
related => [
{
tag => 'template language',
namespace => 'Asset_Template'
},
]
},

View file

@ -16,10 +16,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'template language',
namespace => 'Asset_Template'
},
]
},

View file

@ -16,10 +16,6 @@ our $HELP = {
}
],
related => [
{
tag => 'template language',
namespace => 'Asset_Template',
},
]
},

View file

@ -8,10 +8,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'template language',
namespace => 'Asset_Template'
},
]
},

View file

@ -16,10 +16,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'template language',
namespace => 'Asset_Template'
},
]
},

View file

@ -49,52 +49,6 @@ our $I18N = {
lastUpdated => 1107391368,
},
'684' => {
message => q|Template, Add/Edit|,
lastUpdated => 1038890615
},
'639' => {
message => q|<p>Templates allow you to customize the look and feel of your content on your site. WebGUI comes with many existing templates that you can use as is or copy and modify to suit your individual needs. Note that in many cases that you can change the look of default WebGUI templates through CSS. The advantage to this is that the default templates are automatically updated when you upgrade WebGUI, where custom templates will have to be manually updated.</p>
<p>There are two ways to edit templates, via the Display tab of the Asset Edit screen or via the Asset Manager. In either case, you will need to be an Admin or a Template Admin.
</p>
<p><b>Display tab of the Asset Edit screen</b></p>
<div>
<ul>
<li>Turn on Admin mode.</li>
<li>Click on the Edit icon for an Asset.</li>
<li>Select the "Display" tab for the Asset.</li>
<li>Next to the template that the Asset uses will be two icons.
<dl>
<dt>Edit</dt>
<dd>This will allow you to edit the currently selected template.</dd>
<dt>Manage</dt>
<dd>This will take you to the Folder in the Asset Manager that contains this template.</dd>
</dl>
</li></ul>
</div>
<p><b>Asset Manager</b></p>
<div>
<ul>
<li>Turn on Admin mode.</li>
<li>Click on the "Assets" icon in the Admin bar.</li>
<li>In the crumb trail style navigation, click on "Root".</li>
<li>Then click on Asset titled, "Import Node".</li>
<li>Most default WebGUI templates are stored by type in folders inside the Template Folder.</li>
</ul>
</div>
<p><b>Template Name</b><br />
Give this template a descriptive name so that you'll know what it is when you're applying a template to content.
</p>
<p>
<b>NOTE:</b> You should never edit the default templates that come with WebGUI as they are subject to change with each new release. Instead, copy the template you wish to edit, and edit the copy.</p>
|,
lastUpdated => 1146800528
},
'namespace description' => {
message => q|What type of template is this?|,
lastUpdated => 1146455494,
@ -120,127 +74,6 @@ Give this template a descriptive name so that you'll know what it is when you're
lastUpdated => 1146455514,
},
'825' => {
message => q|Template, Language|,
lastUpdated => 1038865669
},
'826' => {
message => q|<p>WebGUI has a powerful templating language built to give you maximum control over the layout of your content.</p>
<p><b>NOTES:</b><br />
Both the template language and template variables are case-insensitive.
</p>
<p>
<b>Variables</b><br />
Variables are the most basic of the template commands. They are used to position pieces of content.
In the examples below, please note that the words <i>foo</i> and <i>bar</i> are used as placeholders for the actual variable names that you'll use. They are not part of the template language.</p>
<p>
<i>Syntax:</i> &lt;tmpl_var foo&gt; or &lt;tmpl_var name="foo"&gt;
</p>
<p>
<i>Example:</i> &lt;tmpl_var name&gt;
</p>
<p>
<b>Escaping text</b><br />
Sometimes you would like to escape text to make it safe to use inside of XML and HTML tags or Javascript code. There
is a built-in way to do this for variables, using the ESCAPE option inside of &lt;tmpl_var&gt;.
</p>
<p>
<i>Javascript safe:</i> &lt;tmpl_var foo ESCAPE="JS"&gt;
</p>
<p>
<i>XML and HTML safe:</i> &lt;tmpl_var foo ESCAPE="HTML"&gt;
</p>
<p>
<b>Conditions</b><br />
To programmers conditions are nothing new, but to designers they can often be confusing at first. Conditions are really just true or false questions, and if you think of them that way, you'll have no trouble at all.
</p>
<p>
<i>Syntax:</i> &lt;tmpl_if foo&gt; &lt;tmpl_else&gt; &lt;/tmpl_if&gt;<br />
<i>Syntax:</i> &lt;tmpl_unless foo&gt; &lt;tmpl_else&gt; &lt;/tmpl_unless&gt;
</p>
<p>
<i>Example:</i> &lt;tmpl_if isTrue&gt; It was true!&lt;tmpl_else&gt; It was false! &lt;/tmpl_if&gt;
</p>
<p>Truth or falsehood is determined by the following rules:</p>
<div>
<ul>
<li><p>Variables not used in this template are false.</p></li>
<li><p>Variables which are undefined are false.</p></li>
<li><p>Variables which are empty are false.</p></li>
<li><p>Variables which are equal to zero are false.</p></li>
<li><p>All other variables are true.</p></li>
</ul></div>
<p><b>Loops</b><br />
Loops iterate over a list of data output for each pass in the loop. Loops are slightly more complicated to use than plain variables, but are considerably more powerful.
</p>
<p>
<i>Syntax:</i> &lt;tmpl_loop foo&gt; &lt;/tmpl_loop&gt;
</p>
<p>
<i>Example:</i> <br />
&lt;tmpl_loop users&gt; <br />
&nbsp; Name: &lt;tmpl_var first_name&gt;&lt;br/&gt;<br />
&lt;/tmpl_loop&gt;
</p>
<p>
<b>Loop Conditions</b><br />
Loops come with special condition variables of their own. They are __FIRST__, __ODD__, __INNER__, and __LAST__.
There is also a loop counter variable, __COUNTER__, which keeps track of how many times the
loop has been executed.
</p>
<p><i>Examples:</i></p>
<pre>
&lt;TMPL_LOOP FOO&gt;
&lt;TMPL_IF __FIRST__&gt;
This only outputs on the first pass.
&lt;/TMPL_IF&gt;
&lt;TMPL_IF __ODD__&gt;
This outputs every other pass, on the odd passes.
&lt;/TMPL_IF&gt;
&lt;TMPL_UNLESS __ODD__&gt;
This outputs every other pass, on the even passes.
&lt;/TMPL_UNLESS&gt;
&lt;TMPL_IF __INNER__&gt;
This outputs on passes that are neither first nor last.
&lt;/TMPL_IF&gt;
&lt;TMPL_IF __LAST__&gt;
This only outputs on the last pass.
&lt;TMPL_IF&gt;
Loop number: &lt;TMPL_VAR __COUNTER__&gt;
This keeps track of how many times you have gone through the loop.
&lt;TMPL_IF&gt;
&lt;/TMPL_LOOP&gt;
</pre>
<p><i>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.</i></p>.
<p><i>Some examples have been borrowed from the HTML::Template documentation.</i></p>.
|,
lastUpdated =>1157490959,
},
'template variable title' => {
message => q|Template Variables|,
lastUpdated => 1130972019,
@ -454,23 +287,6 @@ has been set to some other language you will need to consult that template's doc
lastUpdated => 1146455484,
},
'style wizard help' => {
message => q|<p>The Style Wizard can help you create simple CSS based page style templates for your website
with your choice of two layouts and navigation styles, and configurable colors. To access the Style
Wizard edit a template in the "style" namespace. A link to open the Style Wizard will
be on the right side of the page.</p>
<p>Creating a style template is a three step process:</p>
<div>
<ol>
<li>Select one of the layouts.</li>
<li>Enter your site name, upload a logo and configure the colors.</li>
<li>Make customizations to the generated template.</li>
</ol>
</div>
|,
lastUpdated => 1146456174,
},
'plugin name' => {
message => q|Parser Name|,
lastUpdated => 1162087997,