Browse files

* Updates to B*/C* config directives

  • Loading branch information...
1 parent 6290532 commit a59e04bc152124cc377382d6740509899dbfc6be @docelic docelic committed Jan 7, 2009
Showing with 26 additions and 27 deletions.
  1. +1 −0 TODO
  2. +2 −0 refs/Autoload
  3. +1 −1 refs/BounceReferrals
  4. +3 −3 refs/CartTrigger
  5. +6 −6 refs/Catalog
  6. +1 −1 refs/CheckHTML
  7. +2 −3 refs/ChildLife
  8. +1 −1 refs/CodeDef
  9. +4 −8 refs/CodeRepository
  10. +2 −2 refs/CookieDomain
  11. +1 −0 refs/CustomShipping
  12. +2 −2 refs/FullUrl
View
1 TODO
@@ -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
View
2 refs/Autoload
@@ -82,10 +82,12 @@ Autoload <<EOA
[/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__
View
2 refs/BounceReferrals
@@ -29,7 +29,7 @@ There's no easy way around this, and we consider it a separate issue from the
&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__
View
6 refs/CartTrigger
@@ -17,7 +17,7 @@ __END__
__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 @@ action); for the <literal>update</literal> action, this will be a
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 @@ responsibility of deciding whether or not it is appropriate to invoke cart
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.
View
12 refs/Catalog
@@ -24,7 +24,7 @@ name in error, warning, and informational messages. It must contain only
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 @@ won't be activated.
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 @@ the &conf-Catalog; line in the &gcf; file as part of the standard procedure.
</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 @@ including it in your &glos-configuration;.
__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
View
2 refs/CheckHTML
@@ -39,7 +39,7 @@ __NAME__ notes
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
View
5 refs/ChildLife
@@ -18,9 +18,8 @@ __NAME__ description
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
View
2 refs/CodeDef
@@ -50,7 +50,7 @@ __END__
__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
View
12 refs/CodeRepository
@@ -18,11 +18,10 @@ Furthermore, it is hard to manually determine what subset of code is required,
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 @@ after &conf-HouseKeeping; seconds), &IC; will find the code already compiled
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>
View
4 refs/CookieDomain
@@ -18,15 +18,15 @@ The directive specifies the domain common to all servers providing
&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>
Things, however, go bad if you use more &IC; servers
(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
View
1 refs/CustomShipping
@@ -28,5 +28,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 ?
+Much is missing basically
__END__
View
4 refs/FullUrl
@@ -33,8 +33,8 @@ __END__
__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__

0 comments on commit a59e04b

Please sign in to comment.