[interchange-docs] xmldocs - docelic modified 7 files

[docs at icdevgroup.org]

User:      docelic
Date:      2007-11-10 23:46:13 GMT
Modified:  refs     lc.filter uc.filter
Added:     refs     lcfirst.filter lspace_to_nbsp.filter round.filter
Added:              sha1.filter ucfirst.filter
Log:
* Document few new filters

Revision  Changes    Path
1.3       +1 -1      xmldocs/refs/lc.filter


rev 1.3, prev_rev 1.2
Index: lc.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/lc.filter,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- lc.filter	18 Aug 2007 21:33:40 -0000	1.2
+++ lc.filter	10 Nov 2007 23:46:13 -0000	1.3
@@ -1,5 +1,5 @@
 __NAME__ purpose
-simply transform all input to lowercase
+transform all input to lowercase
 __END__
 
 



1.2       +1 -1      xmldocs/refs/uc.filter


rev 1.2, prev_rev 1.1
Index: uc.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/uc.filter,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- uc.filter	22 Dec 2004 22:58:12 -0000	1.1
+++ uc.filter	10 Nov 2007 23:46:13 -0000	1.2
@@ -1,5 +1,5 @@
 __NAME__ purpose
-simply transform all input to uppercase
+transform all input to uppercase
 __END__
 
 



1.1                  xmldocs/refs/lcfirst.filter


rev 1.1, prev_rev 1.0
Index: lcfirst.filter
===================================================================
__NAME__ purpose
transform first character in input to lowercase
__END__


__NAME__ description
The filter simply transforms first characther in input to lowercase.
__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 lcfirst]ABC DEF[/filter]
]]></programlisting>
__END__




1.1                  xmldocs/refs/lspace_to_nbsp.filter


rev 1.1, prev_rev 1.0
Index: lspace_to_nbsp.filter
===================================================================
__NAME__ purpose
replace leading spaces (" ") with nonbreakable space ("&amp;nbsp;") characters
__END__


__NAME__ see also
space_to_null, lspace_to_nbsp
__END__


__NAME__ description
The filter replaces leading space ("<literal> </literal>") characters
with &glos-HTML;'s nonbreakable-space ("<literal>&amp;nbsp;</literal>")
characters.
</para><para>
This is similar in functionality to &filter-space_to_nbsp; filter,
where all space (not just leading) is converted.
__END__


__NAME__ online: Filter example
<programlisting><![CDATA[
</div>
[filter lspace_to_nbsp]
          Text with leading whitespace.
[/filter]
</div>
]]></programlisting>
__END__




1.1                  xmldocs/refs/round.filter


rev 1.1, prev_rev 1.0
Index: round.filter
===================================================================
__NAME__ purpose
round value in floating-point-safe way
__END__


__NAME__ description
The filter rounds input value in a floating-point-safe way, using 
&IC;'s built-in function <function>Vend::util::round_to_frac_digits</function>.
__END__


__NAME__ online: Filter example
<programlisting>
[filter round.4]512.78953334[/filter]
[filter round.4]512.78955334[/filter]
[filter round.4]512.78958334[/filter]
</programlisting>
__END__

__NAME__ author
&mheins;
__END__




1.1                  xmldocs/refs/sha1.filter


rev 1.1, prev_rev 1.0
Index: sha1.filter
===================================================================
__NAME__ purpose
calculate SHA1 sum of input
__END__

__NAME__ see also
md5
__END__


__NAME__ description
The filter outputs SHA1 sum for the input text.
__END__


__NAME__ online: Filter example
<programlisting>
[filter sha1][/filter]
[filter sha1]One[/filter]
[filter sha1]Two[/filter]
[filter sha1]MyPassword[/filter]
[filter sha1]Very long string[/filter]
</programlisting>
__END__

__NAME__ author
&jon;
__END__




1.1                  xmldocs/refs/ucfirst.filter


rev 1.1, prev_rev 1.0
Index: ucfirst.filter
===================================================================
__NAME__ purpose
transform first character in input to uppercase
__END__


__NAME__ description
The filter simply transforms first characther in 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 ucfirst]abc def[/filter]
]]></programlisting>
__END__