[interchange-docs] xmldocs - docelic modified 3 files

[docs at icdevgroup.org]

User:      docelic
Date:      2006-03-24 21:12:51 GMT
Modified:  refs     CreditCardAuto
Added:     refs     OnFly PGP
Log:
- refs/CreditCardAuto: better title
- refs/*: two new items

Revision  Changes    Path
1.2       +1 -1      xmldocs/refs/CreditCardAuto


rev 1.2, prev_rev 1.1
Index: CreditCardAuto
===================================================================
RCS file: /var/cvs/xmldocs/refs/CreditCardAuto,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- CreditCardAuto	18 Nov 2005 23:15:02 -0000	1.1
+++ CreditCardAuto	24 Mar 2006 21:12:51 -0000	1.2
@@ -1,5 +1,5 @@
 __NAME__ purpose
-automatically store encrypted credit card information
+automatically encrypt credit card information
 __END__
 
 



1.1                  xmldocs/refs/OnFly


rev 1.1, prev_rev 1.0
Index: OnFly
===================================================================

__NAME__ purpose
enable on-fly additions to client shopping cart
__END__

__NAME__ see also
__END__

__NAME__ synopsis
<group choice='plain'>
	<group choice='opt'>
		<arg choice='plain'>0</arg>
		<arg choice='plain'>1</arg>
	</group>
	<arg choice='plain'><replaceable>ITL_tag_name</replaceable></arg>
</group>
__END__

__NAME__ description
If the directive is enabled, it enables on-the-fly item additions to the
client shopping cart. If set to a name of an existing &glos-ITL; tag,
the tag definition will be used to parse and format the item with the
following call:
</para><para>
<programlisting>
$item = Vend::Parse::do_tag($Vend::Cfg->{OnFly},
  $code,
  $quantity,
  $fly[$j],
);
</programlisting>
In other words, your custom tag will be invoked with four arguments, 
of which the first three are the tag name, item code and item quantity
respectively, 
and the last argument is the value of <mv>mv_order_fly</mv> &glos-mv;
variable for the item.
</para><para>
The default &tag-onfly; tag is already provided in &IC;.
__END__

__NAME__ notes
See &glos-onfly; glossary entry for a complete discussion.
__END__

__NAME__ example: Enabling OnFly
<programlisting>
OnFly 1
</programlisting>
__END__

__NAME__ example: Configuring OnFly with a custom ITL tag
<programlisting>
OnFly my_onfly_tag
</programlisting>
For your custom tag, use the existing &tag-onfly; tag, whose 
CVS source is available online in &cvsfile-code_SystemTag_onfly.coretag;.
__END__




1.1                  xmldocs/refs/PGP


rev 1.1, prev_rev 1.0
Index: PGP
===================================================================
__NAME__ purpose
automatically encrypted full order report
__END__


__NAME__ see also
EncryptProgram, PGP, CreditCardAuto
__END__

__NAME__ synopsis
<arg choice='plain'><replaceable>filename</replaceable></arg>
<arg choice='opt'><replaceable>arguments</replaceable></arg>
__END__


__NAME__ description
The directive enables automatic encryption of complete order 
reports sent to the store owner or an e-mail processing system.
</para><para>
The PGP key ring must be in the &IC; daemon user's home directory,
or defined in the environment variable <envar>PGPPATH</envar>.
The target user's public key must be present in the keyring, of course.
__END__

__NAME__ notes
If this directive is non-null, the PGP command string will be used as-given
to encrypt the entire order, in addition to any encryption done as a result
of the &conf-CreditCardAuto; directive. If, for some reason, an error comes
from PGP, the customer will see &glos-special; page
"<literal>failed</literal>".
</para><para>
If the &conf-Route; directive is set up to "<literal>supplant</literal>",
the &conf-PGP;  directive is ignored.
__END__

__NAME__ example: Defining PGP
<programlisting>
PGP /usr/local/bin/pgp -feat orders at company.com
</programlisting>
__END__