[interchange-docs] xmldocs - docelic modified 18 files
docs at icdevgroup.org
docs at icdevgroup.org
Sat Aug 12 18:43:12 EDT 2006
User: docelic
Date: 2006-08-12 22:43:12 GMT
Modified: . TODO
Modified: bin refs-autogen
Modified: files/tutorial-phase2/pages flypage.html
Modified: files/tutorial-phase3/pages flypage.html index.html
Modified: files/tutorial-phase4/pages checkout.html flypage.html
Modified: index.html
Modified: files/tutorial-phase5/pages checkout.html flypage.html
Modified: index.html results.html
Modified: glossary database expire pragma
Modified: refs Pragma SpecialSub xml-generator
Log:
- files/*: xhtml compliance
- glossary/* and refs/*: updates to existing material
Revision Changes Path
1.92 +1 -0 xmldocs/TODO
rev 1.92, prev_rev 1.91
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.91
retrieving revision 1.92
diff -u -r1.91 -r1.92
--- TODO 30 Jul 2006 20:40:02 -0000 1.91
+++ TODO 12 Aug 2006 22:43:11 -0000 1.92
@@ -7,6 +7,7 @@
- aliases like DataDir/DefaultTables are not documented
- that howto entries get automatic title if start with < in first line
- unit testing
+- remove NEW from <meta>
Outstanding:
=======
1.112 +1 -3 xmldocs/bin/refs-autogen
rev 1.112, prev_rev 1.111
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.111
retrieving revision 1.112
diff -u -r1.111 -r1.112
--- refs-autogen 27 Jul 2006 20:48:14 -0000 1.111
+++ refs-autogen 12 Aug 2006 22:43:11 -0000 1.112
@@ -719,9 +719,7 @@
# DONE
$ag{latest} = $hash{version};
-# # Visually mark NEW (cvs-head) items . HEH, too bad this doesn't work.
-# DocBook strips non-text stuff when creating TOC entries. So under symbol
-# names you see a nice NEW icon, but in TOC that plain text looks very poor.
+# # Visually mark NEW (cvs-head) items .
if ( @{ $ag{'_available in'} } == 1 and
( ${$ag{'_available in'}}[0] eq $ENV{XMLDOCS_CUR_DEVEL} or
${$ag{'_available in'}}[0] eq 'cvs-head' )) {
1.2 +1 -1 xmldocs/files/tutorial-phase2/pages/flypage.html
rev 1.2, prev_rev 1.1
Index: flypage.html
===================================================================
RCS file: /var/cvs/xmldocs/files/tutorial-phase2/pages/flypage.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- flypage.html 11 Jul 2004 21:06:30 -0000 1.1
+++ flypage.html 12 Aug 2006 22:43:11 -0000 1.2
@@ -4,6 +4,6 @@
<h3>Test #[item-code]</h3>
<p>[item-field description] . . . [item-field price]</p>
-<br>
+<br/>
Return to the [page index]Index page</a>.
[include bottom]
1.2 +1 -1 xmldocs/files/tutorial-phase3/pages/flypage.html
rev 1.2, prev_rev 1.1
Index: flypage.html
===================================================================
RCS file: /var/cvs/xmldocs/files/tutorial-phase3/pages/flypage.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- flypage.html 11 Jul 2004 21:06:30 -0000 1.1
+++ flypage.html 12 Aug 2006 22:43:11 -0000 1.2
@@ -4,6 +4,6 @@
<h3>Test #[item-code]</h3>
<p>[item-field description] . . . [item-field price]</p>
-<br>
+<br/>
Return to the [page index]Index page</a>.
[include bottom]
1.5 +1 -1 xmldocs/files/tutorial-phase3/pages/index.html
rev 1.5, prev_rev 1.4
Index: index.html
===================================================================
RCS file: /var/cvs/xmldocs/files/tutorial-phase3/pages/index.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- index.html 20 Sep 2004 17:21:43 -0000 1.4
+++ index.html 12 Aug 2006 22:43:11 -0000 1.5
@@ -19,6 +19,6 @@
</tr>
[/loop]
</table>
-<hr>
+<hr/>
<p align=center>[page order]View shopping cart</a></p>
[include bottom]
1.2 +16 -16 xmldocs/files/tutorial-phase4/pages/checkout.html
rev 1.2, prev_rev 1.1
Index: checkout.html
===================================================================
RCS file: /var/cvs/xmldocs/files/tutorial-phase4/pages/checkout.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- checkout.html 11 Jul 2004 21:06:31 -0000 1.1
+++ checkout.html 12 Aug 2006 22:43:11 -0000 1.2
@@ -3,49 +3,49 @@
<h1>Checkout Page</h1>
<form method="post" action="[process]">
-<input type="hidden" name="mv_todo" value="submit">
-<input type="hidden" name="mv_order_profile" value="order_profile">
-<input type="hidden" name="mv_cyber_mode" value="minivend_test">
+<input type="hidden" name="mv_todo" value="submit" />
+<input type="hidden" name="mv_order_profile" value="order_profile" />
+<input type="hidden" name="mv_cyber_mode" value="minivend_test" />
<table cellpadding="3">
<tr>
<td align="right"><b>First name:</b></td>
-<td><input type="text" name="fname" value="[value fname]"></td>
+<td><input type="text" name="fname" value="[value fname]" /></td>
</tr>
<tr>
<td align="right"><b>Last name:</b></td>
-<td><input type="text" name="lname" value="[value lname]"></td>
+<td><input type="text" name="lname" value="[value lname]" /></td>
</tr>
<tr>
<td align="right" rowspan="2"><b>Address:</b></td>
-<td><input type="text" name="address1" value="[value address1]"></td>
+<td><input type="text" name="address1" value="[value address1]" /></td>
</tr>
<tr>
-<td><input type="text" name="address2" value="[value address2]"></td>
+<td><input type="text" name="address2" value="[value address2]" /></td>
</tr>
<tr>
<td align="right"><b>City:</b></td>
-<td><input type=text name=city value="[value city]"></td>
+<td><input type=text name="city" value="[value city]" /></td>
</tr>
<tr>
<td align="right"><b>State:</b></td>
-<td><input type="text" name="state" value="[value state]"></td>
+<td><input type="text" name="state" value="[value state]" /></td>
</tr>
<tr>
<td align="right"><b>Postal code:</b></td>
-<td><input type="text" name="zip" value="[value zip]"></td>
+<td><input type="text" name="zip" value="[value zip]" /></td>
</tr>
<tr>
<td align="right"><b>Country:</b></td>
-<td><input type="text" name="country" value="[value country]"></td>
+<td><input type="text" name="country" value="[value country]" /></td>
</tr>
</table>
@@ -58,25 +58,25 @@
<tr>
<td align="right"><b>Credit card number:</b></td>
-<td><input type="text" name="mv_credit_card_number" value="" size="20"></td>
+<td><input type="text" name="mv_credit_card_number" value="" size="20" /></td>
</tr>
<tr>
<td align="right"><b>Credit card expiration date:</b></td>
<td>
Month (number from 1-12):
-<input type="text" name="mv_credit_card_exp_month" value="" size="2" maxlength="2">
+<input type="text" name="mv_credit_card_exp_month" value="" size="2" maxlength="2" />
<br>
Year (last two digits only):
-<input type="text" name="mv_credit_card_exp_year" value="" size="2" maxlength="2">
+<input type="text" name="mv_credit_card_exp_year" value="" size="2" maxlength="2" />
</td>
</tr>
</table>
<p>
-<input type="submit" name="submit" value="Finalize!">
-<input type="reset" name="reset" value="Reset">
+<input type="submit" name="submit" value="Finalize!" />
+<input type="reset" name="reset" value="Reset" />
</p>
</form>
1.2 +1 -1 xmldocs/files/tutorial-phase4/pages/flypage.html
rev 1.2, prev_rev 1.1
Index: flypage.html
===================================================================
RCS file: /var/cvs/xmldocs/files/tutorial-phase4/pages/flypage.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- flypage.html 11 Jul 2004 21:06:31 -0000 1.1
+++ flypage.html 12 Aug 2006 22:43:11 -0000 1.2
@@ -4,6 +4,6 @@
<h3>Test #[item-code]</h3>
<p>[item-field description] . . . [item-field price]</p>
-<br>
+<br/>
Return to the [page index]Index page</a>.
[include bottom]
1.5 +1 -1 xmldocs/files/tutorial-phase4/pages/index.html
rev 1.5, prev_rev 1.4
Index: index.html
===================================================================
RCS file: /var/cvs/xmldocs/files/tutorial-phase4/pages/index.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- index.html 20 Sep 2004 17:21:43 -0000 1.4
+++ index.html 12 Aug 2006 22:43:11 -0000 1.5
@@ -19,6 +19,6 @@
</tr>
[/loop]
</table>
-<hr>
+<hr/>
<p align=center>[page order]View shopping cart</a></p>
[include bottom]
1.2 +17 -17 xmldocs/files/tutorial-phase5/pages/checkout.html
rev 1.2, prev_rev 1.1
Index: checkout.html
===================================================================
RCS file: /var/cvs/xmldocs/files/tutorial-phase5/pages/checkout.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- checkout.html 11 Jul 2004 21:06:31 -0000 1.1
+++ checkout.html 12 Aug 2006 22:43:11 -0000 1.2
@@ -2,50 +2,50 @@
__LEFT__
<h1>Checkout Page</h1>
-<form method="post" action="[process]">
-<input type="hidden" name="mv_todo" value="submit">
-<input type="hidden" name="mv_order_profile" value="order_profile">
-<input type="hidden" name="mv_cyber_mode" value="minivend_test">
+<form method="post" action="[process]" />
+<input type="hidden" name="mv_todo" value="submit" />
+<input type="hidden" name="mv_order_profile" value="order_profile" />
+<input type="hidden" name="mv_cyber_mode" value="minivend_test" />
<table cellpadding="3">
<tr>
<td align="right"><b>First name:</b></td>
-<td><input type="text" name="fname" value="[value fname]"></td>
+<td><input type="text" name="fname" value="[value fname]" /></td>
</tr>
<tr>
<td align="right"><b>Last name:</b></td>
-<td><input type="text" name="lname" value="[value lname]"></td>
+<td><input type="text" name="lname" value="[value lname]" /></td>
</tr>
<tr>
<td align="right" rowspan="2"><b>Address:</b></td>
-<td><input type="text" name="address1" value="[value address1]"></td>
+<td><input type="text" name="address1" value="[value address1]" /></td>
</tr>
<tr>
-<td><input type="text" name="address2" value="[value address2]"></td>
+<td><input type="text" name="address2" value="[value address2]" /></td>
</tr>
<tr>
<td align="right"><b>City:</b></td>
-<td><input type=text name=city value="[value city]"></td>
+<td><input type=text name="city" value="[value city]" /></td>
</tr>
<tr>
<td align="right"><b>State:</b></td>
-<td><input type="text" name="state" value="[value state]"></td>
+<td><input type="text" name="state" value="[value state]" /></td>
</tr>
<tr>
<td align="right"><b>Postal code:</b></td>
-<td><input type="text" name="zip" value="[value zip]"></td>
+<td><input type="text" name="zip" value="[value zip]" /></td>
</tr>
<tr>
<td align="right"><b>Country:</b></td>
-<td><input type="text" name="country" value="[value country]"></td>
+<td><input type="text" name="country" value="[value country]" /></td>
</tr>
</table>
@@ -58,7 +58,7 @@
<tr>
<td align="right"><b>Credit card number:</b></td>
-<td><input type="text" name="mv_credit_card_number" value="" size="20"></td>
+<td><input type="text" name="mv_credit_card_number" value="" size="20" /></td>
</tr>
<tr>
@@ -66,7 +66,7 @@
<td>
Month:
-<select name=mv_credit_card_exp_month>
+<select name="mv_credit_card_exp_month">
[loop
lr=1
option=mv_credit_card_exp_month
@@ -88,7 +88,7 @@
</select>
Year:
-<select name=mv_credit_card_exp_year>
+<select name="mv_credit_card_exp_year">
[comment]
This should always return the current year as the first, then
seven more years.
@@ -113,8 +113,8 @@
</table>
<p>
-<input type="submit" name="submit" value="Finalize!">
-<input type="reset" name="reset" value="Reset">
+<input type="submit" name="submit" value="Finalize!" />
+<input type="reset" name="reset" value="Reset" />
</p>
</form>
1.2 +1 -1 xmldocs/files/tutorial-phase5/pages/flypage.html
rev 1.2, prev_rev 1.1
Index: flypage.html
===================================================================
RCS file: /var/cvs/xmldocs/files/tutorial-phase5/pages/flypage.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- flypage.html 11 Jul 2004 21:06:31 -0000 1.1
+++ flypage.html 12 Aug 2006 22:43:11 -0000 1.2
@@ -4,6 +4,6 @@
<h3>Test #[item-code]</h3>
<p>[item-field description] . . . [currency][item-field price][/currency]</p>
-<br>
+<br/>
Return to the [page index]Index page</a>.
__BOTTOM__
1.5 +1 -1 xmldocs/files/tutorial-phase5/pages/index.html
rev 1.5, prev_rev 1.4
Index: index.html
===================================================================
RCS file: /var/cvs/xmldocs/files/tutorial-phase5/pages/index.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- index.html 20 Sep 2004 17:21:43 -0000 1.4
+++ index.html 12 Aug 2006 22:43:11 -0000 1.5
@@ -19,6 +19,6 @@
</tr>
[/loop]
</table>
-<hr>
+<hr/>
<p align=center>[page order]View shopping cart</a></p>
__BOTTOM__
1.3 +1 -1 xmldocs/files/tutorial-phase5/pages/results.html
rev 1.3, prev_rev 1.2
Index: results.html
===================================================================
RCS file: /var/cvs/xmldocs/files/tutorial-phase5/pages/results.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- results.html 8 Aug 2004 21:04:26 -0000 1.2
+++ results.html 12 Aug 2006 22:43:11 -0000 1.3
@@ -31,7 +31,7 @@
[/no-match]
[/search-region]
-<hr>
+<hr/>
<p align="center">[page index]Return to welcome page</a></p>
<p align="center">[page order]View shopping cart</a></p>
1.6 +10 -0 xmldocs/glossary/database
rev 1.6, prev_rev 1.5
Index: database
===================================================================
RCS file: /var/cvs/xmldocs/glossary/database,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- database 24 Jan 2006 16:06:47 -0000 1.5
+++ database 12 Aug 2006 22:43:11 -0000 1.6
@@ -283,6 +283,16 @@
<section>
+ <title>Interchange Database Design</title>
+<para>
+We are trying not to impose any database structure that would require
+our own tools to maintain the data. We always want to keep
+it such that &IC; data can be maintained via a spreadsheet processor or
+foreign database tools.
+</para>
+</section>
+
+<section>
<title>Interchange Database Conventions</title>
<para>
This section describes naming and file usage conventions used with
1.4 +24 -2 xmldocs/glossary/expire
rev 1.4, prev_rev 1.3
Index: expire
===================================================================
RCS file: /var/cvs/xmldocs/glossary/expire,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- expire 5 Jul 2006 14:03:30 -0000 1.3
+++ expire 12 Aug 2006 22:43:11 -0000 1.4
@@ -3,7 +3,7 @@
a DBM database) for each &glos-catalog;. Since session
data is not deleted after sessions end (or timeout), periodic expiring
needs to be set up to keep the session database or session files from growing
-too large and wasting disk space.
+too large, wasting disk space and slowing down directory lookups.
</para><para>
There's no worry that expiring will do any harm, because all our scripts
only clean up unused sessions. Active users will not notice any change.
@@ -29,7 +29,7 @@
<note>
<para>
If a session saved search paging files in &conf-ScratchDir;, they would
-be deleted too.
+not be deleted (see below for a solution).
</para>
</note>
@@ -78,5 +78,27 @@
account:
<programlisting>
44 4 * * * su -c "/PATH/TO/INTERCHANGE/bin/expireall -r" IC_USERNAME
+</programlisting>
+
+The above does not, however, clean temporary files from the &conf-ScratchDir;
+directory. We don't often use the expire scripts any more. We just use
+a small standalone script <filename>clean_session_tmp</filename>:
+<programlisting><![CDATA[
+#!/bin/sh
+
+for DIR in $*; do
+ for i in session tmp; do
+ if test -d "$DIR/$i"; then
+ find $DIR/$i -type f -mmin +480 | xargs --no-run-if-empty rm
+ find $DIR/$i -type d -empty -mtime +2 -depth | xargs --no-run-if-empty rmdir
+ else
+ echo "$0: $DIR/$i doesn't exist.";
+ fi
+ done
+done
+]]></programlisting>
+using a cron entry similar to:
+<programlisting>
+44 0,4,8,12,16,20 * * * <replaceable>DIR/bin/</replaceable>clean_session_tmp <replaceable>/path/to/catdir1</replaceable> <replaceable>/path/to/catdir2</replaceable>
</programlisting>
1.6 +15 -1 xmldocs/glossary/pragma
rev 1.6, prev_rev 1.5
Index: pragma
===================================================================
RCS file: /var/cvs/xmldocs/glossary/pragma,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- pragma 20 Aug 2005 19:27:25 -0000 1.5
+++ pragma 12 Aug 2006 22:43:11 -0000 1.6
@@ -3,6 +3,19 @@
</para><para>
Pragma values can be defined at any level; catalog-wide, page-wide or
&glos-ITL;-block wide.
+</para>
+
+<note><para>
+Catalog-wide pragmas are equivalent to inserting <code>[pragma ...]</code>
+on every page. However, setting the &conf-Pragma; catalog directive (instead of
+using &tag-pragma; tag all the time) has the benefit of initializing at
+catalog startup time (so, only once), which avoids extra hash key lookups.
+Namely, there is some crossover point at about 4 &PERL; references where it
+saves processor power to assign a scalar instead of looking it up every time.
+</para>
+</note>
+
+<para>
To define a pragma catalog-wide, use the <option>Pragma</option> directive:
<programlisting>
Pragma <replaceable>NAME</replaceable> <group choice='req'><arg choice='plain'>0</arg><arg choice='plain'>1</arg><arg choice='plain'>=<replaceable>pragma-specific value</replaceable></arg></group>
@@ -30,4 +43,5 @@
Starting with Interchange 5.0, the <code>$::Pragma->{name}</code> syntax
is used in the &IC; source, instead of the old
<code>$Vend::Cfg->{Pragma}{name}</code>.
-
+</para><para>
+See the list of available pragmas in <olink targetdoc='pragmas'/>.
1.2 +3 -1 xmldocs/refs/Pragma
rev 1.2, prev_rev 1.1
Index: Pragma
===================================================================
RCS file: /var/cvs/xmldocs/refs/Pragma,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Pragma 25 May 2005 09:36:50 -0000 1.1
+++ Pragma 12 Aug 2006 22:43:11 -0000 1.2
@@ -36,4 +36,6 @@
</programlisting>
__END__
-
+__NAME__ see also
+pragma
+__END__
1.7 +3 -0 xmldocs/refs/SpecialSub
rev 1.7, prev_rev 1.6
Index: SpecialSub
===================================================================
RCS file: /var/cvs/xmldocs/refs/SpecialSub,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- SpecialSub 8 Jul 2006 17:20:00 -0000 1.6
+++ SpecialSub 12 Aug 2006 22:43:11 -0000 1.7
@@ -48,6 +48,9 @@
The return value should either be a type name, or a &glos-false; value
(in which case &IC; proceeds with built-in detection algorithm).
</para></listitem>
+<listitem><para>
+ <literal>flypage</literal> —
+</para></listitem>
</itemizedlist>
</para><para>
__END__
1.3 +13 -1 xmldocs/refs/xml-generator
rev 1.3, prev_rev 1.2
Index: xml-generator
===================================================================
RCS file: /var/cvs/xmldocs/refs/xml-generator,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- xml-generator 11 Apr 2006 15:05:34 -0000 1.2
+++ xml-generator 12 Aug 2006 22:43:11 -0000 1.3
@@ -4,6 +4,11 @@
__END__
__NAME__ notes
+<emphasis role='bold'>
+Pay special attention to whitespace! The &tag-__FILENAME__; tag is very
+particular about white space.
+</emphasis>
+</para><para>
It appears that the <literal>type=delimited</literal> and
<literal>field_names=</literal> do not function properly. This is,
however, not a problem because &tag-xml-generator; is obsolete. If you
@@ -300,10 +305,17 @@
__END__
+__NAME__ example: Exporting products SKU, title and price to XML
+<programlisting>
+[xml-generator type="delimited" toplevel_tag="products" field_names="sku title price"][query list=1 sql="select sku, title, price from products" prefix=xml][xml-param sku] [xml-param title] [xml-param price]
+[/query][/xml-generator]
+</programlisting>
+__END__
+
**** Notice the missing _ at the beginning, this is effectively a comment.
_NAME__ example: Display an individual field
-We rely on the default setting of <literal>type=delimitea</literal>d here:
+We rely on the default setting of <literal>type=delimited</literal> here:
<programlisting>
[comment]
The following field is set manually only to complete the example,
More information about the docs
mailing list