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

58
lib/WebGUI/URL.pm
View file

@ -58,20 +58,16 @@ These subroutines are available from this package:
Returns a URL after adding some information to the end of it.
=over
=item url
=head3 url
The URL to append information to.
=item pairs
=head3 pairs
Name value pairs to add to the URL in the form of:
name1=value1&name2=value2&name3=value3
=back
=cut
sub append {
@ -91,16 +87,12 @@ sub append {
Encodes a string to make it safe to pass in a URL.
NOTE: See WebGUI::URL::unescape()
B<NOTE:> See WebGUI::URL::unescape()
=over
=item string
=head3 string
The string to escape.
=back
=cut
sub escape {
@ -114,20 +106,16 @@ sub escape {
Generate a URL based on WebGUI's gateway script.
=over
=item pageURL
=head3 pageURL
The urlized title of a page that you wish to create a URL for.
=item pairs
=head3 pairs
Name value pairs to add to the URL in the form of:
name1=value1&name2=value2&name3=value3
=back
=cut
sub gateway {
@ -147,18 +135,14 @@ sub gateway {
Returns an absolute url.
=over
=item url
=head3 url
The url to make absolute.
=item baseURL
=head3 baseURL
The base URL to use. This defaults to current page url.
=back
=cut
sub makeAbsolute {
@ -223,14 +207,10 @@ sub getSiteURL {
Returns a string that has made into a WebGUI compliant URL.
=over
=item string
=head3 string
The string to make compliant. This is usually a page title or a filename.
=back
=cut
sub makeCompliant {
@ -253,16 +233,12 @@ sub makeCompliant {
Returns the URL of the current page.
=over
=item pairs
=head3 pairs
Name value pairs to add to the URL in the form of:
name1=value1&name2=value2&name3=value3
=back
=cut
sub page {
@ -282,16 +258,12 @@ sub page {
Decodes a string that was URL encoded.
NOTE: See WebGUI::URL::escape()
B<NOTE:> See WebGUI::URL::escape()
=over
=item string
=head3 string
The string to unescape.
=back
=cut
sub unescape {
@ -304,14 +276,10 @@ sub unescape {
Returns a url that is safe for WebGUI pages.
=over
=item string
=head3 string
The string to urlize.
=back
=cut
sub urlize {