[interchange-docs] xmldocs - docelic modified 17 files

docs at icdevgroup.org docs at icdevgroup.org
Wed Jan 14 14:25:53 UTC 2009


User:      docelic
Date:      2009-01-14 14:25:53 GMT
Modified:  refs     EncryptProgram currency.filter date2time.filter
Modified:           decode_entities.filter duration.filter
Modified:           encrypt.filter hash2acl.filter integer.filter
Modified:           large.filter lc.filter lcfirst.filter
Modified:           linkdecode.filter liven_urls.filter tt.filter
Modified:           urldecode.filter urlencode.filter
Added:     refs     isbn.ordercheck
Log:
* Commit isbn ordercheck (forgot last time)
* Updates to d-l* filters
* Fix [filter] -> [/filter] on a couple places

Revision  Changes    Path
1.9                  xmldocs/refs/EncryptProgram


rev 1.9, prev_rev 1.8
Index: EncryptProgram
===================================================================
RCS file: /var/cvs/xmldocs/refs/EncryptProgram,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- EncryptProgram	6 Nov 2006 18:41:20 -0000	1.8
+++ EncryptProgram	14 Jan 2009 14:25:53 -0000	1.9
@@ -24,6 +24,21 @@
 If &IC; can found a variant of <command>gpg</command>/<command>pgp</command>
 on your system, it is the default. Setting of <literal>none</literal> disables
 encryption.
+</para><para>
+Specifying command line options for the encryption program isn't required,
+as &IC; automatically adds the following options, depending on the program
+recognized:
+<itemizedlist>
+  <listitem><para>
+    <literal>gpg --batch --always-trust -e -a -r <replaceable>KEY</replaceable></literal>
+  </para></listitem>
+  <listitem><para>
+    <literal>pgpe -fat -r <replaceable>KEY</replaceable></literal>
+  </para></listitem>
+  <listitem><para>
+    <literal>pgp -fat - <replaceable>KEY</replaceable></literal>
+  </para></listitem>
+</itemizedlist>
 __END__
 
 
@@ -54,7 +69,7 @@
 
 __NAME__ example: Specifying EncryptProgram with full path and arguments
 <programlisting>
-EncryptProgram /usr/local/bin/gpg -feat orders@&def-domain;
+EncryptProgram /usr/local/bin/gpg --batch --always-trust -e -a -r orders@&def-domain;
 </programlisting>
 __END__
 
@@ -66,6 +81,7 @@
 
 __NAME__ missing
 PORT_OLD
+Will autoadding of options in Vend::Order::pgp_encrypt properly honor any manually set options?
 __END__
 
 



1.3                  xmldocs/refs/currency.filter


rev 1.3, prev_rev 1.2
Index: currency.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/currency.filter,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- currency.filter	13 Jan 2009 14:09:27 -0000	1.2
+++ currency.filter	14 Jan 2009 14:25:53 -0000	1.3
@@ -15,14 +15,10 @@
 
 __NAME__ example: Displaying a value in specific locale formatted as a currency
 <programlisting>
-[filter currency.LOCALE_NAME]40.2[/filter]
+[filter currency.fr_FR]40.2[/filter]
 </programlisting>
 __END__
 
-__NAME__ missing
-Actual value that can be specified for LOCALE_NAME parameter
-__END__
-
 __NAME__ see also
 PriceDivide,Locale,PriceCommas
 __END__



1.5                  xmldocs/refs/date2time.filter


rev 1.5, prev_rev 1.4
Index: date2time.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/date2time.filter,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- date2time.filter	18 Aug 2007 21:33:39 -0000	1.4
+++ date2time.filter	14 Jan 2009 14:25:53 -0000	1.5
@@ -27,6 +27,8 @@
 
 
 __NAME__ notes
+This filter is considered deprecated, and is replaced by &filter-datetime2epoch;.
+</para><para>
 For more information on &PERL; Regular Expressions, pattern matching and
 character classes, see
 <citerefentry><refentrytitle>perlre</refentrytitle><manvolnum>1</manvolnum></citerefentry>.



1.3                  xmldocs/refs/decode_entities.filter


rev 1.3, prev_rev 1.2
Index: decode_entities.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/decode_entities.filter,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- decode_entities.filter	16 Dec 2005 13:24:44 -0000	1.2
+++ decode_entities.filter	14 Jan 2009 14:25:53 -0000	1.3
@@ -23,7 +23,7 @@
 
 __NAME__ online: Filter example
 <programlisting>
-[filter decode_entities]One &amp; Two &amp; Three[filter]
+[filter decode_entities]One &amp; Two &amp; Three[/filter]
 </programlisting>
 __END__
 



1.2                  xmldocs/refs/duration.filter


rev 1.2, prev_rev 1.1
Index: duration.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/duration.filter,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- duration.filter	29 May 2005 15:01:39 -0000	1.1
+++ duration.filter	14 Jan 2009 14:25:53 -0000	1.2
@@ -25,9 +25,8 @@
 
 __NAME__ online: Obtaining an end date string
 The following example sets start date to Feb 12, 2005 (at 8:00 am),
