Remove the "using macros" entry, and all references.

Pruning and altering Macro docs up to and including CanEditText.
This commit is contained in:
Colin Kuskie 2007-07-17 15:44:12 +00:00
parent 7c6ba21048
commit cffe4fbc7b
63 changed files with 20 additions and 662 deletions

View file

@ -83,10 +83,6 @@ our $HELP = {
tag => 'edit ad space',
namespace => 'AdSpace',
},
{
tag => 'ad space',
namespace => 'Macro_AdSpace',
},
],
},

View file

@ -435,14 +435,6 @@ our $HELP = {
tag => 'metadata edit property',
namespace => 'Asset'
},
{
tag => 'aoi hits',
namespace => 'Macro_AOIHits'
},
{
tag => 'aoi rank',
namespace => 'Macro_AOIRank'
},
{
tag => 'wobject add/edit',
namespace => 'Asset_Wobject',
@ -451,9 +443,9 @@ our $HELP = {
},
'metadata edit property' => {
title => 'metadata edit property',
body => 'metadata edit property body',
fields => [
title => 'metadata edit property',
body => 'metadata edit property body',
fields => [
{
title => 'Field name',
description => 'Field Name description',
@ -474,26 +466,18 @@ our $HELP = {
description => 'Possible Values description',
namespace => 'Asset',
},
],
related => [
{
tag => 'metadata manage',
namespace => 'Asset'
},
{
tag => 'aoi hits',
namespace => 'Macro_AOIHits'
},
{
tag => 'aoi rank',
namespace => 'Macro_AOIRank'
},
{
tag => 'wobject add/edit',
namespace => 'Asset_Wobject',
},
],
},
],
related => [
{
tag => 'metadata manage',
namespace => 'Asset'
},
{
tag => 'wobject add/edit',
namespace => 'Asset_Wobject',
},
],
},
'manage versions' => {
title => 'committed versions',

View file

@ -8,10 +8,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'macros using',
namespace => 'Macros'
},
{
tag => 'style sheets using',
namespace => 'WebGUI'

View file

@ -1,32 +0,0 @@
package WebGUI::Help::Macro_AOIHits;
our $HELP = {
'aoi hits' => {
title => 'aoi hits title',
body => 'aoi hits body',
fields => [
],
related => [
{
tag => 'metadata manage',
namespace => 'Asset'
},
{
tag => 'settings',
namespace => 'WebGUI'
},
{
tag => 'aoi rank',
namespace => 'Macro_AOIRank',
},
{
tag => 'macros using',
namespace => 'Macros'
},
]
},
};
1;

View file

@ -1,32 +0,0 @@
package WebGUI::Help::Macro_AOIRank;
our $HELP = {
'aoi rank' => {
title => 'aoi rank title',
body => 'aoi rank body',
fields => [
],
related => [
{
tag => 'metadata manage',
namespace => 'Asset'
},
{
tag => 'settings',
namespace => 'WebGUI'
},
{
tag => 'aoi hits',
namespace => 'Macro_AOIHits',
},
{
tag => 'macros using',
namespace => 'Macros'
},
]
},
};
1;

View file

@ -1,15 +0,0 @@
package WebGUI::Help::Macro_AdSpace;
our $HELP = { ##hashref of hashes
'ad space' => {
title => 'adspace title', #The title and body are looked up in the
body => 'adspace body', #i18n file of the same name
fields => [
],
related => [
],
},
};
1;

View file

@ -2,9 +2,9 @@ package WebGUI::Help::Macro_AdminBar;
our $HELP = {
'admin bar' => {
'admin bar' => {
title => 'admin bar title',
body => 'admin bar body',
body => '',
fields => [
],
variables => [
@ -35,10 +35,6 @@ our $HELP = {
}
],
related => [
{
tag => 'macros using',
namespace => 'Macros'
},
{
tag => 'template language',
namespace => 'Asset_Template'

View file

@ -1,20 +0,0 @@
package WebGUI::Help::Macro_AdminText;
our $HELP = {
'admin text' => {
title => 'admin text title',
body => 'admin text body',
fields => [
],
related => [
{
tag => 'macros using',
namespace => 'Macros'
},
]
},
};
1;

View file

@ -4,7 +4,7 @@ our $HELP = {
'admin toggle' => {
title => 'admin toggle title',
body => 'admin toggle body',
body => '',
variables => [
{
'name' => 'toggle.url'
@ -16,10 +16,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'macros using',
namespace => 'Macros'
},
{
tag => 'template language',
namespace => 'Asset_Template'

View file

@ -1,24 +0,0 @@
package WebGUI::Help::Macro_AssetProxy;
our $HELP = {
'asset proxy' => {
title => 'asset proxy title',
body => 'asset proxy body',
fields => [
],
related => [
{
tag => 'macros using',
namespace => 'Macros'
},
{
tag => 'shortcut add/edit',
namespace => 'Asset_Shortcut'
},
]
},
};
1;

View file

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

View file

@ -1,20 +0,0 @@
package WebGUI::Help::Macro_CanEditText;
our $HELP = {
'can edit text' => {
title => 'can edit text title',
body => 'can edit text body',
fields => [
],
related => [
{
tag => 'macros using',
namespace => 'Macros'
},
]
},
};
1;

View file

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

View file

@ -16,10 +16,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'macros using',
namespace => 'Macros'
},
]
},

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -16,10 +16,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'macros using',
namespace => 'Macros'
},
]
},

View file

@ -16,10 +16,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'macros using',
namespace => 'Macros'
},
]
},

View file

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

View file

@ -16,10 +16,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'macros using',
namespace => 'Macros'
},
]
},

