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

changed POD formatting

Browse source
This commit is contained in:
JT Smith 2004-09-14 02:22:38 +00:00
parent bf5a0145ae
commit 2b6eb201a9
55 changed files with 1188 additions and 3220 deletions
Download patch file Download diff file Expand all files Collapse all files

46
lib/WebGUI/Template.pm
View file

@ -93,18 +93,14 @@ sub _execute {
Returns a hash reference containing all of the template parameters.
=over
=item templateId
=head3 templateId
Defaults to "1". Specify the templateId of the template to retrieve.
=item namespace
=head3 namespace
Defaults to "page". Specify the namespace of the template to retrieve.
=back
=cut
sub get {
@ -120,14 +116,10 @@ sub get {
Returns a hash reference containing template ids and template names of all the templates in the specified namespace.
=over
=item namespace
=head3 namespace
Defaults to "page". Specify the namespace to build the list for.
=back
=cut
sub getList {
@ -142,18 +134,14 @@ sub getList {
Returns a template ID by looking up the name for it.
=over
=item name
=head3 name
The name to look up.
=item namespace
=head3 namespace
The namespace to focus on when searching.
=back
=cut
sub getIdByName {
@ -171,22 +159,18 @@ sub getIdByName {
Evaluate a template replacing template commands for HTML.
=over
=item templateId
=head3 templateId
Defaults to "1". Specify the templateId of the template to retrieve.
=item namespace
=head3 namespace
Defaults to "page". Specify the namespace of the template to retrieve.
=item vars
=head3 vars
A hash reference containing template variables and loops. Automatically includes the entire WebGUI session.
=back
=cut
sub process {
@ -247,18 +231,14 @@ sub process {
Evaluate a template replacing template commands for HTML.
=over
=item template
=head3 template
A scalar variable containing the template.
=item vars
=head3 vars
A hash reference containing template variables and loops. Automatically includes the entire WebGUI session.
=back
=cut
sub processRaw {
@ -280,9 +260,7 @@ sub processRaw {
Store a template and it's metadata.
=over
=item data
=head3 data
A hash reference containing the data to be stored. At minimum the hash reference must include "templateId" and "namespace". The following are the elements allowed to be stored.
@ -298,8 +276,6 @@ A hash reference containing the data to be stored. At minimum the hash reference
isEditable - A boolean indicating whether this template should be editable through the template manager.
=back
=cut
sub set {