-and the duration to 12 hours. Filter output should return again, Feb 12, 2005,
-but with the time set to 8:00 pm. So exactly, it should return 
-<literal>200502122000</literal>.
+and the duration to 12 hours.
+
 <programlisting>
 [cgi name=start_date set=200502120800 hide=1]
 [cgi name=length     set="12 hours"   hide=1]



1.2                  xmldocs/refs/encrypt.filter


rev 1.2, prev_rev 1.1
Index: encrypt.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/encrypt.filter,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- encrypt.filter	18 Nov 2005 23:15:02 -0000	1.1
+++ encrypt.filter	14 Jan 2009 14:25:53 -0000	1.2
@@ -4,6 +4,23 @@
 
 __NAME__ description
 The filter PGP-encrypts the provided input.
+</para><para>
+It accepts two optional arguments, encryption key and encryption program.
+</para><para>
+Specifying command line options for the encryption program isn't possible, but
+it isn't needed as &IC; automatically adds the following options, depending on
+the program recognized:
+<itemizedlist>
+	<listitem><para>
+		<literal>gpg --batch --always-trust -e -a -r <replaceable>KEY</replaceable></literal>
+	</para></listitem>
+	<listitem><para>
+		<literal>pgpe -fat -r <replaceable>KEY</replaceable></literal>
+	</para></listitem>
+	<listitem><para>
+		<literal>pgp -fat - <replaceable>KEY</replaceable></literal>
+	</para></listitem>
+</itemizedlist>
 __END__
 
 
@@ -12,10 +29,15 @@
 __END__
 
 
-__NAME__ online: Filter example
+__NAME__ online: Filter example using specific key ID
 <programlisting>
-[filter encrypt.KEY]Secret phrase or a credit card number[filter]
+[filter encrypt.KEY]Secret phrase or a credit card number[/filter]
+</programlisting>
+__END__
+
+__NAME__ online: Filter example using specific key ID and encrypt program
+<programlisting>
+[filter encrypt.KEY./usr/local/bin/gpg]Secret phrase or a credit card number[/filter]
 </programlisting>
 __END__
 
-TODO Standalone example



1.2                  xmldocs/refs/hash2acl.filter


rev 1.2, prev_rev 1.1
Index: hash2acl.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/hash2acl.filter,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- hash2acl.filter	21 Mar 2006 12:42:12 -0000	1.1
+++ hash2acl.filter	14 Jan 2009 14:25:53 -0000	1.2
@@ -16,12 +16,6 @@
 operate in the &tag-table-editor;.
 __END__
 
-
-__NAME__ online: Filter example
-<programlisting>
-</programlisting>
-__END__
-
 __NAME__ missing
 Better description
 __END__



1.2                  xmldocs/refs/integer.filter


rev 1.2, prev_rev 1.1
Index: integer.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/integer.filter,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- integer.filter	29 May 2005 15:01:39 -0000	1.1
+++ integer.filter	14 Jan 2009 14:25:53 -0000	1.2
@@ -1,10 +1,10 @@
 __NAME__ purpose
-simply return integer value of the input
+return integer value of the input
 __END__
 
 
 __NAME__ description
-The filter simply returns integer value of the input
+The filter returns integer value of the inputr.
 __END__
 
 
@@ -17,13 +17,13 @@
 
 __NAME__ online: Filter example
 <programlisting>
-[filter integer]12.4[filter] 
+[filter integer]12.4[/filter] 
 </programlisting>
 __END__
 
 __NAME__ online: Erase whitespace, filter out non-digits, and return integer part of the number
 <programlisting>
-The whole is:  [filter no_white digits_dot integer]Stock 904.82[filter] 
+The whole is:  [filter op="no_white digits_dot integer"]Stock 904.82[/filter] 
 </programlisting>
 __END__
 



1.2                  xmldocs/refs/large.filter


rev 1.2, prev_rev 1.1
Index: large.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/large.filter,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- large.filter	29 May 2005 15:01:39 -0000	1.1
+++ large.filter	14 Jan 2009 14:25:53 -0000	1.2
@@ -13,7 +13,7 @@
 __END__
 
 
-__NAME__ online: Filter example
+__NAME__ example: Filter example
 <programlisting>
 You can see that "[filter large] This text is larger than usual. [/filter]"
 </programlisting>



1.4                  xmldocs/refs/lc.filter


rev 1.4, prev_rev 1.3
Index: lc.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/lc.filter,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- lc.filter	10 Nov 2007 23:46:13 -0000	1.3
+++ lc.filter	14 Jan 2009 14:25:53 -0000	1.4
@@ -4,7 +4,7 @@
 
 
 __NAME__ description
-The filter simply transforms all input to lowercase.
+The filter transforms all input to lowercase.
 __END__
 
 



1.3                  xmldocs/refs/lcfirst.filter


