[interchange-docs] xmldocs - docelic modified 12 files

docs at icdevgroup.org docs at icdevgroup.org
Wed Jan 7 23:58:52 UTC 2009


User:      docelic
Date:      2009-01-07 23:58:52 GMT
Modified:  .        TODO
Modified:  refs     Autoload BounceReferrals CartTrigger Catalog
Modified:           CheckHTML ChildLife CodeDef CodeRepository
Modified:           CookieDomain CustomShipping FullUrl
Log:
* Updates to B*/C* config directives

Revision  Changes    Path
1.122                xmldocs/TODO


rev 1.122, prev_rev 1.121
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.121
retrieving revision 1.122
diff -u -r1.121 -r1.122
--- TODO	7 Jan 2009 23:04:06 -0000	1.121
+++ TODO	7 Jan 2009 23:58:52 -0000	1.122
@@ -2,6 +2,7 @@
 - adjust iccattut to use tarball install paths
 -see how AcrossLocks works... does it open tables directly, or opens all tables so you dont have to put perl tables=
 - see why 'attribute' glossentry isn't found
+-make all-lowercase options for other auto* entitites too
 
 - manpages, first line of <screen> loses linebreaks
 - work on bin/mkreport



1.6                  xmldocs/refs/Autoload


rev 1.6, prev_rev 1.5
Index: Autoload
===================================================================
RCS file: /var/cvs/xmldocs/refs/Autoload,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- Autoload	23 Apr 2008 01:49:36 -0000	1.5
+++ Autoload	7 Jan 2009 23:58:52 -0000	1.6
@@ -82,10 +82,12 @@
 [/perl]
 EOA
 ]]></programlisting>
+<!-- (Remark irrelevant in the context)
 <para>
 Please note that &conf-SpecialPage; is the corresponding directive in 
 the catalog &glos-configuration; (and not <literal>Special</literal> as
 we see above). This is an exceptional case &mdash; the hash keys otherwise
 have the same name as the catalog configuration directives themselves.
+-->
 __END__
 



1.3                  xmldocs/refs/BounceReferrals


rev 1.3, prev_rev 1.2
Index: BounceReferrals
===================================================================
RCS file: /var/cvs/xmldocs/refs/BounceReferrals,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- BounceReferrals	10 Nov 2007 18:28:14 -0000	1.2
+++ BounceReferrals	7 Jan 2009 23:58:52 -0000	1.3
@@ -29,7 +29,7 @@
 &conf-BounceReferrals; concept.
 If session IDs in URLs are a concern, they'll need a separate solution.
 </para><para>
-Historically, many application servers always bounce the first request
+Historically, many application servers always bounced the first request
 to check for &glos-cookie; support. Nowadays, many simply require cookies for
 anything that needs a session. &IC; is different on both counts.
 __END__



1.7                  xmldocs/refs/CartTrigger


rev 1.7, prev_rev 1.6
Index: CartTrigger
===================================================================
RCS file: /var/cvs/xmldocs/refs/CartTrigger,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- CartTrigger	15 Nov 2007 16:37:35 -0000	1.6
+++ CartTrigger	7 Jan 2009 23:58:52 -0000	1.7
@@ -17,7 +17,7 @@
 
 
 __NAME__ description
-The directive specifies names of the &PERL; subroutines to be invoked
+The directive specifies names of the &PERL; subroutines to invoke
 when &glos-cart; contents change. The subroutines can 
 be defined on both global and catalog level.
 </para><para>
@@ -52,7 +52,7 @@
 The old row will no longer be a member of the cart
 </para></listitem>
 <listitem><para>
-The cart symbolic name
+The symbolic name of the cart
 </para></listitem>
 </itemizedlist>
 </para><para>
@@ -77,7 +77,7 @@
 triggers along the way.
 __END__
 
-__NAME__ example: Quantity of sub items follows their master item
+__NAME__ example: Quantity of subitems follows their master item
 The quantity of sub items are automatically changed to the quantity of
 the corresponding master item <emphasis role='bold'>regardless</emphasis> 
 of the current quantity.



1.9                  xmldocs/refs/Catalog


