diff --git a/lib/WebGUI/Macro/AdminToggle.pm b/lib/WebGUI/Macro/AdminToggle.pm index 7e8dfe9ec..e3f4047be 100644 --- a/lib/WebGUI/Macro/AdminToggle.pm +++ b/lib/WebGUI/Macro/AdminToggle.pm @@ -27,7 +27,7 @@ Macro for displaying a url to the user for turning Admin mode on and off. =head2 process ( [turnOn,turnOff,template ] ) -process takes two optional parameters for customizing the content and layout +process takes three optional parameters for customizing the content and layout of the account link. =head3 turnOn @@ -42,7 +42,7 @@ Turn On Admin group. If this is blank an internationalized default is used. =head3 template -A template to use for formatting the link. +A template from the Macro/AdminToggle namespace to use for formatting the link. =cut diff --git a/lib/WebGUI/Macro/D_date.pm b/lib/WebGUI/Macro/D_date.pm index 646ede447..5f8966f08 100644 --- a/lib/WebGUI/Macro/D_date.pm +++ b/lib/WebGUI/Macro/D_date.pm @@ -13,6 +13,29 @@ package WebGUI::Macro::D_date; use strict; use WebGUI::DateTime; +=head1 NAME + +Package WebGUI::Macro::D_date + +=head1 DESCRIPTION + +Macro for displaying dates formatted for reading by people using WebGUI::DateTime::epochToHuman(). + +=head2 process ( format string, [ date ] ) + +=head3 format string + +A string specifying how to format the date using codes similar to those used by +sprintf. See L for a list of codes. + +=head3 date + +An optional date in epoch format. If the date is omitted, then the present +time is used instead. + +=cut + + #------------------------------------------------------------------- sub process { my (@param, $temp, $time); diff --git a/lib/WebGUI/Macro/EditableToggle.pm b/lib/WebGUI/Macro/EditableToggle.pm index be4d152cb..3b8c3f31c 100644 --- a/lib/WebGUI/Macro/EditableToggle.pm +++ b/lib/WebGUI/Macro/EditableToggle.pm @@ -17,6 +17,38 @@ use WebGUI::Session; use WebGUI::Asset::Template; use WebGUI::URL; +=head1 NAME + +Package WebGUI::Macro::EditableToggle + +=head1 DESCRIPTION + +Macro for displaying a url to the user for turning Admin mode on and off if they +have editing rights to the current Asset. + +=head2 process ( [turnOn,turnOff,template ] ) + +process takes three optional parameters for customizing the content and layout +of the account link. + +=head3 turnOn + +The text displayed to the user if Admin mode is turned off, they are in the +Turn On Admin group and they have editing rights to this Asset. +If this is blank an internationalized default is used. + +=head3 turnOff + +The text displayed to the user if Admin mode is turned on, they are in +the Turn On Admin group and they have editing rights to this Asset.. +If this is blank an internationalized default is used. + +=head3 template + +A template from the Macro/EditableToggle namespace to use for formatting the link. + +=cut + #------------------------------------------------------------------- sub process { if (exists $session{asset} && $session{asset}->canEdit && WebGUI::Grouping::isInGroup(12)) { diff --git a/lib/WebGUI/Macro/Env.pm b/lib/WebGUI/Macro/Env.pm index 11a275829..8eefe2bf2 100644 --- a/lib/WebGUI/Macro/Env.pm +++ b/lib/WebGUI/Macro/Env.pm @@ -13,6 +13,23 @@ package WebGUI::Macro::Env; use strict; use WebGUI::Session; +=head1 NAME + +Package WebGUI::Macro::Env + +=head1 DESCRIPTION + +Macro for displaying fields from the Session env hash. + +=head2 process ( key ) + +=head3 key + +The key from the Session env hash to display. If the key doesn't exist, +then undef will be returned. + +=cut + #------------------------------------------------------------------- sub process { return $session{env}{shift};