[interchange-docs] xmldocs - docelic modified 4 files
docs at icdevgroup.org
docs at icdevgroup.org
Mon Apr 10 18:14:48 EDT 2006
User: docelic
Date: 2006-04-10 22:14:47 GMT
Modified: files/tutorial-phase5 left
Modified: glossary price
Modified: guides iccattut.xml install.xml
Log:
- fixes for catalog tutorial (search-box related)
- small updates to install guide
- remove note about IC precompiling pricing information in price glossary
entry, as that is not really happening
Revision Changes Path
1.3 +3 -2 xmldocs/files/tutorial-phase5/left
rev 1.3, prev_rev 1.2
Index: left
===================================================================
RCS file: /var/cvs/xmldocs/files/tutorial-phase5/left,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- left 8 Aug 2004 21:04:25 -0000 1.2
+++ left 10 Apr 2006 22:14:47 -0000 1.3
@@ -1,14 +1,15 @@
<tr>
<td align="center">
<form action="[area search]" method="post">
+ [form-session-id]
Search:<br>
[set testname]
su=yes
- fi=product
+ fi=products
sf=sk
sf=description
[/set]
- <input type="hidden" name="mv_profile" value="testname>"
+ <input type="hidden" name="mv_profile" value="testname">
<input type="text" name="mv_searchspec" size="15" value="">
</form>
<hr>
1.3 +34 -26 xmldocs/glossary/price
rev 1.3, prev_rev 1.2
Index: price
===================================================================
RCS file: /var/cvs/xmldocs/glossary/price,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- price 1 Feb 2005 21:33:12 -0000 1.2
+++ price 10 Apr 2006 22:14:47 -0000 1.3
@@ -9,11 +9,6 @@
description columns using &conf-PriceField; and &conf-DescriptionField;
directives.
</para>
-<para>
-To optimize for speed, &IC; precomputes some pricing information at
-startup (or catalog configuration time actually), so you need to reconfigure
-the catalog if you change any of the pricing-related config directives.
-</para>
<section id="SimplePricing">
@@ -48,16 +43,17 @@
<itemizedlist>
<listitem><para>
+<emphasis role='bold'>
If &conf-CommonAdjust; is set to <emphasis>any</emphasis> value (so, be it a
valid &CAs; or not), extended price
-adjustments are enabled
+adjustments are enabled</emphasis>
<!-- TODO clarify: It may also hold the default pricing scheme. -->
</para></listitem>
<listitem><para>
If the <database class='field'>price</database> field in the
<database>products</database> database contains a
-&CAs;, it takes
+&CAs; (or a non-empty, non-zero value), it takes
precedence over the default set with &conf-CommonAdjust;
</para></listitem>
@@ -65,7 +61,10 @@
If the value of the &conf-CommonAdjust; directive is set to a valid &CAs;,
and the <database class='field'>price</database> field is empty or
specifically <literal>0</literal>, then the &CAs;
-will be used to set the price of the item
+will be used to set the price of the item. An effective way to make
+the <database class='field'>price</database> field empty is to use
+the &conf-PriceField; directive to set field name to an invalid value, such as
+<literal>0</literal>, <literal>none</literal> or <literal>noprice</literal>.
</para></listitem>
<listitem><para>
@@ -117,11 +116,19 @@
<para>
Atom types are recognizable from the syntax used to define them.
-A chained atom ends with a comma. A fallback atom has a
-leading semi-colon. Final atoms have no comma appended or semi-colon prepended.
-Atoms themselves are separated by whitespace and may be quoted, although there
-should normally be no whitespace in a setting and therefore no quotes
-necessary.
+<itemizedlist>
+<listitem><para>
+Chained atom ends with a comma
+</para></listitem>
+<listitem><para>
+Fallback atom has a leading semi-colon
+</para></listitem>
+<listitem><para>
+Final atoms have no comma appended or semi-colon prepended
+</para></listitem>
+</itemizedlist>
+Atoms themselves are separated by whitespace and must be quoted if they
+themselves contain whitespace.
</para>
<para>
A <emphasis>settor</emphasis> is a mean by which the price is set. In other
@@ -173,11 +180,12 @@
<!-- TODO are settors able to yield new atoms, or only settors? -->
<listitem><para>
- <!-- TODO is 2-decimal places fixed here or can be any? -->
<literal>-</literal><emphasis role='bold'><replaceable>decimal</replaceable></emphasis>
</para><para>
- A number which is applied directly. For instance, a value of
- <literal>10</literal> will yield a price of <literal>10</literal>.
+ A number which is applied to the <emphasis>current</emphasis>
+ price value. For instance,
+ a price of <literal>10</literal> and settor of <literal>2</literal> result
+ in new current price of <literal>12</literal>.
May be a positive or negative decimal.
</para></listitem>
@@ -196,13 +204,14 @@
Causes a direct lookup in a database table. Table defaults to the
<database>products</database> database entry for the item (subject,
of course, to multiple <database>products</database> databases). Column
- argument must always be present, but you'd set it to
- <literal>price</literal> unless you changed &conf-PriceField; or have
- some interesting ideas in mind.
- <!-- TODO what means "key is item code except in attribute-based lookup?-->
- Key, of course, defaults to the item code (except in a special
- case of attribute-based lookup). The database value returned is treated
- as settor again, and is re-parsed accordingly.
+ argument must always be present, but you'd usually set it to
+ <literal>price</literal>. (That scheme is often used in combination with
+ setting &conf-PriceField; to something different of
+ <database class='field'>price</database>, because the
+ <database class='field'>price</database> field would take precedence
+ over the &CAs;).
+ The key defaults to the item &glos-SKU; (except in a special
+ case of attribute-based lookup).
</para></listitem>
<listitem><para>
@@ -261,12 +270,11 @@
block is passed to the equivalent of a &tag-calc; tag. However, no &IC; tags
<!-- TODO tag_data : elaborate how to set it -->
can be used in there. Even so, your <function>tag_data</function> routine
- <emphasis>is</emphasis> available, the current price and quantity are
- available inside the <varname>$s</varname> hash reference, and
+ <emphasis>is</emphasis> available, the <emphasis>current</emphasis> price is
+ available in variable <varname>$s</varname>, and
the current item details (code, quantity, price, and any attributes) are
available inside the <varname>$item</varname> hashref. All are found
in package <classname>Vend::Interpolate</classname>.
- <!-- TODO see this for myself and show Dumper output of the hash -->
</para>
<para>
That said,
1.36 +2 -1 xmldocs/guides/iccattut.xml
rev 1.36, prev_rev 1.35
Index: iccattut.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/iccattut.xml,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -r1.35 -r1.36
--- iccattut.xml 5 Feb 2006 13:17:15 -0000 1.35
+++ iccattut.xml 10 Apr 2006 22:14:47 -0000 1.36
@@ -1117,10 +1117,11 @@
<td align="center">
- __DISPLAYDATE__
+ <form action="[area search]" method="post">
++ [form-session-id]
+ Search:<br>
+ [set testname]
+ su=yes
-+ fi=product
++ fi=products
+ sf=sk
+ sf=description
+ [/set]
1.3 +6 -4 xmldocs/guides/install.xml
rev 1.3, prev_rev 1.2
Index: install.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/install.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- install.xml 9 Apr 2006 00:20:04 -0000 1.2
+++ install.xml 10 Apr 2006 22:14:47 -0000 1.3
@@ -6,7 +6,7 @@
<article id='install'>
<articleinfo>
- <title>Interchange Guides: the Installation</title>
+ <title>Interchange Guides: Installation</title>
<titleabbrev>install</titleabbrev>
<copyright>
@@ -156,8 +156,8 @@
suggested). Since the link program does not contain anything specific
to the &IC; catalog it is used by, you can probably get someone to compile
it for you, and then keep copying it around to new names for each of the
- catalogs (unless, of course, you want to modify link program settings
- such as socket file location or timeout value).
+ catalogs (unless, of course, you want to modify compile-time link
+ program setttings such as socket file location or timeout values).
</para>
</sect2>
@@ -242,7 +242,9 @@
</para>
<para>
For ultimate flexibility, it is a quite common approach to let every
- catalog user have its own instance of the &IC; server.
+ catalog user have its own instance of the &IC; server. In that case,
+ make sure you don't mix up different link programs, as they become
+ instance-specific at compile time.
</para>
</sect2>
More information about the docs
mailing list