* Updates to I/J/K/L/M config directives

interchange · Jan 9, 2009 · a815905 · a815905
1 parent 38c9048
commit a815905
Show file tree

Hide file tree

Showing 20 changed files with 83 additions and 101 deletions.
diff --git a/glossary/gate b/glossary/gate
@@ -1,3 +1,11 @@
 In &IC; parlance, "gating" is the process of controlling access to
-certain pages. See &howto-control-access-to-certain-pages; HOW-TO entry
+certain pages. See <olink targetdoc='howtos' targetptr='gate'/> HOW-TO entry
 for further information and examples.
+</para>
+	<note><para>
+		In &IC; versions prior to 5.7.0, <filename>.access</filename> file found
+		directly in &conf-PageDir; (i.e.
+		<filename class='directory'>pages/</filename>) is mistakenly ignored,
+		but does work for subdirectories.
+	</para></note>
+<para>
diff --git a/guides/howtos.xml b/guides/howtos.xml
@@ -51,7 +51,7 @@
 <qandadiv><title>Interchange</title>
 
 	<qandadiv><title>Core</title>
-		<qandaentry><question><para>
+		<qandaentry><question id='gate'><para>
 		Controlling access to pages
 		</para></question><answer><para>
 There's a built-in &IC; way to control access to pages served
@@ -89,7 +89,11 @@ is not available.
 </programlisting>
 <replaceable>PAGE_NAME</replaceable> is the name of page to be controlled,
 and the page suffix (such as <literal>.html</literal>) is optional.
-Page name of <literal>*</literal> can be used to set a default permission.
+</para><para>
+Page name of "<literal>*</literal>" can be used to set a default permission, but
+globbing is not possible ("<literal>ind*</literal>" will not match
+"<literal>index</literal>"). The default permission has lower precedence
+than any rule that matches the page name explicitly.
 </para><para>
 The <replaceable>CONDITION</replaceable> is a simple &glos-true; (or 
 <literal>Yes</literal>) or &glos-false; (or <literal>No</literal>) value
@@ -122,10 +126,6 @@ baz:      yes
 *:        [data session logged_in]
 </programlisting>
 
-<!-- XXX is it first match wins, and can you say page*: ... ? 
-
--->
-
 		</para></answer></qandaentry>
 
 

diff --git a/refs/IPCsocket b/refs/IPCsocket
@@ -13,8 +13,8 @@ __END__
 
 
 __NAME__ description
-The directive specifies the filename which &IC; should create to enable
-IPC socket communication. The filename must, of course, be writable
+The directive specifies the filename IC; should create to enable
+IPC socket communication. The filename must be writable
 by the Interchange daemon.
 __END__
 

diff --git a/refs/ImageAlias b/refs/ImageAlias
@@ -19,7 +19,9 @@ The directive specifies an alias for the base images location, which is
 set by &conf-ImageDir; and related directives.
 </para><para>
 It is similar in effect to the "alias" feature of Web servers such as 
-&APACHE; or NCSA. 
+&APACHE; or NCSA, and applies to <literal>&lt;body background=</literal>, 
+table elements <literal>background=</literal> and all 
+<literal>src=</literal> specifications.
 __END__
 
 __NAME_ notes

diff --git a/refs/ImageDir b/refs/ImageDir
@@ -17,31 +17,15 @@ __NAME__ description
 &conf-ImageDir; is one of quite basic settings in every &ccf;.
 </para><para>
 The directive specifies a base location, accessible over the web,
-where &IC; should look for IMG and INPUT &glos-HTML;
-<literal>src=</literal> file specifications.
-To be precise, actually, this setting applies to image locations mentioned
+where &IC; should look for image files, when just relative image
+filename is given.
+Automatically "translated" are image locations mentioned
 in <![CDATA[
 <img src="">, <input src="">, <body background="">, <table background=""> and table subelements (<th>, <tr> and <td>).]]>
 </para><para>
