[interchange-docs] xmldocs - docelic modified 12 files
docs at icdevgroup.org
docs at icdevgroup.org
Sat May 17 21:44:39 UTC 2008
User: docelic
Date: 2008-05-17 21:44:39 GMT
Modified: glossary configuration
Modified: guides index.xml search.xml
Modified: refs CodeDef External ExternalExport ExternalFile
Modified: length.ordercheck no_negative_tax
Modified: pay-cert-redeem.tag pay-cert.tag
Added: glossary external
Log:
* External* documented
* some work on Search guide
* updates/fixes here and there
Revision Changes Path
1.8 xmldocs/glossary/configuration
rev 1.8, prev_rev 1.7
Index: configuration
===================================================================
RCS file: /var/cvs/xmldocs/glossary/configuration,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- configuration 29 Jan 2008 20:48:51 -0000 1.7
+++ configuration 17 May 2008 21:44:39 -0000 1.8
@@ -132,18 +132,18 @@
ParseVariables No
-# Will print: Our greeting is: __HELLO__
Message Our greeting is: __HELLO__
+# Will print: Our greeting is: __HELLO__
<ParseVariables Yes>
-# Will print: Our greeting is the shiny Hello World!
Message Our greeting is the shiny __HELLO__
+# Will print: Our greeting is the shiny Hello World!
</ParseVariables>
-# Will print: Our greeting is back to: __HELLO__
Message Our greeting is back to: __HELLO__
+# Will print: Our greeting is back to: __HELLO__
</programlisting>
</section>
1.1 xmldocs/glossary/external
rev 1.1, prev_rev 1.0
Index: external
===================================================================
The set of &glos-configuration; directives prefixed "External" allows
export of Interchange variables for use by other programs and languages,
such as PHP, Ruby or Python.
</para><para>
The three directives are &conf-External;, &conf-ExternalFile; and
&conf-ExternalExport;.
</para><para>
The current functionality is just a proof of concept and is
not for serious use. The interface needs serious work.
</para><para>
A working example for accessing data from PHP is provided in the
&conf-External; reference page.
1.24 xmldocs/guides/index.xml
rev 1.24, prev_rev 1.23
Index: index.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/index.xml,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- index.xml 30 Apr 2008 22:20:27 -0000 1.23
+++ index.xml 17 May 2008 21:44:39 -0000 1.24
@@ -330,7 +330,7 @@
</para>
<para role="copyright">
- Copyright 2005-2007 <ulink url='http://www.icdevgroup.org/'>Interchange Development Group (http://www.icdevgroup.org/)</ulink>, Davor Ocelic, <ulink url='mailto:docelic+icdevgroup.org'>(docelic+icdevgroup.org)</ulink>
+ Copyright 2005-2008 <ulink url='http://www.icdevgroup.org/'>Interchange Development Group (http://www.icdevgroup.org/)</ulink>, Davor Ocelic, <ulink url='mailto:docelic+icdevgroup.org'>(docelic+icdevgroup.org)</ulink>
</para>
<para>
1.23 xmldocs/guides/search.xml
rev 1.23, prev_rev 1.22
Index: search.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/search.xml,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- search.xml 20 Aug 2007 18:37:38 -0000 1.22
+++ search.xml 17 May 2008 21:44:39 -0000 1.23
@@ -138,15 +138,16 @@
<title>Configuration File Examples</title>
<para>
Indexing web sites is pretty easy. Swish provides a spider script, which is
-simply called with the parameters <literal>default</literal> and the starting
-URL. Create a configuration file similar to the following:
+simply called with the parameters <literal>default
+<replaceable>starting_URL</replaceable></literal>. Create a configuration
+file similar to the following:
<programlisting>
IndexFile db/icdevgroup
IndexDir /usr/local/lib/swish-e/spider.pl
SwishProgParameters default http://www.icdevgroup.org/docs/
</programlisting>
Now you can start indexing with <literal>swish-e -S prog -c
-icdevgroup.conf</literal>.
+<replaceable>icdevgroup.conf</replaceable></literal>.
</para>
</section>
</section>
@@ -165,16 +166,24 @@
<section id="mv_base_directory"><title>
<literal>bd — mv_base_directory</literal></title><cmdsynopsis>
(<replaceable>directory_name</replaceable>,
- default Interchange installation directory)</cmdsynopsis><para>
+ default &conf-ProductDir;)</cmdsynopsis><para>
base directory in which to look up text files to search
(related option <literal>fi</literal>).
+ </para><para>
+ Directory paths can be absolute, provided that the pathname is
+ equal to the <varname>MV_SEARCH_FILE</varname> &glos-variable;, or
+ a &glos-scratch; variable of the same name is 1.
+ To enable searching in say,
+ <filename class='directory'>/etc/dict</filename>, use either
+ <code>[calcn]$Variable->{MV_SEARCH_FILE} =
+ '/etc/dict'; return[/calcn]</code> or
+ <code>[tmp /etc/dict]1[/tmp]</code>.
</para>
</section>
<section id="mv_begin_string"><title>
<literal>bs — mv_begin_string</literal></title><cmdsynopsis>
- (<replaceable>regular_expression</replaceable>,
- default none)</cmdsynopsis><para>
- &glos-regexp; that the beginning of the searched field value must match.
+ (1/0, default false)</cmdsynopsis><para>
+ the search string matches only at the beginning of a column.
</para>
</section>
<section id="mv_cache_key"><title>
@@ -186,6 +195,20 @@
reference.
</para>
</section>
+ <section id="mv_case"><title>
+ <literal>cs — mv_case</literal></title><cmdsynopsis>
+ (<literal>0</literal>/<literal>1</literal>,
+ default <literal>0</literal>)</cmdsynopsis><para>
+ case sensitive search.
+ </para>
+ </section>
+ <section id="mv_column_op"><title>
+ <literal>op — mv_column_op</literal></title><cmdsynopsis>
+ (<literal></literal>/<literal></literal>,
+ default <literal></literal>)</cmdsynopsis><para>
+ operation to perform to check field for a match.
+ </para>
+ </section>
<section id="mv_coordinate"><title>
<literal>co — mv_coordinate</literal></title><cmdsynopsis>
(<literal>0</literal>/<literal>1</literal>,
@@ -225,13 +248,6 @@
</itemizedlist>
</para>
</section>
- <section id="mv_case"><title>
- <literal>cs — mv_case</literal></title><cmdsynopsis>
- (<literal>0</literal>/<literal>1</literal>,
- default <literal>0</literal>)</cmdsynopsis><para>
- case sensitive search.
- </para>
- </section>
<section id="mv_verbatim_columns"><title>
<literal>cv — mv_verbatim_columns</literal></title><cmdsynopsis>
(<literal></literal>/<literal></literal>,
@@ -250,7 +266,8 @@
<literal>df — mv_dict_fold</literal></title><cmdsynopsis>
(<literal></literal>/<literal></literal>,
default <literal></literal>)</cmdsynopsis><para>
-
+ Make dictionary matching case-insensitive. Ignored unless
+ <mv>mv_dict_look</mv> is set.
</para>
</section>
<section id="mv_dict_limit"><title>
@@ -278,7 +295,9 @@
<literal>do — mv_dict_order</literal></title><cmdsynopsis>
(<literal></literal>/<literal></literal>,
default <literal></literal>)</cmdsynopsis><para>
-
+ Make dictionary matching follow dictionary order, where only word
+ characters and whitespace matter.
+ Ignored unless <mv>mv_dict_look</mv> is set.
</para>
</section>
<section id="mv_record_delim"><title>
@@ -295,7 +314,8 @@
default <literal>0</literal>)</cmdsynopsis><para>
require that search field matches the search specification exactly
(as opposed to the default word-based matching, or substring matching
- with <literal>su</literal>).
+ with <literal>su</literal>). Search specification will behave as it
+ was enclosed in quotes.
</para>
</section>
<section id="mv_spelling_errors"><title>
@@ -319,8 +339,8 @@
<section id="mv_search_file"><title>
<literal>fi — mv_search_file</literal></title><cmdsynopsis>
(<literal></literal>/<literal></literal>,
- default <literal></literal>)</cmdsynopsis><para>
-
+ default all &conf-ProductFiles; tables)</cmdsynopsis><para>
+ tables and/or text files to be searched.
</para>
</section>
<section id="mv_field_title"><title>
@@ -376,9 +396,10 @@
</section>
<section id="mv_like_field"><title>
<literal>lf — mv_like_field</literal></title><cmdsynopsis>
- (<literal></literal>/<literal></literal>,
- default <literal></literal>)</cmdsynopsis><para>
-
+ (<literal><replaceable>field_name</replaceable></literal>,
+ default none)</cmdsynopsis><para>
+ perform search similar to &glos-SQL; "LIKE" functionality.
+ When defined, <mv>mv_like_spec</mv> is required as well.
</para>
</section>
<section id="mv_list_only"><title>
@@ -397,9 +418,11 @@
</section>
<section id="mv_like_spec"><title>
<literal>ls — mv_like_spec</literal></title><cmdsynopsis>
- (<literal></literal>/<literal></literal>,
- default <literal></literal>)</cmdsynopsis><para>
-
+ (<literal><replaceable>search_specification</replaceable></literal>,
+ default none)</cmdsynopsis><para>
+ string to search for in <mv>mv_like_field</mv>.
+ The behaviour of the <literal>%</literal> character and case-sensitivity
+ depends upon your &glos-SQL; implementation.
</para>
</section>
<section id="mv_more_alpha"><title>
@@ -468,9 +491,9 @@
</section>
<section id="mv_min_string"><title>
<literal>ms — mv_min_string</literal></title><cmdsynopsis>
- (<literal></literal>/<literal></literal>,
- default <literal></literal>)</cmdsynopsis><para>
-
+ (<literal><replaceable>min_length</replaceable></literal>,
+ default <literal>1</literal> for text-based searches)</cmdsynopsis><para>
+ minimum size of a search string for a search operation.
</para>
</section>
<section id="mv_negate"><title>
@@ -517,16 +540,9 @@
</section>
<section id="mv_numeric"><title>
<literal>nu — mv_numeric</literal></title><cmdsynopsis>
- (<literal></literal>/<literal></literal>,
- default <literal></literal>)</cmdsynopsis><para>
-
- </para>
- </section>
- <section id="mv_column_op"><title>
- <literal>op — mv_column_op</literal></title><cmdsynopsis>
- (<literal></literal>/<literal></literal>,
- default <literal></literal>)</cmdsynopsis><para>
-
+ (1/0,
+ default 0)</cmdsynopsis><para>
+ search operator will perform numeric (instead of string) comparison.
</para>
</section>
<section id="mv_orsearch"><title>
@@ -545,9 +561,10 @@
</section>
<section id="mv_return_all"><title>
<literal>ra — mv_return_all</literal></title><cmdsynopsis>
- (<literal></literal>/<literal></literal>,
- default <literal></literal>)</cmdsynopsis><para>
-
+ (1/0,
+ default 0)</cmdsynopsis><para>
+ return all records
+ <!-- XXX how? ignoring searchspec? -->
</para>
</section>
<section id="mv_return_delim"><title>
@@ -609,9 +626,11 @@
</section>
<section id="mv_return_spec"><title>
<literal>rs — mv_return_spec</literal></title><cmdsynopsis>
- (<literal></literal>/<literal></literal>,
- default <literal></literal>)</cmdsynopsis><para>
-
+ (1/0,
+ default 0)</cmdsynopsis><para>
+ the one and only match from the search will be the value of the
+ <mv>mv_searchspec</mv> itself. Useful in testing, or yes/no
+ confirmation whether the search string was found
</para>
</section>
<section id="mv_range_max"><title>
1.9 xmldocs/refs/CodeDef
rev 1.9, prev_rev 1.8
Index: CodeDef
===================================================================
RCS file: /var/cvs/xmldocs/refs/CodeDef,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- CodeDef 14 Nov 2007 13:18:38 -0000 1.8
+++ CodeDef 17 May 2008 21:44:39 -0000 1.9
@@ -31,6 +31,7 @@
&glos-form-action;s,
&conf-GlobalSub;s,
ItemActions,
+SearchOps,
LocaleChanges,
OrderChecks,
and Widgets.
1.3 xmldocs/refs/External
rev 1.3, prev_rev 1.2
Index: External
===================================================================
RCS file: /var/cvs/xmldocs/refs/External,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- External 6 Nov 2006 18:41:20 -0000 1.2
+++ External 17 May 2008 21:44:39 -0000 1.3
@@ -1,4 +1,5 @@
__NAME__ purpose
+enable dump of selected global and catalog values for use by external programs
__END__
@@ -9,20 +10,104 @@
</group>
__END__
-
__NAME__ description
+The directive enables dump of selected global and catalog information for
+use by external programs, possibly written in languages such as PHP, Python
+or Ruby.
+</para><para>
+Dump file format is a direct &PERL; memory dump, internally most often
+produced by invoking Perl's <classname>Storable</classname> methods.
+</para><para>
+The dump takes place at time of &glos-catalog; (re)configuration.
+</para><para>
+Global &conf-External; must be enabled first to allow individual catalogs
+to use &conf-External; themselves and dump their information.
__END__
__NAME__ notes
-The global &conf-External; must be enabled to allow individual catalog setting.
+For discussion and examples of connecting Interchange to external programs,
+see glossary entry &glos-external;.
__END__
__NAME__ example: Defining External
+Put the following in both global &gcf; and the specific
+&ccf;s:
<programlisting>
External yes
</programlisting>
__END__
-__NAME__ missing
-What is it
+__NAME__ example: PHP connector for accessing the structure file
+<programlisting><![CDATA[
+<?php
+
+$interchange_base = '/usr/lib/interchange';
+$interchange_lib = "$interchange_base/lib";
+$interchange_struct = "/var/run/interchange/external.structure";
+
+putenv("PERL_SIGNALS=unsafe");
+umask(7);
+
+$perl = new Perl();
+
+$perlstring = "
+ use lib '$interchange_lib';
+ \$ENV{EXT_INTERCHANGE_FILE} = '$interchange_struct';
+ \$ENV{EXT_INTERCHANGE_DIR} = '$interchange_base';
+";
+$perl->eval($perlstring);
+$perl->require("Vend/External.pm");
+
+$origsid = $sid = $_COOKIE["MV_SESSION_ID"];
+
+if(! $sid) {
+ $_REQUEST["mv_session_id"];
+}
+$cat = 'standard';
+$catback = $perl->catalog($cat);
+
+$out = "sid=$sid<br>";
+$out .= "parm is debug=" . $_REQUEST["debug"] . "<br>";
+$out .= "catalog is $catback<br>";
+$out .= "now sid=$sid<br>";
+$remote = $_SERVER['REMOTE_ADDR'];
+
+$perl->remote_addr($remote);
+$new = $perl->session($sid);
+
+if($new) {
+ $sid = $perl->session_name();
+ $out .= "new session, now sid=$sid<br>";
+}
+
+if($sid != $origsid) {
+ setcookie('MV_SESSION_ID', $sid, 0 , '/');
+}
+
+## Can print now that cookie is set
+print $out;
+
+$fname = $perl->value("values","fname");
+$lname = $perl->value("values","lname");
+print "Well what do you know, we have a '$fname $lname'!<br>";
+$cart = $perl->value('carts', 'main');
+$nitems = count($cart);
+if($nitems) {
+ print "We have a cart with $nitems items</br>";
+ for($i = 0; $i < $nitems; $i++) {
+ $code = $cart[$i]["code"];
+ $quantity = $cart[$i]["quantity"];
+ print "Item $code is in cart, quantity $quantity.<br>";
+ }
+}
+?>
+]]></programlisting>
+__END__
+
+__NAME__ see also
+ExternalFile, ExternalExport
+__END__
+
+__NAME__ author
+&mheins;
__END__
1.2 xmldocs/refs/ExternalExport
rev 1.2, prev_rev 1.1
Index: ExternalExport
===================================================================
RCS file: /var/cvs/xmldocs/refs/ExternalExport,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ExternalExport 6 Nov 2006 22:04:40 -0000 1.1
+++ ExternalExport 17 May 2008 21:44:39 -0000 1.2
@@ -1,5 +1,101 @@
+__NAME__ purpose
+specify Perl variables to dump to external file
+__END__
+
+__NAME__ see also
+External, ExternalFile
+__END__
+
+__NAME__ synopsis
+Global: <arg choice='plain' rep='repeat'><replaceable>Interchange::Object</replaceable>=<replaceable>Output_name</replaceable></arg><sbr/>
+Catalog: <arg choice='plain' rep='repeat'><replaceable>Object</replaceable><arg choice='opt'>-><replaceable>key_or_index</replaceable></arg></arg>
+__END__
-__NAME__ missing
-All
+__NAME__ description
+The directive specifies &PERL; variables to dump to &conf-ExternalFile;.
+</para><para>
+On global level, using the equal sign ("<literal>=</literal>") it is possible
+to specify original Perl structure and the resulting "translated" name in the
+output file. Global elements appear directly under each catalog hash in the
+output file.
+</para><para>
+On catalog level, it is not possible to "translate" names, but you can use
+the notation "<literal>-></literal>" to dump specific elements from array
+or hash structures. Catalog elements appear under hash key
+"<literal>external_config</literal>" under each catalog hash in the
+output file.
+</para><para>
+See <xref linkend="ExternalExport_examples"/> for clarification.
__END__
+__NAME__ notes
+For discussion and examples of connecting Interchange to external programs,
+see glossary entry &glos-external;.
+__END__
+
+__NAME__ example: Defining __FILENAME__
+Here's a complete example and the expected result:
+</para><para>
+In &gcf;:
+<programlisting>
+External yes
+ExternalExport Global::Catalog=number_of_catalogs
+ExternalFile /tmp/external
+</programlisting>
+In &ccf;:
+<programlisting><![CDATA[
+External yes
+ExternalExport <<EOD
+ CatalogName
+ ScratchDefault
+ ValuesDefault
+ ScratchDir
+ SessionDB
+ Sess
+ sionDatabase
+ SessionExpire
+ VendRoot
+ VendURL
+ SecureURL
+ Variable->SQLDSN
+ Variable->SQLPASS
+ Variable->SQLUSER
+EOD
+]]></programlisting>
+After restarting Interchange, file <filename>/tmp/external</filename> will
+be created with the following contents:
+<programlisting><![CDATA[
+{
+ 'number_of_catalogs' => 4,
+ 'Catalogs' => {
+ 'catalog1' => {
+ 'external_config' => {
+ 'VendRoot' => '/home/interchange/catalog1',
+ 'ValuesDefault' => {},
+ 'CatalogName' => 'catalog1',
+ 'SessionExpire' => 3600,
+ 'ScratchDefault' => {
+ 'mv_no_session_id' => '1',
+ 'mv_no_count' => '1',
+ 'mv_add_dot_html' => '1'
+ },
+ 'SessionDB' => '',
+ 'ScratchDir' => '/home/interchange/catalog1/tmp',
+ 'VendURL' => 'http://myhost.mydomain.local/cgi-bin/catalog1',
+ 'SessionDatabase' => '/home/interchange/catalog1/session',
+ 'SecureURL' => 'http://myhost.mydomain.local/cgi-bin/catalog1',
+ 'Variable' => {
+ 'SQLUSER' => 'interch',
+ 'SQLDSN' => 'dbi:Pg:dbname=catalog1',
+ 'SQLPASS' => 'interch'
+ }
+ }
+ }
+ }
+}
+]]></programlisting>
+__END__
+
+__NAME__ author
+&mheins;
+__END__
1.2 xmldocs/refs/ExternalFile
rev 1.2, prev_rev 1.1
Index: ExternalFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/ExternalFile,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ExternalFile 6 Nov 2006 22:04:40 -0000 1.1
+++ ExternalFile 17 May 2008 21:44:39 -0000 1.2
@@ -1,4 +1,37 @@
+__NAME__ purpose
+specify external dump filename
+__END__
+
+__NAME__ synopsis
+<arg choice='plain'><replaceable>filename</replaceable></arg>
+__END__
+
-__NAME__ missing
-All
+__NAME__ description
+Specify "external" output filename. Default is
+<filename>external.structure</filename> in global &conf-RunDir;.
+</para><para>
+For the directive to have any effect, &conf-External; must be enabled.
__END__
+
+__NAME__ notes
+For discussion and examples of connecting Interchange to external programs,
+see glossary entry &glos-external;.
+__END__
+
+__NAME__ example: Setting __FILENAME__
+In &gcf;:
+<programlisting>
+External yes
+ExternalFile /tmp/external
+</programlisting>
+__END__
+
+__NAME__ see also
+External, ExternalExport
+__END__
+
+__NAME__ author
+&mheins;
+__END__
+
1.2 xmldocs/refs/length.ordercheck
rev 1.2, prev_rev 1.1
Index: length.ordercheck
===================================================================
RCS file: /var/cvs/xmldocs/refs/length.ordercheck,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- length.ordercheck 13 Mar 2008 14:03:35 -0000 1.1
+++ length.ordercheck 17 May 2008 21:44:39 -0000 1.2
@@ -1,5 +1,5 @@
__NAME__ purpose
-check string length
+string is within specified length limits
__END__
__NAME__ description
@@ -10,4 +10,4 @@
<programlisting>
username=length 6-32 Size limits exceeded (6-32 characters)
</programlisting>
-__END__
\ No newline at end of file
+__END__
1.2 xmldocs/refs/no_negative_tax
rev 1.2, prev_rev 1.1
Index: no_negative_tax
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_negative_tax,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- no_negative_tax 23 Jan 2008 21:12:24 -0000 1.1
+++ no_negative_tax 17 May 2008 21:44:39 -0000 1.2
@@ -29,3 +29,7 @@
</programlisting>
__END__
+__NAME__ see also
+&glos-tax;
+__END__
+
1.2 xmldocs/refs/pay-cert-redeem.tag
rev 1.2, prev_rev 1.1
Index: pay-cert-redeem.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/pay-cert-redeem.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- pay-cert-redeem.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ pay-cert-redeem.tag 17 May 2008 21:44:39 -0000 1.2
@@ -2,6 +2,25 @@
<row>
<entry>
+ certs
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
table
</entry>
<entry>
@@ -11,7 +30,7 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ <literal>pay_certs</literal>
</entry>
<entry>
<!-- DSC -->
@@ -96,4 +115,4 @@
</row>
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
1.2 xmldocs/refs/pay-cert.tag
rev 1.2, prev_rev 1.1
Index: pay-cert.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/pay-cert.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- pay-cert.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ pay-cert.tag 17 May 2008 21:44:39 -0000 1.2
@@ -2,32 +2,13 @@
<row>
<entry>
- code_scratch
- </entry>
- <entry>
- <!-- POS -->
- </entry>
- <entry>
- <!-- REQ -->
- </entry>
- <entry>
- <!-- DFL -->
- </entry>
- <entry>
- <!-- DSC -->
- </entry>
-
-</row>
-<row>
-
- <entry>
- check_scratch
+ code
</entry>
<entry>
- <!-- POS -->
+ Yes
</entry>
<entry>
- <!-- REQ -->
+ Yes if <literal>auth</literal>=&glos-true;
</entry>
<entry>
<!-- DFL -->
@@ -40,7 +21,7 @@
<row>
<entry>
- order_number
+ code_scratch
</entry>
<entry>
<!-- POS -->
@@ -59,7 +40,7 @@
<row>
<entry>
- transaction
+ check_scratch
</entry>
<entry>
<!-- POS -->
@@ -78,13 +59,13 @@
<row>
<entry>
- issue
+ order_number
</entry>
<entry>
<!-- POS -->
</entry>
<entry>
- <!-- REQ -->
+ Yes if <literal>issue</literal>=&glos-true;
</entry>
<entry>
<!-- DFL -->
@@ -97,7 +78,7 @@
<row>
<entry>
- amount
+ transaction
</entry>
<entry>
<!-- POS -->
@@ -116,7 +97,7 @@
<row>
<entry>
- expires
+ issue
</entry>
<entry>
<!-- POS -->
@@ -125,36 +106,40 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ 0
</entry>
<entry>
- <!-- DSC -->
+ Issue (create) the gift certificate?
</entry>
</row>
<row>
<entry>
- expire
+ amount
</entry>
<entry>
<!-- POS -->
</entry>
<entry>
- <!-- REQ -->
+ Yes if <literal>issue</literal>=&glos-true;
</entry>
<entry>
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ Gift certificate amount.
</entry>
</row>
<row>
<entry>
- expiration
+ <group choice='plain'>
+ <arg choice='plain'>expires</arg>
+ <arg choice='plain'>expire</arg>
+ <arg choice='plain'>expiration</arg>
+ </group>
</entry>
<entry>
<!-- POS -->
@@ -166,7 +151,13 @@
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ Validity period, specified as one of <replaceable>X<replaceable>
+ <literal>y</literal>(ears),
+ <literal>mon</literal>(ths),
+ <literal>m</literal>(inutes),
+ <literal>h</literal>(ours),
+ <literal>d</literal>(ays) or
+ <literal>w</literal>(eeks).
</entry>
</row>
@@ -182,10 +173,10 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ Do not issue a <literal>MV_GIFT_CERT_CODE<literal> cookie to the
+ client's browser?
</entry>
</row>
@@ -362,4 +353,4 @@
</row>
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
More information about the docs
mailing list