Macro Help pruning, up to and including GroupText

This commit is contained in:
Colin Kuskie 2007-07-17 17:27:42 +00:00
parent 5e0d948840
commit 3682e2b433
30 changed files with 14 additions and 514 deletions

View file

@ -1,16 +0,0 @@
package WebGUI::Help::Macro_D_date;
our $HELP = {
'date' => {
title => 'date title',
body => 'date body',
fields => [
],
related => [
]
},
};
1;

View file

@ -4,7 +4,7 @@ our $HELP = {
'editable toggle' => {
title => 'editable toggle title',
body => 'editable toggle body',
body => '',
variables => [
{
'name' => 'toggle.url'

View file

@ -1,16 +0,0 @@
package WebGUI::Help::Macro_Env;
our $HELP = {
'env' => {
title => 'env title',
body => 'env body',
fields => [
],
related => [
]
},
};
1;

View file

@ -1,16 +0,0 @@
package WebGUI::Help::Macro_Execute;
our $HELP = {
'execute' => {
title => 'execute title',
body => 'execute body',
fields => [
],
related => [
]
},
};
1;

View file

@ -1,16 +0,0 @@
package WebGUI::Help::Macro_Extras;
our $HELP = {
'extras' => {
title => 'extras title',
body => 'extras body',
fields => [
],
related => [
]
},
};
1;

View file

@ -1,16 +0,0 @@
package WebGUI::Help::Macro_FetchMimeType;
our $HELP = {
'fetch mime type' => {
title => 'fetch mime type title',
body => 'fetch mime type body',
fields => [
],
related => [
]
},
};
1;

View file

@ -1,16 +0,0 @@
package WebGUI::Help::Macro_FileUrl;
our $HELP = {
'file url' => {
title => 'file url title',
body => 'file url body',
fields => [
],
related => [
]
},
};
1;

View file

@ -1,16 +0,0 @@
package WebGUI::Help::Macro_FormParam;
our $HELP = {
'form param' => {
title => 'form param title',
body => 'form param body',
fields => [
],
related => [
]
},
};
1;

View file

@ -2,9 +2,9 @@ package WebGUI::Help::Macro_GroupAdd;
our $HELP = {
'group add' => {
'group add' => {
title => 'group add title',
body => 'group add body',
body => '',
variables => [
{
'name' => 'group.url'

View file

@ -4,7 +4,7 @@ our $HELP = {
'group delete' => {
title => 'group delete title',
body => 'group delete body',
body => '',
variables => [
{
'name' => 'group.url'

View file

@ -1,16 +0,0 @@
package WebGUI::Help::Macro_GroupText;
our $HELP = {
'group text' => {
title => 'group text title',
body => 'group text body',
fields => [
],
related => [
]
},
};
1;

View file

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

View file

@ -1,16 +0,0 @@
package WebGUI::Help::Macro_c_companyName;
our $HELP = {
'company name' => {
title => 'company name title',
body => 'company name body',
fields => [
],
related => [
]
},
};
1;

View file

@ -1,16 +0,0 @@
package WebGUI::Help::Macro_e_companyEmail;
our $HELP = {
'company email' => {
title => 'company email title',
body => 'company email body',
fields => [
],
related => [
]
},
};
1;

View file

@ -4,7 +4,7 @@ our $I18N = {
'admin bar title' => {
message => q|Admin Bar Macro Template Variables|,
lastUpdated => 1112374923,
lastUpdated => 1184691377,
},
'adminbar_loop' => {

View file

@ -9,7 +9,7 @@ our $I18N = {
'admin toggle title' => {
message => q|Admin Toggle Macro Template Variables|,
lastUpdated => 1112466408,
lastUpdated => 1184691381,
},
'toggle.url' => {

View file

@ -1,64 +0,0 @@
package WebGUI::i18n::English::Macro_D_date;
our $I18N = {
'macroName' => {
message => q|Date|,
lastUpdated => 1128837997,
},
'date title' => {
message => q|Date Macro|,
lastUpdated => 1112466408,
},
'date body' => {
message => q|
<p><b>&#94;D();</b><br />
<b>&#94;D([<i>date formatting code</i>],[<i>epoch date</i>]);</b><br />
The current date and time.
</p>
<p>You can configure the date by using date formatting symbols. For instance, if you created a macro like this <b>&#94;D("%c %D, %y");</b> it would output <b>September 26, 2001</b>. The following are the available date formatting symbols:
</p>
<table><tbody>
<tr><td>%%</td><td>A literal percent sign '%'</td></tr>
<tr><td>%c</td><td>The calendar month name.</td></tr>
<tr><td>%C</td><td>The calendar month name abbreviated to 3 characters and represented in English.</td></tr>
<tr><td>%d</td><td>A two digit day.</td></tr>
<tr><td>%D</td><td>A variable digit day.</td></tr>
<tr><td>%h</td><td>A two digit hour (on a 12 hour clock).</td></tr>
<tr><td>%H</td><td>A variable digit hour (on a 12 hour clock).</td></tr>
<tr><td>%j</td><td>A two digit hour (on a 24 hour clock).</td></tr>
<tr><td>%J</td><td>A variable digit hour (on a 24 hour clock).</td></tr>
<tr><td>%m</td><td>A two digit month.</td></tr>
<tr><td>%M</td><td>A variable digit month.</td></tr>
<tr><td>%n</td><td>A two digit minute.</td></tr>
<tr><td>%o</td><td>Offset from local time represented as an integer.</td></tr>
<tr><td>%O</td><td>Offset from GMT represented in four digit form with a sign. Example: -0600</td></tr>
<tr><td>%p</td><td>A lower-case am/pm.</td></tr>
<tr><td>%P</td><td>An upper-case AM/PM.</td></tr>
<tr><td>%s</td><td>A two digit second.</td></tr>
<tr><td>%w</td><td>Day of the week.</td></tr>
<tr><td>%W</td><td>Day of the week abbreviated to 3 characters and represented in English.</td></tr>
<tr><td>%y</td><td>A four digit year.</td></tr>
<tr><td>%Y</td><td>A two digit year.</td></tr>
<tr><td>%z</td><td>The current user's date format preference, (default: '%H:%n %p').</td></tr>
<tr><td>%Z</td><td>The current user's time format preference, (default: '%M/%D/%y')</td></tr>
</tbody></table>
<p>The default format code is %z %Z.
</p>
<p>You can also pass in an epoch date into this macro as a secondary parameter. If no date is specified then today's date and time will be used.</p>
<p>One common task done with this macro is to display the date that an Asset was last modified. It uses the <b>revisionDate</b> template variable which is available for all Assets.</p>
<p>&#94;D("%z",<tmpl_var revisionDate>);</p>
<p>This Macro may be nested inside other Macros if the formatted date does not contain commas or quotes.</p>
|,
lastUpdated => 1168558613,
},
};
1;

View file

@ -8,8 +8,8 @@ our $I18N = {
},
'editable toggle title' => {
message => q|Editable Toggle Macro|,
lastUpdated => 1112466408,
message => q|Editable Toggle Macro Template Variables|,
lastUpdated => 1184691394,
},
'toggle.url' => {
@ -22,20 +22,6 @@ our $I18N = {
lastUpdated => 1149218423,
},
'editable toggle body' => {
message => q|
<p><b>&#94;EditableToggle; or &#94;EditableToggle();</b><br />
Exactly the same as AdminToggle, except that the toggle is only displayed if the user has the rights to edit the current Asset. This macro takes up to three parameters. The first is a label for "Turn Admin On", the second is a label for "Turn Admin Off", and the third is the name of a template in the Macro/EditableToggle namespace to replace the default template.
</p>
<p>This Macro may not be nested inside other Macros.</p>
<p>The following variables are available in the template:
</p>
|,
lastUpdated => 1168558646,
},
'516' => {
message => q|Turn Admin On!|,
lastUpdated => 1031514049

View file

@ -1,29 +0,0 @@
package WebGUI::i18n::English::Macro_Env;
our $I18N = {
'macroName' => {
message => q|Environment Variable|,
lastUpdated => 1128838196,
},
'env title' => {
message => q|Environment Variable Macro|,
lastUpdated => 1128838196,
},
'env body' => {
message => q|
<p><b>&#94;Env();</b><br />
Can be used to display a web server environment variable on a page. The environment variables available on each server are different. Please consult the documentation for your server for a list of them.</p>
<p>The macro should be specified like this &#94;Env("REMOTE_ADDR");
</p>
<p>This Macro may be nested inside other Macros if the text returned does not contain commas or quotes.</p>
|,
lastUpdated => 1172510936,
},
};
1;

View file

@ -12,21 +12,6 @@ our $I18N = {
lastUpdated => 1134850023,
},
'execute title' => {
message => q|Execute Macro|,
lastUpdated => 1112466408,
},
'execute body' => {
message => q|
<p><b>&#94;Execute();</b><br />
Allows a content manager or administrator to execute an external program. Takes the format of <b>&#94;Execute("/this/file.sh");</b>.
</p>
<p>This Macro may be nested inside other Macros if the text it returns does not contain commas or quotes.</p>
|,
lastUpdated => 1168558923,
},
};
1;

View file

@ -1,26 +0,0 @@
package WebGUI::i18n::English::Macro_Extras;
our $I18N = {
'macroName' => {
message => q|Extras|,
lastUpdated => 1128838281,
},
'extras title' => {
message => q|Extras Macro|,
lastUpdated => 1112466752,
},
'extras body' => {
message => q|
<p><b>&#94;Extras; or &#94;Extras(path/to/something/in/extras/folder);</b><br />
Returns the path to the WebGUI "extras" folder, which contains things like WebGUI icons.
</p>
|,
lastUpdated => 1146679288,
},
};
1;

View file

@ -1,28 +0,0 @@
package WebGUI::i18n::English::Macro_FetchMimeType;
our $I18N = {
'fetch mime type title' => {
message => q|Fetch MIME Type Macro|,
lastUpdated => 1134252488,
},
'fetch mime type body' => {
message => q|
<p><b>&#94;FetchMimeType;</b><br />
<b>&#94;FetchMimeType(<i>file system path to file</i>);</b><br />
Returns the MIME type for a file. An absolute or relative file path
to the file is required. A URL to the file will not work.</p>
<p>This Macro may be nested inside other Macros.</p>
|,
lastUpdated => 1168558941,
},
'macroName' => {
message => q|FetchMimeType|,
lastUpdated => 1134256852
},
};
1;

View file

@ -7,21 +7,6 @@ our $I18N = {
lastUpdated => 1128838332,
},
'file url title' => {
message => q|File Url Macro|,
lastUpdated => 1112315917,
},
'file url body' => {
message => q|
<p><b>&#94;FileUrl</b>();<br />
<b>&#94;FileUrl</b>(<i>Asset URL</i>);<br />
This macro is used to return a filesystem URL to an Asset which stores a single file (File, Image, ZipArchive, etc.) identified by its Asset URL. The Macro will <i>not</i> work on Assets which store multiple files, such as the Post or Article Assets.</p>
<p>This Macro may be nested inside other Macros.</p>
|,
lastUpdated => 1168622358,
},
'invalid url' => {
message => q|Invalid Asset URL|,
lastUpdated => 1134855446,

View file

@ -1,28 +0,0 @@
package WebGUI::i18n::English::Macro_FormParam;
our $I18N = {
'macroName' => {
message => q|Form Parameter|,
lastUpdated => 1128838349,
},
'form param title' => {
message => q|Form Parameter Macro|,
lastUpdated => 1112466408,
},
'form param body' => {
message => q|
<p><b>&#94;FormParam();</b><br />
This macro is mainly used in generating dynamic queries in SQL Reports. Using this macro, you can pull the value of any form field simply by specifying the name of the form field, like this: &#94;FormParam("phoneNumber");
</p>
<p>If the macro is used to pull data from a form field that returns multiple values, like a dropdown list, then only the first value will be returned.</p>
<p>This Macro may be nested inside other Macros if the text returned does not contain commas or quotes.</p>
|,
lastUpdated => 1168622375,
},
};
1;

View file

@ -8,9 +8,10 @@ our $I18N = {
},
'group add title' => {
message => q|Group Add Macro|,
lastUpdated => 1112466408,
message => q|Group Add Macro Template Variables|,
lastUpdated => 1184690370,
},
'group.url' => {
message => q|The URL with the action to add the user to the group.|,
lastUpdated => 1149218343,
@ -21,32 +22,6 @@ our $I18N = {
lastUpdated => 1149218343,
},
'group add body' => {
message => q|
<p><b>&#94;GroupAdd();</b><br />
Using this macro you can allow users to add themselves to a group. The first parameter is the name of the group this user should be added to. The second parameter is a text string for the user to click on to add themselves to this group. The third parameter allows you to specify the name of a template in the Macro/GroupAdd namespace to replace the default template.</p>
<p><b>NOTE:</b> All these conditions must be met for the link to be displayed:
</p>
<div>
<ul>
<li>User must be logged in.</li>
<li>User must not already belong to the group.</li>
<li>The group must exist.</li>
<li>The group must be set up to allow auto adds.</li>
</ul>
</div>
<p>This Macro may not be nested inside other Macros.</p>
<p>These variables are available in the template:</p>
|,
lastUpdated => 1168622402,
},
};
1;

View file

@ -8,8 +8,8 @@ our $I18N = {
},
'group delete title' => {
message => q|Group Delete Macro|,
lastUpdated => 1112466408,
message => q|Group Delete Macro Template Variables|,
lastUpdated => 1184691437,
},
'group.url' => {
@ -22,29 +22,6 @@ our $I18N = {
lastUpdated => 1149217736,
},
'group delete body' => {
message => q|
<p><b>&#94;GroupDelete();</b><br />
Using this macro you can allow users to delete themselves from a group. The first parameter is the name of the group this user should be deleted from. The second parameter is a text string for the user to click on to delete themselves from this group. The third parameter allows you to specify the name of a template in the Macro/GroupDelete namespace to replace the default template.</p>
<p><b>NOTE:</b> All these conditions must be met for the link to be displayed:</p>
<div>
<ul>
<li>User must be logged in.</li>
<li>User must be a member of the group.</li>
<li>The group must exist.</li>
<li>The group must be set up to allow auto deletes.</li>
</ul>
</div>
<p>This Macro may not be nested inside other Macros.</p>
<p>>These variables are available in the template:</p>
|,
lastUpdated => 1168622413,
},
};
1;

View file

@ -13,22 +13,6 @@ our $I18N = {
context => q|Error message when a group is not found during a by-name lookup of groups.|,
},
'group text title' => {
message => q|Group Text Macro|,
lastUpdated => 1112466408,
},
'group text body' => {
message => q|
<p><b>&#94;GroupText();</b><br />
Displays a small text message to the user if they belong to the specified group. And you can specify an alternate message to those who are not in the group.
</p>
<p><i>Example:</i> &#94;GroupText("Visitors","You need an account to do anything cool on this site!","We value our registered users!");
</p>
<p>This Macro may be nested inside other Macros if the text returned does not contain commas or quotes.</p>
|,
lastUpdated => 1168622429,
},
};
1;

View file

@ -4,7 +4,7 @@ our $I18N = {
'account title' => {
message => q|Account Macro Template Variables|,
lastUpdated => 1112466408,
lastUpdated => 1184691356,
},
'account.url' => {

View file

@ -1,27 +0,0 @@
package WebGUI::i18n::English::Macro_c_companyName;
our $I18N = {
'macroName' => {
message => q|Company Name|,
lastUpdated => 1128837978,
},
'company name title' => {
message => q|Company Name Macro|,
lastUpdated => 1112374923,
},
'company name body' => {
message => q|
<p><b>&#94;c;</b><br />
The name of your company, specified in the settings by your Administrator.</p>
<p>Any commas or quotes in the company name will be translated into HTML encodings so
that you can always embed this macro inside of other macros.</p>
|,
lastUpdated => 1171408777,
},
};
1;

View file

@ -1,26 +0,0 @@
package WebGUI::i18n::English::Macro_e_companyEmail;
our $I18N = {
'macroName' => {
message => q|Company Email|,
lastUpdated => 1128838058,
},
'company email title' => {
message => q|Company Email Macro|,
lastUpdated => 1112466408,
},
'company email body' => {
message => q|
<p><b>&#94;e;</b><br />
The email address for your company specified in the settings by your Administrator.
</p>
<p>This Macro may be nested inside other Macros if the email address does not contain commas or quotes.</p>
|,
lastUpdated => 1168558595,
},
};
1;