[interchange-docs] xmldocs - docelic modified 14 files
docs at icdevgroup.org
docs at icdevgroup.org
Tue Jun 26 20:02:32 EDT 2007
User: docelic
Date: 2007-06-27 00:02:31 GMT
Modified: refs AccumulateCode ActionMap AddDirective AdminSub
Modified: AdminUser AliasTable AsciiTrack AutoModifier
Modified: DiscountSpacesOn RobotHost RobotIP RobotUA
Modified: interpolate_itl_references
Added: refs NotRobotUA
Log:
* Added docs for: DiscountSpacesOn RobotHost NotRobotUA
* The rest are small fixes
Revision Changes Path
1.6 +0 -1 xmldocs/refs/AccumulateCode
rev 1.6, prev_rev 1.5
Index: AccumulateCode
===================================================================
RCS file: /var/cvs/xmldocs/refs/AccumulateCode,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- AccumulateCode 19 Oct 2006 19:29:54 -0000 1.5
+++ AccumulateCode 27 Jun 2007 00:02:31 -0000 1.6
@@ -52,6 +52,5 @@
<programlisting>
AccumulateCode Yes
</programlisting>
-See &conf-CodeRepository; for a complete example.
__END__
1.6 +1 -1 xmldocs/refs/ActionMap
rev 1.6, prev_rev 1.5
Index: ActionMap
===================================================================
RCS file: /var/cvs/xmldocs/refs/ActionMap,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ActionMap 19 Oct 2006 19:29:54 -0000 1.5
+++ ActionMap 27 Jun 2007 00:02:31 -0000 1.6
@@ -26,7 +26,7 @@
__END__
-__NAME__ example: Ignoring the Order action
+__NAME__ example: Replacing the Order action with a no-op
Put the following in &ccf;:
<programlisting>
ActionMap order sub { 1 }
1.6 +1 -1 xmldocs/refs/AddDirective
rev 1.6, prev_rev 1.5
Index: AddDirective
===================================================================
RCS file: /var/cvs/xmldocs/refs/AddDirective,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- AddDirective 19 Oct 2006 19:29:54 -0000 1.5
+++ AddDirective 27 Jun 2007 00:02:31 -0000 1.6
@@ -53,7 +53,7 @@
a boolean list, and not a true boolean value. The list achieves the effect
of being boolean by logically returning &glos-true; or &glos-false;,
depending on whether the searched item is present in the list or not.
-True boolean values are called <literal>yesno</literal>s in &IC; parlance.
+True boolean values are called "<literal>yesno</literal>"s in &IC; parlance.
</para><para>
Please see the &glos-configuration; glossary entry for a discussion
on config directives.
1.3 +3 -3 xmldocs/refs/AdminSub
rev 1.3, prev_rev 1.2
Index: AdminSub
===================================================================
RCS file: /var/cvs/xmldocs/refs/AdminSub,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AdminSub 12 Oct 2006 13:51:35 -0000 1.2
+++ AdminSub 27 Jun 2007 00:02:31 -0000 1.3
@@ -20,10 +20,10 @@
__NAME__ description
-Specify global subroutines that may only be used by &glos-catalogs; which are listed under
-the &conf-AllowGlobal; directive.
+Specify global subroutines that may only be used by &glos-catalog;s
+which are listed under the &conf-AllowGlobal; directive.
</para><para>
-Otherwise, in a normal course of action, global subroutines can be used
+Otherwise, in the default course of action, global subroutines can be used
by all catalogs.
__END__
1.4 +7 -3 xmldocs/refs/AdminUser
rev 1.4, prev_rev 1.3
Index: AdminUser
===================================================================
RCS file: /var/cvs/xmldocs/refs/AdminUser,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AdminUser 19 Oct 2006 19:29:54 -0000 1.3
+++ AdminUser 27 Jun 2007 00:02:31 -0000 1.4
@@ -2,14 +2,18 @@
usernames that are given full access to all catalogs, regardless of any permissions
__END__
-
__NAME__ synopsis
<arg choice='plain' rep='repeat'>
<replaceable>username</replaceable>:<replaceable>password</replaceable>
</arg>
__END__
-__NAME__ missing
-everything, see Util.pm
+__NAME__ description
+Username and password pairs for users which are given administrator
+privileges to all catalogs.
+</para><para>
+This functionality is standalone —
+you do not need to have the access &glos-database; since
+usernames and passwords here are specified directly.
__END__
1.4 +4 -4 xmldocs/refs/AliasTable
rev 1.4, prev_rev 1.3
Index: AliasTable
===================================================================
RCS file: /var/cvs/xmldocs/refs/AliasTable,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AliasTable 19 Oct 2006 19:29:54 -0000 1.3
+++ AliasTable 27 Jun 2007 00:02:31 -0000 1.4
@@ -11,7 +11,7 @@
__NAME__ description
The directive specifies Interchange &glos-database; that
contains page aliases (default database name is
-<literal>alias</literal>).
+<database>alias</database>).
</para><para>
This way, flypages can be aliased and redirected to different locations
without performing file lookup cycles.
@@ -37,10 +37,10 @@
<xi:include parse='text' href='../files/various/alias.txt'/>
</programlisting>
</para><para>
-&TAB_DELIMITED_NOTICE;
-</para><para>
-In our example database, page <literal>4595</literal>.html redirects
+In our example, page <literal>4595</literal>.html redirects
back to the index page.
+</para><para>
+&TAB_DELIMITED_NOTICE;
</para><para>
To minimize the chance of confusion, you can download properly composed
example file <ulink url="files/various/alias.txt">alias.txt</ulink>.
1.5 +1 -1 xmldocs/refs/AsciiTrack
rev 1.5, prev_rev 1.4
Index: AsciiTrack
===================================================================
RCS file: /var/cvs/xmldocs/refs/AsciiTrack,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- AsciiTrack 19 Oct 2006 19:29:54 -0000 1.4
+++ AsciiTrack 27 Jun 2007 00:02:31 -0000 1.5
@@ -17,7 +17,7 @@
__END__
__NAME__ notes
-If the &conf-Route; directive is set to <literal>supplant</literal>, this
+If the &conf-Route; directive is set to "<literal>supplant</literal>", this
directive is ignored.
__END__
1.9 +2 -2 xmldocs/refs/AutoModifier
rev 1.9, prev_rev 1.8
Index: AutoModifier
===================================================================
RCS file: /var/cvs/xmldocs/refs/AutoModifier,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- AutoModifier 19 Oct 2006 19:29:54 -0000 1.8
+++ AutoModifier 27 Jun 2007 00:02:31 -0000 1.9
@@ -36,7 +36,7 @@
fields in the <database>products</database> database.
</para><para>
This facility will often be employed in determining product
-&glos-price;, &glos-discount;, &glos-tax;, &glos-shipping; amd
+&glos-price;, &glos-discount;, &glos-tax; and &glos-shipping;, and
other custom attributes; these attributes will probably
be used in custom &PERL; code that will scan the electronic
&glos-cart; contents and perform some decisions. For example, by defining
@@ -49,7 +49,7 @@
__END__
-<!--
+<!-- TODO
This one has a bit of "magic" associated. To account for matrix-option
products, the various product tables are searched, for both the item
code and the base SKU associated with the item.
1.3 +28 -6 xmldocs/refs/DiscountSpacesOn
rev 1.3, prev_rev 1.2
Index: DiscountSpacesOn
===================================================================
RCS file: /var/cvs/xmldocs/refs/DiscountSpacesOn,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DiscountSpacesOn 6 Nov 2006 18:41:20 -0000 1.2
+++ DiscountSpacesOn 27 Jun 2007 00:02:31 -0000 1.3
@@ -1,9 +1,5 @@
__NAME__ purpose
-__END__
-
-
-__NAME__ see also
-DiscountSpaceVar
+enable "discount spaces" feature
__END__
__NAME__ synopsis
@@ -15,11 +11,37 @@
__NAME__ description
+This directive enables the "discount spaces" feature.
+</para><para>
+When &conf-DiscountSpacesOn; is enabled, then on a per-page
+before-&glos-autoload; basis, this routine initializes the
+current discount space to '<literal>main</literal>', and then checks
+all &glos-CGI; variables defined with the &conf-DiscountSpaceVar;
+configuration directive to see if an alternate discount space has
+been specified.
+</para><para>
+When &conf-DiscountSpacesOn; is not enabled, then the behavior is
+compatible to how it was before the feature was added to &IC; —
+all "discount space" functions become a no-operation; any attempts
+to specify an alternate discount space will have no effect, and will
+result in an error message in the &glos-catalog;'s error log.
+</para><para>
+See glossary entry &glos-discount; for a complete discussion.
__END__
-__NAME__ example: Defining DiscountSpacesOn
+__NAME__ example: Enabling DiscountSpacesOn
<programlisting>
DiscountSpacesOn Yes
</programlisting>
__END__
+__NAME__ notes
+__END__
+
+__NAME__ see also
+DiscountSpaceVar, discount
+__END__
+
+__NAME__ author
+ðan;
+__END__
1.3 +1 -1 xmldocs/refs/RobotHost
rev 1.3, prev_rev 1.2
Index: RobotHost
===================================================================
RCS file: /var/cvs/xmldocs/refs/RobotHost,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- RobotHost 6 Nov 2006 18:41:21 -0000 1.2
+++ RobotHost 27 Jun 2007 00:02:31 -0000 1.3
@@ -8,7 +8,7 @@
__END__
__NAME__ synopsis
-<arg choice='plain' rep='repeat'><replaceable>hostname</replaceable></arg>
+<arg choice='plain' rep='repeat'><replaceable>hostname_glob</replaceable></arg>
__END__
1.3 +3 -3 xmldocs/refs/RobotIP
rev 1.3, prev_rev 1.2
Index: RobotIP
===================================================================
RCS file: /var/cvs/xmldocs/refs/RobotIP,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- RobotIP 6 Nov 2006 18:41:21 -0000 1.2
+++ RobotIP 27 Jun 2007 00:02:31 -0000 1.3
@@ -1,5 +1,5 @@
__NAME__ purpose
-specify IP numbers or ranges that will be classified as crawler bots (search engines) visiting the site
+specify IP numbers or ranges that will be classified as crawler bots (search engines)
__END__
@@ -8,7 +8,7 @@
__END__
__NAME__ synopsis
-<arg choice='plain' rep='repeat'><replaceable>IP_address</replaceable></arg>
+<arg choice='plain' rep='repeat'><replaceable>IP_address_glob</replaceable></arg>
__END__
@@ -44,7 +44,7 @@
202.9.155.123, 204.152.191.41, 208.146.26.19,
208.146.26.233, 209.185.141.209, 209.185.141.211,
209.202.148.36, 209.202.148.41, 216.200.130.207,
- 216.35.103.6?, 216.35.103.70,
+ 216.35.103.6?, 216.35.103.*,
EOR
]]></programlisting>
__END__
1.3 +1 -1 xmldocs/refs/RobotUA
rev 1.3, prev_rev 1.2
Index: RobotUA
===================================================================
RCS file: /var/cvs/xmldocs/refs/RobotUA,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- RobotUA 6 Nov 2006 18:41:21 -0000 1.2
+++ RobotUA 27 Jun 2007 00:02:31 -0000 1.3
@@ -1,5 +1,5 @@
__NAME__ purpose
-specify user-agents that will be classified as crawler bots (search engines) visiting the site
+specify user-agents that will be classified as crawler bots (search engines)
__END__
1.4 +2 -0 xmldocs/refs/interpolate_itl_references
rev 1.4, prev_rev 1.3
Index: interpolate_itl_references
===================================================================
RCS file: /var/cvs/xmldocs/refs/interpolate_itl_references,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- interpolate_itl_references 6 Nov 2006 22:34:44 -0000 1.3
+++ interpolate_itl_references 27 Jun 2007 00:02:31 -0000 1.4
@@ -19,6 +19,8 @@
__NAME__ description
When the pragma is enabled, ITL interpolation of reference-based ITL attributes
is enabled.
+</para><para>
+In other words, suppose that you execute the following code:
__END__
1.1 xmldocs/refs/NotRobotUA
rev 1.1, prev_rev 1.0
Index: NotRobotUA
===================================================================
__NAME__ purpose
specify user-agents that will NOT be classified as crawler bots (search engines)
__END__
__NAME__ see also
RobotUA, RobotIP
__END__
__NAME__ synopsis
<arg choice='plain' rep='repeat'><replaceable>useragent_string</replaceable></arg>
__END__
__NAME__ description
The &conf-NotRobotUA; directive defines a list of useragent strings which will
<emphasis role='bold'>never</emphasis> be classified as crawler robots
(search engines) visiting the site.
</para><para>
This directive has priority over &conf-RobotUA;.
If the user agent matches &conf-NotRobotUA;, then the check for
&conf-RobotUA; is not performed and the client is not treated
as an unattended &glos-robot;.
__END__
__NAME__ notes
For more details regarding web spiders/bots and &IC;, see
&glos-robot; glossary entry.
</para><para>
For more details regarding user sessions, see &glos-session; glossary
entry.
__END__
__NAME__ example: Defining __FILENAME__
<programlisting><![CDATA[
__FILENAME__ <<EOR
*wget*
EOR
]]></programlisting>
__END__
More information about the docs
mailing list