[docs] docs - jon modified 5 files
docs@interchange.redhat.com
docs@interchange.redhat.com
Wed Dec 5 22:29:47 2001
User: jon
Date: 2001-12-06 03:27:28 GMT
Modified: . ic_ecommerce.sdf icadvanced.sdf icdatabase.sdf
Modified: ictags.sdf ictemplates.sdf
Log:
Get rid of some old MV3 stuff.
Convert all [process-order] and [process-target] to simple [process] to
remove the mystery (they're just aliases).
Revision Changes Path
1.10 +3 -6 docs/ic_ecommerce.sdf
rev 1.10, prev_rev 1.9
Index: ic_ecommerce.sdf
===================================================================
RCS file: /var/cvs/docs/ic_ecommerce.sdf,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -u -r1.9 -r1.10
--- ic_ecommerce.sdf 2001/12/06 01:23:13 1.9
+++ ic_ecommerce.sdf 2001/12/06 03:27:27 1.10
@@ -1,10 +1,10 @@
!init OPT_LOOK="akopia"; OPT_STYLE="manual"
-# $Id: ic_ecommerce.sdf,v 1.9 2001/12/06 01:23:13 jon Exp $
+# $Id: ic_ecommerce.sdf,v 1.10 2001/12/06 03:27:27 jon Exp $
!define DOC_NAME "Interchange Ecommerce Functions"
!define DOC_TYPE ""
!define DOC_CODE "ic_ecommerce"
-!define DOC_VERSION substr('$Revision: 1.9 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.10 $',11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://interchange.redhat.com/doc/ic_ecommerce.html"
@@ -436,7 +436,7 @@
You can also order items from a form, using the C<mv_order_item>,
C<mv_cartname>, and optional C<mv_order_quantity> variables.
-> <FORM METHOD=POST ACTION="[process-order]">
+> <FORM METHOD=POST ACTION="[process]">
> <input type=checkbox name="mv_order_item" value="M3243"> Item M3243
> <input name="mv_order_quantity" value="1"> Quantity
> <input type=hidden name="mv_cartname" value="layaway">
@@ -1451,9 +1451,6 @@
Any input field from the order page can be included using the dollar
sign notation.
-
-To prevent a value from being included in the order report, just add it
-to the B<ReportIgnore> configuration directive.
Interchange defines some values for use in the search form -- they begin
with C<mv_> and are automatically ignored.
1.7 +3 -3 docs/icadvanced.sdf
rev 1.7, prev_rev 1.6
Index: icadvanced.sdf
===================================================================
RCS file: /var/cvs/docs/icadvanced.sdf,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -u -r1.6 -r1.7
--- icadvanced.sdf 2001/12/06 01:23:13 1.6
+++ icadvanced.sdf 2001/12/06 03:27:27 1.7
@@ -1,10 +1,10 @@
!init OPT_LOOK="akopia"; OPT_STYLE="manual"
-# $Id: icadvanced.sdf,v 1.6 2001/12/06 01:23:13 jon Exp $
+# $Id: icadvanced.sdf,v 1.7 2001/12/06 03:27:27 jon Exp $
!define DOC_NAME "Advanced Interchange Topics"
!define DOC_TYPE ""
!define DOC_CODE "icadvanced"
-!define DOC_VERSION substr('$Revision: 1.6 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.7 $',11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://interchange.redhat.com/doc/icadvanced.html"
@@ -1014,7 +1014,7 @@
-UNIX-domain sockets will not work on NFS-mounted file systems! This means that the server C<minivend> and the CGI program C<vlink> must be executing on the same machine.
--The C<tlink> program does not have this problem, but it must have the proper host name(s) and TCP ports set in the TcpHost and TcpPort directives in C<interchange.cfg>. Also, be careful of security if sensitive information, like customer credit card numbers, is being placed on a network wire.
+-The C<tlink> program does not have this problem, but it must have the proper host name(s) and TCP ports set in the TcpHost and TcpMap directives in C<interchange.cfg>. Also, be careful of security if sensitive information, like customer credit card numbers, is being placed on a network wire.
Line:
1.32 +9 -13 docs/icdatabase.sdf
rev 1.32, prev_rev 1.31
Index: icdatabase.sdf
===================================================================
RCS file: /var/cvs/docs/icdatabase.sdf,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -u -r1.31 -r1.32
--- icdatabase.sdf 2001/12/06 01:23:13 1.31
+++ icdatabase.sdf 2001/12/06 03:27:27 1.32
@@ -1,10 +1,10 @@
!init OPT_LOOK="akopia"; OPT_STYLE="manual"
-# $Id: icdatabase.sdf,v 1.31 2001/12/06 01:23:13 jon Exp $
+# $Id: icdatabase.sdf,v 1.32 2001/12/06 03:27:27 jon Exp $
!define DOC_NAME "Interchange Databases"
!define DOC_TYPE ""
!define DOC_CODE "icdatabase"
-!define DOC_VERSION substr('$Revision: 1.31 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.32 $',11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://interchange.redhat.com/doc/icadvanced.html"
@@ -1900,12 +1900,8 @@
LI1: [process-search]
-.Calls the search with the proper URL, including Interchange session tags. Used as the ACTION value for the search form.
+.Outputs the complete URL for a search, including Interchange session tags. Used as the ACTION value for the search form. This is exactly the same as [area search].
-LI1: [process-target frame]
-
-.Calls the search with the proper URL, including Interchange session tags. Used as the ACTION value for the search form if the results are to be targeted to a different window than the one set by SearchFrame (which is "_self" by default).
-
H1: Sorting
Interchange has standard sorting options for sorting the search lists, loop lists, and item lists based on the contents of database fields. In addition, it adds list slices for limiting the displayed entries based on a start value and chunk size (or start and end value, from which a chunk size is determined). All accept a standard format sort tag which must be directly after the list call:
@@ -2665,7 +2661,7 @@
[userdb function=login]
[/set]
- <FORM ACTION="[process-target]" METHOD=POST>
+ <FORM ACTION="[process]" METHOD=POST>
<INPUT TYPE=hidden NAME=mv_click VALUE=Login>
Username <INPUT NAME=mv_username SIZE=10>
Password <INPUT NAME=mv_password SIZE=10>
@@ -3025,7 +3021,7 @@
By default, they are placed in the variable C<address_book>. Here is a little snippet that builds a select box:
!block example
- <FORM ACTION="[process-target]" METHOD=POST>
+ <FORM ACTION="[process]" METHOD=POST>
[userdb function=get_shipping_names]
[if value address_book]
<SELECT NAME="s_nickname">
@@ -3211,13 +3207,13 @@
H1: Tracking and Back-End Order Entry
-Interchange allows the entry of orders into a system through one of several methods. The C<AsciiBackend> capability allows submission of parameters to an external order entry script. Support for SQL allows the entry of orders directly into an SQL database. Orders can be written to an ASCII file. They can be formatted precisely for e-mail-based systems. The orders can be placed in a DBM file. Finally, embedded Perl allows completely flexible order entry, including real-time credit card verification and settlement.
+Interchange allows the entry of orders into a system through one of several methods. Orders can be written to an ASCII file or formatted precisely for email-based systems. Or they can go directly into an SQL or DBM database. Finally, embedded Perl allows completely flexible order entry, including real-time credit card verification and settlement.
H2: ASCII Backup Order Tracking
-If C<AsciiTrack> is set to a legal file name (based in VendRoot unless it has a leading "/"). A copy of the order is saved and sent in an e-mail.
+If C<AsciiTrack> is set to a legal file name (based in VendRoot unless it has a leading "/"), a copy of the order is saved and sent in an email.
-If the file name string begins with a pipe "|," a program will be run and the output "piped" to that program. This allows easy back-end entry of orders with an external program.
+If the file name string begins with a pipe "|", a program will be run and the output "piped" to that program. This allows easy back-end entry of orders with an external program.
H2: Database Tracking
@@ -3609,7 +3605,7 @@
Note[label='IMPORTANT NOTE: '] Interchange attempts to perform operations securely, but no guarantees or warranties of any kind are made! Since Interchange comes with source code, it is fairly easy to modify the program to create security problems. One way to minimize this possibility is to record digital signatures, using MD5 or PGP or GnuPG, of C<interchange>, C<interchange.cfg>, and all modules included in Interchange. Check them on a regular basis to ensure they have not been changed.
-Interchange uses the C<SecureURL> directive to set the base URL for secure transactions, and the C<VendURL> directive for normal non-secure transactions. Secure URLs can be enabled for forms through a form action of C<[process-target secure=1]>. An individual page can be displayed via SSL with C<[page href=mvstyle_pagename secure=1]>. A certain page can be set to be always secure with the C<AlwaysSecure> catalog.cfg directive.
+Interchange uses the C<SecureURL> directive to set the base URL for secure transactions, and the C<VendURL> directive for normal non-secure transactions. Secure URLs can be enabled for forms through a form action of C<[process secure=1]>. An individual page can be displayed via SSL with C<[page href=mvstyle_pagename secure=1]>. A certain page can be set to be always secure with the C<AlwaysSecure> catalog.cfg directive.
Interchange incorporates additional security for credit card numbers. The field C<mv_credit_card_number> will not ever be written to disk.
1.68 +10 -7 docs/ictags.sdf
rev 1.68, prev_rev 1.67
Index: ictags.sdf
===================================================================
RCS file: /var/cvs/docs/ictags.sdf,v
retrieving revision 1.67
retrieving revision 1.68
diff -u -u -r1.67 -r1.68
--- ictags.sdf 2001/11/27 17:15:44 1.67
+++ ictags.sdf 2001/12/06 03:27:27 1.68
@@ -1,10 +1,10 @@
!init OPT_LOOK="akopia"; OPT_STYLE="manual"
-# $Id: ictags.sdf,v 1.67 2001/11/27 17:15:44 jon Exp $
+# $Id: ictags.sdf,v 1.68 2001/12/06 03:27:27 jon Exp $
!define DOC_NAME "Interchange Tags Reference"
!define DOC_TYPE ""
!define DOC_CODE "ictags"
-!define DOC_VERSION substr('$Revision: 1.67 $', 11, -2)
+!define DOC_VERSION substr('$Revision: 1.68 $', 11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://interchange.redhat.com/doc/ictags.html"
@@ -9021,7 +9021,7 @@
the item-code/SKU and use the C<refresh> N<action:>
!block example
- <FORM ACTION="[process-target]" METHOD=POST>
+ <FORM ACTION="[process]" METHOD=POST>
<INPUT TYPE=hidden NAME="mv_todo" VALUE="refresh">
<INPUT TYPE=hidden NAME="mv_order_item" VALUE="[[EXAMPLE_SKU]]">
@@ -9034,7 +9034,7 @@
Groups of items may be batched:
!block example
- <FORM ACTION="[process-target]" METHOD=POST>
+ <FORM ACTION="[process]" METHOD=POST>
<INPUT TYPE=hidden NAME="mv_todo" VALUE="refresh">
<INPUT TYPE=hidden NAME="mv_order_item" VALUE="TK112">
@@ -9944,7 +9944,7 @@
H2: process
-This is a shortcut for the 'process' action, expanding to your catalog URL and session ID. It is analogous to the {{C[jump="#area"]area}} tag, but is more limited. The following expansion is N<illuastrative:>
+This is a shortcut for the 'process' action, expanding to your catalog URL and session ID. It is analogous to the {{C[jump="#area"]area}} tag for the 'process' page, but is more limited. The following expansion is N<illustrative:>
!block example
[process target=targetframe]
@@ -9961,7 +9961,7 @@
<A HREF="[process target=targetframe]">...
!endblock
-N:Alias: B<process_target>
+N:Aliases: B<process_target>, B<process_order>
H3: Summary
@@ -10016,8 +10016,11 @@
!endblock
+H2: process_search
+This is an exact alias for [area search].
+
H2: query
Passes SQL statements through to SQL databases, or allows SQL queries
@@ -13975,7 +13978,7 @@
> [userdb function=login]
> [/set]
>
-> <FORM ACTION="[process-target]" METHOD=POST>
+> <FORM ACTION="[process]" METHOD=POST>
> <INPUT TYPE=hidden NAME=mv_click VALUE=Login>
> Username <INPUT NAME=mv_username SIZE=10>
> Password <INPUT NAME=mv_password SIZE=10>
1.28 +4 -4 docs/ictemplates.sdf
rev 1.28, prev_rev 1.27
Index: ictemplates.sdf
===================================================================
RCS file: /var/cvs/docs/ictemplates.sdf,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -u -r1.27 -r1.28
--- ictemplates.sdf 2001/11/02 17:47:33 1.27
+++ ictemplates.sdf 2001/12/06 03:27:27 1.28
@@ -1,10 +1,10 @@
!init OPT_LOOK="akopia"; OPT_STYLE="manual"
-# $Id: ictemplates.sdf,v 1.27 2001/11/02 17:47:33 edl Exp $
+# $Id: ictemplates.sdf,v 1.28 2001/12/06 03:27:27 jon Exp $
!define DOC_NAME "Template Guide"
!define DOC_TYPE ""
!define DOC_CODE "ictemplates"
-!define DOC_VERSION substr('$Revision: 1.27 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.28 $',11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://interchange.redhat.com/doc/ictemplates.html"
@@ -2634,7 +2634,7 @@
Many Interchange variables can be "stacked," meaning they can have multiple values for the same variable name. As an example, to allow the user to order multiple items with one click, set up a form like this:
!block example
-<FORM METHOD=POST ACTION="[process-order]">
+<FORM METHOD=POST ACTION="[process]">
<input type=checkbox name="mv_order_item" value="M3243"> Item M3243
<input type=checkbox name="mv_order_item" value="M3244"> Item M3244
<input type=checkbox name="mv_order_item" value="M3245"> Item M3245
@@ -2648,7 +2648,7 @@
To place a "delete" checkbox on the shopping basket display:
!block example
-<FORM METHOD=POST ACTION="[process-order]">
+<FORM METHOD=POST ACTION="[process]">
[item-list]
<input type=checkbox name="[quantity-name]" value="0"> Delete
Part number: [item-code]