rev 1.9, prev_rev 1.8
Index: Catalog
===================================================================
RCS file: /var/cvs/xmldocs/refs/Catalog,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- Catalog	19 Oct 2006 20:28:13 -0000	1.8
+++ Catalog	7 Jan 2009 23:58:52 -0000	1.9
@@ -24,7 +24,7 @@
 alphanumeric characters, hyphens, and underscores. It is highly recommended that
 it is also all lowercase.
 </para><para>
-Second argument specifies the local filesystem base directory of the catalog.
+Second argument specifies the filesystem base directory of the catalog.
 If the directory does not exist, the required &ccf; is not there, or &IC;
 detects any other problem, catalog configuration will be skipped and the
 &glos-catalog;
@@ -33,7 +33,7 @@
 Third argument is the so called <literal>SCRIPT_NAME</literal> of the 
 &glos-link-program;. It is a webserver path by which the catalog can be 
 accessed. It can be followed by different
-<emphasis role='bold'>aliases</emphasis>, all allowing you to access
+<emphasis role='bold'>aliases</emphasis>, all allowing access to
 the same &glos-catalog;. For example, this is useful when calling an SSL
 server or a
 members-only alias that requires a Basic HTTP authorization using the 
@@ -58,8 +58,8 @@
 </para><para>
 If the &ccf; file, expected in the catalog base directory, is not found, or is
 unreadable by the &IC; server, somewhat misguiding error message will be reported.
-Namely, instead of the appropriate permissions-problem message, the mandatory
-&conf-VendURL; directive will be reported undefined.
+Instead of the appropriate permissions-problem message, the mandatory
+&conf-VendURL; directive will be reported as undefined.
 __END__
 (Did I do this right? Now that MailOrderTo isn't mandatory anymore, 
 error will be about VendURL? Check that out.)
@@ -82,8 +82,8 @@
 __END__
 
 __NAME__ example: Elaborate Catalog directive definition
-Given the nature of the &conf-Catalog; directive, a catalog can be somewhat
-verbosely registered as:
+Given the nature of the &conf-Catalog; directive, a catalog can be registered somewhat
+verbosely with:
 <programlisting>
 Catalog simple  directory /home/catalogs/simple
 Catalog simple  script    /cgi-bin/ic/simple



1.7                  xmldocs/refs/CheckHTML


rev 1.7, prev_rev 1.6
Index: CheckHTML
===================================================================
RCS file: /var/cvs/xmldocs/refs/CheckHTML,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- CheckHTML	19 Oct 2006 19:29:54 -0000	1.6
+++ CheckHTML	7 Jan 2009 23:58:52 -0000	1.7
@@ -39,7 +39,7 @@
 Leaving this directive enabled on a production server usually leads to
 unnecessary performance degradation. The additional process spawn
 (and the time it takes to complete) every time a page is visited is
-very costly.
+costly.
 </para><para>
 <emphasis role='bold'>
 Additionally, this directive currently appears to be broken 



1.5                  xmldocs/refs/ChildLife


rev 1.5, prev_rev 1.4
Index: ChildLife
===================================================================
RCS file: /var/cvs/xmldocs/refs/ChildLife,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ChildLife	6 Nov 2006 18:41:20 -0000	1.4
+++ ChildLife	7 Jan 2009 23:58:52 -0000	1.5
@@ -18,9 +18,8 @@
 there are no problems arising from long-running processes
 (such as memory leaks).
 </para><para>
-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.
+In general, restarting is handled by the
+&conf-MaxRequestsPerChild; configuration directive.
 </para><para>
 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



1.11                 xmldocs/refs/CodeDef


rev 1.11, prev_rev 1.10
Index: CodeDef
===================================================================
RCS file: /var/cvs/xmldocs/refs/CodeDef,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- CodeDef	15 Jul 2008 12:19:39 -0000	1.10
+++ CodeDef	7 Jan 2009 23:58:52 -0000	1.11
@@ -50,7 +50,7 @@
 
 __NAME__ example: Defining a custom SearchOp
 Here's an exemplary "<literal>find_hammer</literal>" SearchOp that