rev 1.3, prev_rev 1.2
Index: lcfirst.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/lcfirst.filter,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- lcfirst.filter	11 Nov 2007 20:49:17 -0000	1.2
+++ lcfirst.filter	14 Jan 2009 14:25:53 -0000	1.3
@@ -4,7 +4,7 @@
 
 
 __NAME__ description
-The filter simply transforms first character in input to lowercase.
+The filter transforms first character in input to lowercase.
 __END__
 
 



1.2                  xmldocs/refs/linkdecode.filter


rev 1.2, prev_rev 1.1
Index: linkdecode.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/linkdecode.filter,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- linkdecode.filter	16 Dec 2005 13:24:44 -0000	1.1
+++ linkdecode.filter	14 Jan 2009 14:25:53 -0000	1.2
@@ -12,9 +12,3 @@
 &glos-HTML; URLs or source specifiers (such as &lt;a&gt; or &lt;img&gt; tags).
 __END__
 
-__NAME__ online: Filter example
-<programlisting>
-[filter linkdecode][/filter]
-</programlisting>
-__END__
-TODO EXAMPLE!



1.5                  xmldocs/refs/liven_urls.filter


rev 1.5, prev_rev 1.4
Index: liven_urls.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/liven_urls.filter,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- liven_urls.filter	22 Nov 2007 01:22:13 -0000	1.4
+++ liven_urls.filter	14 Jan 2009 14:25:53 -0000	1.5
@@ -23,7 +23,7 @@
 </para><para>
 The matching expressions were generated with the help of
 Abigail's
-<ulink url="http://ucan.foad.org/~abigail/Perl/url2.html">Regex for URLs</ulink>.
+<ulink url="http://ucan.foad.org/~abigail/Perl/url2.html">Regex for URLs</ulink> (link appears broken, and no replacement found).
 </para><para>
 To save on processing time, only the most common protocols 
 (http/https, ftp and mailto) are actually enabled in the filter.
@@ -39,7 +39,7 @@
 Here's an incomplete collection of URLs that the filter can recognize.
 <programlisting><![CDATA[
 [filter liven_urls]
-http://www.acl.lanl.gov/URI/archive/uri-archive.index.html
+http://www.clusty.com/
 ftp://@host.com/
 ftp://host.com/
 ftp://foo:@host.com/



1.4                  xmldocs/refs/tt.filter


rev 1.4, prev_rev 1.3
Index: tt.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/tt.filter,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- tt.filter	19 Nov 2005 22:37:41 -0000	1.3
+++ tt.filter	14 Jan 2009 14:25:53 -0000	1.4
@@ -13,7 +13,7 @@
 <programlisting><![CDATA[
 R. J. Zavada's <a href="http://www.jfk-info.com/zreport.htm">report</a>:<br/>
 [filter tt]Zapruder, eight millimeter, 8mm, cage print, B&H Model J Printer,<br/>
-B&H 414PD Camera, NARA, ARRB[filter] 
+B&H 414PD Camera, NARA, ARRB[/filter] 
 ]]></programlisting>
 __END__
 



1.3                  xmldocs/refs/urldecode.filter


rev 1.3, prev_rev 1.2
Index: urldecode.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/urldecode.filter,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- urldecode.filter	16 Dec 2005 13:24:44 -0000	1.2
+++ urldecode.filter	14 Jan 2009 14:25:53 -0000	1.3
@@ -17,7 +17,7 @@
 
 __NAME__ online: Filter example
 <programlisting>
-[filter urlencode urldecode]http://&def-hostname;<![CDATA[/path/script.cgi?var1=val1&var2=val2[filter]
+[filter urlencode urldecode]http://&def-hostname;<![CDATA[/path/script.cgi?var1=val1&var2=val2[/filter]
 ]]></programlisting>
 __END__
 



1.2                  xmldocs/refs/urlencode.filter


rev 1.2, prev_rev 1.1
Index: urlencode.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/urlencode.filter,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- urlencode.filter	22 Dec 2004 22:58:12 -0000	1.1
+++ urlencode.filter	14 Jan 2009 14:25:53 -0000	1.2
@@ -17,7 +17,7 @@
 
 __NAME__ online: Filter example
 <programlisting>
-[filter urlencode]http://&def-hostname;<![CDATA[/path/script.cgi?var1=val1&var2=val2[filter]
+[filter urlencode]http://&def-hostname;<![CDATA[/path/script.cgi?var1=val1&var2=val2[/filter]
 ]]></programlisting>
 __END__
 



1.1                  xmldocs/refs/isbn.ordercheck


rev 1.1, prev_rev 1.0
Index: isbn.ordercheck
===================================================================
__NAME__ purpose
string is a valid ISBN-10/ISBN-13 code
__END__

__NAME__ see also
__END__


__NAME__ description
Verification of the form field value succeeds if
the passed value is a valid &glos-ISBN;-10/ISBN-13 code.
__END__

__NAME__ notes
__END__

__NAME__ example: Verifying ISBN code
<programlisting>
FORM_FIELD_NAME=__FILENAME__ "Not a valid ISBN code"
</programlisting>
__END__








More information about the docs mailing list