-As you might know, &IC; keeps its pages in a special directory
-<filename class='directory'>pages/</filename> (which is a subdirectory of 
-your catalog's &glos-CATROOT;). That directory can be readable only by the 
-&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,
-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
-and transparently prefix all &lt;img src=...&gt; &glos-HTML; tags with
-your value.
-</para><para>
-For example, if the &glos-link-program; and images are kept on the same
-server, and images are found in your web server's document root,
-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 &lt;img src="order.png"&gt;
-would automatically be translated to &lt;img src="/images/order.png"&gt;.
+A setting of &conf-ImageDir; <literal>/images/</literal> and a specification
+of <literal>&lt;img src="test/test.png"&gt;</literal> would be
+translated to <literal>&lt;img src="/images/test/test.png"&gt;</literal>.
 __END__
 
 __NAME_ notes

diff --git a/refs/ImageDirSecure b/refs/ImageDirSecure
@@ -19,10 +19,10 @@ where &IC; should look for IMG and INPUT &glos-HTML;
 <literal>src=</literal> file specifications,
 <emphasis role='bold'>when the originating page is being served
 over a secure connection (HTTPS)</emphasis>.
-To be precise, actually, this setting applies to image locations mentioned in <![CDATA[ <img src="">, <input src="">, <body background="">, <table background=""> and table subelements (<th>, <tr> and <td>).]]>
+This setting applies to image locations mentioned in <![CDATA[ <img src="">, <input src="">, <body background="">, <table background=""> and table subelements (<th>, <tr> and <td>).]]>
 </para><para>
 This is useful if you are using separate HTTPS and HTTP servers, and cannot
-make the image directory path heads match. If &conf-ImageDirSecure; is
+make the image directory paths match. If &conf-ImageDirSecure; is
 unspecified, it defaults to &conf-ImageDir;.
 __END__
 

diff --git a/refs/Inet_Mode b/refs/Inet_Mode
@@ -26,8 +26,8 @@ This &glos-configuration; directive can be overridden using
 __END__
 
 __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).
+In general, you will need &IC; INET mode when the
+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

diff --git a/refs/ItemAction b/refs/ItemAction
@@ -40,14 +40,13 @@ Consequently, direct manipulation of the &glos-cart; from within &PERL;
 <emphasis role='bold'>will not</emphasis> cause this function to be invoked. The
 triggers only fire when the cart contents are modified through the standard
 Interchange &glos-CGI;-based variable processing. Therefore, it is assumed
-(for the moment, at least) that any programmer sufficiently comfortable or
+that any programmer sufficiently comfortable or
 confident to manipulate cart contents directly can also be given the
 responsibility of deciding whether or not it is appropriate to manually invoke
 this function.
 </para><para>
 This &glos-configuration; directive is very similar to &conf-CartTrigger;
-and &conf-CartTriggerQuantity;, the two directives that could be percieved
-as more recent and flexible options.
+and &conf-CartTriggerQuantity;, the two more recent and flexible options.
 __END__
 
 __NAME__ example: Specifying __FILENAME__

diff --git a/refs/Jobs b/refs/Jobs
@@ -15,9 +15,10 @@ __END__
 __NAME__ description
 </para><para>
 This directive configures Interchange batch &glos-jobs; facility.
-It accepts a list of key/value pairs.
+For detailed discussion, please see the &glos-jobs; glossary entry.
 </para><para>
-It can be specified at both the global and &glos-catalog; level.
+The directive accepts a list of key/value pair and
+can be specified at both global and &glos-catalog; level.
 </para><para>
 The available keys for the <emphasis role='bold'>global directive</emphasis>
 are:
@@ -34,18 +35,18 @@ are:
 <row>
 <entry><literal>MaxLifetime</literal></entry>
 <entry><literal>600</literal></entry>
-<entry>The maximum time (in seconds) that a job will be allowed to run.</entry>
+<entry>The maximum time in seconds that a job will be allowed to run</entry>
 </row>
 <row>
 <entry><literal>MaxServers</literal></entry>
 <entry><literal>1</literal></entry>
