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

44
lib/WebGUI/HTML.pm
View file

@ -53,16 +53,12 @@ These methods are available from this package:
Returns an HTML segment that has been stripped of the <BODY> tag and anything before it, as well as the </BODY> tag and anything after it. It's main purpose is to get rid of META tags and other garbage from an HTML page that will be used as a segment inside of another page.
NOTE: This filter does have one exception, it leaves anything before the <BODY> tag that is enclosed in <STYLE></STYLE> or <SCRIPT></SCRIPT> tags.
B<NOTE:> This filter does have one exception, it leaves anything before the <BODY> tag that is enclosed in <STYLE></STYLE> or <SCRIPT></SCRIPT> tags.
=over
=item html
=head3 html
The HTML segment you want cleaned.
=back
=cut
sub cleanSegment {
@ -95,18 +91,14 @@ sub cleanSegment {
Returns HTML with unwanted tags filtered out.
=over
=item html
=head3 html
The HTML content you want filtered.
=item filter
=head3 filter
Choose from "all", "none", "macros", "javascript", or "most". Defaults to "most". "all" removes all HTML tags and macros; "none" removes no HTML tags; "javascript" removes all references to javacript and macros; "macros" removes all macros, but nothing else; and "most" removes all but simple formatting tags like bold and italics.
=back
=cut
sub filter {
@ -151,18 +143,14 @@ sub filter {
Formats various text types into HTML.
=over
=item content
=head3 content
The text content to be formatted.
=item contentType
=head3 contentType
The content type to use as formatting. Valid types are 'html', 'text', 'code', and 'mixed'. Defaults to mixed. See also the contentType method in WebGUI::Form, WebGUI::HTMLForm, and WebGUI::FormProcessor.
=back
=cut
sub format {
@ -194,14 +182,10 @@ sub format {
Converts html to text. It currently handles only text, so tables
or forms are not converted.
=over
=item html
=head3 html
The html segment you want to convert to text.
=back
=cut
sub html2text {
@ -240,18 +224,14 @@ sub html2text {
Returns html with all relative links converted to absolute.
=over
=item html
=head3 html
The html to be made absolute.
=item baseURL
=head3 baseURL
The base URL to use. Defaults to current page's url.
=back
=cut
sub makeAbsolute {
@ -322,14 +302,10 @@ sub makeAbsolute {
Processes text using the WebGUI replacements system.
=over
=item content
=head3 content
The content to be processed through the replacements filter.
=back
=cut
sub processReplacements {