[docs] xmldocs - docelic modified 9 files

docs at icdevgroup.org docs at icdevgroup.org
Wed Dec 22 17:58:13 EST 2004


User:      docelic
Date:      2004-12-22 22:58:12 GMT
Added:     refs     text2html.filter tt.filter uc.filter unix.filter
Added:              urldecode.filter urlencode.filter value.filter
Added:              word.filter zerofix.filter
Log:
Documented a handful (;-) of filters.

Revision  Changes    Path
1.1                  xmldocs/refs/text2html.filter


rev 1.1, prev_rev 1.0
Index: text2html.filter
===================================================================
__NAME__ purpose
transform input plain-text to most basic HTML
__END__


__NAME__ description
The filter only replaces double newline with &glos-HTML; <p> tag,
and single newline with <br>.
__END__


__NAME__ notes
For more information on &PERL; Regular Expressions, pattern matching and
character classes, see
<citerefentry><refentrytitle>perlre</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
__END__


__NAME__ online: Filter example
<programlisting><![CDATA[
[filter text2html]
Perl is a lot of fun!
Interesting tricks with the language can be seen at MJD's 
<a href="http://perl.plover.com/">plover.com</a>.

Programming is an art.
[/filter]
]]></programlisting>
__END__




1.1                  xmldocs/refs/tt.filter


rev 1.1, prev_rev 1.0
Index: tt.filter
===================================================================
__NAME__ purpose
simply enclose input in HTML &lt;tt&gt; (typerwiter) tag
__END__


__NAME__ description
The filter simply encloses input in &glos-HTML; &lt;tt&gt; (typewriter)
tag.
__END__


__NAME__ online: Filter example
<programlisting><![CDATA[
R. J. Zavada's <a href="http://www.jfk-info.com/zreport.htm">report</a>:<br/>
[filter tt]Zapruder, eight milimeter, 8mm, cage print, B&H Model J Printer,<br/>
B&H 414PD Camera, NARA, ARRB[filter] 
]]></programlisting>
__END__




1.1                  xmldocs/refs/uc.filter


rev 1.1, prev_rev 1.0
Index: uc.filter
===================================================================
__NAME__ purpose
simply transform all input to uppercase
__END__


__NAME__ description
The filter simply transforms all input to uppercase.
__END__


__NAME__ notes
For more information on &PERL; Regular Expressions, pattern matching and
character classes, see
<citerefentry><refentrytitle>perlre</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
__END__


__NAME__ online: Filter example
<programlisting><![CDATA[
[filter uc]You are kindly invited to [filter] 
<a href="http://www.j-walk.com/other/conf/">The 3rd Annual Nigerian
EMail Conference</a>.
]]></programlisting>
__END__




1.1                  xmldocs/refs/unix.filter


rev 1.1, prev_rev 1.0
Index: unix.filter
===================================================================
__NAME__ purpose
replace DOS CRLF or CR sequences with Unix LF
__END__


__NAME__ see also
__END__


__NAME__ description
DOS and Microsoft Windows use CRLF (Carriage Return/Line Feed -
<literal>\r\n</literal>) to signal end of line in text files.
Unix, on the other hand, uses only line feeds (<literal>\n</literal>), so CRs 
end up as excess characters.
</para><para>
The &filter-unix; filter removes CRLF or CR sequences with LF.
__END__


__NAME__ notes
For more information on &PERL; Regular Expressions, pattern matching and
character classes, see
<citerefentry><refentrytitle>perlre</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
__END__


__NAME__ online: Filter example
<programlisting>
[filter unix]Those pesky DOS characters, we can only be lucky that there are
none hiding in this text ;-)[/filter]
</programlisting>
__END__




1.1                  xmldocs/refs/urldecode.filter


rev 1.1, prev_rev 1.0
Index: urldecode.filter
===================================================================
__NAME__ purpose
replace encoded (hex) characters with their normal representation
__END__

__NAME__ description
The filter replaces encoded (hex) characters with their normal 
representation.
__END__


__NAME__ notes
For more information on &PERL; Regular Expressions, pattern matching and
character classes, see
<citerefentry><refentrytitle>perlre</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
__END__


__NAME__ online: Filter example
<programlisting>
[filter urlencode urldecode]http://&def-hostname;<![CDATA[/path/script.cgi?var1=val1&var2=val2[filter]
]]></programlisting>
__END__




1.1                  xmldocs/refs/urlencode.filter


rev 1.1, prev_rev 1.0
Index: urlencode.filter
===================================================================
__NAME__ purpose
replace non-word characters or a colon with encoded (hex) representation
__END__

__NAME__ description
The filter replaces non-word characters or colons with their encoded
(hex) representation.
__END__


__NAME__ notes
For more information on &PERL; Regular Expressions, pattern matching and
character classes, see
<citerefentry><refentrytitle>perlre</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
__END__


__NAME__ online: Filter example
<programlisting>
[filter urlencode]http://&def-hostname;<![CDATA[/path/script.cgi?var1=val1&var2=val2[filter]
]]></programlisting>
__END__




1.1                  xmldocs/refs/value.filter


rev 1.1, prev_rev 1.0
Index: value.filter
===================================================================
__NAME__ purpose
expand to value of the UserDB variable specified in body
__END__


__NAME__ description
The filter expands to the value of a &glos-UserDB; variable.
Name of the variable is specified in filter body.
__END__


__NAME__ online: Filter example
<programlisting>
[value name=online_value_test set="TEST VALUE" hide=1]

My test value is [filter value]online_value_test[/filter]
</programlisting>
__END__




1.1                  xmldocs/refs/word.filter


rev 1.1, prev_rev 1.0
Index: word.filter
===================================================================
__NAME__ purpose
eliminate any non-word characters
__END__


__NAME__ see also
__END__


__NAME__ description
The filter eliminates non-word characters in the input.
(Non-word characters are those outside the 
[<literal>a-zA-Z0-9_</literal>] range.)
__END__


__NAME__ notes
For more information on &PERL; Regular Expressions, pattern matching and
character classes, see
<citerefentry><refentrytitle>perlre</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
__END__


__NAME__ online: Filter example
<programlisting>
[filter word]Hello, World![/filter]
</programlisting>
__END__




1.1                  xmldocs/refs/zerofix.filter


rev 1.1, prev_rev 1.0
Index: zerofix.filter
===================================================================
__NAME__ purpose
eliminate possible zeros at beginning of input
__END__


__NAME__ see also
__END__


__NAME__ description
The filter eliminates zeros (<literal>0</literal>) that might be present
<emphasis>at the beginning</emphasis> of an input string.
__END__


__NAME__ notes
For more information on &PERL; Regular Expressions, pattern matching and
character classes, see
<citerefentry><refentrytitle>perlre</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
__END__


__NAME__ online: Filter example
<programlisting>
[filter zerofix]000123456[/filter]
</programlisting>
__END__









More information about the docs mailing list