-<entry>The maximum number of servers processing jobs. Excess jobs will be queued.
+<entry>The maximum number of servers processing jobs. Excess jobs will be queued
 </entry>
 </row>
 <row>
 <entry><literal>UseGlobal</literal></entry>
 <entry><literal>false</literal></entry>
-<entry>Search always for global job definitions.
+<entry>Always search for global job definitions?
 </entry>
 </row>
 </tbody>
@@ -70,20 +71,20 @@ The available keys for the <emphasis role='bold'>catalog directive</emphasis> ar
 <entry><literal>add_session</literal></entry>
 <entry><literal>false</literal></entry>
 <entry>Add session dump to 
-<olink targetdoc='glossary' targetptr='JobOutput'>job output</olink>.</entry>
+<olink targetdoc='glossary' targetptr='JobOutput'>job output</olink>?</entry>
 </row>
 <row>
 <entry><literal>autoend</literal></entry>
-<entry><emphasis>None</emphasis></entry>
+<entry>None</entry>
 <entry>
-A macro executed after each invidiual file in the job.
+A macro to execute after each invidiual file in the job
 </entry>
 </row>
 <row>
 <entry><literal>autoload</literal></entry>
-<entry><emphasis>None</emphasis></entry>
+<entry>None</entry>
 <entry>
-A macro executed before each invidiual file in the job.
+A macro to execute before each invidiual file in the job
 </entry>
 </row>
 <row>
@@ -94,65 +95,65 @@ to search for batch jobs.</entry>
 </row>
 <row>
 <entry><literal>email</literal></entry>
-<entry><emphasis>None</emphasis></entry>
+<entry>None</entry>
 <entry>Email <olink targetdoc='glossary' targetptr='JobOutput'>job output</olink>
-to this address.</entry>
+to this address</entry>
 </row>
 <row>
 <entry><literal>extra_headers</literal></entry>
-<entry><emphasis>None</emphasis></entry>
-<entry>Additional email headers.</entry>
+<entry>None</entry>
+<entry>Additional email headers</entry>
 </row>
 <row>
 <entry><literal>from</literal></entry>
 <entry>&conf-MailOrderTo;</entry>
-<entry>"From" address in emails.</entry>
+<entry>"From" address in emails</entry>
 </row>
 <row>
 <entry><literal>ignore_errors</literal></entry>
 <entry><literal>false</literal></entry>
 <entry>Excludes fatal errors from
-<olink targetdoc='glossary' targetptr='JobOutput'>job output</olink>.
+<olink targetdoc='glossary' targetptr='JobOutput'>job output</olink>
 </entry>
 </row>
 <row>
 <entry><literal>filter</literal></entry>
 <entry>&filter-strip;</entry>
-<entry>Filter(s) applied to
-<olink targetdoc='glossary' targetptr='JobOutput'>job output</olink>.</entry>
+<entry>Filters applied to
+<olink targetdoc='glossary' targetptr='JobOutput'>job output</olink></entry>
 </row>
 <row>
 <entry><literal>initialize</literal></entry>
-<entry><emphasis>None</emphasis></entry>
+<entry>None</entry>
 <entry>
-A macro executed before the job commences.
+A macro executed before the job commences
 </entry>
 </row>
 <row>
 <entry><literal>log</literal></entry>
-<entry><emphasis>None</emphasis></entry>
+<entry>None</entry>
 <entry>Write <olink targetdoc='glossary' targetptr='JobOutput'>job output</olink>
-to this logfile.</entry>
+to this logfile</entry>
 </row>
 <row>
 <entry><literal>subject</literal></entry>
 <entry><literal>Interchange results for job: %s</literal></entry>
-<entry>Subject for emails, including placeholder for job name.</entry>
+<entry>Subject for emails, including placeholder for job name</entry>
 </row>
 <row>
 <entry><literal>suffix</literal></entry>
-<entry><emphasis>None</emphasis></entry>
-<entry>Restrict job to files matching the specified suffix.</entry>
+<entry>None</entry>
+<entry>Restrict job to files matching the specified suffix</entry>
 </row>
 <row>
 <entry><literal>trackdb</literal></entry>
