From e718fc5b9a440c12799fd8ed308935abe1e3e3a5 Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Mon, 17 Jul 2006 22:54:34 +0000 Subject: [PATCH] update pod and macro docs --- lib/WebGUI/Macro/Page.pm | 4 ++-- lib/WebGUI/Macro/User.pm | 2 +- lib/WebGUI/i18n/English/Macro_Page.pm | 5 +++-- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/lib/WebGUI/Macro/Page.pm b/lib/WebGUI/Macro/Page.pm index 5e7ff1835..14b139940 100644 --- a/lib/WebGUI/Macro/Page.pm +++ b/lib/WebGUI/Macro/Page.pm @@ -23,11 +23,11 @@ Macro for pulling information from the Asset in which it's embedded. =head2 process ( property ) If the macro is called from outside of an Asset, or if there's no asset in -session variable, returns a single space. +session variable, returns an empty string. =head3 property -The name of the property to retrieve from the assset via $session->asset->get() +The name of the property to retrieve from the asset via $session->asset->get() =cut diff --git a/lib/WebGUI/Macro/User.pm b/lib/WebGUI/Macro/User.pm index 3c3fc4200..bb817db66 100644 --- a/lib/WebGUI/Macro/User.pm +++ b/lib/WebGUI/Macro/User.pm @@ -22,7 +22,7 @@ Macro for displaying information from the current User's profile. =head2 process( field ) -process takes a single parameter, the name of a field in the User's User Profile from +process takes a single parameter, the name of a field in the current user's User Profile from the data stored in $session . If the field does not exist, undef is returned. =cut diff --git a/lib/WebGUI/i18n/English/Macro_Page.pm b/lib/WebGUI/i18n/English/Macro_Page.pm index edd83adbc..8bbc7eb3b 100644 --- a/lib/WebGUI/i18n/English/Macro_Page.pm +++ b/lib/WebGUI/i18n/English/Macro_Page.pm @@ -16,11 +16,12 @@ our $I18N = { message => q|

^Page();
-This can be used to retrieve information about the current page. For instance it could be used to get the page URL like this ^Page("urlizedTitle"); or to get the menu title like this ^Page("menuTitle");. +This can be used to retrieve information about the current asset. For instance it could be used to get the page URL like this ^Page("urlizedTitle"); or to get the menu title like this ^Page("menuTitle");. If the macro is called outside the context of +an asset, or if the property doesn't exist, then it returns nothing.

|, - lastUpdated => 1146609799, + lastUpdated => 1153177069, }, };