-should be placed to &gcf;:
+should be placed in &gcf;:
 
 <programlisting><![CDATA[
 CodeDef find_hammer SearchOp find_hammer



1.11                 xmldocs/refs/CodeRepository


rev 1.11, prev_rev 1.10
Index: CodeRepository
===================================================================
RCS file: /var/cvs/xmldocs/refs/CodeRepository,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- CodeRepository	6 Nov 2006 18:41:20 -0000	1.10
+++ CodeRepository	7 Jan 2009 23:58:52 -0000	1.11
@@ -18,11 +18,10 @@
 especially when an &glos-ITL; tag calls
 <code>$Tag-&gt;<replaceable>TAGNAME</replaceable>()</code>
 which calls some filter which calls some sort of an action &mdash; 
-you get the picture.
+you get the idea.
 </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,
-&conf-CodeRepository; does just that.
+&conf-__FILENAME__; allows building catalogs with a more optimal
+set of code than just "everything".
 </para><para>
 &conf-CodeRepository; depends on a related directive, &conf-AccumulateCode;.
 If &conf-AccumulateCode; is disabled, operation is traditional and everything
@@ -43,10 +42,7 @@
 and ready to go.
 </para><para>
 Fetched code blocks are copied to 
-<filename class='directory'>&glos-ICROOT;/code/Accumulated/</filename>
-directory
-(<filename class='directory'>
-<varname>$Global::TagDir</varname>/Accumulated/</filename>, to be exact).
+<filename class='directory'><varname>$Global::TagDir</varname>/Accumulated/</filename>.
 When you restart &IC; the next time, these code blocks will be found,
 read normally and need not be recompiled and loaded on the fly again.
 </para><para>



1.5                  xmldocs/refs/CookieDomain


rev 1.5, prev_rev 1.4
Index: CookieDomain
===================================================================
RCS file: /var/cvs/xmldocs/refs/CookieDomain,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- CookieDomain	6 Nov 2006 18:41:20 -0000	1.4
+++ CookieDomain	7 Jan 2009 23:58:52 -0000	1.5
@@ -18,7 +18,7 @@
 &IC; content.
 </para><para>
 By default, the &glos-session; ID cookie domain is set to the hostname
-that you're accessing. For example, if you access the catalog using
+you're accessing. For example, if you access the catalog using
 server <literal>&def-hostname;</literal>, then cookie will be set by
 <literal>&def-hostname;</literal>.
 </para><para>
@@ -26,7 +26,7 @@
 (in a non-transparent way for the user) to provide content.
 For example, if SSL content was served from host
 <literal>ssl.&def-domain;</literal>, then users would have one 
-session for <literal>&def-hostname;</literal> and one for 
+session for <literal>&def-hostname;</literal> and another for 
 <literal>ssl.&def-domain;</literal>. This is undesired, of course.
 </para><para>
 To fix the described problem, we need to find part of the



1.4                  xmldocs/refs/CustomShipping


rev 1.4, prev_rev 1.3
Index: CustomShipping
===================================================================
RCS file: /var/cvs/xmldocs/refs/CustomShipping,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- CustomShipping	6 Nov 2006 18:41:20 -0000	1.3
+++ CustomShipping	7 Jan 2009 23:58:52 -0000	1.4
@@ -28,5 +28,6 @@
 Make real-world example
 Make shipping.txt database to supplement the example
 Where is the error issued ?
+Much is missing basically
 __END__
 



1.5                  xmldocs/refs/FullUrl


rev 1.5, prev_rev 1.4
Index: FullUrl
===================================================================
RCS file: /var/cvs/xmldocs/refs/FullUrl,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- FullUrl	10 Oct 2008 09:29:32 -0000	1.4
+++ FullUrl	7 Jan 2009 23:58:52 -0000	1.5
@@ -33,8 +33,8 @@
 
 __NAME__ notes
 If &conf-FullUrl; is defined, <emphasis role='bold'>you must modify all
-&conf-catalog; lines in your &gcf; to include the hostname &mdash; 
-&conf-FullUrl; and non-&conf-FullUrl; &conf-catalog; specifications
+&conf-Catalog; lines in your &gcf; to include the hostname &mdash; 
+&conf-FullUrl; and non-&conf-FullUrl; &conf-Catalog; specifications
 are not compatible.</emphasis>
 __END__
 







More information about the docs mailing list