[interchange-docs] xmldocs - docelic modified 13 files
docs at icdevgroup.org
docs at icdevgroup.org
Thu May 15 22:41:25 UTC 2008
User: docelic
Date: 2008-05-15 22:41:25 GMT
Modified: . TODO
Modified: bin refs-autogen stattree
Modified: glossary discount
Modified: refs CAPTCHA_IMAGE_PATH CookieName DatabaseAutoIgnore
Modified: digits.filter
Added: glossary captcha
Added: refs CAPTCHA_IMAGE_UMASK COMPANY COUNTRY VALUE
Log:
* some new items
* small fixes to some existing items
Revision Changes Path
1.115 xmldocs/TODO
rev 1.115, prev_rev 1.114
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.114
retrieving revision 1.115
diff -u -r1.114 -r1.115
--- TODO 15 Feb 2008 18:24:49 -0000 1.114
+++ TODO 15 May 2008 22:41:25 -0000 1.115
@@ -1,7 +1,4 @@
-Bugs:
--document <ParseVaribles Yes>
- work on bin/mkreport
-- search doc se nevidi jer je search neki actionmap
- provide static files for download, describe keys like alt+n
- documentation for bounce and restrict is ignored
- some small error in glossary/pragma at the bottom, [tag pragma]0[/tag]
@@ -13,7 +10,6 @@
- order counter, Session->{mv_order_number}, cronjob -0001, or file da-te.counter, or session_id.time
- in iccattut, s/item-field/item-param/ at least on some places.
-- Make xmldocs tarball in ftp autoupdated
- Change -latest to version number in tarball download
- fix/update AdminUser docs
- aliases like DataDir/DefaultTables are not documented
@@ -21,7 +17,6 @@
- remove NEW from <meta>
- In tags, make XSLT code print position number besides "Yes" word in
positional parameters for tags
-- in search.xml replace mv_ listitems with sections so they're listed in TOC
- note in configuration glossentry to use '' to skip values
- Check ConfigDatabase and DirectiveDatabase. Is description correct? One seems to be wrong
- preprocessor directives in configuration ?
1.128 xmldocs/bin/refs-autogen
rev 1.128, prev_rev 1.127
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.127
retrieving revision 1.128
diff -u -r1.127 -r1.128
--- refs-autogen 26 Apr 2008 17:33:34 -0000 1.127
+++ refs-autogen 15 May 2008 22:41:25 -0000 1.128
@@ -21,7 +21,7 @@
$Data::Dumper::Indent = 1;
$Data::Dumper::Terse++;
$Data::Dumper::Sortkeys++;
-$ENV{XMLDOCS_CUR_DEVEL} ||= "";
+$ENV{XMLDOCS_CUR_DEVEL} ||= '';
}
my $dumpdb = 0;
@@ -44,7 +44,7 @@
my @set_unused; # Notice which files inside refs/ were not used
my @parsed_versions; # IC versions we parsed
my $specific_only; # Build only one specific .xml ?
-my $output_spec; # 'list' produces tag list, 'xml' produces real xml source
+my $output_spec; # 'list' produces symbol lists, 'xml' produces real xml source
my $output_both; # Unconditionally override $output_spec
my $no_autorefs; # Generate autorefs.ent collection of entities by default
my $validate = 0; # Whether to validate XML chunks
@@ -306,7 +306,7 @@
# Ok, now we're done with the by-the-way tasks, and the real work begins.
- # Outer loop: $gkey: symbol types (pragmas, globvars, ...)
+ # Outer loop: $gkey: symbol groups (pragmas, globvars, ...)
# Inner loop (~25 lines below): $key, actual symbols from symbol groups
while ( my ($gkey,$gval) = each %{ $hash{symbols} } ) {
@@ -514,7 +514,7 @@
# What would happen if we inserted into $loc the HTML link,
# with <phrase condition="online"> ?
- my ( $cstart, $cend, $ctxmeta ) = ("", "", "");
+ my ( $cstart, $cend, $ctxmeta ) = ('','','');
my $all = 0; # Showing all for an item?
if ( $gkey !~ /(tag|filter|widget|actionmap|ordercheck)$/ ) {
1.62 xmldocs/bin/stattree
rev 1.62, prev_rev 1.61
Index: stattree
===================================================================
RCS file: /var/cvs/xmldocs/bin/stattree,v
retrieving revision 1.61
retrieving revision 1.62
diff -u -r1.61 -r1.62
--- stattree 24 Apr 2008 15:41:04 -0000 1.61
+++ stattree 15 May 2008 22:41:25 -0000 1.62
@@ -107,7 +107,7 @@
$dumppath .= "/.cache.bin";
# Ok, onto some work now
-chdir $path; # Go into the directory
+chdir $path; # Go into the Interchange tree which needs to be parsed
# Let's just pick CVS lines first:
my @files = `find . -name Entries | cut -b 3-`;
1.6 xmldocs/glossary/discount
rev 1.6, prev_rev 1.5
Index: discount
===================================================================
RCS file: /var/cvs/xmldocs/glossary/discount,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- discount 1 Jul 2007 11:30:22 -0000 1.5
+++ discount 15 May 2008 22:41:25 -0000 1.6
@@ -29,17 +29,19 @@
</itemizedlist>
-The discounts are specified using a formula. The formula is scanned for
+Discounts within the &tag-discount; tag are specified using a formula.
+The formula is scanned for
the <varname>$q</varname> and <varname>$s</varname> variables which are
substituted for the item quantity and subtotal respectively.
The variable <varname>$s</varname> is saved between
iterations, so that the discounts can be cumulative.
</para><para>
-In case of individual item discounts, the formula must be defined in a way
-that it produces a subtotal which includes <emphasis>all items</emphasis> of
-the same &glos-SKU; that are found in the user's basket. There are many ways
-and reasons why the same &glos-SKU; might be present multiple times in the
-user's basket — one is the &conf-SeparateItems; configuration directive.
+In case of individual item discounts, the formula must be constructed to
+handle all instances of a particular &glos-SKU; found in the user's basket.
+There are many ways how same &glos-SKU; might occur
+multiple times in the user's basket (for example, with &conf-SeparateItems;
+enabled) — the same formula will be invoked on every occurrence and
+it should always give out the correct individual subtotal.
</para><para>
In case of an entire order discount, the formula is usually simpler
and defines a flat discount amount or percentage.
1.1 xmldocs/glossary/captcha
<<captcha: empty>>
1.2 xmldocs/refs/CAPTCHA_IMAGE_PATH
rev 1.2, prev_rev 1.1
Index: CAPTCHA_IMAGE_PATH
===================================================================
RCS file: /var/cvs/xmldocs/refs/CAPTCHA_IMAGE_PATH,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- CAPTCHA_IMAGE_PATH 13 Dec 2006 22:48:11 -0000 1.1
+++ CAPTCHA_IMAGE_PATH 15 May 2008 22:41:25 -0000 1.2
@@ -19,6 +19,6 @@
__END__
__NAME__ see also
-DOCROOT, CAPTCHA_IMAGE_LOCATION
+DOCROOT, CAPTCHA_IMAGE_LOCATION, CAPTCHA_IMAGE_UMASK
__END__
1.6 xmldocs/refs/CookieName
rev 1.6, prev_rev 1.5
Index: CookieName
===================================================================
RCS file: /var/cvs/xmldocs/refs/CookieName,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- CookieName 6 Nov 2006 18:41:20 -0000 1.5
+++ CookieName 15 May 2008 22:41:25 -0000 1.6
@@ -1,5 +1,5 @@
__NAME__ purpose
-specify Interchange cookie name
+specify Interchange session cookie name
__END__
1.6 xmldocs/refs/DatabaseAutoIgnore
rev 1.6, prev_rev 1.5
Index: DatabaseAutoIgnore
===================================================================
RCS file: /var/cvs/xmldocs/refs/DatabaseAutoIgnore,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- DatabaseAutoIgnore 6 Nov 2006 18:41:20 -0000 1.5
+++ DatabaseAutoIgnore 15 May 2008 22:41:25 -0000 1.6
@@ -34,6 +34,7 @@
in &PGSQL; 7.4 and newer.
<programlisting>
DatabaseAutoIgnore ^sql_
+DatabaseAuto dbi:Pg:dbname=DBNAME;host=PGHOST
</programlisting>
__END__
1.2 xmldocs/refs/digits.filter
rev 1.2, prev_rev 1.1
Index: digits.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/digits.filter,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- digits.filter 29 May 2005 15:01:39 -0000 1.1
+++ digits.filter 15 May 2008 22:41:25 -0000 1.2
@@ -3,7 +3,7 @@
__END__
__NAME__ see also
-digits_dot
+digits_dot, digits_dash
__END__
1.1 xmldocs/refs/CAPTCHA_IMAGE_UMASK
rev 1.1, prev_rev 1.0
Index: CAPTCHA_IMAGE_UMASK
===================================================================
__NAME__ purpose
specify default "captcha" umask
__END__
__NAME__ synopsis
<replaceable>umask</replaceable>
__END__
__NAME__ description
The variable specifies umask for creating &glos-captcha; images.
The default umask is 002.
__END__
__NAME__ example
<programlisting>
Variable __FILENAME__ 022
</programlisting>
__END__
__NAME__ see also
CAPTCHA_IMAGE_LOCATION, CAPTCHA_IMAGE_PATH
__END__
1.1 xmldocs/refs/COMPANY
rev 1.1, prev_rev 1.0
Index: COMPANY
===================================================================
__NAME__ purpose
specify company or entity name
__END__
__NAME__ synopsis
<replaceable>name</replaceable>
__END__
__NAME__ description
The variable specifies company or entity name to
display in appropriate contexts.
__END__
__NAME__ example
<programlisting>
Variable __FILENAME__ Interchange Development Group
</programlisting>
__END__
__NAME__ see also
__END__
1.1 xmldocs/refs/COUNTRY
rev 1.1, prev_rev 1.0
Index: COUNTRY
===================================================================
__NAME__ purpose
(obsolete)
__END__
1.1 xmldocs/refs/VALUE
rev 1.1, prev_rev 1.0
Index: VALUE
===================================================================
__NAME__ purpose
(obsolete)
__END__
More information about the docs
mailing list