[interchange-docs] xmldocs - docelic modified 24 files
docs at icdevgroup.org
docs at icdevgroup.org
Thu Oct 12 09:51:36 EDT 2006
User: docelic
Date: 2006-10-12 13:51:35 GMT
Modified: refs ACTIVE_SESSION_MINUTES AcceptRedirect
Modified: AccumulateCode AcrossLocks ActionMap AddDirective
Modified: AdminSub AdminUser AliasTable AllowGlobal
Modified: AlwaysSecure AsciiTrack AutoEnd AutoModifier
Modified: AutoVariable Autoload CodeRepository Locale
Modified: OrderCounter Require SafeUntrap SocketFile Suggest
Added: refs Accounting
Log:
Went over a few of the configuration directives:
* improved text flow
* Simplified Synopsis line (Removed surrounding { .. } brackets
where there's only one item so no grouping is required)
* Fixed a few typos & similar issues
Revision Changes Path
1.2 +1 -3 xmldocs/refs/ACTIVE_SESSION_MINUTES
rev 1.2, prev_rev 1.1
Index: ACTIVE_SESSION_MINUTES
===================================================================
RCS file: /var/cvs/xmldocs/refs/ACTIVE_SESSION_MINUTES,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ACTIVE_SESSION_MINUTES 2 Feb 2005 11:35:58 -0000 1.1
+++ ACTIVE_SESSION_MINUTES 12 Oct 2006 13:51:35 -0000 1.2
@@ -5,9 +5,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>minutes</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>minutes</replaceable></arg>
__END__
1.3 +17 -9 xmldocs/refs/AcceptRedirect
rev 1.3, prev_rev 1.2
Index: AcceptRedirect
===================================================================
RCS file: /var/cvs/xmldocs/refs/AcceptRedirect,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AcceptRedirect 8 Dec 2004 12:39:58 -0000 1.2
+++ AcceptRedirect 12 Oct 2006 13:51:35 -0000 1.3
@@ -3,7 +3,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
@@ -13,7 +13,7 @@
__NAME__ description
The directive
enables processing of HTTP server redirects, i.e. when handling ErrorDocument
-for a Web server such as &APACHE;. For instance, if your
+for a Web server such as &APACHE;. For instance, if your Apache
<filename>httpd.conf</filename> contains
<programlisting>
@@ -22,27 +22,35 @@
then a request for <literal>/somedir/index.html</literal> that is not found
on the Web server would be resent to
-<filename>/cgi-bin/ic/foundation/somedir/index.html</filename>, and
-would be
-indistinguishable from the Web server-served page by the client.
+<literal>/cgi-bin/ic/foundation/somedir/index.html</literal>, and
+would be indistinguishable from the static Web server-served page.
__END__
__NAME__ notes
+Combined with the &conf-RedirectCache; directive, you can automatically
+create missing &glos-HTML; pages in your web server's static HTML space,
+so that they <emphasis role='bold'>are</emphasis> found on next access.
+Just beware; that turns them into static pages!
+</para><para>
Although the idea seems attractive at first sight,
caution should be taken not to allow Web server's ErrorDocument redirection
to &IC; globally — it would render you subject to a
denial-of-service attack at random URLs (i.e. a flood of MS Windows
"Code Red" attacks). It is recommended that you enable it only for
-specific directories, as &APACHE; or another HTTP server will stand up
-much better under such a flood.
+specific directories, as &APACHE; or another HTTP server would stand
+much better up to such a "limited-scale" flood.
__END__
-__NAME__ example: Enabling AcceptRedirect
-Put any of the following lines in &ccf;:
+__NAME__ example: Enabling __FILENAME__
<programlisting>
AcceptRedirect Yes
</programlisting>
+__END__
+
+
+__NAME__ see also
+RedirectCache
__END__
1.4 +10 -6 xmldocs/refs/AccumulateCode
rev 1.4, prev_rev 1.3
Index: AccumulateCode
===================================================================
RCS file: /var/cvs/xmldocs/refs/AccumulateCode,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AccumulateCode 27 Oct 2005 19:09:03 -0000 1.3
+++ AccumulateCode 12 Oct 2006 13:51:35 -0000 1.4
@@ -4,7 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
@@ -13,17 +13,21 @@
__NAME__ description
The directive instructs &IC; to fetch code blocks "on-demand" from the
-&conf-CodeRepository;, instead of starting up with everything.
+&conf-CodeRepository; instead of starting up with everything.
</para><para>
So, at runtime, when particular functionality is needed but is not
yet present in the running &IC; installation, it is copied from
&conf-CodeRepository; to
-<filename class='directory'>$Global::TagDir/Accumulated/</filename>.
-When you restart &IC; the next time, these code blocks will be found,
-read normally and need not be recompiled on the fly again.
+<filename class='directory'>$Global::TagDir/Accumulated/</filename>
+<emphasis role='bold'>and automatically activated</emphasis>.
+Later, when you restart &IC; the next time, these code blocks will be
+found in the accumulated directory and loaded normally
+(there will be no need to fetch them from &conf-CodeRepository;
+again).
</para><para>
Over time, as you access pages and routines, a full set of tags
-will be developed and you can then disable &conf-AccumulateCode;.
+will be copied to the accumulated directory, and you will then be
+able to turn &conf-AccumulateCode; off.
(In fact, &conf-AccumulateCode; is recommended for development and should
really be turned off in production systems).
__END__
1.2 +10 -3 xmldocs/refs/AcrossLocks
rev 1.2, prev_rev 1.1
Index: AcrossLocks
===================================================================
RCS file: /var/cvs/xmldocs/refs/AcrossLocks,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- AcrossLocks 12 Aug 2005 12:41:51 -0000 1.1
+++ AcrossLocks 12 Oct 2006 13:51:35 -0000 1.2
@@ -1,10 +1,10 @@
__NAME__ purpose
-
+open real databases instead of fast dummy pointers
__END__
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
@@ -12,6 +12,13 @@
__NAME__ description
+All configured &glos-database;s are opened every time an &IC; page is
+visited and enters processing. Opening a new database connection takes
+time, so &IC; provides fast dummy pointer to each database until that
+database is actually used within the page.
+</para><para>
+Enabling this directive has the effect of disabling fast pointers
+and always opening real &glos-database;s.
__END__
__NAME__ notes
@@ -24,7 +31,7 @@
__END__
-__NAME__ example: Enabling AcrossLocks
+__NAME__ example: Enabling __FILENAME__
<programlisting>
AcrossLocks yes
</programlisting>
1.4 +2 -0 xmldocs/refs/ActionMap
rev 1.4, prev_rev 1.3
Index: ActionMap
===================================================================
RCS file: /var/cvs/xmldocs/refs/ActionMap,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ActionMap 9 Jun 2005 12:02:43 -0000 1.3
+++ ActionMap 12 Oct 2006 13:51:35 -0000 1.4
@@ -43,4 +43,6 @@
__NAME__ missing
In the example, I provided some erroneous comment.
+Also fix description and add synopsis
__END__
+
1.4 +21 -16 xmldocs/refs/AddDirective
rev 1.4, prev_rev 1.3
Index: AddDirective
===================================================================
RCS file: /var/cvs/xmldocs/refs/AddDirective,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AddDirective 28 Sep 2005 14:11:19 -0000 1.3
+++ AddDirective 12 Oct 2006 13:51:35 -0000 1.4
@@ -3,7 +3,7 @@
__END__
__NAME__ synopsis
- <arg choice='req'><replaceable>directive_name</replaceable></arg>
+ <arg choice='plain'><replaceable>directive_name</replaceable></arg>
<arg>
<replaceable>parse_function_name</replaceable>
<arg><replaceable>default_value</replaceable></arg>
@@ -12,30 +12,33 @@
__NAME__ description
-The directive allows you to extend the set of regular configuration
+This directive allows you to extend the set of regular
+&glos-configuration;
directives accepted in each &ccf; with your custom ones. The added
directives are then treated the same as the existing "built-ins".
</para><para>
Three standard arguments can be specified, just as you can see in
-<filename>lib/Vend/Config.pm</filename>: the new directive name, name of
-the parser/validating function, and a default value.
+<filename>lib/Vend/Config.pm</filename>: the
+<literal>directive_name</literal>,
+<literal>parse_function_name</literal> and
+<literal>default_value</literal>.
</para><para>
If the parser function is not defined (either by omitting it or
literally specifying <literal>undef</literal>), then no parser
-will be called at all,
+will be called on the value at all,
and the value of the directive will be exactly what users specify in their
-&ccf; files (which is usually a &PERL; scalar value). If the parser
+config files (which will usually be &PERL; scalar values). If the parser
argument <emphasis>is</emphasis> supplied, then the requested parser function
must already be defined because it can't be referenced
<emphasis>in advance</emphasis>. It can be defined either as a
&conf-Sub; or &conf-GlobalSub; block, or can refer to an existing parser
function from <filename>lib/Vend/Config.pm</filename>.
-</para><para>
-<filename>lib/Vend/Config.pm</filename> contains all the default
+The file <filename>lib/Vend/Config.pm</filename> contains all the default
parser functions, which are recognized by the mandatory prefix
<literal>parse_</literal>. (You do not, however, include
-<literal>parse_</literal> in the parser function name argument to
-&conf-AddDirective;).
+<literal>parse_</literal> in the <literal>parse_function_name</literal>.
+</para><para>
+The <literal>default_value</literal> does not have to be specified.
</para><para>
Directly modifying <filename>Config.pm</filename> (or any other
files from the &IC; installation) is discouraged for portability and other
@@ -52,6 +55,9 @@
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.
+</para><para>
+Please see the &glos-configuration; glossary entry for a discussion
+on config directives.
__END__
__NAME__ example: Adding a new catalog configuration directive
@@ -69,24 +75,23 @@
}
EOS
-AddDirective DocRoot docroot "/tmp"
+AddDirective DocRoot docroot "/var/www"
]]></programlisting>
__END__
__NAME__ example: Adding the Swish directive
-The first step in add support for searching using Swish, is the
-inclusion of relevant &PERL; modules and the creation of the
-new <literal>Swish</literal> directive. At the same time, we can use
-it as an &conf-AddDirective; example. Put the following in your &gcf;:
<programlisting>
Require module Vend::Swish
+
Variable swish Vend::Swish
+
AddDirective Swish hash
</programlisting>
__END__
-u
+
__NAME__ missing
Make better example, and exactly show how to define a new parser function without modifying Config.pm directly.
Docroot example doesn't work
+also, does it only extends the set available in catalog.cfg or also in interchange.cfg ?
__END__
1.2 +2 -2 xmldocs/refs/AdminSub
rev 1.2, prev_rev 1.1
Index: AdminSub
===================================================================
RCS file: /var/cvs/xmldocs/refs/AdminSub,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- AdminSub 27 Jul 2005 17:19:13 -0000 1.1
+++ AdminSub 12 Oct 2006 13:51:35 -0000 1.2
@@ -13,14 +13,14 @@
__END__
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain' rep='repeat'><replaceable>subroutine_name</replaceable></arg>
</group>
__END__
__NAME__ description
-Specify global subroutines that may only be used by catalogs which are listed under
+Specify global subroutines that may only be used by &glos-catalogs; which are listed under
the &conf-AllowGlobal; directive.
</para><para>
Otherwise, in a normal course of action, global subroutines can be used
1.2 +15 -1 xmldocs/refs/AdminUser
rev 1.2, prev_rev 1.1
Index: AdminUser
===================================================================
RCS file: /var/cvs/xmldocs/refs/AdminUser,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- AdminUser 18 Feb 2005 00:28:07 -0000 1.1
+++ AdminUser 12 Oct 2006 13:51:35 -0000 1.2
@@ -1,3 +1,17 @@
__NAME__ purpose
-username that is given full access to all catalogs, regardless of any permissions
+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
+__END__
+
+
+See Util.pm
1.2 +18 -21 xmldocs/refs/AliasTable
rev 1.2, prev_rev 1.1
Index: AliasTable
===================================================================
RCS file: /var/cvs/xmldocs/refs/AliasTable,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- AliasTable 27 Jul 2005 17:19:13 -0000 1.1
+++ AliasTable 12 Oct 2006 13:51:35 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>database_name</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>database_name</replaceable></arg>
__END__
@@ -19,39 +17,38 @@
without performing file lookup cycles.
</para><para>
Primary applications include content management and creation of
-pseudo-paths.
+pseudo-paths. See <xref linkend="__FILENAME___examples"/>.
__END__
__NAME__ notes
__END__
-__NAME__ example: Creating AliasTable database
+
+__NAME__ example: Defining AliasTable
<programlisting>
-<xi:include parse='text' href='../files/various/alias.txt'/>
+Database alias alias.txt TAB
+AliasTable alias
</programlisting>
-You might notice that the fields names and values in the tables
-above are not properly aligned. This is an unfortunate nature of
-<glossterm linkend="tab_delimited">TAB-delimited</glossterm> files.
-</para><para>
-In our example database, a flypage for the item SKU
-<literal>4595</literal> redirects back to the index page.
</para><para>
-To minimize the chance of confusion, you can download properly composed
-<ulink url="files/various/alias.txt">alias.txt</ulink>.
__END__
-__NAME__ example: Defining AliasTable
+__NAME__ example: Creating AliasTable database
<programlisting>
-Database alias alias.txt TAB
-AliasTable alias
+<xi:include parse='text' href='../files/various/alias.txt'/>
</programlisting>
</para><para>
-With the above in &ccf;, a visit to the page <literal>4595.html</literal>
-should redirect you to the index page.
+&TAB_DELIMITED_NOTICE;
+</para><para>
+In our example database, page <literal>4595</literal>.html redirects
+back to the index page.
+</para><para>
+To minimize the chance of confusion, you can download properly composed
+<ulink url="files/various/alias.txt">alias.txt</ulink>.
__END__
-TODO : describe cgi passing of control:
-"Allows initialization of CGI inputs via base_control field."
+__NAME__ missing
+TODO : describe cgi passing of control: "Allows initialization of CGI inputs via base_control field."
TODO: produce working example
+__END__
1.5 +5 -9 xmldocs/refs/AllowGlobal
rev 1.5, prev_rev 1.4
Index: AllowGlobal
===================================================================
RCS file: /var/cvs/xmldocs/refs/AllowGlobal,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- AllowGlobal 11 Jun 2005 23:39:25 -0000 1.4
+++ AllowGlobal 12 Oct 2006 13:51:35 -0000 1.5
@@ -3,23 +3,16 @@
__END__
-__NAME__ missing
-Fix value type in directive definition?
-__END__
-
-
__NAME__ see also
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>catalog</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>catalog</replaceable></arg>
__END__
__NAME__ description
-Specify catalogs that may define subroutines and tags that can operate with the full permissions of the &IC; server.
+Specify catalogs that can operate with the full permissions of the &IC; server.
</para><para>
Don't use this directive unless the catalog user is completely trusted.
__END__
@@ -30,3 +23,6 @@
</programlisting>
__END__
+__NAME__ missing
+how does SafeTrap/Untrap play with AllowGlobal?
+__END__
1.3 +1 -3 xmldocs/refs/AlwaysSecure
rev 1.3, prev_rev 1.2
Index: AlwaysSecure
===================================================================
RCS file: /var/cvs/xmldocs/refs/AlwaysSecure,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AlwaysSecure 6 Mar 2005 11:51:28 -0000 1.2
+++ AlwaysSecure 12 Oct 2006 13:51:35 -0000 1.3
@@ -7,9 +7,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>page</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>page_path</replaceable></arg>
__END__
1.3 +5 -4 xmldocs/refs/AsciiTrack
rev 1.3, prev_rev 1.2
Index: AsciiTrack
===================================================================
RCS file: /var/cvs/xmldocs/refs/AsciiTrack,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AsciiTrack 4 Apr 2006 19:43:34 -0000 1.2
+++ AsciiTrack 12 Oct 2006 13:51:35 -0000 1.3
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>filename</arg>
-</group>
+<arg choice='plain'>filename</arg>
__END__
@@ -20,9 +18,12 @@
__NAME__ notes
If the &conf-Route; directive is set to <literal>supplant</literal>, this
-directive is disregarded.
+directive is ignored.
__END__
+__NAME__ missing
+Route is not set to supplant, route IS supplant, right?!
+__END__
__NAME__ example: Setting AsciiTrack
<programlisting>
1.2 +3 -5 xmldocs/refs/AutoEnd
rev 1.2, prev_rev 1.1
Index: AutoEnd
===================================================================
RCS file: /var/cvs/xmldocs/refs/AutoEnd,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- AutoEnd 27 Jul 2005 17:19:13 -0000 1.1
+++ AutoEnd 12 Oct 2006 13:51:35 -0000 1.2
@@ -8,16 +8,14 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>subroutine_name_or_ITL_code</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>subroutine_name_or_ITL_code</replaceable></arg>
__END__
__NAME__ description
Specify actions (in form of &PERL; subroutines or &glos-ITL; tags)
-that are to be invoked automatically, on the end of every
-page access. This step is performed after any page parsing occurs,
+that are to be invoked automatically, at the end of every
+page access. This step is performed after all page parsing occurs,
just before the whole transaction ends.
</para><para>
In other respects, it behaves the same as its closely related
1.7 +13 -7 xmldocs/refs/AutoModifier
rev 1.7, prev_rev 1.6
Index: AutoModifier
===================================================================
RCS file: /var/cvs/xmldocs/refs/AutoModifier,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- AutoModifier 6 Dec 2005 21:54:39 -0000 1.6
+++ AutoModifier 12 Oct 2006 13:51:35 -0000 1.7
@@ -4,6 +4,9 @@
__NAME__ missing
+fix examples (split to three)
+improve description based on syntax seen in examples
+in the examples, explain mv_sku lookup, not clear now
__END__
@@ -12,9 +15,11 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>column</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'>
+ <arg choice='opt'>table</arg>
+ <replaceable>column</replaceable>
+ <arg choice='opt'>key</arg>
+</arg>
__END__
@@ -27,10 +32,11 @@
attributes declared in &conf-AutoModifier; will be set to the values of the
fields in the <database>products</database> database.
</para><para>
-This facility will often be used in determining pricing, shipping,
-or other custom product attributes. These attributes will probably
-be used in a custom &PERL; code which will scan the items in the electronic
-&glos-cart; and make decisions.
+This facility will often be employed in determining product
+&glos-price;, &glos-discount;, &glos-tax;, &glos-shipping; amd
+other custom attributes. In other words, these attributes will probably
+be used in custom &PERL; code that will scan the electronic
+&glos-cart; contents and perform some decisions.
<!--
</para><para>
There are several forms of the specification. The simplest is
1.3 +1 -3 xmldocs/refs/AutoVariable
rev 1.3, prev_rev 1.2
Index: AutoVariable
===================================================================
RCS file: /var/cvs/xmldocs/refs/AutoVariable,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AutoVariable 3 Mar 2005 15:19:55 -0000 1.2
+++ AutoVariable 12 Oct 2006 13:51:35 -0000 1.3
@@ -7,9 +7,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>directive</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>directive</replaceable></arg>
__END__
1.2 +1 -3 xmldocs/refs/Autoload
rev 1.2, prev_rev 1.1
Index: Autoload
===================================================================
RCS file: /var/cvs/xmldocs/refs/Autoload,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Autoload 27 Jul 2005 17:19:13 -0000 1.1
+++ Autoload 12 Oct 2006 13:51:35 -0000 1.2
@@ -8,9 +8,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>subroutine_name_or_ITL_code</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>subroutine_name_or_ITL_code</replaceable></arg>
__END__
1.8 +37 -28 xmldocs/refs/CodeRepository
rev 1.8, prev_rev 1.7
Index: CodeRepository
===================================================================
RCS file: /var/cvs/xmldocs/refs/CodeRepository,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- CodeRepository 18 Nov 2005 23:15:01 -0000 1.7
+++ CodeRepository 12 Oct 2006 13:51:35 -0000 1.8
@@ -11,12 +11,14 @@
__NAME__ description
-There is a huge base of &IC; code included in the default installation.
+There is a huge base of &IC; code (collection of &conf-UserTag;s and
+&conf-CodeDef;s) included in the default installation.
Much of it is not needed in even the '&std-catalog;' catalog with full
user interface (UI). This causes a larger memory profile than necessary.
</para><para>
Furthermore, it is difficult to determine from the &IC; pages what code is
-needed (especially when an &glos-ITL; tag calls <code>$Tag-><replaceable>TAGNAME</replaceable>()</code>
+needed (especially when an &glos-ITL; tag calls
+<code>$Tag-><replaceable>TAGNAME</replaceable>()</code>
which calls a filter which calls some sort of action —
you get the picture).
</para><para>
@@ -26,25 +28,29 @@
</para><para>
&conf-CodeRepository; depends on a related directive, &conf-AccumulateCode;.
If &conf-AccumulateCode; is disabled, operation is traditional and everything
-gets loaded. (There have
+gets loaded at &IC; startup time. (There have
been some code initialization changes and routine calling changes,
but the data structures are identical and no difference in operation
should be seen).
</para><para>
-It's when you enable &conf-AccumulateCode; that things get interesting.
-&IC; starts looking into &conf-CodeRepository; for pieces it is
+It's when you remove the
+<filename class='directory'>&glos-ICROOT;/code/</filename> directory and
+enable &conf-AccumulateCode; that things get interesting.
+&IC; starts looking into &conf-CodeRepository; for pieces it finds
missing (&glos-ITL; tags, &glos-ActionMap;s, &glos-filter;s, widgets, etc.)
and compiles these as needed, in runtime!
The code is sent to the master process for compilation and
-incorporation, so that the next iteration of a page (after
-&conf-HouseKeeping; seconds expire) will find the code already compiled
+incorporation, so that on the next page access (or in the worst case,
+after &conf-HouseKeeping; seconds), &IC; will find the code already compiled
and ready to go.
</para><para>
-It also copies the code file to the <literal>code/</literal>
-(<varname>$Global::TagDir</varname> actually) directory, in the
-<filename class='directory'>Accumulated/</filename> subdirectory tree.
+Fetched code blocks are copied to
+<filename class='directory'>&glos-ICROOT;/code/Accumulated/</filename>
+directory
+(<filename class='directory'>
+<varname>$Global::TagDir</varname>/Accumulated/</filename>, to be exact)
When you restart &IC; the next time, these code blocks will be found,
-read normally and need not be recompiled on the fly again.
+read normally and need not be recompiled and loaded on the fly again.
</para><para>
Over time, as you access pages and routines, a full set of tags
will be developed and you can then disable &conf-AccumulateCode;.
@@ -64,20 +70,24 @@
The &tag-area;, &tag-tmp;, &tag-tmpn;, and &tag-image; tags are known to
fail in this manner in the '&std-catalog;' catalog.
Tags that are frequently called
-in this fashion should probably be placed in directory
-<filename class='directory'>code/Vital/</filename> directory and not
-be accumulated.
-This "failure" could be avoided if the catalog is listed under the
+in this fashion should probably be manually placed in directory
+<filename class='directory'>code/Vital/</filename> and not
+be accumulated "by chance".
+This temporary failure could be avoided by listing &glos-catalog; in the
&conf-AllowGlobal; directive, and it
-might be possible to make a directive that turns on &conf-AllowGlobal; for
-the catalog only when in &conf-AccumulateCode; mode.
-</para><para>
-Another nice feature is that you can easily add a tag simply
-by adding its code to the &conf-CodeRepository; directory and having it
-compiled.
-It might also
-be possible to remove code from the master and recompile it on next access
-on-the-fly, but this has yet to be looked at.
+might be possible to make a directive that allows &conf-AllowGlobal; for
+a catalog automatically, when in &conf-AccumulateCode; mode.
+(If you don't want to trade immediate code loading for the lack of
+&conf-AllowGlobal; protection, then just set &conf-HouseKeeping; to
+something like <literal>20 seconds</literal> — and
+only do it on your development system!)
+</para><para>
+One convenient side-effect is that you can easily load new code
+"on the fly" by simply adding files to the &conf-CodeRepository;
+directory. This alleviates the need for &IC; server restart.
+It might also be possible to dynamically <emphasis role='bold'>remove and
+load</emphasis> code from the server in this manner, but this has yet
+to be looked at.
</para>
<warning>
@@ -85,15 +95,14 @@
Nice features are often dangerous! Don't run this in
production — you have been warned!
</para><para>
-&conf-OrderCheck; is not yet implemented, and a full audit has
+"OrderCheck" &conf-CodeDef; is not yet implemented, and a full audit has
not been done on all compiled code directives.
</para><para>
Not fully tested in &conf-PreFork; mode, and really not intended for
that mode.
</para><para>
-Including multiple tags in a code definition file may have unpredictable
-behavior. You should try to keep related Alias and tag things in
-the same file.
+Defining multiple tags or code blocks (&conf-UserTag;s or &conf-CodeDef;s)
+within a single file may result in an unpredictable behavior.
</para><para>
This feature only applies to global code — catalog-based code
is not affected and behaves as usual.
1.11 +0 -2 xmldocs/refs/Locale
rev 1.11, prev_rev 1.10
Index: Locale
===================================================================
RCS file: /var/cvs/xmldocs/refs/Locale,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- Locale 30 Mar 2006 07:23:04 -0000 1.10
+++ Locale 12 Oct 2006 13:51:35 -0000 1.11
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<arg choice='opt'><replaceable>locale</replaceable></arg><sbr />
<arg choice='plain' rep='repeat'><replaceable>locale_key</replaceable> <replaceable>locale_value</replaceable></arg><sbr />
-<arg choice='plain' rep='repeat'><replaceable>locale</replaceable> <replaceable>locale_key</replaceable> <replaceable>locale_value</replaceable></arg>
__END__
1.3 +14 -4 xmldocs/refs/OrderCounter
rev 1.3, prev_rev 1.2
Index: OrderCounter
===================================================================
RCS file: /var/cvs/xmldocs/refs/OrderCounter,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- OrderCounter 6 Oct 2006 20:04:01 -0000 1.2
+++ OrderCounter 12 Oct 2006 13:51:35 -0000 1.3
@@ -14,11 +14,14 @@
__NAME__ description
-Specify filename where the order number is kept (and, of course,
-incremented with every new order).
+Specify filename where the simple order number template is kept
+(and, of course, incremented with every new order). Within the template,
+the right-most number is found and incremented, preserving zero
+padding, if any.
</para><para>
-If not set, the order will be
-assigned a string based on the time of the order and the user's session number.
+If the counter file is unset, then the order number will be
+assigned a string in form of
+<literal><replaceable>session_id</replaceable>.<replaceable>unix_time</replaceable></literal>.
__END__
@@ -33,6 +36,13 @@
</para><para> -->
See &glos-order; glossary entry for complete discussion of &IC;'s
ordering process.
+__END__
+
+__NAME__ example: Creating file etc/order.number
+<programlisting>
+#COUNTER-1.0
+W-TEST-0000
+</programlisting>
__END__
__NAME__ example: Setting OrderCounter
1.8 +2 -2 xmldocs/refs/Require
rev 1.8, prev_rev 1.7
Index: Require
===================================================================
RCS file: /var/cvs/xmldocs/refs/Require,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Require 8 Jul 2006 17:20:00 -0000 1.7
+++ Require 12 Oct 2006 13:51:35 -0000 1.8
@@ -3,14 +3,14 @@
__END__
__NAME__ see also
-Require,Suggest
+Require,Suggest,Capability
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain' rep='repeat'>
<replaceable>type</replaceable>
- <replaceable>type-specific value</replaceable>
+ <replaceable>type-specific-value</replaceable>
</arg>
</group>
__END__
1.3 +4 -4 xmldocs/refs/SafeUntrap
rev 1.3, prev_rev 1.2
Index: SafeUntrap
===================================================================
RCS file: /var/cvs/xmldocs/refs/SafeUntrap,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SafeUntrap 12 Jul 2006 22:09:38 -0000 1.2
+++ SafeUntrap 12 Oct 2006 13:51:35 -0000 1.3
@@ -2,10 +2,6 @@
specify operation codes to untrap in Safe.pm compartments
__END__
-__NAME__ see also
-Require,Suggest
-__END__
-
__NAME__ synopsis
<group choice='req'>
<arg choice='plain' rep='repeat'>opcode</arg>
@@ -18,6 +14,10 @@
<classname>Safe</classname> compartments, for use in
embedded &PERL; and conditional operations.
Define it as blank to prevent any operators but the default restrictive ones.
+</para><para>
+For a complete discussion and the opcodes list, see
+<citerefentry><refentrytitle>Opcode</refentrytitle>
+<manvolnum>3perl</manvolnum></citerefentry> manual page.
__END__
__NAME__ notes
1.4 +2 -2 xmldocs/refs/SocketFile
rev 1.4, prev_rev 1.3
Index: SocketFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/SocketFile,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SocketFile 10 Feb 2006 00:52:33 -0000 1.3
+++ SocketFile 12 Oct 2006 13:51:35 -0000 1.4
@@ -1,5 +1,5 @@
__NAME__ purpose
-name of the Unix socket file
+Unix socket filename
__END__
__NAME__ see also
@@ -15,7 +15,7 @@
__NAME__ description
-The directive specified the filename which &IC; should create to enable
+The directive specifies the filename which &IC; should create to enable
Unix-domain socket communication. The filename must, of course, be writable
by the Interchange daemon.
__END__
1.5 +2 -2 xmldocs/refs/Suggest
rev 1.5, prev_rev 1.4
Index: Suggest
===================================================================
RCS file: /var/cvs/xmldocs/refs/Suggest,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Suggest 21 May 2005 11:09:24 -0000 1.4
+++ Suggest 12 Oct 2006 13:51:35 -0000 1.5
@@ -10,13 +10,13 @@
<group choice='req'>
<arg choice='plain' rep='repeat'>
<replaceable>type</replaceable>
- <replaceable>type-specific value</replaceable>
+ <replaceable>type-specific-value</replaceable>
</arg>
</group>
__END__
__NAME__ description
-Just like &conf-Require; or &conf-Suggest;, this directive checks for
+Just like &conf-Require; or &conf-Capability;, this directive checks for
a feature or capability. When the tested feature is missing, a
warning message is shown.
</para><para>
1.1 xmldocs/refs/Accounting
rev 1.1, prev_rev 1.0
Index: Accounting
===================================================================
__NAME__ purpose
specify accounting software and accounting options
__END__
__NAME__ synopsis
<arg choice='plain'>Class <replaceable>MODULE_NAME</replaceable></arg><sbr />
assign_username
<group choice='plain'>
<arg choice='plain'><replaceable>1</replaceable></arg>
<arg choice='plain'><replaceable>0</replaceable></arg>
</group>
__END__
__NAME__ description
The directive specifies the accounting software and accounting options
to use.
<itemizedlist>
<listitem><para>
<literal>Class</literal> - name of the accounting software. Accounting
programs are supported through the appropriate &PERL; module interfaces
which must exist in the
<filename class='directory'>&glos-ICROOT;/lib/Vend/Accounting/</filename>
directory. An appropriate setting for this option is the class name;
for instance, class name of the &PERL; module
<filename>&glos-ICROOT;/lib/Vend/Accounting/SQL_Ledger.pm</filename>
is <classname>Vend::Accounting::SQL_Ledger</classname>.
</para></listitem>
<listitem><para>
<literal>assign_username</literal> - default 1 <!-- TODO -->
</para></listitem>
</itemizedlist>
__END__
__NAME__ missing
description for assign_username
__END__
__NAME__ example: Defining __FILENAME__
<programlisting>
Accounting Class Vend::Accounting::SQL_Ledger
Accounting assign_username 0
</programlisting>
__END__
__NAME__ notes
To check out which accounting modules (and therefore accounting software)
can be used with your version of &IC;, simply invoke
<command>ls -al <replaceable>ICROOT</replaceable>/lib/Vend/Accounting/</command>.
__END__
More information about the docs
mailing list