View file

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

View file

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

View file

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

View file

@ -66,10 +66,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'macros using',
namespace => 'Macros'
},
]
},

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -65,10 +65,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'macros using',
namespace => 'Macros'
},
{
tag => 'manage product',
namespace => 'ProductManager'

View file

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

View file

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

View file

@ -7,10 +7,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'macros using',
namespace => 'Macros'
},
{
tag => 'random asset proxy',
namespace => 'Macro_RandomAssetProxy'

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -22,10 +22,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'macros using',
namespace => 'Macros'
},
]
},

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -16,10 +16,6 @@ our $HELP = {
fields => [
],
related => [
{
tag => 'macros using',
namespace => 'Macros'
},
]
},

View file

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

View file

@ -3,19 +3,6 @@ package WebGUI::Help::Macros;
our $HELP = {
'macros using' => {
title => 'macros using title',
body => 'macros using body',
fields => [
],
related => [
{
tag => "macros list",
namespace => "Macros",
},
],
},
'macros list' => {
title => 'macros list title',
body => sub {

View file

@ -1,47 +0,0 @@
package WebGUI::i18n::English::Macro_AOIHits;
our $I18N = {
'macroName' => {
message => q|AOI Hits|,
lastUpdated => 1128837648,
},
'aoi hits title' => {
message => q|Areas of Interest Hits Macro|,
lastUpdated => 1165355347,
},
'aoi hits body' => {
message => q|
<p><b>&#94;AOIHits();</b><br />
<b>&#94;AOIHits(<i>metadata property</i>, <i>metadata value</i>);</b><br />
This macro displays to a user how many times they have visited Assets
of a given type, based on Metadata and Passive Profiling. To use the
macro, you will need to enable Passive Profiling in the WebGUI Settings
admin screen, and then add Metadata to the Assets in your site.</p>
<p>Here's an example:</p>
<p>Suppose you run a news site, and you want to tell the user how many times they have
visited several kinds of stories.
You enable Passive Profiling in the WebGUI Settings, then create a new Metadata
field called "contentType". As your content managers add stories to the site, they also classify
the stories by giving the Metadata field contentType a value, such as "Sports", "General Interest",
"Regional", "Business", "Entertainment" and so on. On each page, you add
you place these &#94;AOIHits() macro calls to show the user how many times they have
visited Sports, Regional and Business stories:</p>
<p>You visited sports stories: &#94;AOIHits(contentType,Sports); times<br />
You visited sports stories: &#94;AOIHits(contentType,Regional); times<br />
You visited sports stories: &#94;AOIHits(contentType,Business); times</p>
<p>You must give &#94;AOIRank(); two arguments, the Metadata property to use and the
Metadata value whose count you want displayed to the user.</p>
<p>This Macro may be nested inside other Macros.</p>
|,
lastUpdated => 1168558407,
},
};
1;

View file

@ -1,49 +0,0 @@
package WebGUI::i18n::English::Macro_AOIRank;
our $I18N = {
'macroName' => {
message => q|AOI Rank|,
lastUpdated => 1128837912,
},
'aoi rank title' => {
message => q|Areas of Interest Rank Macro|,
lastUpdated => 1165355407,
},
'aoi rank body' => {
message => q|
<p>
<b>&#94;AOIRank(<i>metadata property</i>, [<i>rank</i>]);</b><br />
This macro is for displaying which Assets are the most frequently viewed on your site, based on
Metadata and Passive Profiling. To use the macro, you will need to enable Passive Profiling in the
WebGUI Settings admin screen, and then add Metadata to the Assets in your site.</p>
<p>Here's an example:</p>
<p>Suppose you run a news site, and you want to know what kinds of news stories are the
most popular. You enable Passive Profiling in the WebGUI Settings, then create a new Metadata
field called "contentType". As your content managers add stories to the site, they also classify
the stories by giving the Metadata field contentType a value, such as "Sports", "General Interest",
"Regional", "Business", "Entertainment" and so on. Next, on a separate page of your site,
you place these &#94;AOIRank() macro calls:</p>
<p>Most popular kind of story: &#94;AOIRank(contentType);<br />
Second-most popular kind of story: &#94;AOIRank(contentType,2);<br />
Third most popular kind of story: &#94;AOIRank(contentType,3);</p>
<p>By default, &#94;AOIRank(contentType); will always display the most popular Metadata property,
which in our case is called contentType. If you wish to see which Metadata properties are lower
ranked, pass the macro the rank that you want to see.</p>
<p>As users visit your site, each story they read will be counted up and added to the counter for
the correct contentType. As you visit you separate page, you'll see the three most popular types
of stories.</p>
<p>This Macro may be nested inside other Macros if the Metadata field does not contain commas or quotes.</p>
|,
lastUpdated => 1168558455,
},
};
1;

View file

@ -1,30 +0,0 @@
package WebGUI::i18n::English::Macro_AdSpace;
our $I18N = {
'adspace title' => {
message => q|Ad Space Macro|,
lastUpdated => 1144979657,
},
'adspace body' => {
message => q|
<p><b>&#94;AdSpace;</b><br />
<b>&#94;AdSpace(adName);</b><br />
This macro is used to display advertisements from the AdSpace system on a page. The macro
takes a single argument, which is the name of the Ad Space from the AdSpace manager to display
from the AdSpace manager.
As a convenience, the AdSpace manager will display the macro code to put into a page to
display each Ad Space.</p>
<p>This Macro may not be nested inside other Macros.</p>
|,
lastUpdated => 1168558375,
},
'macroName' => {
message => q|Ad Space|,
lastUpdated => 1144979669,
},
};
1;

View file

@ -3,7 +3,7 @@ package WebGUI::i18n::English::Macro_AdminBar;
our $I18N = {
'admin bar title' => {
message => q|Admin Bar Macro|,
message => q|Admin Bar Macro Template Variables|,
lastUpdated => 1112374923,
},
@ -42,21 +42,6 @@ our $I18N = {
lastUpdated => 1149178356,
},
'admin bar body' => {
message => q|
<p><b>&#94;AdminBar;</b><br />
<b>&#94;AdminBar(<i>custom template ID</i>);</b><br />
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>
<p>This Macro may not be nested inside other Macros.</p>
<p>
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>
|,
lastUpdated => 1168558295,
},
'376' => {
message => q|Package|,
lastUpdated => 1031514049

View file

@ -1,26 +0,0 @@
package WebGUI::i18n::English::Macro_AdminText;
our $I18N = {
'macroName' => {
message => q|Admin Text|,
lastUpdated => 1128837612,
},
'admin text title' => {
message => q|Admin Text Macro|,
lastUpdated => 1112466408,
},
'admin text body' => {
message => q|
<p><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>
<p>This Macro may be nested inside other Macros if the text does not contain commas or quotes.</p>
|,
lastUpdated => 1168558334,
},
};
1;

View file

@ -8,7 +8,7 @@ our $I18N = {
},
'admin toggle title' => {
message => q|Admin Toggle Macro|,
message => q|Admin Toggle Macro Template Variables|,
lastUpdated => 1112466408,
},
@ -22,22 +22,6 @@ our $I18N = {
lastUpdated => 1149178440,
},
'admin toggle body' => {
message => q|
<p><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>
<p>This Macro may be nested inside other Macros if the text does not contain commas or quotes.</p>
<p>
The following variables are available in the template:
</p>
|,
lastUpdated => 1168558355,
},
'516' => {
message => q|Turn Admin On!|,
lastUpdated => 1031514049

View file

@ -2,37 +2,11 @@ package WebGUI::i18n::English::Macro_AssetProxy;
our $I18N = {
'macroName' => {
message => q|Asset Proxy|,
lastUpdated => 1128837929,
},
'asset proxy title' => {
message => q|Asset Proxy Macro|,
lastUpdated => 1112315917,
},
'invalid url' => {
message => q|Invalid Asset URL|,
lastUpdated => 1134769012,
},
'asset proxy body' => {
message => q|
<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 or for snippets.</p>
<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.</p>
<p>This Macro may not be nested inside other Macros.</p>
|,
lastUpdated => 1168558479,
},
};
1;

View file

@ -1,26 +0,0 @@
package WebGUI::i18n::English::Macro_At_username;
our $I18N = {
'macroName' => {
message => q|User Name|,
lastUpdated => 1128837946,
},
'username title' => {
message => q|User Name Macro|,
lastUpdated => 1112466408,
},
'username body' => {
message => q|
<p><b>&#94;@; - Username</b><br />
The username of the currently logged in user.
</p>
<p>This Macro may be nested inside other Macros if all usernames do not contain commas or quotes.</p>
|,
lastUpdated => 1168558540,
},
};
1;

View file

@ -1,35 +0,0 @@
package WebGUI::i18n::English::Macro_CanEditText;
our $I18N = {
'macroName' => {
message => q|Can Edit Text|,
lastUpdated => 1128837964,
},
'can edit text title' => {
message => q|Can Edit Text Macro|,
lastUpdated => 1112466408,
},
'can edit text body' => {
message => q|
<p><b>&#94;CanEditText(<i>text message</i>);</b><br />
Display a message to a user that can edit the current Asset.
</p>
<p><i>Example:</i><br />
&#94;CanEditText("You may edit this Asset");<br />
&#94;CanEditText(&#94;AdminToggle;);
</p>
<p>Do not use this Macro outside of an Asset as it will have unpredictable
results.
</p>
<p>This Macro may be nested inside other Macros if the text does not contain commas or quotes.</p>
|,
lastUpdated => 1168558566,
},
};
1;