[interchange-docs] xmldocs - docelic modified 179 files
docs at icdevgroup.org
docs at icdevgroup.org
Mon Nov 6 13:41:29 EST 2006
User: docelic
Date: 2006-11-06 18:41:29 GMT
Modified: . TODO
Modified: docbook literals.ent
Modified: glossary database
Modified: guides search.xml
Modified: refs CartTriggerQuantity ChildLife ClearCache CodeDef
Modified: CodeRepository CommonAdjust ConfDir ConfigDatabase
Modified: ConfigDir ConfigParseComments CookieDomain
Modified: CookieLogin CookieName CookiePattern Cookies
Modified: CreditCardAuto CustomShipping DataTrace Database
Modified: DatabaseAuto DatabaseAutoIgnore DatabaseDefault
Modified: DebugFile DefaultLocale DefaultShipping
Modified: DeleteDirective DeliverImage DescriptionField
Modified: DirConfig DirectoryIndex DiscountSpacesOn
Modified: DisplayErrors DomainTail DumpAllCfg DumpStructure
Modified: DynamicData EncryptKey EncryptProgram Environment
Modified: ErrorFile ExecutionLocale External ExtraSecure
Modified: Feature FeatureDir Filter FormIgnore
Modified: FractionalItems FullUrl Glimpse GlobalSub
Modified: HTMLsuffix HammerLock History HitCount
Modified: HostnameLookups HotDBI HouseKeeping ImageAlias
Modified: ImageDir ImageDirSecure Inet_Mode IpHead IpQuad
Modified: Jobs Locale LocaleDatabase LockType LockoutCommand
Modified: MailOrderTo Mall MaxRequestsPerChild MaxServers
Modified: NoAbsolute NoCache NoImport NoImportExternal
Modified: NoSearch NonTaxableField OfflineDir OnFly
Modified: OrderCounter OrderLineLimit OrderProfile
Modified: OrderReport PGP PIDcheck PIDfile PageDir
Modified: PageSelectField ParseVariables Password
Modified: PermanentDir PreFork PriceCommas PriceDivide
Modified: PriceField ProcessPage ProductDir ProductFiles
Modified: Profiles ReadPermission RemoteUser Require
Modified: RobotHost RobotIP RobotLimit RobotUA SOAP SOAP_Host
Modified: SOAP_MaxRequests SOAP_Perms SOAP_Socket
Modified: SOAP_StartServers SafeUntrap SaveExpire
Modified: ScratchDefault ScratchDir SearchProfile SecureURL
Modified: SendMailProgram SeparateItems SessionDB
Modified: SessionDatabase SessionExpire SessionLockFile
Modified: SessionType SetGroup ShowTimes SocketFile
Modified: SocketPerms SpecialPage SpecialPageDir SpecialSub
Modified: StartServers Static StaticAll StaticDBM StaticDepth
Modified: StaticDir StaticFly StaticPage StaticPath
Modified: StaticPattern StaticSuffix Sub Suggest
Modified: TableRestrict TagDir TagGroup TagInclude
Modified: TaxInclusive TaxShipping TcpHost TcpMap TemplateDir
Modified: TolerateGet TrackFile TrackPageParam TrustProxy
Modified: Unix_Mode UpsZoneFile UrlSepChar UseModifier
Modified: UserControl UserDatabase ValuesDefault Variable
Modified: VariableDatabase VendURL WideOpen Windows
Modified: WritePermission XHTML
Modified: refs/area control
Log:
* Went over the rest of configuration directives, polished the text,
fixed a few small typos, simplified synopsis lines
Revision Changes Path
1.99 +2 -0 xmldocs/TODO
rev 1.99, prev_rev 1.98
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.98
retrieving revision 1.99
diff -u -r1.98 -r1.99
--- TODO 19 Oct 2006 20:28:13 -0000 1.98
+++ TODO 6 Nov 2006 18:41:20 -0000 1.99
@@ -15,6 +15,8 @@
listed under See Also.
- 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 ?
Outstanding:
=======
1.41 +1 -0 xmldocs/docbook/literals.ent
rev 1.41, prev_rev 1.40
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.40
retrieving revision 1.41
diff -u -r1.40 -r1.41
--- literals.ent 19 Oct 2006 19:29:54 -0000 1.40
+++ literals.ent 6 Nov 2006 18:41:20 -0000 1.41
@@ -97,6 +97,7 @@
<!-- ENTITIES FOR CORE DEVELOPERS, FOR AUTHOR LINES-->
<!ENTITY racke "<ulink url='mailto:racke at linuxia.de'>Stefan Hornburg (Racke)</ulink>">
<!ENTITY docelic "<ulink url='mailto:docelic at icdevgroup.org'>Davor Ocelic</ulink>">
+<!ENTITY yure "<ulink url='mailto:jure.kodzoman at spinstorm.com'>Jure Kodzoman</ulink>">
<!ENTITY mheins "Mike Heins">
<!ENTITY jon "Jon Jensen">
<!ENTITY jonc "Jonathan Clark">
1.7 +19 -0 xmldocs/glossary/database
rev 1.7, prev_rev 1.6
Index: database
===================================================================
RCS file: /var/cvs/xmldocs/glossary/database,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- database 12 Aug 2006 22:43:11 -0000 1.6
+++ database 6 Nov 2006 18:41:20 -0000 1.7
@@ -460,3 +460,22 @@
</section>
<para>
+
+
+
+<!--
+
+For &GDBM; &glos-database;s, the import would ordinarily happen when the
+gdbm file is deleted, a change in appropriate text source file is detected,
+&IC; is (re)started, or the catalog is reconfigured. &glos-SQL; databases
+are imported only once, at first configuration.
+
+
+<emphasis>External</emphasis> database types are DBI (&MYSQL;, &PGSQL;,
+&ORACLE; etc.) and LDAP (&OPENLDAP; etc.). In contrast,
+<emphasis>internal</emphasis> database types are DBM variants
+(&GDBM;, &BDBM;, SDBM) and in-memory.
+
+
+table= and sql parser
+-->
1.18 +1 -0 xmldocs/guides/search.xml
rev 1.18, prev_rev 1.17
Index: search.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/search.xml,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- search.xml 29 Sep 2006 21:37:47 -0000 1.17
+++ search.xml 6 Nov 2006 18:41:20 -0000 1.18
@@ -569,6 +569,7 @@
<literal>mv_return_fields</literal>
(rf, <literal></literal>/<literal></literal>,
default <literal></literal>) —
+ (specification of <literal>:*</literal> indicates "all fields").
</para>
</listitem>
1.3 +4 -2 xmldocs/refs/CartTriggerQuantity
rev 1.3, prev_rev 1.2
Index: CartTriggerQuantity
===================================================================
RCS file: /var/cvs/xmldocs/refs/CartTriggerQuantity,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CartTriggerQuantity 19 Oct 2006 19:29:54 -0000 1.2
+++ CartTriggerQuantity 6 Nov 2006 18:41:20 -0000 1.3
@@ -8,8 +8,10 @@
__END__
__NAME__ synopsis
-<arg choice='plain'>No</arg>
-<arg choice='plain'>Yes</arg>
+<group choice='plain'>
+ <arg choice='plain'>No</arg>
+ <arg choice='plain'>Yes</arg>
+</group>
__END__
1.4 +17 -14 xmldocs/refs/ChildLife
rev 1.4, prev_rev 1.3
Index: ChildLife
===================================================================
RCS file: /var/cvs/xmldocs/refs/ChildLife,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ChildLife 19 Oct 2006 19:29:54 -0000 1.3
+++ ChildLife 6 Nov 2006 18:41:20 -0000 1.4
@@ -4,7 +4,7 @@
__NAME__ see also
-PreFork,MaxServers,PIDcheck,PIDfile,HouseKeeping
+MaxRequestsPerChild,PreFork,MaxServers,PIDcheck,PIDfile
__END__
@@ -14,28 +14,31 @@
__NAME__ description
-Occasionally, in &conf-PreFork; mode, you will find child processes that get
-"starved", in other words they never seem to win the battle and receive a
-page request so they just sit there forever.
+&IC; page servers are, by default, periodically restarted to make sure
+there are no problems arising from long-running processes
+(such as memory leaks).
</para><para>
-The &conf-ChildLife; directive times out a page server after a period
-of time.
+In general, periodic &IC; page server re-starting is handled by the
+&conf-MaxRequestsPerChild; configuration directive which re-starts
+each server after a specified number of served client requests.
</para><para>
-If &conf-ChildLife; is not set, the default, the server will act just
-like it did before, stuck in that internal loop forever until
-<command>kill -9</command> happens.
+However, when &conf-PreFork; &glos-ic-run-mode; is used, some page servers
+never win the page server "selection battle"; they never get to serve a page
+request and consequently they are never restarted by &conf-MaxRequestsPerChild;.
+This is why the &conf-ChildLife; directive restarts
+a page server on an unconditional, periodic basis to make sure all servers
+are re-started from time to time.
</para><para>
-All the directive does is set the start_time of the server, and then when
-&conf-HouseKeeping; gets triggered, it checks the current time and terminates
-the server (just like &conf-MaxRequestsPerChild;, basically) if it
-has expired.
+If &conf-ChildLife; is not set, the "starved" page servers will act just
+like they did before; get stuck in an internal loop forever until
+<command>kill -9</command> on the process happens.
</para><para>
This should clear up the problem where people see with a growing number of
servers over time.
__END__
__NAME__ notes
-The directive is only used when &IC; is in <literal>PreFork</literal>
+The directive should only be used when &IC; is in <literal>PreFork</literal>
&glos-ic-run-mode;.
</para><para>
The directive value can be any Interchange &glos-interval;.
1.3 +4 -2 xmldocs/refs/ClearCache
rev 1.3, prev_rev 1.2
Index: ClearCache
===================================================================
RCS file: /var/cvs/xmldocs/refs/ClearCache,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ClearCache 19 Oct 2006 20:28:13 -0000 1.2
+++ ClearCache 6 Nov 2006 18:41:20 -0000 1.3
@@ -3,8 +3,10 @@
__END__
__NAME__ synopsis
-<arg choice='plain'>No</arg>
-<arg choice='plain'>Yes</arg>
+<group choice='plain'>
+ <arg choice='plain'>No</arg>
+ <arg choice='plain'>Yes</arg>
+</group>
__END__
__NAME__ see also
1.6 +1 -0 xmldocs/refs/CodeDef
rev 1.6, prev_rev 1.5
Index: CodeDef
===================================================================
RCS file: /var/cvs/xmldocs/refs/CodeDef,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- CodeDef 19 Oct 2006 20:28:13 -0000 1.5
+++ CodeDef 6 Nov 2006 18:41:20 -0000 1.6
@@ -20,6 +20,7 @@
__NAME__ missing
synopsis
replace plain words with entities in description
+more description
__END__
__NAME__ description
1.10 +17 -12 xmldocs/refs/CodeRepository
rev 1.10, prev_rev 1.9
Index: CodeRepository
===================================================================
RCS file: /var/cvs/xmldocs/refs/CodeRepository,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- CodeRepository 19 Oct 2006 20:28:13 -0000 1.9
+++ CodeRepository 6 Nov 2006 18:41:20 -0000 1.10
@@ -11,14 +11,14 @@
__NAME__ description
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.
+Much of it is not needed for the usual installations,
+causing a larger process 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
+Furthermore, it is hard to manually determine what subset of code is required,
+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).
+which calls some filter which calls some sort of an action —
+you get the picture.
</para><para>
A feature was needed to allow building catalogs with a more optimal
set of code than just "everything". And as we'll see in a second,
@@ -65,23 +65,23 @@
not much to be done about it. The good news is that the error should
go away after &conf-HouseKeeping; seconds, when the tag gets compiled by the
master.
-The &tag-area;, &tag-tmp;, &tag-tmpn;, and &tag-image; tags are known to
-fail in this manner in the '&std-catalog;' catalog.
+&tag-area;, &tag-tmp;, &tag-tmpn;, and &tag-image; are examples of tags known
+to fail in this manner.
Tags that are frequently called
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
+Anyway, 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 allows &conf-AllowGlobal; for
+might also 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;
+One convenient side-effect is that you can easily load new code (such as new
+&IC; tags) "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
@@ -132,3 +132,8 @@
</programlisting>
__END__
+
+__NAME__ missing
+Hot-link MapRoutine word
+provide link to example pricing.txt
+__END__
1.5 +2 -1 xmldocs/refs/CommonAdjust
rev 1.5, prev_rev 1.4
Index: CommonAdjust
===================================================================
RCS file: /var/cvs/xmldocs/refs/CommonAdjust,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- CommonAdjust 19 Oct 2006 20:28:13 -0000 1.4
+++ CommonAdjust 6 Nov 2006 18:41:20 -0000 1.5
@@ -31,7 +31,8 @@
Most of the practical setups will use a separate (<emphasis>outboard</emphasis>)
database to define pricing-related options. This <emphasis>could</emphasis>
be all done in the <database>products</database> database as well, but let's
-stick to a visually cleaner implementation.
+stick to a visually cleaner implementation. (<emphasis role='bold'>This
+database is used by other examples above!)</emphasis>
</para><para>
An example <database>pricing</database> database looks like this:
1.4 +1 -1 xmldocs/refs/ConfDir
rev 1.4, prev_rev 1.3
Index: ConfDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfDir,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ConfDir 19 Oct 2006 20:28:13 -0000 1.3
+++ ConfDir 6 Nov 2006 18:41:20 -0000 1.4
@@ -4,7 +4,7 @@
__NAME__ synopsis
-<arg choice='plain'>directory</arg>
+<arg choice='plain'><replaceable>directory_name</replaceable></arg>
__END__
1.3 +1 -1 xmldocs/refs/ConfigDatabase
rev 1.3, prev_rev 1.2
Index: ConfigDatabase
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigDatabase,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ConfigDatabase 19 Oct 2006 20:28:13 -0000 1.2
+++ ConfigDatabase 6 Nov 2006 18:41:20 -0000 1.3
@@ -1,5 +1,5 @@
__NAME__ purpose
-specify database which should hold definitions usually found in catalog.cfg
+specify database holding definitions usually found in catalog.cfg
__END__
1.5 +2 -1 xmldocs/refs/ConfigDir
rev 1.5, prev_rev 1.4
Index: ConfigDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigDir,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ConfigDir 19 Oct 2006 20:28:13 -0000 1.4
+++ ConfigDir 6 Nov 2006 18:41:20 -0000 1.5
@@ -45,7 +45,8 @@
__NAME__ example: Setting directive value from a file
In combination with the above example, the following would read the
-directive value from file <filename>variables/mailorderto</filename>.
+directive value from file <filename>variables/mailorderto</filename>
+(relative to the &glos-CATROOT;, of course).
<programlisting>
MailOrderTo <mailorderto
</programlisting>
1.5 +10 -10 xmldocs/refs/ConfigParseComments
rev 1.5, prev_rev 1.4
Index: ConfigParseComments
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigParseComments,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ConfigParseComments 19 Oct 2006 20:28:13 -0000 1.4
+++ ConfigParseComments 6 Nov 2006 18:41:20 -0000 1.5
@@ -4,13 +4,15 @@
__NAME__ synopsis
-<arg choice='plain'>Yes</arg>
-<arg choice='plain'>No</arg>
+<group choice='plain'>
+ <arg choice='plain'>Yes</arg>
+ <arg choice='plain'>No</arg>
+</group>
__END__
__NAME__ notes
This directive is obsolete as of &IC; 5.5.0, and the behavior is
-as if <code>ConfigParseComments Yes</code> was specified.
+as if <code>ConfigParseComments No</code> was specified.
__END__
@@ -23,15 +25,13 @@
are treated as pure comments with no specific meaning.
</para><para>
However, since those were originally borrowed from the C preprocessor,
-and true to their C heritage - they started with an '#' (hash) character
-in &IC; versions up to and including 4.6.
+and, true to their C heritage, they started with an '<literal>#</literal>'
+(hash) character in &IC; versions up to and including 4.6.
</para><para>
This was inconvenient for newcomers who were easily misguided by thinking
-those were just comments, so Interchange versions 4.7 and up support
-meta-directives without the hash prefix.
-</para><para>
-To preserve compatibility, the default is still <literal>Yes</literal>,
-but you should omit the '#' (hash) in new configuration files.
+those were just comments, so Interchange versions 4.7 and up were changed
+to use the meta-directives <emphasis role='bold'>without the hash
+prefix</emphasis>.
__END__
1.4 +2 -0 xmldocs/refs/CookieDomain
rev 1.4, prev_rev 1.3
Index: CookieDomain
===================================================================
RCS file: /var/cvs/xmldocs/refs/CookieDomain,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- CookieDomain 19 Oct 2006 20:28:13 -0000 1.3
+++ CookieDomain 6 Nov 2006 18:41:20 -0000 1.4
@@ -64,6 +64,8 @@
dot even if you omit it in the &conf-CookieDomain; specification
(<literal>&def-domain;</literal> ends up being the same as
<literal>.&def-domain;</literal>).
+</para><para>
+For a complete discussion on cookies, see &glos-cookie; glossary entry.
__END__
__NAME__ example: Specifying CookieDomain
1.4 +9 -5 xmldocs/refs/CookieLogin
rev 1.4, prev_rev 1.3
Index: CookieLogin
===================================================================
RCS file: /var/cvs/xmldocs/refs/CookieLogin,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- CookieLogin 19 Oct 2006 20:28:13 -0000 1.3
+++ CookieLogin 6 Nov 2006 18:41:20 -0000 1.4
@@ -4,8 +4,10 @@
__NAME__ synopsis
-<arg choice='plain'>No</arg>
-<arg choice='plain'>Yes</arg>
+<group choice='plain'>
+ <arg choice='plain'>No</arg>
+ <arg choice='plain'>Yes</arg>
+</group>
__END__
@@ -26,10 +28,12 @@
__NAME__ notes
To cause the cookie to be generated originally,
-<mv>mv_cookie_password</mv> and/or <mv>mv_cookie_username</mv> must be set.
+<mv>mv_cookie_password</mv> and/or <mv>mv_cookie_username</mv> must be set
+to a &glos-true; value.
The former causes both username and password to be saved; the latter just
-the username. This, however, is done automatically so you don't have to worry
-about it explicitly.
+the username.
+</para><para>
+For a complete discussion on cookies, see &glos-cookie; glossary entry.
__END__
TODO: Does the above really happen automatically - when you turn on
CookieLogin, or you need ScratchDefault mv_cookie_password 1 or some thing like
1.5 +2 -0 xmldocs/refs/CookieName
rev 1.5, prev_rev 1.4
Index: CookieName
===================================================================
RCS file: /var/cvs/xmldocs/refs/CookieName,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- CookieName 12 Aug 2005 22:33:40 -0000 1.4
+++ CookieName 6 Nov 2006 18:41:20 -0000 1.5
@@ -31,6 +31,8 @@
</para><para>
If the cookie is generated by another program and &conf-CookieName;
is set appropriately, &IC; will take it over without modification.
+</para><para>
+For a complete discussion on cookies, see &glos-cookie; glossary entry.
__END__
__NAME__ example: Defining CookieName
1.2 +6 -1 xmldocs/refs/CookiePattern
rev 1.2, prev_rev 1.1
Index: CookiePattern
===================================================================
RCS file: /var/cvs/xmldocs/refs/CookiePattern,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- CookiePattern 12 Aug 2005 12:41:51 -0000 1.1
+++ CookiePattern 6 Nov 2006 18:41:20 -0000 1.2
@@ -4,7 +4,7 @@
__NAME__ see also
-CookieName
+CookieName, Limit
__END__
@@ -16,6 +16,9 @@
__NAME__ description
The directive sets the regular expression that &IC; will use to extract
the session ID out of the client browser's &glos-cookie;.
+</para><para>
+This is useful in extracting session IDs out of cookies generated by programs
+other than &IC;.
__END__
__NAME__ notes
@@ -36,6 +39,8 @@
value if you somehow change the <emphasis role='bold'>content</emphasis>
that &IC; stores in browser cookies (by say, letting other program create
the cookie).
+</para><para>
+For a complete discussion on cookies, see &glos-cookie; glossary entry.
__END__
1.5 +7 -5 xmldocs/refs/Cookies
rev 1.5, prev_rev 1.4
Index: Cookies
===================================================================
RCS file: /var/cvs/xmldocs/refs/Cookies,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Cookies 19 Oct 2006 20:28:13 -0000 1.4
+++ Cookies 6 Nov 2006 18:41:20 -0000 1.5
@@ -1,11 +1,13 @@
__NAME__ purpose
-specify whether Interchange will try to land session cookies in client browsers
+specify whether Interchange will try to send session cookies to client browsers
__END__
__NAME__ synopsis
-<arg choice='plain'>Yes</arg>
-<arg choice='plain'>No</arg>
+<group choice='plain'>
+ <arg choice='plain'>Yes</arg>
+ <arg choice='plain'>No</arg>
+</group>
__END__
@@ -13,13 +15,13 @@
The directive determines whether &IC; will send &glos-cookie; to the client and
read it back to keep track of &glos-session; ID.
</para><para>
-For a complete discussion, see &glos-cookie; glossary entry.
+For a complete discussion on cookies, see &glos-cookie; glossary entry.
__END__
Caching, timed builds, and static page building will never be in effect unless
this directive is enabled.
__NAME__ see also
-CookieLogin,SaveExpire
+CookieLogin,SaveExpire,CookieDomain,CookiePattern,CookieName
__END__
1.4 +7 -2 xmldocs/refs/CreditCardAuto
rev 1.4, prev_rev 1.3
Index: CreditCardAuto
===================================================================
RCS file: /var/cvs/xmldocs/refs/CreditCardAuto,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- CreditCardAuto 19 Oct 2006 20:28:14 -0000 1.3
+++ CreditCardAuto 6 Nov 2006 18:41:20 -0000 1.4
@@ -8,8 +8,10 @@
__END__
__NAME__ synopsis
-<arg choice='plain'>No</arg>
-<arg choice='plain'>Yes</arg>
+<group choice='plain'>
+ <arg choice='plain'>No</arg>
+ <arg choice='plain'>Yes</arg>
+</group>
__END__
@@ -26,3 +28,6 @@
</programlisting>
__END__
+__NAME__ missing
+Saving CC info where ?
+__END__
1.3 +1 -0 xmldocs/refs/CustomShipping
rev 1.3, prev_rev 1.2
Index: CustomShipping
===================================================================
RCS file: /var/cvs/xmldocs/refs/CustomShipping,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CustomShipping 19 Oct 2006 20:28:14 -0000 1.2
+++ CustomShipping 6 Nov 2006 18:41:20 -0000 1.3
@@ -27,5 +27,6 @@
Overview the text, see if it's OK
Make real-world example
Make shipping.txt database to supplement the example
+Where is the error issued ?
__END__
1.5 +1 -1 xmldocs/refs/DataTrace
rev 1.5, prev_rev 1.4
Index: DataTrace
===================================================================
RCS file: /var/cvs/xmldocs/refs/DataTrace,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- DataTrace 19 Oct 2006 20:28:14 -0000 1.4
+++ DataTrace 6 Nov 2006 18:41:20 -0000 1.5
@@ -9,7 +9,7 @@
__NAME__ description
-Trace DBI calls with variable granularity.
+Trace &PERL; DBI calls with variable granularity.
As this tends to produce large amounts of output, only use it if
there's a strong chance that your problem is related to DBI.
</para><para>
1.6 +0 -1 xmldocs/refs/Database
rev 1.6, prev_rev 1.5
Index: Database
===================================================================
RCS file: /var/cvs/xmldocs/refs/Database,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- Database 19 Oct 2006 20:28:14 -0000 1.5
+++ Database 6 Nov 2006 18:41:20 -0000 1.6
@@ -50,7 +50,6 @@
__END__
__NAME__ missing
-Database on global level doesn't work!!
Examples for each DB type supported (Oracle, Pg, Mys,... )
List of all keys that can occur in a specification
__END__
1.10 +7 -5 xmldocs/refs/DatabaseAuto
rev 1.10, prev_rev 1.9
Index: DatabaseAuto
===================================================================
RCS file: /var/cvs/xmldocs/refs/DatabaseAuto,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- DatabaseAuto 19 Oct 2006 20:28:14 -0000 1.9
+++ DatabaseAuto 6 Nov 2006 18:41:20 -0000 1.10
@@ -56,8 +56,10 @@
</para><para>
Currently, the <literal>catalog</literal> argument is not used by any
database driver, but it
-may be in the future. See the DBI manual and your DBD module's manual
-for details on these arguments.
+may be in the future. The other options (<literal>schema</literal>,
+<literal>name</literal> and <literal>type</literal>) are database-specific;
+see the DBI manual, appropriate DBD manual and
+<xref linkend='DatabaseAuto_examples'/> for details and examples.
</para><para>
If the &PERL; module <classname>DBIx::DBSchema</classname> was found,
@@ -80,9 +82,9 @@
For more about &IC; and databases, and supported formats, see &glos-database;
glossary entry.
</para><para>
-The <literal>schema</literal> argument to this directive can be specified to
-avoid using the &conf-DatabaseAutoIgnore; directive, which can easily ignore
-more tables than you really intended.
+The <literal>schema</literal> argument to this directive can be specified when
+you want to avoid using the &conf-DatabaseAutoIgnore; directive (it's drawback
+is that it could easily ignore more tables than you really intended).
</para><para>
Also be aware that it is possible to make some confusing configuration mistakes
here, if the schema you specify is not in the database user's
1.5 +6 -5 xmldocs/refs/DatabaseAutoIgnore
rev 1.5, prev_rev 1.4
Index: DatabaseAutoIgnore
===================================================================
RCS file: /var/cvs/xmldocs/refs/DatabaseAutoIgnore,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- DatabaseAutoIgnore 19 Oct 2006 20:28:14 -0000 1.4
+++ DatabaseAutoIgnore 6 Nov 2006 18:41:20 -0000 1.5
@@ -1,5 +1,5 @@
__NAME__ purpose
-prevent DatabaseAuto from bringing in tables whose names match this regex pattern
+prevent DatabaseAuto from configuring tables whose names match regex pattern
__END__
__NAME__ synopsis
@@ -11,9 +11,10 @@
__END__
__NAME__ description
-The directive prevents &conf-DatabaseAuto;
-from automatically configuring tables that match specified
-regular expression.
+The directive allows &glos-regexp; specification of an "ignore list" that
+prevents &conf-DatabaseAuto; from automatically configuring
+<emphasis>all</emphasis> tables found. (For example, you will want
+to exclude tables in non-default schemas.)
</para><para>
Note that instead of using this directive, you may prefer to directly
specify <literal>schema</literal> argument to the &conf-DatabaseAuto; directive.
@@ -30,7 +31,7 @@
__NAME__ example: Specifying DatabaseAutoIgnore
This prevents &IC; from bringing in tables in non-default schemas
-in PostgreSQL 7.4 and newer, which cause errors.
+in &PGSQL; 7.4 and newer.
<programlisting>
DatabaseAutoIgnore ^sql_
</programlisting>
1.5 +2 -2 xmldocs/refs/DatabaseDefault
rev 1.5, prev_rev 1.4
Index: DatabaseDefault
===================================================================
RCS file: /var/cvs/xmldocs/refs/DatabaseDefault,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- DatabaseDefault 19 Oct 2006 20:28:14 -0000 1.4
+++ DatabaseDefault 6 Nov 2006 18:41:20 -0000 1.5
@@ -11,8 +11,8 @@
</para><para>
For a list of possible parameters (keys), see the &conf-Database; directive.
</para><para>
-&conf-DatabaseDefault; accepts any scalar setting, which means all
-<emphasis role='bold'>except</emphasis>:
+&conf-DatabaseDefault; accepts scalar keys, which actually
+means all from the list above <emphasis role='bold'>except</emphasis>:
<itemizedlist>
<listitem><para>
1.5 +3 -3 xmldocs/refs/DebugFile
rev 1.5, prev_rev 1.4
Index: DebugFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/DebugFile,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- DebugFile 19 Oct 2006 20:28:14 -0000 1.4
+++ DebugFile 6 Nov 2006 18:41:20 -0000 1.5
@@ -14,11 +14,11 @@
__NAME__ description
-Specify the Interchange debug output file. If the filename is not absolute,
-it is treated relative to the Interchange root directory (ICROOT).
+Specify the &IC; debug output file. If the filename is not absolute,
+it is treated relative to the Interchange root directory (&glos-ICROOT;).
</para><para>
When enabled, the debug file will gather output of the
-<function>::logDebug()</function> Interchange statements and Perl warnings
+<function>::logDebug()</function> Interchange statements and &PERL; warnings
(if they are enabled).
__END__
1.2 +1 -3 xmldocs/refs/DefaultLocale
rev 1.2, prev_rev 1.1
Index: DefaultLocale
===================================================================
RCS file: /var/cvs/xmldocs/refs/DefaultLocale,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DefaultLocale 22 May 2005 10:21:28 -0000 1.1
+++ DefaultLocale 6 Nov 2006 18:41:20 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>locale definition</arg>
-</group>
+<arg choice='plain'><replaceable>locale_definition</replaceable></arg>
__END__
1.2 +2 -4 xmldocs/refs/DefaultShipping
rev 1.2, prev_rev 1.1
Index: DefaultShipping
===================================================================
RCS file: /var/cvs/xmldocs/refs/DefaultShipping,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DefaultShipping 29 Jan 2006 14:48:19 -0000 1.1
+++ DefaultShipping 6 Nov 2006 18:41:20 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>ship_mode</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>ship_mode</replaceable></arg>
__END__
@@ -17,7 +15,7 @@
It defaults to a value "<literal>default</literal>".
__END__
-__NAME__ example: Specifying DefaultShipping
+__NAME__ example: Specifying __FILENAME__
<programlisting>
DefaultShipping UPS
</programlisting>
1.2 +1 -3 xmldocs/refs/DeleteDirective
rev 1.2, prev_rev 1.1
Index: DeleteDirective
===================================================================
RCS file: /var/cvs/xmldocs/refs/DeleteDirective,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DeleteDirective 19 Feb 2005 17:14:03 -0000 1.1
+++ DeleteDirective 6 Nov 2006 18:41:20 -0000 1.2
@@ -3,9 +3,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.3 +4 -1 xmldocs/refs/DeliverImage
rev 1.3, prev_rev 1.2
Index: DeliverImage
===================================================================
RCS file: /var/cvs/xmldocs/refs/DeliverImage,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DeliverImage 9 Aug 2005 17:01:01 -0000 1.2
+++ DeliverImage 6 Nov 2006 18:41:20 -0000 1.3
@@ -4,7 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
@@ -47,3 +47,6 @@
&conf-ImageDir; or &conf-ImageDirSecure;, of course).
__END__
+__NAME__ missing
+Better description
+__END__
1.3 +6 -6 xmldocs/refs/DescriptionField
rev 1.3, prev_rev 1.2
Index: DescriptionField
===================================================================
RCS file: /var/cvs/xmldocs/refs/DescriptionField,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DescriptionField 11 Jun 2005 08:29:00 -0000 1.2
+++ DescriptionField 6 Nov 2006 18:41:20 -0000 1.3
@@ -4,15 +4,14 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>field_name</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>field_name</replaceable></arg>
__END__
__NAME__ description
-By default, &IC; expects the item description to be in the
-<database class='field'>description</database> field in the database.
+By default, &IC; expects the product description to be in the
+<database class='field'>description</database> field in the
+<database>products</database> database.
This directive allows modification of the default name.
</para><para>
The field is accessed implicitly when you call say,
@@ -24,7 +23,8 @@
The existence of the field is not exactly crucial, but it's important
for say, &glos-flypage;s.
</para><para>
-It's also useful to set the directive value based on &glos-locale;.
+It's also useful to set the directive value based on &glos-locale;,
+allowing for locale-specific product descriptions.
__END__
TODO: Clarify this? "If there is an
1.3 +1 -1 xmldocs/refs/DirConfig
rev 1.3, prev_rev 1.2
Index: DirConfig
===================================================================
RCS file: /var/cvs/xmldocs/refs/DirConfig,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DirConfig 19 Nov 2005 22:37:41 -0000 1.2
+++ DirConfig 6 Nov 2006 18:41:20 -0000 1.3
@@ -26,7 +26,7 @@
values) named after file names.
</para><para>
The source file name is kept in
-<varname>$Vend::Cfg->{DirConfig}{Variable}{VARNAME}</varname>,
+<varname>$Vend::Cfg->{DirConfig}{Variable}{<replaceable>VARNAME</replaceable>}</varname>
if <pragma>dynamic_variables</pragma> &glos-pragma; is set.
<pragma>dynamic_variables</pragma> enables <emphasis>dynamic</emphasis>
updating of variables from files.
1.3 +1 -3 xmldocs/refs/DirectoryIndex
rev 1.3, prev_rev 1.2
Index: DirectoryIndex
===================================================================
RCS file: /var/cvs/xmldocs/refs/DirectoryIndex,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DirectoryIndex 22 Dec 2004 00:14:21 -0000 1.2
+++ DirectoryIndex 6 Nov 2006 18:41:20 -0000 1.3
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>filename</arg>
-</group>
+<arg choice='plain'><replaceable>filename</replaceable></arg>
__END__
1.2 +1 -1 xmldocs/refs/DiscountSpacesOn
rev 1.2, prev_rev 1.1
Index: DiscountSpacesOn
===================================================================
RCS file: /var/cvs/xmldocs/refs/DiscountSpacesOn,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DiscountSpacesOn 3 Apr 2006 23:28:56 -0000 1.1
+++ DiscountSpacesOn 6 Nov 2006 18:41:20 -0000 1.2
@@ -7,7 +7,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
1.3 +1 -1 xmldocs/refs/DisplayErrors
rev 1.3, prev_rev 1.2
Index: DisplayErrors
===================================================================
RCS file: /var/cvs/xmldocs/refs/DisplayErrors,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DisplayErrors 8 Dec 2004 12:39:58 -0000 1.2
+++ DisplayErrors 6 Nov 2006 18:41:20 -0000 1.3
@@ -4,7 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
1.2 +7 -6 xmldocs/refs/DomainTail
rev 1.2, prev_rev 1.1
Index: DomainTail
===================================================================
RCS file: /var/cvs/xmldocs/refs/DomainTail,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DomainTail 1 Mar 2005 10:31:12 -0000 1.1
+++ DomainTail 6 Nov 2006 18:41:20 -0000 1.2
@@ -9,9 +9,9 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>yes</arg>
- <arg choice='plain'>no</arg>
+<group choice='plain'>
+ <arg choice='plain'>Yes</arg>
+ <arg choice='plain'>No</arg>
</group>
__END__
@@ -31,9 +31,10 @@
Note that this directive is <emphasis role='bold'>enabled</emphasis>
by default.
</para><para>
-If you are encrypting credit cards with PGP/GPG or using payment services
-(such as CyberCash), then look at the &conf-WideOpen; directive, which
-enables more browser compatibility, again at the cost of some more security.
+If you are encrypting credit cards with PGP/GPG or using payment services,
+then look at the &conf-WideOpen; directive, which
+enables even more browser compatibility, again at the cost of even more
+security.
__END__
__NAME__ example: Disabling DomainTail
1.2 +5 -4 xmldocs/refs/DumpAllCfg
rev 1.2, prev_rev 1.1
Index: DumpAllCfg
===================================================================
RCS file: /var/cvs/xmldocs/refs/DumpAllCfg,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DumpAllCfg 21 May 2005 12:51:29 -0000 1.1
+++ DumpAllCfg 6 Nov 2006 18:41:20 -0000 1.2
@@ -4,15 +4,16 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>0</arg>
- <arg choice='plain'>1</arg>
+<group choice='plain'>
+ <arg choice='plain'>No</arg>
+ <arg choice='plain'>Yes</arg>
</group>
__END__
__NAME__ description
-Instruct &IC; to dump the complete server configuration (with &conf-Include;s expanded) to <filename>allconfigs.cfg</filename> in the &IC; run
+Instruct &IC; to dump the complete server configuration (with "includes"
+expanded) to <filename>allconfigs.cfg</filename> in the &IC; run
directory.
</para><para>
The dump file does not contain catalog configurations.
1.4 +1 -1 xmldocs/refs/DumpStructure
rev 1.4, prev_rev 1.3
Index: DumpStructure
===================================================================
RCS file: /var/cvs/xmldocs/refs/DumpStructure,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DumpStructure 21 May 2005 12:51:29 -0000 1.3
+++ DumpStructure 6 Nov 2006 18:41:20 -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>
1.2 +1 -3 xmldocs/refs/DynamicData
rev 1.2, prev_rev 1.1
Index: DynamicData
===================================================================
RCS file: /var/cvs/xmldocs/refs/DynamicData,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DynamicData 21 May 2005 13:15:33 -0000 1.1
+++ DynamicData 6 Nov 2006 18:41:20 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>database</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>database</replaceable></arg>
__END__
1.2 +1 -1 xmldocs/refs/EncryptKey
rev 1.2, prev_rev 1.1
Index: EncryptKey
===================================================================
RCS file: /var/cvs/xmldocs/refs/EncryptKey,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- EncryptKey 12 Aug 2005 12:41:51 -0000 1.1
+++ EncryptKey 6 Nov 2006 18:41:20 -0000 1.2
@@ -4,7 +4,7 @@
__NAME__ synopsis
- <arg choice='req'><replaceable>key_or_user_identifier</replaceable></arg>
+<arg choice='plain'><replaceable>key_or_user_identifier</replaceable></arg>
__END__
1.8 +3 -0 xmldocs/refs/EncryptProgram
rev 1.8, prev_rev 1.7
Index: EncryptProgram
===================================================================
RCS file: /var/cvs/xmldocs/refs/EncryptProgram,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- EncryptProgram 2 Sep 2006 22:21:48 -0000 1.7
+++ EncryptProgram 6 Nov 2006 18:41:20 -0000 1.8
@@ -37,6 +37,9 @@
</para><para>
Since &IC; 4.7.7, specifying program filename only is enough —
no arguments are needed, although they will still work as expected.
+</para><para>
+If the encrypt program is in your path, avoid using full pathname to
+ease the eventual switch to a platform with different binary file locations.
__END__
__NAME__ see also
1.3 +1 -3 xmldocs/refs/Environment
rev 1.3, prev_rev 1.2
Index: Environment
===================================================================
RCS file: /var/cvs/xmldocs/refs/Environment,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Environment 8 Dec 2004 12:39:58 -0000 1.2
+++ Environment 6 Nov 2006 18:41:20 -0000 1.3
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'>environment variable</arg>
-</group>
+<arg choice='plain' rep='repeat'>environment_variable_name</arg>
__END__
1.4 +1 -3 xmldocs/refs/ErrorFile
rev 1.4, prev_rev 1.3
Index: ErrorFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/ErrorFile,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ErrorFile 2 Feb 2005 11:35:58 -0000 1.3
+++ ErrorFile 6 Nov 2006 18:41:20 -0000 1.4
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>filename</arg>
-</group>
+<arg choice='plain'><replaceable>filename</replaceable></arg>
__END__
1.3 +1 -3 xmldocs/refs/ExecutionLocale
rev 1.3, prev_rev 1.2
Index: ExecutionLocale
===================================================================
RCS file: /var/cvs/xmldocs/refs/ExecutionLocale,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ExecutionLocale 22 May 2005 10:21:28 -0000 1.2
+++ ExecutionLocale 6 Nov 2006 18:41:20 -0000 1.3
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>locale definition</arg>
-</group>
+<arg choice='plain'><replaceable>locale_definition</replaceable></arg>
__END__
1.2 +4 -7 xmldocs/refs/External
rev 1.2, prev_rev 1.1
Index: External
===================================================================
RCS file: /var/cvs/xmldocs/refs/External,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- External 8 Apr 2006 23:45:55 -0000 1.1
+++ External 6 Nov 2006 18:41:20 -0000 1.2
@@ -3,7 +3,7 @@
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
@@ -17,15 +17,12 @@
The global &conf-External; must be enabled to allow individual catalog setting.
__END__
-__NAME__ example: Defining External as a global configuration directive
+__NAME__ example: Defining External
<programlisting>
External yes
</programlisting>
__END__
-__NAME__ example: Defining External for a specific catalog
-<programlisting>
-External yes
-</programlisting>
+__NAME__ missing
+What is it
__END__
-
1.2 +3 -3 xmldocs/refs/ExtraSecure
rev 1.2, prev_rev 1.1
Index: ExtraSecure
===================================================================
RCS file: /var/cvs/xmldocs/refs/ExtraSecure,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ExtraSecure 21 May 2005 12:51:29 -0000 1.1
+++ ExtraSecure 6 Nov 2006 18:41:20 -0000 1.2
@@ -8,9 +8,9 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>0</arg>
- <arg choice='plain'>1</arg>
+<group choice='plain'>
+ <arg choice='plain'>No</arg>
+ <arg choice='plain'>Yes</arg>
</group>
__END__
1.3 +1 -3 xmldocs/refs/Feature
rev 1.3, prev_rev 1.2
Index: Feature
===================================================================
RCS file: /var/cvs/xmldocs/refs/Feature,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Feature 20 May 2005 15:24:24 -0000 1.2
+++ Feature 6 Nov 2006 18:41:20 -0000 1.3
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>feature_name</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>feature_name</replaceable></arg>
__END__
1.3 +1 -3 xmldocs/refs/FeatureDir
rev 1.3, prev_rev 1.2
Index: FeatureDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/FeatureDir,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- FeatureDir 29 Sep 2006 21:37:48 -0000 1.2
+++ FeatureDir 6 Nov 2006 18:41:20 -0000 1.3
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>directory</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>directory_name</replaceable></arg>
__END__
1.3 +10 -7 xmldocs/refs/Filter
rev 1.3, prev_rev 1.2
Index: Filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/Filter,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Filter 28 Jan 2006 13:45:52 -0000 1.2
+++ Filter 6 Nov 2006 18:41:20 -0000 1.3
@@ -7,16 +7,14 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>
- <replaceable>variable_name</replaceable>
- <replaceable>filter_name</replaceable>
- </arg>
-</group>
+<arg choice='plain' rep='repeat'>
+ <replaceable>variable_name</replaceable>
+ <replaceable>filter_name</replaceable>
+</arg>
__END__
__NAME__ description
-The directive assigns one or more (space separated) &glos-filter;s
+The directive assigns one or more (comma separated) &glos-filter;s
that should be automatically applied to a variable.
__END__
@@ -36,5 +34,10 @@
You could also use the &tag-filter; tag to help yourself, but in the long
run the &conf-Filter; approach reduces typing and minimizes the chance
of omission.
+__END__
+
+__NAME__ missing
+Comma-separated list when multiple filters, right? Can't be space, it'd split into directive=value pair.
+More examples
__END__
1.2 +6 -7 xmldocs/refs/FormIgnore
rev 1.2, prev_rev 1.1
Index: FormIgnore
===================================================================
RCS file: /var/cvs/xmldocs/refs/FormIgnore,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- FormIgnore 11 Jun 2005 17:22:36 -0000 1.1
+++ FormIgnore 6 Nov 2006 18:41:20 -0000 1.2
@@ -1,16 +1,14 @@
__NAME__ purpose
-specify variables that should not be propagated from the CGI to Values space
+specify variables that should not be propagated from CGI to Values space
__END__
__NAME__ see also
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'>
- <replaceable>variable_name</replaceable>
- </arg>
-</group>
+<arg choice='plain' rep='repeat'>
+ <replaceable>variable_name</replaceable>
+</arg>
__END__
__NAME__ description
@@ -26,7 +24,8 @@
__NAME__ notes
-See &glos-CGI; glossary entry for introduction and discussion.
+See &glos-CGI; and &glos-value; glossary entries for an
+introduction and discussion.
__END__
1.2 +3 -3 xmldocs/refs/FractionalItems
rev 1.2, prev_rev 1.1
Index: FractionalItems
===================================================================
RCS file: /var/cvs/xmldocs/refs/FractionalItems,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- FractionalItems 11 Jun 2005 17:22:36 -0000 1.1
+++ FractionalItems 6 Nov 2006 18:41:20 -0000 1.2
@@ -4,9 +4,9 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>0</arg>
- <arg choice='plain'>1</arg>
+<group choice='plain'>
+ <arg choice='plain'>No</arg>
+ <arg choice='plain'>Yes</arg>
</group>
__END__
1.2 +5 -5 xmldocs/refs/FullUrl
rev 1.2, prev_rev 1.1
Index: FullUrl
===================================================================
RCS file: /var/cvs/xmldocs/refs/FullUrl,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- FullUrl 19 Feb 2005 17:14:03 -0000 1.1
+++ FullUrl 6 Nov 2006 18:41:20 -0000 1.2
@@ -4,7 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
@@ -15,16 +15,16 @@
&IC; determines the appropriate catalog to invoke by the
<literal>SCRIPT_NAME</literal> from the CGI call. This means that different
(possibly virtual) hosts cannot use the same <literal>SCRIPT_NAME</literal>, as
-the catalogs would become indistinguishable. Set this directive to enable
-differentiation performed on the hostname as well.
+the catalogs would become indistinguishable. Setting this directive includes
+the hostname in the catalog selection method.
</para><para>
See the &conf-Catalog; directive for more on the subject and concrete
examples.
__END__
__NAME__ notes
-If &conf-FullUrl; is defined, <emphasis role='bold'>all> catalogs must be
-defined with hostnames included</emphasis>. Per-catalog setting will not work,
+If &conf-FullUrl; is defined, <emphasis role='bold'>all catalogs must be
+defined with hostnames included</emphasis>. Per-catalog setting can not work,
as this is used before the catalog name is known.
__END__
1.2 +2 -4 xmldocs/refs/Glimpse
rev 1.2, prev_rev 1.1
Index: Glimpse
===================================================================
RCS file: /var/cvs/xmldocs/refs/Glimpse,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Glimpse 24 Mar 2006 22:29:59 -0000 1.1
+++ Glimpse 6 Nov 2006 18:41:20 -0000 1.2
@@ -7,10 +7,8 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>program_path</replaceable></arg>
- <arg choice='opt' rep='repeat'><replaceable>option</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>program_path</replaceable></arg>
+<arg choice='opt' rep='repeat'><replaceable>option</replaceable></arg>
__END__
1.4 +9 -13 xmldocs/refs/GlobalSub
rev 1.4, prev_rev 1.3
Index: GlobalSub
===================================================================
RCS file: /var/cvs/xmldocs/refs/GlobalSub,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- GlobalSub 28 Jan 2006 13:45:52 -0000 1.3
+++ GlobalSub 6 Nov 2006 18:41:20 -0000 1.4
@@ -7,12 +7,10 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>
- <literal>Sub</literal>
- <replaceable>perl_code</replaceable>
- </arg>
-</group>
+<arg choice='plain'>
+ <literal>Sub</literal>
+ <replaceable>perl_code</replaceable>
+</arg>
__END__
__NAME__ description
@@ -27,7 +25,7 @@
<programlisting><![CDATA[
GlobalSub <<EOF
sub count_orders {
- my $counter = new File::CounterFile "/tmp/count_orders", '1';
+ my $counter = new File::CounterFile "tmp/count_orders", '1';
my $number = $counter->inc();
return "There have been $number orders placed.\n";
}
@@ -36,10 +34,8 @@
The above code would be called from an &IC; page in the following way:
<programlisting><![CDATA[
-Items, sorted by quantity:
-[perl tables=products subs='sort_cart_by_quantity']
- my $cart = $Carts->{main};
- return sort_cart_by_quantity($cart);
+[perl tables=products subs='count_orders']
+ return count_orders();
[/perl]
]]></programlisting>
__END__
@@ -48,8 +44,8 @@
__NAME__ notes
As with &PERL; "here documents," the "<literal>EOF</literal>" (or arbitrarily
named end marker) must be the <emphasis>only</emphasis> thing on the line,
-without leading or trailing white space. Do not even append a semicolon to the
-marker (as you would in &PERL;).
+without leading or trailing white space. Also, do not append a semicolon to the
+opening marker (as you would in &PERL;).
</para><para>
Global subroutines are not subject to <classname>Safe</classname> security
checks. They can do most anything!
1.4 +3 -5 xmldocs/refs/HTMLsuffix
rev 1.4, prev_rev 1.3
Index: HTMLsuffix
===================================================================
RCS file: /var/cvs/xmldocs/refs/HTMLsuffix,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- HTMLsuffix 11 Jun 2005 08:29:00 -0000 1.3
+++ HTMLsuffix 6 Nov 2006 18:41:20 -0000 1.4
@@ -4,15 +4,13 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>HTML file extension (suffix)</arg>
-</group>
+<arg choice='plain'><replaceable>file_extension</replaceable></arg>
__END__
__NAME__ description
-Specify extension to append to the filename when looking for the source
-file in the <filename class='directory'>pages/</filename> directory.
+Specify extension to append to the filenames when looking for the source
+files in the <filename class='directory'>pages/</filename> directory.
__END__
1.2 +1 -3 xmldocs/refs/HammerLock
rev 1.2, prev_rev 1.1
Index: HammerLock
===================================================================
RCS file: /var/cvs/xmldocs/refs/HammerLock,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- HammerLock 11 Dec 2004 23:42:45 -0000 1.1
+++ HammerLock 6 Nov 2006 18:41:20 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>interval</arg>
-</group>
+<arg choice='plain'><replaceable>interval</replaceable></arg>
__END__
1.2 +3 -4 xmldocs/refs/History
rev 1.2, prev_rev 1.1
Index: History
===================================================================
RCS file: /var/cvs/xmldocs/refs/History,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- History 11 Jun 2005 17:22:36 -0000 1.1
+++ History 6 Nov 2006 18:41:20 -0000 1.2
@@ -4,15 +4,14 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>count</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>count</replaceable></arg>
__END__
__NAME__ description
The directive specifies
-how many of the most recent user clicks should be stored in the session history.
+how many of the most recent user clicks should be stored in the &glos-session;
+history.
__END__
__NAME__ see also
1.4 +1 -1 xmldocs/refs/HitCount
rev 1.4, prev_rev 1.3
Index: HitCount
===================================================================
RCS file: /var/cvs/xmldocs/refs/HitCount,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- HitCount 8 Dec 2004 12:39:58 -0000 1.3
+++ HitCount 6 Nov 2006 18:41:20 -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>
1.2 +2 -2 xmldocs/refs/HostnameLookups
rev 1.2, prev_rev 1.1
Index: HostnameLookups
===================================================================
RCS file: /var/cvs/xmldocs/refs/HostnameLookups,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- HostnameLookups 12 Aug 2005 22:33:40 -0000 1.1
+++ HostnameLookups 6 Nov 2006 18:41:20 -0000 1.2
@@ -1,10 +1,10 @@
__NAME__ purpose
-perform hostname lookups (DNS resolving)?
+perform hostname lookups (DNS resolving)
__END__
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
1.3 +2 -4 xmldocs/refs/HotDBI
rev 1.3, prev_rev 1.2
Index: HotDBI
===================================================================
RCS file: /var/cvs/xmldocs/refs/HotDBI,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- HotDBI 19 Nov 2005 22:37:41 -0000 1.2
+++ HotDBI 6 Nov 2006 18:41:20 -0000 1.3
@@ -3,14 +3,12 @@
__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 should use persistent database connections.
+Specify &glos-catalog;s that should use persistent database connections.
When a connection is persistent, it will be maintained and cached without
reconnecting for every page request.
__END__
1.7 +2 -4 xmldocs/refs/HouseKeeping
rev 1.7, prev_rev 1.6
Index: HouseKeeping
===================================================================
RCS file: /var/cvs/xmldocs/refs/HouseKeeping,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- HouseKeeping 15 Aug 2006 20:22:02 -0000 1.6
+++ HouseKeeping 6 Nov 2006 18:41:20 -0000 1.7
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>interval</arg>
-</group>
+<arg choice='plain'><replaceable>interval</replaceable></arg>
__END__
@@ -15,7 +13,7 @@
<emphasis>wake up</emphasis> and
look for user reconfiguration requests and hung processes. On some
systems, this wakeup is the only time the server will terminate in response
-to a stop command.
+to a <literal>-stop</literal> command.
__END__
1.2 +2 -4 xmldocs/refs/ImageAlias
rev 1.2, prev_rev 1.1
Index: ImageAlias
===================================================================
RCS file: /var/cvs/xmldocs/refs/ImageAlias,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ImageAlias 18 Nov 2005 23:15:02 -0000 1.1
+++ ImageAlias 6 Nov 2006 18:41:20 -0000 1.2
@@ -9,10 +9,8 @@
__NAME__ synopsis
- <arg choice='req'>
- <replaceable>alias_location</replaceable>
- <replaceable>real_location</replaceable>
- </arg>
+<arg choice='plain'><replaceable>alias_location</replaceable></arg>
+<arg choice='plain'><replaceable>real_location</replaceable></arg>
__END__
1.4 +4 -6 xmldocs/refs/ImageDir
rev 1.4, prev_rev 1.3
Index: ImageDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/ImageDir,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ImageDir 18 Nov 2005 23:15:02 -0000 1.3
+++ ImageDir 6 Nov 2006 18:41:20 -0000 1.4
@@ -4,14 +4,12 @@
__NAME__ see also
-ImageDir, ImageDirSecure, VendURL, SecureURL,no_image_rewrite
+ImageDir, ImageDirSecure, VendURL, SecureURL,no_image_rewrite, ImageAlias
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>location</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>location</replaceable></arg>
__END__
@@ -31,7 +29,7 @@
&IC; user, and contents in it cannot be accessed by the web server without
&IC; mediating the connection. This directory is generally supposed to
only contain directories and Interchange-enabled &glos-HTML; pages,
-and nothing else.
+nothing else.
</para><para>
It is therefore obvious that an alternative way has to be provided
to serve images. When you define &conf-ImageDir;, &IC; will appropriately
@@ -43,7 +41,7 @@
in the <filename class='directory'>images/</filename> subdirectory, then
you would set &conf-ImageDir; to <literal>/images/</literal>.
With this setting in effect, a link such as <img src="order.png">
-would be changed to <img src="/images/order.png">.
+would automatically be translated to <img src="/images/order.png">.
__END__
__NAME_ notes
1.2 +1 -3 xmldocs/refs/ImageDirSecure
rev 1.2, prev_rev 1.1
Index: ImageDirSecure
===================================================================
RCS file: /var/cvs/xmldocs/refs/ImageDirSecure,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ImageDirSecure 12 Aug 2005 22:33:40 -0000 1.1
+++ ImageDirSecure 6 Nov 2006 18:41:20 -0000 1.2
@@ -9,9 +9,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>location</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>location</replaceable></arg>
__END__
1.3 +6 -2 xmldocs/refs/Inet_Mode
rev 1.3, prev_rev 1.2
Index: Inet_Mode
===================================================================
RCS file: /var/cvs/xmldocs/refs/Inet_Mode,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Inet_Mode 19 Nov 2005 22:37:41 -0000 1.2
+++ Inet_Mode 6 Nov 2006 18:41:20 -0000 1.3
@@ -8,7 +8,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
@@ -17,7 +17,7 @@
__NAME__ description
Specify whether the &IC; server should open an INET-domain socket and
-listen on some port.
+listen on some port (<literal>7786</literal> by default).
</para><para>
This &glos-configuration; directive can be overridden using
<literal>interchange -i</literal> switch on the command line.
@@ -27,6 +27,10 @@
__NAME__ notes
You will need &IC; INET mode in only rare circumstances (that is, only if your
Web and &IC; server are not the same machine).
+</para><para>
+The default port number, <literal>7786</literal>, was chosen since it
+represents the ASCII numbers of letters <literal>M</literal> and
+<literal>V</literal>. (&IC; was once called MiniVend).
__END__
__NAME__ example: Enabling Inet_Mode
1.3 +2 -1 xmldocs/refs/IpHead
rev 1.3, prev_rev 1.2
Index: IpHead
===================================================================
RCS file: /var/cvs/xmldocs/refs/IpHead,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- IpHead 8 Dec 2004 12:39:58 -0000 1.2
+++ IpHead 6 Nov 2006 18:41:20 -0000 1.3
@@ -9,7 +9,7 @@
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
@@ -36,6 +36,7 @@
<programlisting>
DomainTail No
IpHead Yes
+IpQuad 3
</programlisting>
__END__
1.4 +1 -3 xmldocs/refs/IpQuad
rev 1.4, prev_rev 1.3
Index: IpQuad
===================================================================
RCS file: /var/cvs/xmldocs/refs/IpQuad,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- IpQuad 19 Nov 2005 22:37:41 -0000 1.3
+++ IpQuad 6 Nov 2006 18:41:20 -0000 1.4
@@ -9,9 +9,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>number</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>number</replaceable></arg>
__END__
1.2 +4 -0 xmldocs/refs/Jobs
rev 1.2, prev_rev 1.1
Index: Jobs
===================================================================
RCS file: /var/cvs/xmldocs/refs/Jobs,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Jobs 24 Mar 2006 22:29:59 -0000 1.1
+++ Jobs 6 Nov 2006 18:41:20 -0000 1.2
@@ -72,4 +72,8 @@
Diff between initialize and autoload
Log specifies filename or just 1/0 ?
Exactly what does add_session do
+Turn list of keys into format NAME (SYNTAX, default DEF) - DESCRIPTION
+Add examples
+Check if there are more keys than listed
__END__
+
1.12 +2 -0 xmldocs/refs/Locale
rev 1.12, prev_rev 1.11
Index: Locale
===================================================================
RCS file: /var/cvs/xmldocs/refs/Locale,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- Locale 12 Oct 2006 13:51:35 -0000 1.11
+++ Locale 6 Nov 2006 18:41:20 -0000 1.12
@@ -81,6 +81,8 @@
__NAME__ missing
purpose and description is wrong completely
The description doesn't seem to match the description of the same variable when set in catalog.cfg
+The usual list format of NAME (SYN, default DEF) - DESC
+More sound examples
__END__
1.2 +1 -3 xmldocs/refs/LocaleDatabase
rev 1.2, prev_rev 1.1
Index: LocaleDatabase
===================================================================
RCS file: /var/cvs/xmldocs/refs/LocaleDatabase,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- LocaleDatabase 11 Jun 2005 23:39:25 -0000 1.1
+++ LocaleDatabase 6 Nov 2006 18:41:20 -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__
1.3 +4 -4 xmldocs/refs/LockType
rev 1.3, prev_rev 1.2
Index: LockType
===================================================================
RCS file: /var/cvs/xmldocs/refs/LockType,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- LockType 8 Dec 2004 12:39:58 -0000 1.2
+++ LockType 6 Nov 2006 18:41:20 -0000 1.3
@@ -4,10 +4,10 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>flock</arg>
- <arg choice='plain'>fcntl</arg>
- <arg choice='plain'>none</arg>
+<group choice='plain'>
+ <arg choice='plain'><literal>flock</literal></arg>
+ <arg choice='plain'><literal>fcntl</literal></arg>
+ <arg choice='plain'><literal>none</literal></arg>
</group>
__END__
1.3 +1 -3 xmldocs/refs/LockoutCommand
rev 1.3, prev_rev 1.2
Index: LockoutCommand
===================================================================
RCS file: /var/cvs/xmldocs/refs/LockoutCommand,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- LockoutCommand 8 Dec 2004 12:39:58 -0000 1.2
+++ LockoutCommand 6 Nov 2006 18:41:20 -0000 1.3
@@ -9,9 +9,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>command</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>command</replaceable></arg>
__END__
1.4 +4 -0 xmldocs/refs/MailOrderTo
rev 1.4, prev_rev 1.3
Index: MailOrderTo
===================================================================
RCS file: /var/cvs/xmldocs/refs/MailOrderTo,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- MailOrderTo 28 Jan 2006 13:45:52 -0000 1.3
+++ MailOrderTo 6 Nov 2006 18:41:20 -0000 1.4
@@ -35,3 +35,7 @@
__END__
+__NAME__ missing
+Remove note on funny errmsg if catalog.cfg not readable if it was fixed in the code
+__END__
+
1.2 +4 -4 xmldocs/refs/Mall
rev 1.2, prev_rev 1.1
Index: Mall
===================================================================
RCS file: /var/cvs/xmldocs/refs/Mall,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Mall 25 May 2005 09:36:50 -0000 1.1
+++ Mall 6 Nov 2006 18:41:20 -0000 1.2
@@ -8,15 +8,15 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>0</arg>
- <arg choice='plain'>1</arg>
+<group choice='plain'>
+ <arg choice='plain'>No</arg>
+ <arg choice='plain'>Yes</arg>
</group>
__END__
__NAME__ description
-Issue cookies only for the current catalog's script. By
+Issue &glos-cookie;s only for the current catalog's script. By
default, when &IC; issues a cookie, it does so for the whole base domain.
</para><para>
This setting will allow multiple catalogs to operate on the same domain
1.3 +1 -5 xmldocs/refs/MaxRequestsPerChild
rev 1.3, prev_rev 1.2
Index: MaxRequestsPerChild
===================================================================
RCS file: /var/cvs/xmldocs/refs/MaxRequestsPerChild,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- MaxRequestsPerChild 8 Dec 2004 12:39:58 -0000 1.2
+++ MaxRequestsPerChild 6 Nov 2006 18:41:20 -0000 1.3
@@ -9,9 +9,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>count</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>count</replaceable></arg>
__END__
@@ -25,8 +23,6 @@
__END__
__NAME__ notes
-The directive is only used when &IC; is in <literal>PreFork</literal>
-&glos-ic-run-mode;.
__END__
1.6 +1 -3 xmldocs/refs/MaxServers
rev 1.6, prev_rev 1.5
Index: MaxServers
===================================================================
RCS file: /var/cvs/xmldocs/refs/MaxServers,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- MaxServers 15 Aug 2006 20:22:02 -0000 1.5
+++ MaxServers 6 Nov 2006 18:41:20 -0000 1.6
@@ -9,9 +9,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>count</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>count</replaceable></arg>
__END__
1.4 +1 -1 xmldocs/refs/NoAbsolute
rev 1.4, prev_rev 1.3
Index: NoAbsolute
===================================================================
RCS file: /var/cvs/xmldocs/refs/NoAbsolute,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- NoAbsolute 12 Aug 2005 12:41:51 -0000 1.3
+++ NoAbsolute 6 Nov 2006 18:41:20 -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>
1.6 +3 -3 xmldocs/refs/NoCache
rev 1.6, prev_rev 1.5
Index: NoCache
===================================================================
RCS file: /var/cvs/xmldocs/refs/NoCache,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- NoCache 11 Jun 2005 23:39:25 -0000 1.5
+++ NoCache 6 Nov 2006 18:41:20 -0000 1.6
@@ -4,9 +4,9 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'>file or directory name</arg>
-</group>
+<arg choice='plain' rep='repeat'>
+ <replaceable>file_or_directory_name</replaceable>
+</arg>
__END__
__NAME__ see also
1.3 +3 -17 xmldocs/refs/NoImport
rev 1.3, prev_rev 1.2
Index: NoImport
===================================================================
RCS file: /var/cvs/xmldocs/refs/NoImport,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- NoImport 11 Jun 2005 23:39:25 -0000 1.2
+++ NoImport 6 Nov 2006 18:41:20 -0000 1.3
@@ -4,27 +4,13 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>table_name</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>table_name</replaceable></arg>
__END__
__NAME__ description
-The directive specifies &glos-database; tables that should not be
-re-imported from the text source files. The database would then be
-re-imported only on critical events, such as
-<filename><replaceable>table</replaceable>.gdbm</filename> being deleted.
-__END__
-
-__NAME__ notes
-The import would ordinarily happen when a change in appropriate
-text source file is detected, &IC; is (re)started, or the catalog
-is reconfigured.
-</para><para>
-This setting is useful for &glos-SQL; databases used by other applications
-besides &IC;, or large databases you load and back up outside of Interchange.
-With this option, you can omit text source files for databases entirely.
+The directive specifies &glos-database; tables that should never be
+imported from the text source files.
__END__
__NAME__ example: Disabling 'products' and 'inventory' table import
1.2 +3 -8 xmldocs/refs/NoImportExternal
rev 1.2, prev_rev 1.1
Index: NoImportExternal
===================================================================
RCS file: /var/cvs/xmldocs/refs/NoImportExternal,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- NoImportExternal 11 Jun 2005 23:39:25 -0000 1.1
+++ NoImportExternal 6 Nov 2006 18:41:20 -0000 1.2
@@ -4,9 +4,9 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>0</arg>
- <arg choice='plain'>1</arg>
+<group choice='plain'>
+ <arg choice='plain'>No</arg>
+ <arg choice='plain'>Yes</arg>
</group>
__END__
@@ -14,11 +14,6 @@
__NAME__ description
The directive specifies that all external &glos-database; tables
should not be re-imported.
-</para><para>
-<emphasis>External</emphasis> database types are DBI (&MYSQL;, &PGSQL;,
-&ORACLE; etc.) and LDAP (&OPENLDAP; etc.). In contrast,
-<emphasis>internal</emphasis> database types are DBM variants
-(&GDBM;, &BDBM;, SDBM) and in-memory.
__END__
__NAME__ notes
1.2 +3 -3 xmldocs/refs/NoSearch
rev 1.2, prev_rev 1.1
Index: NoSearch
===================================================================
RCS file: /var/cvs/xmldocs/refs/NoSearch,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- NoSearch 11 Jun 2005 23:39:25 -0000 1.1
+++ NoSearch 6 Nov 2006 18:41:20 -0000 1.2
@@ -4,9 +4,9 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>database_name_glob</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'>
+ <replaceable>database_name_glob</replaceable>
+</arg>
__END__
1.2 +1 -3 xmldocs/refs/NonTaxableField
rev 1.2, prev_rev 1.1
Index: NonTaxableField
===================================================================
RCS file: /var/cvs/xmldocs/refs/NonTaxableField,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- NonTaxableField 24 Mar 2006 22:29:59 -0000 1.1
+++ NonTaxableField 6 Nov 2006 18:41:20 -0000 1.2
@@ -11,9 +11,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>field_name</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>field_name</replaceable></arg>
__END__
1.2 +1 -3 xmldocs/refs/OfflineDir
rev 1.2, prev_rev 1.1
Index: OfflineDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/OfflineDir,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- OfflineDir 11 Jun 2005 23:39:25 -0000 1.1
+++ OfflineDir 6 Nov 2006 18:41:20 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>directory</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>directory</replaceable></arg>
__END__
1.2 +6 -6 xmldocs/refs/OnFly
rev 1.2, prev_rev 1.1
Index: OnFly
===================================================================
RCS file: /var/cvs/xmldocs/refs/OnFly,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- OnFly 24 Mar 2006 21:12:51 -0000 1.1
+++ OnFly 6 Nov 2006 18:41:20 -0000 1.2
@@ -8,10 +8,8 @@
__NAME__ synopsis
<group choice='plain'>
- <group choice='opt'>
- <arg choice='plain'>0</arg>
- <arg choice='plain'>1</arg>
- </group>
+ <arg choice='plain'><literal>0</literal></arg>
+ <arg choice='plain'><literal>1</literal></arg>
<arg choice='plain'><replaceable>ITL_tag_name</replaceable></arg>
</group>
__END__
@@ -35,7 +33,8 @@
and the last argument is the value of <mv>mv_order_fly</mv> &glos-mv;
variable for the item.
</para><para>
-The default &tag-onfly; tag is already provided in &IC;.
+The default &tag-onfly; tag that you can use in place of
+<option>ITL_tag_name</option> is already provided in &IC;.
__END__
__NAME__ notes
@@ -52,7 +51,8 @@
<programlisting>
OnFly my_onfly_tag
</programlisting>
-For your custom tag, use the existing &tag-onfly; tag, whose
+For your custom tag, use the existing &tag-onfly; tag as a starting
+point, whose
CVS source is available online in &cvsfile-code_SystemTag_onfly.coretag;.
__END__
1.4 +1 -3 xmldocs/refs/OrderCounter
rev 1.4, prev_rev 1.3
Index: OrderCounter
===================================================================
RCS file: /var/cvs/xmldocs/refs/OrderCounter,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- OrderCounter 12 Oct 2006 13:51:35 -0000 1.3
+++ OrderCounter 6 Nov 2006 18:41:20 -0000 1.4
@@ -7,9 +7,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>filename</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>filename</replaceable></arg>
__END__
1.2 +1 -3 xmldocs/refs/OrderLineLimit
rev 1.2, prev_rev 1.1
Index: OrderLineLimit
===================================================================
RCS file: /var/cvs/xmldocs/refs/OrderLineLimit,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- OrderLineLimit 11 Jun 2005 23:39:25 -0000 1.1
+++ OrderLineLimit 6 Nov 2006 18:41:20 -0000 1.2
@@ -8,9 +8,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>count</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>count</replaceable></arg>
__END__
1.2 +3 -4 xmldocs/refs/OrderProfile
rev 1.2, prev_rev 1.1
Index: OrderProfile
===================================================================
RCS file: /var/cvs/xmldocs/refs/OrderProfile,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- OrderProfile 11 Jun 2005 23:39:25 -0000 1.1
+++ OrderProfile 6 Nov 2006 18:41:20 -0000 1.2
@@ -7,9 +7,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>filename</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>filename</replaceable></arg>
__END__
@@ -19,7 +17,7 @@
__NAME__ notes
-The actions defined in order profiles can also used for
+The actions defined in order profiles can also be used for
<literal>mv_click</literal> actions
if the actions are not defined in &glos-scratch; space. They are accessed by
setting the <mv>mv_order_profile</mv> variable to the name of the order
@@ -36,4 +34,5 @@
__NAME__ missing
Diff between Profiles and OrderProfile ?
+Confusing note in NOTES about scratch space and mv_click actions
__END__
1.2 +1 -3 xmldocs/refs/OrderReport
rev 1.2, prev_rev 1.1
Index: OrderReport
===================================================================
RCS file: /var/cvs/xmldocs/refs/OrderReport,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- OrderReport 25 May 2005 09:36:50 -0000 1.1
+++ OrderReport 6 Nov 2006 18:41:20 -0000 1.2
@@ -8,9 +8,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>filename</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>filename</replaceable></arg>
__END__
1.2 +5 -1 xmldocs/refs/PGP
rev 1.2, prev_rev 1.1
Index: PGP
===================================================================
RCS file: /var/cvs/xmldocs/refs/PGP,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- PGP 24 Mar 2006 21:12:51 -0000 1.1
+++ PGP 6 Nov 2006 18:41:21 -0000 1.2
@@ -1,5 +1,5 @@
__NAME__ purpose
-automatically encrypted full order report
+automatically encrypt complete order reports
__END__
@@ -39,3 +39,7 @@
</programlisting>
__END__
+
+__NAME__ missing
+Can route "be set to supplant"?
+__END__
1.4 +3 -3 xmldocs/refs/PIDcheck
rev 1.4, prev_rev 1.3
Index: PIDcheck
===================================================================
RCS file: /var/cvs/xmldocs/refs/PIDcheck,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- PIDcheck 11 Dec 2004 23:42:45 -0000 1.3
+++ PIDcheck 6 Nov 2006 18:41:21 -0000 1.4
@@ -8,9 +8,9 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>0</arg>
- <arg choice='plain'>interval</arg>
+<group choice='plain'>
+ <arg choice='plain'><literal>0</literal></arg>
+ <arg choice='plain'><replaceable>interval</replaceable></arg>
</group>
__END__
1.3 +1 -3 xmldocs/refs/PIDfile
rev 1.3, prev_rev 1.2
Index: PIDfile
===================================================================
RCS file: /var/cvs/xmldocs/refs/PIDfile,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- PIDfile 8 Dec 2004 12:39:58 -0000 1.2
+++ PIDfile 6 Nov 2006 18:41:21 -0000 1.3
@@ -8,9 +8,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>filename</arg>
-</group>
+<arg choice='plain'><replaceable>filename</replaceable></arg>
__END__
1.5 +2 -4 xmldocs/refs/PageDir
rev 1.5, prev_rev 1.4
Index: PageDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/PageDir,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- PageDir 11 Jun 2005 08:29:00 -0000 1.4
+++ PageDir 6 Nov 2006 18:41:21 -0000 1.5
@@ -4,14 +4,12 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>directory</arg>
-</group>
+<arg choice='plain'><replaceable>directory_name</replaceable></arg>
__END__
__NAME__ description
-Specify the directory containing catalog pages.
+Specify the directory containing &glos-catalog; pages.
</para><para>
Speaking of &glos-internationalization;, it can be useful to set this
directive to
1.3 +3 -4 xmldocs/refs/PageSelectField
rev 1.3, prev_rev 1.2
Index: PageSelectField
===================================================================
RCS file: /var/cvs/xmldocs/refs/PageSelectField,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- PageSelectField 12 Aug 2006 21:14:40 -0000 1.2
+++ PageSelectField 6 Nov 2006 18:41:21 -0000 1.3
@@ -4,14 +4,13 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>column_name</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>column_name</replaceable></arg>
__END__
__NAME__ description
-Sets a <database>products</database> database column which can be used to
+The directive sets a <database>products</database> database column
+which can be used to
select the on-the-fly template page (the &glos-flypage;). This allows
multiple flypages to be defined and selected automatically. If the field
is empty (no spaces!), the default, <literal>flypage</literal>, will be used.
1.2 +9 -9 xmldocs/refs/ParseVariables
rev 1.2, prev_rev 1.1
Index: ParseVariables
===================================================================
RCS file: /var/cvs/xmldocs/refs/ParseVariables,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ParseVariables 25 May 2005 09:36:50 -0000 1.1
+++ ParseVariables 6 Nov 2006 18:41:21 -0000 1.2
@@ -1,23 +1,23 @@
__NAME__ purpose
-parse (interpolate ITL and variables) variable values before storing them
+parse (interpolate) variable values before storing them
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>0</arg>
- <arg choice='plain'>1</arg>
+<group choice='plain'>
+ <arg choice='plain'>No</arg>
+ <arg choice='plain'>Yes</arg>
</group>
__END__
__NAME__ description
-Specify that global and catalog variables should be parsed in catalog
-configuration directives (not including the &conf-Variable; directives
-themselves, which never have their contents parsed).
+Specify that the &glos-configuration; directives should have their
+values parsed (&glos-interpolate;d).
</para><para>
-Applies only to variables with names in ALL CAPS. Our catalogs enable
-&conf-ParseVariables; and usually rely on that behavior.
+This applies to all configuration directives except &conf-Variable;.
+</para><para>
+Of variables, only those in ALL CAPS are interpolated.
__END__
__NAME__ example: Enabling ParseVariables globally
1.3 +1 -3 xmldocs/refs/Password
rev 1.3, prev_rev 1.2
Index: Password
===================================================================
RCS file: /var/cvs/xmldocs/refs/Password,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Password 11 Jun 2005 23:39:25 -0000 1.2
+++ Password 6 Nov 2006 18:41:21 -0000 1.3
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>password</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>password</replaceable></arg>
__END__
1.3 +1 -3 xmldocs/refs/PermanentDir
rev 1.3, prev_rev 1.2
Index: PermanentDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/PermanentDir,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- PermanentDir 5 Jun 2006 13:17:27 -0000 1.2
+++ PermanentDir 6 Nov 2006 18:41:21 -0000 1.3
@@ -3,7 +3,5 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>directory</arg>
-</group>
+<arg choice='plain'><replaceable>directory_name</replaceable></arg>
__END__
1.3 +1 -1 xmldocs/refs/PreFork
rev 1.3, prev_rev 1.2
Index: PreFork
===================================================================
RCS file: /var/cvs/xmldocs/refs/PreFork,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- PreFork 15 Aug 2006 20:22:02 -0000 1.2
+++ PreFork 6 Nov 2006 18:41:21 -0000 1.3
@@ -8,7 +8,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
1.4 +3 -3 xmldocs/refs/PriceCommas
rev 1.4, prev_rev 1.3
Index: PriceCommas
===================================================================
RCS file: /var/cvs/xmldocs/refs/PriceCommas,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- PriceCommas 19 Nov 2005 22:37:41 -0000 1.3
+++ PriceCommas 6 Nov 2006 18:41:21 -0000 1.4
@@ -4,9 +4,9 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>1</arg>
- <arg choice='plain'>0</arg>
+<group choice='plain'>
+ <arg choice='plain'>Yes</arg>
+ <arg choice='plain'>No</arg>
</group>
__END__
1.4 +1 -3 xmldocs/refs/PriceDivide
rev 1.4, prev_rev 1.3
Index: PriceDivide
===================================================================
RCS file: /var/cvs/xmldocs/refs/PriceDivide,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- PriceDivide 19 Nov 2005 22:37:41 -0000 1.3
+++ PriceDivide 6 Nov 2006 18:41:21 -0000 1.4
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>number</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>number</replaceable></arg>
__END__
1.3 +2 -7 xmldocs/refs/PriceField
rev 1.3, prev_rev 1.2
Index: PriceField
===================================================================
RCS file: /var/cvs/xmldocs/refs/PriceField,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- PriceField 11 Jun 2005 08:29:00 -0000 1.2
+++ PriceField 6 Nov 2006 18:41:21 -0000 1.3
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>field_name</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>field_name</replaceable></arg>
__END__
@@ -21,10 +19,7 @@
__NAME__ notes
-The existence of the field is not exactly crucial, but it's important
-for say, &glos-flypage;s.
-</para><para>
-It's also useful to set the directive based on current &glos-locale;.
+It is useful to set the directive based on current &glos-locale;.
__END__
__NAME__ example: Redefining PriceField
1.2 +1 -3 xmldocs/refs/ProcessPage
rev 1.2, prev_rev 1.1
Index: ProcessPage
===================================================================
RCS file: /var/cvs/xmldocs/refs/ProcessPage,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ProcessPage 18 Nov 2005 23:15:02 -0000 1.1
+++ ProcessPage 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>page_name</arg>
-</group>
+<arg choice='plain'><replaceable>page_name</replaceable></arg>
__END__
1.2 +1 -3 xmldocs/refs/ProductDir
rev 1.2, prev_rev 1.1
Index: ProductDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/ProductDir,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ProductDir 25 May 2005 09:36:50 -0000 1.1
+++ ProductDir 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>directory</arg>
-</group>
+<arg choice='plain'><replaceable>directory</replaceable></arg>
__END__
1.3 +1 -3 xmldocs/refs/ProductFiles
rev 1.3, prev_rev 1.2
Index: ProductFiles
===================================================================
RCS file: /var/cvs/xmldocs/refs/ProductFiles,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ProductFiles 11 Jun 2005 23:39:25 -0000 1.2
+++ ProductFiles 6 Nov 2006 18:41:21 -0000 1.3
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>database_name</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>database_name</replaceable></arg>
__END__
1.3 +1 -3 xmldocs/refs/Profiles
rev 1.3, prev_rev 1.2
Index: Profiles
===================================================================
RCS file: /var/cvs/xmldocs/refs/Profiles,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Profiles 11 Jun 2005 23:39:25 -0000 1.2
+++ Profiles 6 Nov 2006 18:41:21 -0000 1.3
@@ -14,9 +14,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>filename</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>filename</replaceable></arg>
__END__
1.2 +1 -1 xmldocs/refs/ReadPermission
rev 1.2, prev_rev 1.1
Index: ReadPermission
===================================================================
RCS file: /var/cvs/xmldocs/refs/ReadPermission,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ReadPermission 20 May 2005 23:06:42 -0000 1.1
+++ ReadPermission 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,7 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'><literal>user</literal></arg>
<arg choice='plain'><literal>group</literal></arg>
<arg choice='plain'><literal>world</literal></arg>
1.2 +1 -3 xmldocs/refs/RemoteUser
rev 1.2, prev_rev 1.1
Index: RemoteUser
===================================================================
RCS file: /var/cvs/xmldocs/refs/RemoteUser,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- RemoteUser 25 May 2005 09:36:50 -0000 1.1
+++ RemoteUser 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>username</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>username</replaceable></arg>
__END__
1.9 +5 -7 xmldocs/refs/Require
rev 1.9, prev_rev 1.8
Index: Require
===================================================================
RCS file: /var/cvs/xmldocs/refs/Require,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- Require 12 Oct 2006 13:51:35 -0000 1.8
+++ Require 6 Nov 2006 18:41:21 -0000 1.9
@@ -7,12 +7,10 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'>
- <replaceable>type</replaceable>
- <replaceable>type-specific-value</replaceable>
- </arg>
-</group>
+<arg choice='plain' rep='repeat'>
+ <replaceable>type</replaceable>
+ <replaceable>type-specific_value</replaceable>
+</arg>
__END__
__NAME__ description
@@ -29,7 +27,7 @@
<literal>sub</literal>,
<literal>taggroup</literal>,
<literal>usertag</literal> and
-<literal>module</literal> .
+<literal>module</literal>.
</para>
<para>
This directive can also used to implicitly load &PERL; modules. If you add
1.2 +3 -5 xmldocs/refs/RobotHost
rev 1.2, prev_rev 1.1
Index: RobotHost
===================================================================
RCS file: /var/cvs/xmldocs/refs/RobotHost,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- RobotHost 20 Feb 2005 00:59:50 -0000 1.1
+++ RobotHost 6 Nov 2006 18:41:21 -0000 1.2
@@ -8,9 +8,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>hostname</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>hostname</replaceable></arg>
__END__
@@ -29,13 +27,13 @@
visiting does not earn you extra points, and may in fact be
detected by the robot and punished.
</para><para>
-It's important to note that the directive accepts a wildcard list -
+It's important to note that the directive accepts a wildcard list —
<literal>*</literal> represents any number of characters, while
<literal>?</literal> represents a single character.
__END__
__NAME__ notes
-For more details regarding web spiders/bots and &IC; see
+For more details regarding web spiders/bots and &IC;, see
&glos-robot; glossary entry.
__END__
1.2 +3 -5 xmldocs/refs/RobotIP
rev 1.2, prev_rev 1.1
Index: RobotIP
===================================================================
RCS file: /var/cvs/xmldocs/refs/RobotIP,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- RobotIP 20 Feb 2005 00:59:50 -0000 1.1
+++ RobotIP 6 Nov 2006 18:41:21 -0000 1.2
@@ -8,9 +8,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>IP address</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>IP_address</replaceable></arg>
__END__
@@ -29,13 +27,13 @@
visiting does not earn you extra points, and may in fact be
detected by the robot and punished.
</para><para>
-It's important to note that the directive accepts a wildcard list -
+It's important to note that the directive accepts a wildcard list —
<literal>*</literal> represents any number of characters, while
<literal>?</literal> represents a single character.
__END__
__NAME__ notes
-For more details regarding web spiders/bots and &IC; see
+For more details regarding web spiders/bots and &IC;, see
&glos-robot; glossary entry.
__END__
1.2 +6 -3 xmldocs/refs/RobotLimit
rev 1.2, prev_rev 1.1
Index: RobotLimit
===================================================================
RCS file: /var/cvs/xmldocs/refs/RobotLimit,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- RobotLimit 11 Jun 2005 23:39:25 -0000 1.1
+++ RobotLimit 6 Nov 2006 18:41:21 -0000 1.2
@@ -8,9 +8,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>count</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>count</replaceable></arg>
__END__
@@ -36,3 +34,8 @@
</programlisting>
__END__
+
+
+__NAME__ missing
+Didn't we change this from 127.0.0.1 to something else ?
+__END__
1.2 +3 -5 xmldocs/refs/RobotUA
rev 1.2, prev_rev 1.1
Index: RobotUA
===================================================================
RCS file: /var/cvs/xmldocs/refs/RobotUA,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- RobotUA 20 Feb 2005 00:59:50 -0000 1.1
+++ RobotUA 6 Nov 2006 18:41:21 -0000 1.2
@@ -8,9 +8,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>useragent string</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>useragent_string</replaceable></arg>
__END__
@@ -29,13 +27,13 @@
visiting does not earn you extra points, and may in fact be
detected by the robot and punished.
</para><para>
-It's important to note that the directive accepts a wildcard list -
+It's important to note that the directive accepts a wildcard list —
<literal>*</literal> represents any number of characters, while
<literal>?</literal> represents a single character.
__END__
__NAME__ notes
-For more details regarding web spiders/bots and &IC; see
+For more details regarding web spiders/bots and &IC;, see
&glos-robot; glossary entry.
__END__
1.2 +1 -1 xmldocs/refs/SOAP
rev 1.2, prev_rev 1.1
Index: SOAP
===================================================================
RCS file: /var/cvs/xmldocs/refs/SOAP,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SOAP 10 Feb 2006 00:52:33 -0000 1.1
+++ SOAP 6 Nov 2006 18:41:21 -0000 1.2
@@ -7,7 +7,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
1.2 +1 -3 xmldocs/refs/SOAP_Host
rev 1.2, prev_rev 1.1
Index: SOAP_Host
===================================================================
RCS file: /var/cvs/xmldocs/refs/SOAP_Host,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SOAP_Host 10 Feb 2006 00:52:33 -0000 1.1
+++ SOAP_Host 6 Nov 2006 18:41:21 -0000 1.2
@@ -12,9 +12,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>hostname_or_IP</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>hostname_or_IP</replaceable></arg>
__END__
1.2 +3 -5 xmldocs/refs/SOAP_MaxRequests
rev 1.2, prev_rev 1.1
Index: SOAP_MaxRequests
===================================================================
RCS file: /var/cvs/xmldocs/refs/SOAP_MaxRequests,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SOAP_MaxRequests 10 Feb 2006 00:52:33 -0000 1.1
+++ SOAP_MaxRequests 6 Nov 2006 18:41:21 -0000 1.2
@@ -9,9 +9,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>count</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>count</replaceable></arg>
__END__
@@ -31,9 +29,9 @@
__END__
-__NAME__ example: Setting SOAP_MaxRequests
+__NAME__ example: Setting __FILENAME__
<programlisting>
-SOAP_MaxRequests 200
+__FILENAME__ 200
</programlisting>
__END__
1.2 +3 -5 xmldocs/refs/SOAP_Perms
rev 1.2, prev_rev 1.1
Index: SOAP_Perms
===================================================================
RCS file: /var/cvs/xmldocs/refs/SOAP_Perms,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SOAP_Perms 10 Feb 2006 00:52:33 -0000 1.1
+++ SOAP_Perms 6 Nov 2006 18:41:21 -0000 1.2
@@ -8,9 +8,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>mode</arg>
-</group>
+<arg choice='plain'><replaceable>mode</replaceable></arg>
__END__
@@ -31,9 +29,9 @@
__END__
-__NAME__ example: Setting SOAP_Perms
+__NAME__ example: Setting __FILENAME__
<programlisting>
-SOAP_Perms 0666
+__FILENAME__ 0666
</programlisting>
__END__
1.2 +2 -3 xmldocs/refs/SOAP_Socket
rev 1.2, prev_rev 1.1
Index: SOAP_Socket
===================================================================
RCS file: /var/cvs/xmldocs/refs/SOAP_Socket,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SOAP_Socket 10 Feb 2006 00:52:33 -0000 1.1
+++ SOAP_Socket 6 Nov 2006 18:41:21 -0000 1.2
@@ -8,9 +8,8 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'>filename_or_host:port</arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>filename</replaceable></arg><sbr/>
+<arg choice='plain' rep='repeat'><replaceable>host</replaceable>:<replaceable>port</replaceable></arg>
__END__
1.2 +1 -3 xmldocs/refs/SOAP_StartServers
rev 1.2, prev_rev 1.1
Index: SOAP_StartServers
===================================================================
RCS file: /var/cvs/xmldocs/refs/SOAP_StartServers,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SOAP_StartServers 10 Feb 2006 00:52:33 -0000 1.1
+++ SOAP_StartServers 6 Nov 2006 18:41:21 -0000 1.2
@@ -10,9 +10,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>count_less_than_51</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>count_less_than_51</replaceable></arg>
__END__
1.4 +3 -4 xmldocs/refs/SafeUntrap
rev 1.4, prev_rev 1.3
Index: SafeUntrap
===================================================================
RCS file: /var/cvs/xmldocs/refs/SafeUntrap,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SafeUntrap 12 Oct 2006 13:51:35 -0000 1.3
+++ SafeUntrap 6 Nov 2006 18:41:21 -0000 1.4
@@ -3,9 +3,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'>opcode</arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>opcode</replaceable></arg>
__END__
@@ -35,10 +33,11 @@
The following code fails to work with the default SafeUntrap setting.
<programlisting>
+[set upload_repository]upload/[/set]
[calcn]-s $Scratch->{upload_repository};[/calcn]
</programlisting>
-Adding ftsize to SafeUntrap solves this problem:
+Adding <literal>ftsize</literal> to SafeUntrap solves this problem:
<programlisting>
SafeUntrap ftsize
1.2 +1 -3 xmldocs/refs/SaveExpire
rev 1.2, prev_rev 1.1
Index: SaveExpire
===================================================================
RCS file: /var/cvs/xmldocs/refs/SaveExpire,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SaveExpire 11 Jun 2005 23:39:25 -0000 1.1
+++ SaveExpire 6 Nov 2006 18:41:21 -0000 1.2
@@ -12,9 +12,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>interval</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>interval</replaceable></arg>
__END__
1.3 +2 -1 xmldocs/refs/ScratchDefault
rev 1.3, prev_rev 1.2
Index: ScratchDefault
===================================================================
RCS file: /var/cvs/xmldocs/refs/ScratchDefault,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ScratchDefault 11 Jun 2005 23:39:25 -0000 1.2
+++ ScratchDefault 6 Nov 2006 18:41:21 -0000 1.3
@@ -15,7 +15,8 @@
__NAME__ description
-The directive sets default &glos-scratch; variable values.
+The directive sets default &glos-scratch; variable values. These are
+initialized and assigned every time a new uses &glos-session; is created.
__END__
__NAME__ example: Defining default scratch values
1.3 +9 -6 xmldocs/refs/ScratchDir
rev 1.3, prev_rev 1.2
Index: ScratchDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/ScratchDir,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ScratchDir 5 Jun 2006 13:18:31 -0000 1.2
+++ ScratchDir 6 Nov 2006 18:41:21 -0000 1.3
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>directory</arg>
-</group>
+<arg choice='plain'><replaceable>directory</replaceable></arg>
__END__
@@ -18,12 +16,17 @@
__END__
__NAME__ notes
-The specified location is, unless absolute, treated relative to &glos-CATROOT;.
+The specified location is always treated relative to &glos-CATROOT;.
__END__
-__NAME__ example: Setting ScratchDir
+__NAME__ example: Setting __FILENAME__
<programlisting>
-ScratchDir temp
+__FILENAME__ temp
</programlisting>
__END__
+
+
+__NAME__ see also
+PageDir, RunDir, ProductDir
+__END__
1.2 +7 -4 xmldocs/refs/SearchProfile
rev 1.2, prev_rev 1.1
Index: SearchProfile
===================================================================
RCS file: /var/cvs/xmldocs/refs/SearchProfile,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SearchProfile 18 Dec 2005 11:32:11 -0000 1.1
+++ SearchProfile 6 Nov 2006 18:41:21 -0000 1.2
@@ -8,9 +8,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>filename</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>filename</replaceable></arg>
__END__
@@ -18,7 +16,7 @@
The directive specifies filenames that contain search
&glos-profile; definitions.
</para><para>
-An unlimited number of search profiles
+An unlimited number of search &glos-profile;s
can be set up, performing complex searches on a
single user click. At the same time, separately-defined search profiles
keep your &glos-HTML; pages cleaner.
@@ -34,6 +32,11 @@
__NAME__ notes
For a complete discussion, see &glos-profile; glossary entry.
+__END__
+
+
+__NAME__ missing
+Difference between SearchProfile and OrderProfile ??
__END__
__NAME__ example: Defining SearchProfile
1.2 +1 -3 xmldocs/refs/SecureURL
rev 1.2, prev_rev 1.1
Index: SecureURL
===================================================================
RCS file: /var/cvs/xmldocs/refs/SecureURL,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SecureURL 12 Aug 2005 22:33:40 -0000 1.1
+++ SecureURL 6 Nov 2006 18:41:21 -0000 1.2
@@ -9,9 +9,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>URL</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>URL</replaceable></arg>
__END__
1.4 +1 -3 xmldocs/refs/SendMailProgram
rev 1.4, prev_rev 1.3
Index: SendMailProgram
===================================================================
RCS file: /var/cvs/xmldocs/refs/SendMailProgram,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SendMailProgram 21 Feb 2005 01:16:51 -0000 1.3
+++ SendMailProgram 6 Nov 2006 18:41:21 -0000 1.4
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>filename</arg>
-</group>
+<arg choice='plain'><replaceable>filename</replaceable></arg>
__END__
1.3 +2 -2 xmldocs/refs/SeparateItems
rev 1.3, prev_rev 1.2
Index: SeparateItems
===================================================================
RCS file: /var/cvs/xmldocs/refs/SeparateItems,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SeparateItems 8 Dec 2004 12:39:58 -0000 1.2
+++ SeparateItems 6 Nov 2006 18:41:21 -0000 1.3
@@ -4,7 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
@@ -15,7 +15,7 @@
The &conf-SeparateItems; directive changes the default behavior when ordering
item in quantity greater of 1. Instead of only increasing quantity information,
the items are treated as being separate and are listed just as different
-products would (one per line).
+products would be (one per line).
</para><para>
The directive is of little global use, but it allows item attributes to be
easily set for different instances of the same part number (&glos-SKU;),
1.3 +7 -4 xmldocs/refs/SessionDB
rev 1.3, prev_rev 1.2
Index: SessionDB
===================================================================
RCS file: /var/cvs/xmldocs/refs/SessionDB,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SessionDB 8 Dec 2004 12:39:58 -0000 1.2
+++ SessionDB 6 Nov 2006 18:41:21 -0000 1.3
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>database</arg>
-</group>
+<arg choice='plain'><replaceable>database_name</replaceable></arg>
__END__
@@ -21,7 +19,7 @@
__END__
__NAME__ notes
-Using this directive (and DBI sessions in general) is not recommended.
+Using this directive (DBI sessions in general) is not recommended.
__END__
__NAME__ example: Setting SessionDB
@@ -31,3 +29,8 @@
</programlisting>
__END__
+
+
+__NAME__ missing
+Why DBI sessions are not encouraged?
+__END__
1.4 +1 -3 xmldocs/refs/SessionDatabase
rev 1.4, prev_rev 1.3
Index: SessionDatabase
===================================================================
RCS file: /var/cvs/xmldocs/refs/SessionDatabase,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SessionDatabase 9 Jun 2005 12:02:43 -0000 1.3
+++ SessionDatabase 6 Nov 2006 18:41:21 -0000 1.4
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>filename_or_directory</arg>
-</group>
+<arg choice='plain'><replaceable>filename_or_directory_name</replaceable></arg>
__END__
1.3 +4 -5 xmldocs/refs/SessionExpire
rev 1.3, prev_rev 1.2
Index: SessionExpire
===================================================================
RCS file: /var/cvs/xmldocs/refs/SessionExpire,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SessionExpire 8 Dec 2004 12:39:58 -0000 1.2
+++ SessionExpire 6 Nov 2006 18:41:21 -0000 1.3
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>minimum interval</arg>
-</group>
+<arg choice='plain'><replaceable>minimum_interval</replaceable></arg>
__END__
@@ -23,11 +21,12 @@
session IDs).
</para><para>
Old session information needs to be periodically expired. &conf-SessionExpire;
-specifies the minimum of time to keep track of session information.
+specifies the minimum of time for which the session information should be
+preserved.
__END__
__NAME__ notes
-If &conf-CookieLogin; is enabled, &conf-SessionExpire; can be a small value.
+If &conf-CookieLogin; is enabled, &conf-SessionExpire; can be a small value
If the customer's browser has the &IC; session cookie stored, he or she will
be automatically logged back in with the next request. Note, however, that
the customer's cart and session values will be reset.
1.3 +1 -3 xmldocs/refs/SessionLockFile
rev 1.3, prev_rev 1.2
Index: SessionLockFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/SessionLockFile,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SessionLockFile 8 Dec 2004 12:39:58 -0000 1.2
+++ SessionLockFile 6 Nov 2006 18:41:21 -0000 1.3
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>filename</arg>
-</group>
+<arg choice='plain'><replaceable>filename</replaceable></arg>
__END__
1.4 +8 -8 xmldocs/refs/SessionType
rev 1.4, prev_rev 1.3
Index: SessionType
===================================================================
RCS file: /var/cvs/xmldocs/refs/SessionType,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SessionType 20 Apr 2006 18:15:03 -0000 1.3
+++ SessionType 6 Nov 2006 18:41:21 -0000 1.4
@@ -4,12 +4,12 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>DB_File</arg>
- <arg choice='plain'>DBI</arg>
- <arg choice='plain'>File</arg>
- <arg choice='plain'>NFS</arg>
- <arg choice='plain'>GDBM</arg>
+<group choice='plain'>
+ <arg choice='plain'><literal>DB_File</literal></arg>
+ <arg choice='plain'><literal>DBI</literal></arg>
+ <arg choice='plain'><literal>File</literal></arg>
+ <arg choice='plain'><literal>NFS</literal></arg>
+ <arg choice='plain'><literal>GDBM</literal></arg>
</group>
__END__
@@ -32,8 +32,8 @@
__END__
__NAME__ notes
-<literal>File</literal>-based sessions provide best performance and
-reliability in most environments.
+The default <literal>File</literal>-based sessions provide best performance
+and reliability in most environments.
__END__
__NAME__ example: Setting SessionType
1.2 +1 -3 xmldocs/refs/SetGroup
rev 1.2, prev_rev 1.1
Index: SetGroup
===================================================================
RCS file: /var/cvs/xmldocs/refs/SetGroup,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SetGroup 12 Mar 2006 22:12:35 -0000 1.1
+++ SetGroup 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>group</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>group_name</replaceable></arg>
__END__
1.3 +7 -4 xmldocs/refs/ShowTimes
rev 1.3, prev_rev 1.2
Index: ShowTimes
===================================================================
RCS file: /var/cvs/xmldocs/refs/ShowTimes,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ShowTimes 19 Nov 2005 22:37:41 -0000 1.2
+++ ShowTimes 6 Nov 2006 18:41:21 -0000 1.3
@@ -4,9 +4,9 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>0</arg>
- <arg choice='plain'>1</arg>
+<group choice='plain'>
+ <arg choice='plain'>No</arg>
+ <arg choice='plain'>Yes</arg>
</group>
__END__
@@ -14,6 +14,9 @@
__NAME__ description
The &conf-ShowTimes; directive makes &IC; include timing statistics
in debug output.
+</para><para>
+Debug output has to be enabled for this option to work
+(see &var-DEBUG; and &conf-DebugFile;).
__END__
__NAME__ notes
@@ -27,7 +30,7 @@
<screen>
lib/Vend/Server.pm:#show_times("begin response send") if $Global::ShowTimes;
</screen>
-and you will need to remove the "#".
+and you will need to remove the "<literal>#</literal>".
__END__
__NAME__ see also
1.5 +1 -3 xmldocs/refs/SocketFile
rev 1.5, prev_rev 1.4
Index: SocketFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/SocketFile,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- SocketFile 12 Oct 2006 13:51:35 -0000 1.4
+++ SocketFile 6 Nov 2006 18:41:21 -0000 1.5
@@ -8,9 +8,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>filename</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>filename</replaceable></arg>
__END__
1.10 +1 -3 xmldocs/refs/SocketPerms
rev 1.10, prev_rev 1.9
Index: SocketPerms
===================================================================
RCS file: /var/cvs/xmldocs/refs/SocketPerms,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- SocketPerms 27 Jul 2006 20:48:15 -0000 1.9
+++ SocketPerms 6 Nov 2006 18:41:21 -0000 1.10
@@ -8,9 +8,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>mode</arg>
-</group>
+<arg choice='plain'><replaceable>mode</replaceable></arg>
__END__
1.4 +6 -1 xmldocs/refs/SpecialPage
rev 1.4, prev_rev 1.3
Index: SpecialPage
===================================================================
RCS file: /var/cvs/xmldocs/refs/SpecialPage,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SpecialPage 5 Oct 2006 10:30:31 -0000 1.3
+++ SpecialPage 6 Nov 2006 18:41:21 -0000 1.4
@@ -4,7 +4,7 @@
__NAME__ synopsis
-<arg choice='req'>
+<arg choice='plain' rep='repeat'>
<replaceable>type</replaceable>
<replaceable>filename</replaceable>
</arg>
@@ -120,4 +120,9 @@
__NAME__ see also
DirectoryIndex
+__END__
+
+
+__NAME__ missing
+Descriptions for possible keys, and default values
__END__
1.2 +1 -3 xmldocs/refs/SpecialPageDir
rev 1.2, prev_rev 1.1
Index: SpecialPageDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/SpecialPageDir,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SpecialPageDir 22 Feb 2005 12:50:43 -0000 1.1
+++ SpecialPageDir 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>directory</arg>
-</group>
+<arg choice='plain'><replaceable>directory_name</replaceable></arg>
__END__
1.9 +1 -1 xmldocs/refs/SpecialSub
rev 1.9, prev_rev 1.8
Index: SpecialSub
===================================================================
RCS file: /var/cvs/xmldocs/refs/SpecialSub,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- SpecialSub 18 Oct 2006 00:03:41 -0000 1.8
+++ SpecialSub 6 Nov 2006 18:41:21 -0000 1.9
@@ -5,7 +5,7 @@
__NAME__ synopsis
<arg choice='plain'><replaceable>event_name</replaceable></arg>
- <arg choice='plain'><replaceable>subroutine_name</replaceable></arg>
+ <arg choice='plain' rep='repeat'><replaceable>subroutine_name</replaceable></arg>
__END__
1.2 +1 -3 xmldocs/refs/StartServers
rev 1.2, prev_rev 1.1
Index: StartServers
===================================================================
RCS file: /var/cvs/xmldocs/refs/StartServers,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StartServers 20 Feb 2005 00:59:50 -0000 1.1
+++ StartServers 6 Nov 2006 18:41:21 -0000 1.2
@@ -8,9 +8,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>count</arg>
-</group>
+<arg choice='plain'><replaceable>count</replaceable></arg>
__END__
1.2 +1 -1 xmldocs/refs/Static
rev 1.2, prev_rev 1.1
Index: Static
===================================================================
RCS file: /var/cvs/xmldocs/refs/Static,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Static 22 Feb 2005 12:50:43 -0000 1.1
+++ Static 6 Nov 2006 18:41:21 -0000 1.2
@@ -3,7 +3,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
1.2 +1 -1 xmldocs/refs/StaticAll
rev 1.2, prev_rev 1.1
Index: StaticAll
===================================================================
RCS file: /var/cvs/xmldocs/refs/StaticAll,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StaticAll 22 Feb 2005 12:50:43 -0000 1.1
+++ StaticAll 6 Nov 2006 18:41:21 -0000 1.2
@@ -3,7 +3,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
1.2 +1 -1 xmldocs/refs/StaticDBM
rev 1.2, prev_rev 1.1
Index: StaticDBM
===================================================================
RCS file: /var/cvs/xmldocs/refs/StaticDBM,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StaticDBM 22 Feb 2005 12:50:43 -0000 1.1
+++ StaticDBM 6 Nov 2006 18:41:21 -0000 1.2
@@ -3,7 +3,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
1.2 +1 -3 xmldocs/refs/StaticDepth
rev 1.2, prev_rev 1.1
Index: StaticDepth
===================================================================
RCS file: /var/cvs/xmldocs/refs/StaticDepth,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StaticDepth 22 Feb 2005 12:50:43 -0000 1.1
+++ StaticDepth 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>count</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>count</replaceable></arg>
__END__
__NAME__ see also
1.2 +1 -3 xmldocs/refs/StaticDir
rev 1.2, prev_rev 1.1
Index: StaticDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/StaticDir,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StaticDir 22 Feb 2005 12:50:43 -0000 1.1
+++ StaticDir 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>path</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>directory_name</replaceable></arg>
__END__
__NAME__ see also
1.2 +1 -1 xmldocs/refs/StaticFly
rev 1.2, prev_rev 1.1
Index: StaticFly
===================================================================
RCS file: /var/cvs/xmldocs/refs/StaticFly,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StaticFly 22 Feb 2005 12:50:43 -0000 1.1
+++ StaticFly 6 Nov 2006 18:41:21 -0000 1.2
@@ -3,7 +3,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
1.2 +1 -3 xmldocs/refs/StaticPage
rev 1.2, prev_rev 1.1
Index: StaticPage
===================================================================
RCS file: /var/cvs/xmldocs/refs/StaticPage,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StaticPage 22 Feb 2005 12:50:43 -0000 1.1
+++ StaticPage 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>page_name</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>page_name</replaceable></arg>
__END__
__NAME__ see also
1.2 +1 -3 xmldocs/refs/StaticPath
rev 1.2, prev_rev 1.1
Index: StaticPath
===================================================================
RCS file: /var/cvs/xmldocs/refs/StaticPath,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StaticPath 22 Feb 2005 12:50:43 -0000 1.1
+++ StaticPath 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>path</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>directory_name</replaceable></arg>
__END__
__NAME__ notes
1.2 +1 -3 xmldocs/refs/StaticPattern
rev 1.2, prev_rev 1.1
Index: StaticPattern
===================================================================
RCS file: /var/cvs/xmldocs/refs/StaticPattern,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StaticPattern 22 Feb 2005 12:50:43 -0000 1.1
+++ StaticPattern 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>regexp</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>regexp</replaceable></arg>
__END__
__NAME__ description
1.2 +1 -3 xmldocs/refs/StaticSuffix
rev 1.2, prev_rev 1.1
Index: StaticSuffix
===================================================================
RCS file: /var/cvs/xmldocs/refs/StaticSuffix,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StaticSuffix 22 Feb 2005 12:50:43 -0000 1.1
+++ StaticSuffix 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>extension</arg>
-</group>
+<arg choice='plain'><replaceable>file_extension</replaceable></arg>
__END__
__NAME__ notes
1.3 +1 -5 xmldocs/refs/Sub
rev 1.3, prev_rev 1.2
Index: Sub
===================================================================
RCS file: /var/cvs/xmldocs/refs/Sub,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Sub 19 Nov 2005 22:37:41 -0000 1.2
+++ Sub 6 Nov 2006 18:41:21 -0000 1.3
@@ -7,11 +7,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>
- <replaceable>perl_code</replaceable>
- </arg>
-</group>
+<arg choice='plain'><replaceable>perl_code</replaceable></arg>
__END__
__NAME__ description
1.6 +2 -2 xmldocs/refs/Suggest
rev 1.6, prev_rev 1.5
Index: Suggest
===================================================================
RCS file: /var/cvs/xmldocs/refs/Suggest,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- Suggest 12 Oct 2006 13:51:35 -0000 1.5
+++ Suggest 6 Nov 2006 18:41:21 -0000 1.6
@@ -7,7 +7,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain' rep='repeat'>
<replaceable>type</replaceable>
<replaceable>type-specific-value</replaceable>
@@ -25,7 +25,7 @@
<literal>sub</literal>,
<literal>taggroup</literal>,
<literal>usertag</literal> and
-<literal>module</literal> .
+<literal>module</literal>.
__END__
__NAME__ example: Testing for features
1.4 +7 -8 xmldocs/refs/TableRestrict
rev 1.4, prev_rev 1.3
Index: TableRestrict
===================================================================
RCS file: /var/cvs/xmldocs/refs/TableRestrict,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- TableRestrict 19 Nov 2005 22:37:41 -0000 1.3
+++ TableRestrict 6 Nov 2006 18:41:21 -0000 1.4
@@ -18,12 +18,6 @@
and only rows satisfying given condition will be returned. Commonly,
you will want to use something like <literal>owner=username</literal>, to
restrict searches to just rows that the corresponding users "own".
-</para><para>
-As you can see from the ad-hoc example above, <literal>owner</literal> is a
-&glos-database; column name, and <literal>username</literal> is the key
-from the session database. (The user's <code>[data session username]</code>
-must match the value of the <database class='field'>owner</database> field
-if record is to be returned in a search operation).
__END__
__NAME__ notes
@@ -41,6 +35,11 @@
<programlisting>
TableRestrict products owner=username
</programlisting>
+As you can see from the ad-hoc example above, <literal>owner</literal> is a
+&glos-database; column name, and <literal>username</literal> is the key
+from the session database. (The user's <code>[data session username]</code>
+must match the value of the <database class='field'>owner</database> field
+if a record is to be returned in a search operation).
__END__
@@ -61,8 +60,8 @@
__NAME__ example: Searching using SQL
-When using SQL-based database searches, the above directive examples in effect
-turn the base search query of say,
+When using SQL-based database searches, this directive in effect
+turns the base search query of say,
<programlisting>
SELECT * FROM products
</programlisting>
1.3 +6 -6 xmldocs/refs/TagDir
rev 1.3, prev_rev 1.2
Index: TagDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/TagDir,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TagDir 21 Feb 2005 01:16:51 -0000 1.2
+++ TagDir 6 Nov 2006 18:41:21 -0000 1.3
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'>directory</arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>directory_name</replaceable></arg>
__END__
@@ -16,13 +14,15 @@
__END__
__NAME__ notes
-The specified location is treated relative to the &glos-ICROOT;.
+For more information on possible code declarations, see
+&glos-ITL; and &glos-filter; glossary entries and the &conf-CodeDef;
+configuration directive.
__END__
-__NAME__ example: Setting TagDir
+__NAME__ example: Setting __FILENAME__
<programlisting>
-TagDir code etc/other_code
+__FILENAME__ code etc/other_code
</programlisting>
__END__
1.2 +7 -1 xmldocs/refs/TagGroup
rev 1.2, prev_rev 1.1
Index: TagGroup
===================================================================
RCS file: /var/cvs/xmldocs/refs/TagGroup,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TagGroup 20 Feb 2005 00:59:50 -0000 1.1
+++ TagGroup 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,7 +4,7 @@
__NAME__ synopsis
- <arg choice='plain'><literal>:</literal>group</arg>
+ <arg choice='plain'><literal>:</literal><replaceable>group_name</replaceable></arg>
<arg choice='plain' rep='repeat'>code_declaration_names</arg>
__END__
@@ -18,6 +18,12 @@
__NAME__ example: Defining TagGroup
<programlisting>
TagGroup :file "counter file include log value_extended"
+
+Require taggroup :file
</programlisting>
__END__
+
+__NAME__ missing
+TagGroup :file or file?
+__END__
1.2 +2 -2 xmldocs/refs/TagInclude
rev 1.2, prev_rev 1.1
Index: TagInclude
===================================================================
RCS file: /var/cvs/xmldocs/refs/TagInclude,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TagInclude 20 Feb 2005 00:59:50 -0000 1.1
+++ TagInclude 6 Nov 2006 18:41:21 -0000 1.2
@@ -9,8 +9,8 @@
__NAME__ synopsis
<arg choice='opt'><literal>!</literal></arg>
<group choice='opt' rep='repeat'>
- <arg choice='plain'><literal>:</literal>group</arg>
- <arg choice='plain'>tag</arg>
+ <arg choice='plain'><literal>:</literal><replaceable>group_name</replaceable></arg>
+ <arg choice='plain'><replaceable>tag_name</replaceable></arg>
</group>
__END__
1.3 +5 -5 xmldocs/refs/TaxInclusive
rev 1.3, prev_rev 1.2
Index: TaxInclusive
===================================================================
RCS file: /var/cvs/xmldocs/refs/TaxInclusive,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TaxInclusive 19 Nov 2005 22:37:41 -0000 1.2
+++ TaxInclusive 6 Nov 2006 18:41:21 -0000 1.3
@@ -11,16 +11,16 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>0</arg>
- <arg choice='plain'>1</arg>
+<group choice='plain'>
+ <arg choice='plain'>No</arg>
+ <arg choice='plain'>Yes</arg>
</group>
__END__
__NAME__ description
-Display product prices with tax amount included (instead of calculating
-and displaying tax amount separately).
+Display product &glos-price;s with &glos-tax; amount included
+(instead of calculating and displaying tax amount separately).
This is common in European countries.
__END__
1.2 +2 -4 xmldocs/refs/TaxShipping
rev 1.2, prev_rev 1.1
Index: TaxShipping
===================================================================
RCS file: /var/cvs/xmldocs/refs/TaxShipping,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TaxShipping 22 Feb 2005 12:50:43 -0000 1.1
+++ TaxShipping 6 Nov 2006 18:41:21 -0000 1.2
@@ -11,14 +11,12 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>region</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>region_name</replaceable></arg>
__END__
__NAME__ description
-Specify states or jurisdictions that tax shipping costs.
+Specify states or jurisdictions that <replaceable>tax</replaceable> shipping costs.
__END__
__NAME__ example: Defining TaxShipping
1.3 +1 -3 xmldocs/refs/TcpHost
rev 1.3, prev_rev 1.2
Index: TcpHost
===================================================================
RCS file: /var/cvs/xmldocs/refs/TcpHost,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TcpHost 9 Jun 2005 12:02:44 -0000 1.2
+++ TcpHost 6 Nov 2006 18:41:21 -0000 1.3
@@ -8,9 +8,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>hostname</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>hostname</replaceable></arg>
__END__
1.2 +1 -1 xmldocs/refs/TcpMap
rev 1.2, prev_rev 1.1
Index: TcpMap
===================================================================
RCS file: /var/cvs/xmldocs/refs/TcpMap,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TcpMap 12 Mar 2006 22:12:35 -0000 1.1
+++ TcpMap 6 Nov 2006 18:41:21 -0000 1.2
@@ -63,7 +63,7 @@
__END__
-__NAME__ example: Offerning specific catalogs on specific ports
+__NAME__ example: Offering specific catalogs on specific ports
Even though the internal Web server in &IC; is gone,
<literal>tlink</literal> (Inet &glos-link-program;) still relies only on
the <envar>SCRIPT_PATH</envar> environment variable to determine which
1.3 +2 -4 xmldocs/refs/TemplateDir
rev 1.3, prev_rev 1.2
Index: TemplateDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/TemplateDir,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TemplateDir 20 May 2005 15:01:03 -0000 1.2
+++ TemplateDir 6 Nov 2006 18:41:21 -0000 1.3
@@ -4,15 +4,13 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>directory</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>directory_name</replaceable></arg>
__END__
__NAME__ description
Specify directories containing default pages. This effectively allows you to
-keep pages common for all catalogs in common directories, or — in case
+keep pages common for all &glos-catalog;s in common directories, or — in case
of a catalog directive — extend the page
search outside the catalog's <filename class='directory'>pages/</filename>
directory.
1.3 +1 -1 xmldocs/refs/TolerateGet
rev 1.3, prev_rev 1.2
Index: TolerateGet
===================================================================
RCS file: /var/cvs/xmldocs/refs/TolerateGet,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TolerateGet 6 Oct 2006 20:04:01 -0000 1.2
+++ TolerateGet 6 Nov 2006 18:41:21 -0000 1.3
@@ -4,7 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
1.5 +1 -3 xmldocs/refs/TrackFile
rev 1.5, prev_rev 1.4
Index: TrackFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/TrackFile,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TrackFile 4 Apr 2006 17:32:13 -0000 1.4
+++ TrackFile 6 Nov 2006 18:41:21 -0000 1.5
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>filename</arg>
-</group>
+<arg choice='plain'><replaceable>filename</replaceable></arg>
__END__
1.2 +7 -6 xmldocs/refs/TrackPageParam
rev 1.2, prev_rev 1.1
Index: TrackPageParam
===================================================================
RCS file: /var/cvs/xmldocs/refs/TrackPageParam,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TrackPageParam 12 Aug 2005 17:58:58 -0000 1.1
+++ TrackPageParam 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,9 +4,10 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'>page_name cgi_var1,cgi_var2</arg>
-</group>
+<arg choice='plain' rep='repeat'>
+ <replaceable>page_name</replaceable>
+ <replaceable>cgi_var1</replaceable>,<replaceable>cgi_var2</replaceable>
+</arg>
__END__
__NAME__ see also
@@ -18,16 +19,16 @@
inserted into user tracking file along with the visited page information.
</para><para>
Variable names and values are only printed if they are selected for
-output using this directive, and they have really been passed onto the
-target page.
+output using this directive, and if they have really been directly
+passed onto the target page as &glos-CGI; variables.
__END__
__NAME__ notes
__END__
__NAME__ example: Setting TrackPageParam
-First enable &conf-TrackFile; and then insert the following in &ccf;:
<programlisting>
+TrackFile logs/trackfile
TrackPageParam index var1,var2 index2 var3,var4
</programlisting>
The example will monitor values of the <literal>var1</literal>
1.2 +1 -3 xmldocs/refs/TrustProxy
rev 1.2, prev_rev 1.1
Index: TrustProxy
===================================================================
RCS file: /var/cvs/xmldocs/refs/TrustProxy,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TrustProxy 9 Jun 2005 12:02:44 -0000 1.1
+++ TrustProxy 6 Nov 2006 18:41:21 -0000 1.2
@@ -8,9 +8,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>hostname</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>hostname</replaceable></arg>
__END__
1.3 +1 -1 xmldocs/refs/Unix_Mode
rev 1.3, prev_rev 1.2
Index: Unix_Mode
===================================================================
RCS file: /var/cvs/xmldocs/refs/Unix_Mode,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Unix_Mode 19 Nov 2005 22:37:41 -0000 1.2
+++ Unix_Mode 6 Nov 2006 18:41:21 -0000 1.3
@@ -8,7 +8,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>Yes</arg>
<arg choice='plain'>No</arg>
</group>
1.2 +1 -3 xmldocs/refs/UpsZoneFile
rev 1.2, prev_rev 1.1
Index: UpsZoneFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/UpsZoneFile,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- UpsZoneFile 22 Feb 2005 12:50:43 -0000 1.1
+++ UpsZoneFile 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,9 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>filename</arg>
-</group>
+<arg choice='plain'><replaceable>filename</replaceable></arg>
__END__
1.2 +2 -4 xmldocs/refs/UrlSepChar
rev 1.2, prev_rev 1.1
Index: UrlSepChar
===================================================================
RCS file: /var/cvs/xmldocs/refs/UrlSepChar,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- UrlSepChar 21 Feb 2005 01:16:51 -0000 1.1
+++ UrlSepChar 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,16 +4,14 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>non_word_character</arg>
-</group>
+<arg choice='plain'><replaceable>non_word_character</replaceable></arg>
__END__
__NAME__ description
Specify URL separator character for &IC;-generated &glos-HTML; links.
Only one character is allowed, and the only recommended ones are
-the default <literal>&</literal>, <literal>;</literal> and
+the default <literal>&</literal>, <literal>;</literal> or
<literal>:</literal>.
__END__
1.4 +1 -3 xmldocs/refs/UseModifier
rev 1.4, prev_rev 1.3
Index: UseModifier
===================================================================
RCS file: /var/cvs/xmldocs/refs/UseModifier,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- UseModifier 15 Jun 2005 10:30:13 -0000 1.3
+++ UseModifier 6 Nov 2006 18:41:21 -0000 1.4
@@ -11,9 +11,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>modifier_name</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>modifier_name</replaceable></arg>
__END__
1.2 +1 -1 xmldocs/refs/UserControl
rev 1.2, prev_rev 1.1
Index: UserControl
===================================================================
RCS file: /var/cvs/xmldocs/refs/UserControl,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- UserControl 8 Apr 2006 23:45:55 -0000 1.1
+++ UserControl 6 Nov 2006 18:41:21 -0000 1.2
@@ -7,7 +7,7 @@
__END__
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
1.2 +1 -1 xmldocs/refs/UserDatabase
rev 1.2, prev_rev 1.1
Index: UserDatabase
===================================================================
RCS file: /var/cvs/xmldocs/refs/UserDatabase,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- UserDatabase 18 Nov 2005 23:15:02 -0000 1.1
+++ UserDatabase 6 Nov 2006 18:41:21 -0000 1.2
@@ -9,7 +9,7 @@
__NAME__ synopsis
-<arg choice='req'><replaceable>database_name</replaceable></arg>
+<arg choice='plain'><replaceable>database_name</replaceable></arg>
__END__
1.3 +4 -4 xmldocs/refs/ValuesDefault
rev 1.3, prev_rev 1.2
Index: ValuesDefault
===================================================================
RCS file: /var/cvs/xmldocs/refs/ValuesDefault,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ValuesDefault 14 Dec 2004 19:15:43 -0000 1.2
+++ ValuesDefault 6 Nov 2006 18:41:21 -0000 1.3
@@ -15,10 +15,10 @@
__NAME__ description
-The directive sets default user session values. Values are kept in
-&glos-UserDB; and (of course) override the defaults, but when the user
-is not logged in (and hasn't set any
-of his preferences for the current session), the defaults will be used.
+The directive sets default &glos-value;s in users' &glos-session;s.
+Values are otherwise kept in &glos-UserDB; and they override the defaults,
+but when the user is not logged in (and hasn't set any
+of his preferences for the current session), those defaults will be used.
__END__
__NAME__ example: Defining default values
1.6 +6 -2 xmldocs/refs/Variable
rev 1.6, prev_rev 1.5
Index: Variable
===================================================================
RCS file: /var/cvs/xmldocs/refs/Variable,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- Variable 9 Jun 2005 12:02:44 -0000 1.5
+++ Variable 6 Nov 2006 18:41:21 -0000 1.6
@@ -4,7 +4,7 @@
__NAME__ see also
-VariableDatabase
+VariableDatabase, var
__END__
@@ -37,6 +37,9 @@
- to first look for a catalog variable, falling back to global
unless found
</para></listitem>
+ <listitem><para>
+ Using the &tag-var; tag
+ </para></listitem>
</itemizedlist>
__END__
@@ -44,7 +47,8 @@
__NAME__ notes
Variable names <emphasis role='bold'>do not</emphasis> need to begin
with a capital letter (unlike the documentation prior to
-&IC; &first-xmldocs-release; release stated).
+&IC; &first-xmldocs-release; release stated), even though specifying
+them in all-uppercase is a widely accepted practice.
__END__
1.6 +1 -3 xmldocs/refs/VariableDatabase
rev 1.6, prev_rev 1.5
Index: VariableDatabase
===================================================================
RCS file: /var/cvs/xmldocs/refs/VariableDatabase,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- VariableDatabase 19 Nov 2005 22:37:41 -0000 1.5
+++ VariableDatabase 6 Nov 2006 18:41:21 -0000 1.6
@@ -8,9 +8,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>database name</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>database_name</replaceable></arg>
__END__
1.3 +1 -3 xmldocs/refs/VendURL
rev 1.3, prev_rev 1.2
Index: VendURL
===================================================================
RCS file: /var/cvs/xmldocs/refs/VendURL,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- VendURL 14 Dec 2004 19:15:43 -0000 1.2
+++ VendURL 6 Nov 2006 18:41:21 -0000 1.3
@@ -9,9 +9,7 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'><replaceable>URL</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>URL</replaceable></arg>
__END__
1.4 +7 -6 xmldocs/refs/WideOpen
rev 1.4, prev_rev 1.3
Index: WideOpen
===================================================================
RCS file: /var/cvs/xmldocs/refs/WideOpen,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- WideOpen 19 Nov 2005 22:37:41 -0000 1.3
+++ WideOpen 6 Nov 2006 18:41:21 -0000 1.4
@@ -9,7 +9,7 @@
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
@@ -17,18 +17,19 @@
__NAME__ description
-The &conf-WideOpen; directive disables IP-based qualification user sessions,
-which usually results in reduced catalog security.
+The &conf-WideOpen; directive disables IP-based qualification of user
+&glos-session;s.
+This increases compatibility, but reduces &glos-catalog; security.
</para><para>
-When &conf-WideOpen; is enabled, no IP-based checking is done, so
+When this directive is enabled, no IP-based checking is done, so
anyone guessing and supplying a valid session ID can hijack other client's
session.
</para><para>
The option was introduced to achieve more compatibility with old browsers, at
cost of some security. Do not enable it unless you first experience problems.
Also do not use it unless you are using some encryption
-(PGP/&conf-CreditCardAuto;) or a real-time payment gateway, such as
-&glos-CyberCash;.
+(PGP/&conf-CreditCardAuto;) or a real-time payment gateway, or the risk may
+be too high.
__END__
1.3 +3 -3 xmldocs/refs/Windows
rev 1.3, prev_rev 1.2
Index: Windows
===================================================================
RCS file: /var/cvs/xmldocs/refs/Windows,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Windows 21 May 2005 11:09:24 -0000 1.2
+++ Windows 6 Nov 2006 18:41:21 -0000 1.3
@@ -4,9 +4,9 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>0</arg>
- <arg choice='plain'>1</arg>
+<group choice='plain'>
+ <arg choice='plain'>No</arg>
+ <arg choice='plain'>yes</arg>
</group>
__END__
1.2 +1 -1 xmldocs/refs/WritePermission
rev 1.2, prev_rev 1.1
Index: WritePermission
===================================================================
RCS file: /var/cvs/xmldocs/refs/WritePermission,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- WritePermission 20 May 2005 23:06:42 -0000 1.1
+++ WritePermission 6 Nov 2006 18:41:21 -0000 1.2
@@ -4,7 +4,7 @@
__NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
<arg choice='plain'><literal>user</literal></arg>
<arg choice='plain'><literal>group</literal></arg>
<arg choice='plain'><literal>world</literal></arg>
1.4 +4 -4 xmldocs/refs/XHTML
rev 1.4, prev_rev 1.3
Index: XHTML
===================================================================
RCS file: /var/cvs/xmldocs/refs/XHTML,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- XHTML 20 Oct 2005 14:09:50 -0000 1.3
+++ XHTML 6 Nov 2006 18:41:21 -0000 1.4
@@ -8,9 +8,9 @@
__END__
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>0</arg>
- <arg choice='plain'>1</arg>
+<group choice='plain'>
+ <arg choice='plain'>No</arg>
+ <arg choice='plain'>Yes</arg>
</group>
__END__
@@ -30,7 +30,7 @@
Making HTML output XHTML-compliant is extremely easy (basically, you only
need to lowercase argument names, quote argument options, and include
<varname>$Vend::Xtrailer</varname> before the ending
-"<literal><</literal>" for standalone tags. That said, XHTML-compliance
+"<literal>></literal>" for standalone tags. That said, XHTML-compliance
patches are gladly accepted to speed up the transition process.
__END__
1.4 +1 -1 xmldocs/refs/area/control
rev 1.4, prev_rev 1.3
Index: control
===================================================================
RCS file: /var/cvs/xmldocs/refs/area/control,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- control 6 Mar 2005 11:51:28 -0000 1.3
+++ control 6 Nov 2006 18:41:29 -0000 1.4
@@ -1,3 +1,3 @@
-purpose: produce a hypertext link
+purpose: produce a hypertext link URL
see also: page
missing: under example 2, tell how to extract arg1=val1/arg2=val2 as separate fields from [data session arg]. Also see why there's no href in synopsis
More information about the docs
mailing list