diff --git a/lib/WebGUI/Help/Macro_AOIRank.pm b/lib/WebGUI/Help/Macro_AOIRank.pm index 68336539c..19bc6e61f 100644 --- a/lib/WebGUI/Help/Macro_AOIRank.pm +++ b/lib/WebGUI/Help/Macro_AOIRank.pm @@ -8,13 +8,16 @@ our $HELP = { fields => [ ], related => [ - { - tag => 'macros using', - namespace => 'Macros' - }, { tag => 'metadata manage', namespace => 'Asset' + { + tag => 'settings', + namespace => 'WebGUI' + }, + { + tag => 'macros using', + namespace => 'Macros' }, ] }, diff --git a/lib/WebGUI/i18n/English/Asset.pm b/lib/WebGUI/i18n/English/Asset.pm index 64d14f6ce..d300bdbb9 100644 --- a/lib/WebGUI/i18n/English/Asset.pm +++ b/lib/WebGUI/i18n/English/Asset.pm @@ -599,8 +599,8 @@ each asset under the tab "Meta" in the asset properties.
WebGUI config file.Areas of Interest Ranking
- Metadata in combination with passive profiling produces AOI (Areas of
- Interest) information. You can retrieve the value of a metadata property
+ Metadata in combination with passive profiling produces AOI (Areas of
+ Interest) information. You can retrieve the value of a metadata property
with the ^AOIRank(); and ^AOIHits(); macros.
Show content based upon criteria
@@ -619,7 +619,7 @@ each asset under the tab "Meta" in the asset properties.
^AOIHits();
^AOIHits(metadata property, metadata value);
-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
-viewed content with that property and value.
^AOIHits(contenttype,sport); would display 99 if this user has looked at content that was tagged "contenttype = sport" 99 times.
+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. + +Here's an example:
+ +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 ^AOIHits() macro calls to show the user how many times they have +visited Sports, Regional and Business stories:
+ +You visited sports stories: ^AOIHits(contentType,Sports); times
+You visited sports stories: ^AOIHits(contentType,Regional); times
+You visited sports stories: ^AOIHits(contentType,Business); times
You must give ^AOIRank(); two arguments, the Metadata property to use and the +Metadata value whose count you want displayed to the user.
|, - lastUpdated => 1146626467, + lastUpdated => 1165363159, }, }; diff --git a/lib/WebGUI/i18n/English/Macro_AOIRank.pm b/lib/WebGUI/i18n/English/Macro_AOIRank.pm index 860e626ab..ac94d5971 100644 --- a/lib/WebGUI/i18n/English/Macro_AOIRank.pm +++ b/lib/WebGUI/i18n/English/Macro_AOIRank.pm @@ -8,24 +8,40 @@ our $I18N = { }, 'aoi rank title' => { - message => q|AOI Rank Macro|, - lastUpdated => 1112466408, + message => q|Areas of Interest Rank Macro|, + lastUpdated => 1165355407, }, 'aoi rank body' => { message => q| -
^AOIRank(metadata property, [rank]);
-This macro is for displaying Areas of Interest Rankings, which is based on passive profiling
-of which wobjects are viewed most frequently by users, on a per user basis. The macro
-takes up to two arguments, a metadata property and the rank of the metadata value to
-be returned. If the rank is left out, it defaults to 1, the highest rank.
-^AOIRank(contenttype); would display "sport" if the current user has looked at content tagged "contenttype = sport" the most.
-^AOIRank(contenttype, 2); would return the second highest ranked value for contenttype.
Here's an example:
+ +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 ^AOIRank() macro calls:
+ +Most popular kind of story: ^AOIRank(contentType);
+Second-most popular kind of story: ^AOIRank(contentType,2);
+Third most popular kind of story: ^AOIRank(contentType,3);
By default, ^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.
+ +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.
|, - lastUpdated => 1146627736, + lastUpdated => 1165361640, }, };