-<entry><emphasis>None</emphasis></entry>
-<entry>Table for <olink targetdoc='glossary' targetptr='JobTracking'>tracking jobs</olink>.</entry>
+<entry>None</entry>
+<entry>Table for <olink targetdoc='glossary' targetptr='JobTracking'>tracking jobs</olink></entry>
 </row>
 <row>
 <entry><literal>use_global</literal></entry>
 <entry><literal>false</literal></entry>
-<entry>Search for global job definitions.</entry>
+<entry>Search for global job definitions?</entry>
 </row>
 </tbody>
 </tgroup>
@@ -170,21 +171,18 @@ The invocation of jobs from the command line will only queue them for execution
 and will return the shell prompt before the jobs have actually started
 executing.
 </para><para>
-A common temporary &glos-session; (<mv>mv_tmp_session</mv> == &glos-true;)
+In that case, a common temporary &glos-session; (<mv>mv_tmp_session</mv> == &glos-true;)
 will be created for use by all of the files
 in the job queue. The session will be closed when the jobs complete.
 The remote IP address will be set to <literal>none</literal> and the
 user agent string will be set to <literal>commandline</literal>.
 __END__
 
 __NAME__ example: Define catalog-level Jobs directive
-Specify directory that will hold the job files, and set up a log file to
-for job runs. Also specify an email address to which any output jobs
-output will be sent:
 <programlisting>
 Jobs &lt;&lt;EOJ
-  base_directory  jobs
   log             logs/jobs.log
+  base_directory  jobs
   email           root@&def-hostname;
 EOJ
 </programlisting>

diff --git a/refs/Levies b/refs/Levies
@@ -1,5 +1,5 @@
 __NAME__ purpose
-specify Levy sections to apply
+specify levy sections to apply
 __END__
 
 

diff --git a/refs/Levy b/refs/Levy
@@ -77,4 +77,5 @@ synopsis
 descriptions
 turn list into NAME (SYNOPSIS, default DEF) - DESC
 add examples
+description of all levy keys
 __END__
diff --git a/refs/Limit b/refs/Limit
@@ -14,7 +14,7 @@ __NAME__ description
 <tbody>
 <row>
 <entry>cart_quantity_per_line</entry>
-<entry>-</entry>
+<entry>none</entry>
 <entry>maximum quantity per item in cart</entry>
 </row>
 <row>
@@ -98,3 +98,7 @@ __END__
 __NAME__ see also
 RobotLimit
 __END__
+
+__NAME__ missing
+fill in complete limits table
+__END__
diff --git a/refs/Locale b/refs/Locale
@@ -16,7 +16,7 @@ a number of items:
 <literal>currency_symbol</literal> - default currency symbol. Can be a simple value like "<literal>$</literal>" or " <literal>E</literal>", or a more flexible setting such as '<literal>&lt;img src="euro.png" /&gt;</literal>'.
 </para></listitem>
 <listitem><para>
-<literal>frac_digits</literal> - 
+<literal>frac_digits</literal> -
 </para></listitem>
 <listitem><para>
 <literal>int_curr_symbol</literal> -

diff --git a/refs/LocaleDatabase b/refs/LocaleDatabase
@@ -26,3 +26,6 @@ LocaleDatabase locale
 </programlisting>
 __END__
 
+__NAME__ missing
+example of LocaleDatabase structure (what fields etc.?)
+__END__
diff --git a/refs/LogFile b/refs/LogFile
@@ -17,7 +17,7 @@ Specify &glos-catalog; log file. If the filename is not absolute,
 it is treated relative to the catalog root directory (&glos-CATROOT;).
 </para><para>
 The file will gather output of the
-<function>::logData()</function> function.
+<function>::logData()</function> function (including the tag &tag-log;).
 __END__
 
 __NAME__ see also

diff --git a/refs/Mall b/refs/Mall
@@ -25,7 +25,7 @@ __END__
 
 __NAME__ example: Enabling Mall
 <programlisting>
-Mall 1
+Mall Yes
 </programlisting>
 __END__