oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

stub documentation for Thumbnail Macro, fixed an ordering problem in List of Macros, cleaned up Macro help "A".

Browse source
This commit is contained in:
Colin Kuskie 2005-04-04 04:24:36 +00:00
parent 7b6c7e5af0
commit ffa4aa4d08
14 changed files with 82 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lib/WebGUI/Help/AOIHits.pm
View file

@ -10,6 +10,10 @@ our $HELP = {
tag => 'macros using',
namespace => 'Macros'
},
{
tag => 'metadata manage',
namespace => 'Asset'
},
]
},

4
lib/WebGUI/Help/AOIRank.pm
View file

@ -10,6 +10,10 @@ our $HELP = {
tag => 'macros using',
namespace => 'Macros'
},
{
tag => 'metadata manage',
namespace => 'Asset'
},
]
},

4
lib/WebGUI/Help/AdminBar.pm
View file

@ -10,6 +10,10 @@ our $HELP = {
tag => 'macros using',
namespace => 'Macros'
},
{
tag => 'template language',
namespace => 'Template'
},
]
},

4
lib/WebGUI/Help/AdminToggle.pm
View file

@ -10,6 +10,10 @@ our $HELP = {
tag => 'macros using',
namespace => 'Macros'
},
{
tag => 'template language',
namespace => 'Template'
},
]
},

4
lib/WebGUI/Help/AssetProxy.pm
View file

@ -10,6 +10,10 @@ our $HELP = {
tag => 'macros using',
namespace => 'Macros'
},
{
tag => 'shortcut add/edit',
namespace => 'Shortcut'
},
]
},

6
lib/WebGUI/Help/Macros.pm
View file

@ -18,7 +18,9 @@ our $HELP = {
'macros list' => {
title => 'macros list title',
body => 'macros list body',
related => [ map {
related => [
sort { $a->{tag} cmp $b->{tag} }
map {
$tag = $_;
$tag =~ s/^[a-zA-Z]+_//; #Remove initial shortcuts
$tag =~ s/([A-Z]+(?![a-z]))/$1 /g; #Separate acronyms
@ -27,7 +29,7 @@ our $HELP = {
{ tag => $tag,
namespace => $_ }
}
sort values %{ $session{config}{macros} }
values %{ $session{config}{macros} }
],
},

18
lib/WebGUI/Help/Thumbnail.pm Normal file
View file

@ -0,0 +1,18 @@
package WebGUI::Help::Thumbnail;
our $HELP = {
'thumbnail' => {
title => 'thumbnail title',
body => 'thumbnail body',
related => [
{
tag => 'macros using',
namespace => 'Macros',
},
]
},
};
1;

1
lib/WebGUI/i18n/English/AOIHits.pm
View file

@ -11,6 +11,7 @@ our $I18N = {
message => q|
<b>&#94;AOIHits();</b><br>
<b>&#94;AOIHits(<i>metadata property</i>, <i>metadata value</i>);</b><br>
This macro is for displaying Areas of Interest Hits, which is based on passive profiling
of which wobjects are viewed by users, on a per user basis. The macro takes two arguments,
a metadata property and metadata value, and returns how many times the current user has

4
lib/WebGUI/i18n/English/AdminBar.pm
View file

@ -15,7 +15,7 @@ our $I18N = {
Places the administrative tool bar on the page. Omitting this macro will prevent you from adding content, pasting
content from the clipboard, accessing the help system and other administrative functions.
<p>
The macro takes up to one optional argument, an alternate template in the Macro/AdminBar namespace for generating the AdminBar. The following variables are available in the template:
The macro may take one optional argument, an alternate template in the Macro/AdminBar namespace for generating the AdminBar. The following variables are available in the template:
<p/>
<b>packages.label</b><br/>
@ -94,7 +94,7 @@ The URL for executing this admin function.
<p/>
The <i>.adminBar</i> style sheet class is tied to the default template for this macro.
|,
lastUpdated => 1112374920,
lastUpdated => 1112583521,
},
};

4
lib/WebGUI/i18n/English/AdminText.pm
View file

@ -10,12 +10,12 @@ our $I18N = {
'admin text body' => {
message => q|
<b>&#94;AdminText();</b><br>
<b>&#94;AdminText(<i>text message</i>);</b><br>
Displays a small text message to a user who is in admin mode. Example: &#94;AdminText("You are in admin mode!");
<p>
|,
lastUpdated => 1112466919,
lastUpdated => 1112583570,
},
};

5
lib/WebGUI/i18n/English/AdminToggle.pm
View file

@ -3,14 +3,15 @@ package WebGUI::i18n::English::AdminToggle;
our $I18N = {
'admin toggle title' => {
message => q|Admin Text Macro|,
message => q|Admin Toggle Macro|,
lastUpdated => 1112466408,
},
'admin toggle body' => {
message => q|
<b>&#94;AdminToggle; or &#94;AdminToggle();</b><br>
<b>&#94;AdminToggle();</b><br>
<b>&#94;AdminToggle([<i>enable admin</i>], [<i>disable admin</i>], [<i>template name</i>]);</b><br>
Places a link on the page which is only visible to content managers and administrators. The link toggles on/off admin mode. You can optionally specify other messages to display like this: &#94;AdminToggle("Edit On","Edit Off"); This macro optionally takes a third parameter that allows you to specify an alternate template name in the Macro/AdminToggle namespace.
<p>
The following variables are available in the template:

13
lib/WebGUI/i18n/English/AssetProxy.pm
View file

@ -9,14 +9,17 @@ our $I18N = {
'asset proxy body' => {
message => q|
<P><B>&#94;AssetProxy</B>();<BR>
<B>&#94;AssetProxy</B>(<i>Asset URL</i>);<BR>
<P><B>&#94;AssetProxy</B>(<i>Asset URL</i>);<BR>
This macro is used to render an Asset and display it inline according
to its template. Any Asset can be displayed, including Navigations,
images, links to files for downloading, snippets or for displaying
content from another part of the site on this page.
images, links to files for downloading or for snippets.
<p>It can also be like a Shortcut Asset, displaying content from another
part of the site on this page. Unlike a Shortcut, it cannot override
any part of the original Asset.
|,
lastUpdated => 1112315914,
lastUpdated => 1112583827,
},
};

2
lib/WebGUI/i18n/English/Macros.pm
View file

@ -7,7 +7,7 @@ our $I18N = {
},
'macros list body' => {
message => q|<P>These Macros are available for use on your site. The set of available Macros is defined in the WebGUI configuration file:</P>|,
message => q|<P>The set of available Macros is defined in the WebGUI configuration file. These Macros are available for use on your site:</P>|,
context => 'Content for dynamically generated macro list',
lastUpdated => 1112560683,
},

23
lib/WebGUI/i18n/English/Thumbnail.pm Normal file
View file

@ -0,0 +1,23 @@
package WebGUI::i18n::English::Thumbnail;
our $I18N = {
'thumbnail title' => {
message => q|Thumbnail Macro|,
lastUpdated => 1112566765,
},
'thumbnail body' => {
message => q|
<b>&#94;Thumbnail(<i>assetId</i>);</b><br>
This macro will allow you to fetch the thumbnail for any File or Image Asset by its
AssetId.
<p>
|,
lastUpdated => 1112566767,
},
};
1;