[docs] xmldocs - docelic modified 41 files
docs at icdevgroup.org
docs at icdevgroup.org
Wed Dec 8 07:40:00 EST 2004
User: docelic
Date: 2004-12-08 12:39:59 GMT
Modified: . Makefile
Modified: bin refs-autogen
Modified: docbook olinkdb-c.xml olinkdb-nc.xml
Modified: glossary ActionMap
Modified: refs AcceptRedirect AllowGlobal Capability CheckHTML
Modified: ConfigAllAfter ConfigAllBefore ConfigParseComments
Modified: DataTrace DebugFile DisplayErrors DumpStructure
Modified: Environment ErrorFile HitCount HouseKeeping IpHead
Modified: IpQuad Locale LockType LockoutCommand
Modified: MaxRequestsPerChild MaxServers NoAbsolute NoCache
Modified: PIDcheck PIDfile Require SeparateItems SessionDB
Modified: SessionDatabase SessionExpire SessionLockFile
Modified: Variable
Added: glossary form-action link-program
Added: refs ActionMap
Log:
A large commit. Here's the deal:
- Makefile:
- Some corrections to work properly with reduced number of reference sets:
( glob & cat confs -> confs, system & user & ui tags -> tags).
- docbook/olink*:
- Also corrections/updates to work with compound docs (as above)
- Added some new glossary and refs items
- bin/refs-autogen:
- Hacked in support for EASIER adding of examples. The previous syntax:
__NAME__ example
<example>
<title>Example Title</title>
<para>
blah blah
<programlisting>
...
</programlisting>
</para>
</example>
__END__
Is now simply:
__NAME__ example: Example Title
blah blah
<programlisting>
...
</programlisting>
__END__
(that is, <example> and <para> are assumed, <title> is inserted if
you provide a title after a colon).
The rationale behind this is that I want sections to be disassociated
from the encapsulating elements (<example> in this case) so that we
can directly include the text in other contexts, without first having
to remove <example> and other context-specific tags from the input.
This is a generalization of the idea to have a "preamble" in tags.html
and confs.html that describes how to use tags and confs. (As Jon
said it'd be nice to preserve that layout like in old docs).
- refs/*:
- Adjusted 'example' sections to adhere to above convention. Also added
some missing bits and fixed few spelling errors.
Revision Changes Path
1.51 +1 -2 xmldocs/Makefile
rev 1.51, prev_rev 1.50
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.50
retrieving revision 1.51
diff -u -r1.50 -r1.51
--- Makefile 5 Dec 2004 22:12:07 -0000 1.50
+++ Makefile 8 Dec 2004 12:39:58 -0000 1.51
@@ -12,8 +12,7 @@
#############################################################
# Base definitions
-#SYMBOL_TYPES= pragmas globvars usertags uitags systemtags globconfs catconfs filters catvars
-SYMBOL_TYPES= pragmas globvars tags globconfs catconfs filters catvars
+SYMBOL_TYPES= pragmas globvars tags confs filters catvars
GUIDES = iccattut xmldocs
HOWTOS = howtos
GLOSSARY = glossary
1.73 +39 -7 xmldocs/bin/refs-autogen
rev 1.73, prev_rev 1.72
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.72
retrieving revision 1.73
diff -u -r1.72 -r1.73
--- refs-autogen 6 Dec 2004 13:55:15 -0000 1.72
+++ refs-autogen 8 Dec 2004 12:39:58 -0000 1.73
@@ -116,6 +116,17 @@
my @mandatory = (qw/synopsis example description purpose/);
+# General section intros and "outros"; they are set per-item and not
+# only per-section as you could achieve with putting them in a template.
+# The header is inserted
+# *after* <title>, if title was specified in section definition.
+my %item_header = (
+ example => "<example>\n%s<para>",
+);
+my %item_footer = (
+ example => "</para>\n</example>",
+);
+
my @paths = @ARGV; # Versions requested
my $path; # Current path, used in loop for each version requested
my $dumppath; # Path to cache dump file
@@ -791,14 +802,32 @@
my @c = <IN>;
close IN;
- my ( $section, $content );
+ my ( $section, $title, $pre_content, $content, $post_content );
# XXX check if it's empty, then don't update
for my $line (@c) {
- if ( $line =~ /^__NAME__ (.+)\s*$/ ) { $section = $1; next }
- if ( $line =~ /^__END__/ ) {
- update_field("append", $group, $name, $ref, "$refpath", $section, $content);
+ # Here we support format of this kind:
+ # __NAME__ section name: section title
+ # The 'title' part will be automatically wrapped in a
+ # <title> element.
+ if ( $line =~ /^__NAME__\s+(.+)\s*$/ ) {
+ # Support for this exists only in this format, it's not
+ # supported in control files or name/*. And fortunately, since
+ # we didn't modify the templates to do this trick, those old files
+ # can remain as-they-are and work properly !! Excellent.
+ my ( $sec, $title) = split /\s*:\s*/, $1, 2;
+ $section = $sec;
+ $title = $title ? "<title>$title</title>" : "";
+ $pre_content = sprintf($item_header{$section}||"", $title);
+ $post_content = sprintf($item_footer{$section}||"", $title);
+ next
+
+ } elsif ( $line =~ /^__END__/ ) {
+ update_field("append", $group, $name, $ref, "$refpath", $section, $content, $pre_content, $post_content);
$section = "";
+ $title = "";
+ $pre_content = "";
$content = "";
+ $post_content = "";
}
# If not a beginning or end of section, simply add line to content
$content .= $line if $section;
@@ -814,12 +843,15 @@
}
sub update_field {
- my ($mode, $group, $name, $sref, $fn, $sect, $content) = @_;
+ my ($mode, $group, $name, $sref, $fn, $sect, $content, $pre, $post) = @_;
$sect =~ s/[\-\.\+_:\d].*//;
$sect =~ s/([a-z])([A-Z])/$1 $2/g;
$sect = lc $sect;
+ $pre ||= "";
+ $post ||= "";
+
if ( $sect ne 'missing' ) {
if (!( grep {/^$sect/} @page_order ) and $sect ne 'ignore') {
@@ -860,12 +892,12 @@
}
if ( $mode eq 'override' ) {
- $$sref{lc $sect} = $content;
+ $$sref{lc $sect} = $pre . $content . $post if $content;
} else {
# Causes problems
#$$sref{lc $sect} .= $$sref{lc $sect} ?
# '</para><para>' . $content : $content;
- $$sref{lc $sect} .= $content if $content;
+ $$sref{lc $sect} .= $pre . $content . $post if $content;
}
} else { # "Missing" section
1.8 +6 -36 xmldocs/docbook/olinkdb-c.xml
rev 1.8, prev_rev 1.7
Index: olinkdb-c.xml
===================================================================
RCS file: /var/cvs/xmldocs/docbook/olinkdb-c.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- olinkdb-c.xml 4 Dec 2004 22:47:23 -0000 1.7
+++ olinkdb-c.xml 8 Dec 2004 12:39:58 -0000 1.8
@@ -8,13 +8,9 @@
<!ENTITY pragmas SYSTEM "../tmp/pragmas-c.db">
<!ENTITY globvars SYSTEM "../tmp/globvars-c.db">
<!ENTITY catvars SYSTEM "../tmp/catvars-c.db">
- <!ENTITY uitags SYSTEM "../tmp/uitags-c.db">
- <!ENTITY usertags SYSTEM "../tmp/usertags-c.db">
- <!ENTITY systemtags SYSTEM "../tmp/systemtags-c.db">
- <!ENTITY globconfs SYSTEM "../tmp/globconfs-c.db">
- <!ENTITY catconfs SYSTEM "../tmp/catconfs-c.db">
<!-- COMPOUNDS -->
<!ENTITY tags SYSTEM "../tmp/tags-c.db">
+ <!ENTITY confs SYSTEM "../tmp/confs-c.db">
]>
<targetset>
@@ -66,42 +62,16 @@
&catvars;
</document>
</dir>
-
- <!--
- <dir name='uitags'>
- <document targetdoc="uitags">
- &uitags;
- </document>
- </dir>
-
- <dir name='usertags'>
- <document targetdoc="usertags">
- &usertags;
- </document>
- </dir>
-
- <dir name='systemtags'>
- <document targetdoc="systemtags">
- &systemtags;
- </document>
- </dir>
- -->
- <dir name='ictags'>
+ <dir name='tags'>
<document targetdoc="tags">
&tags;
</document>
</dir>
-
- <dir name='globconfs'>
- <document targetdoc="globconfs">
- &globconfs;
- </document>
- </dir>
-
- <dir name='catconfs'>
- <document targetdoc="catconfs">
- &catconfs;
+
+ <dir name='confs'>
+ <document targetdoc="confs">
+ &confs;
</document>
</dir>
1.8 +2 -12 xmldocs/docbook/olinkdb-nc.xml
rev 1.8, prev_rev 1.7
Index: olinkdb-nc.xml
===================================================================
RCS file: /var/cvs/xmldocs/docbook/olinkdb-nc.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- olinkdb-nc.xml 5 Dec 2004 23:11:51 -0000 1.7
+++ olinkdb-nc.xml 8 Dec 2004 12:39:58 -0000 1.8
@@ -8,13 +8,9 @@
<!ENTITY pragmas SYSTEM "../tmp/pragmas-nc.db">
<!ENTITY globvars SYSTEM "../tmp/globvars-nc.db">
<!ENTITY catvars SYSTEM "../tmp/catvars-nc.db">
- <!ENTITY usertags SYSTEM "../tmp/usertags-nc.db">
- <!ENTITY uitags SYSTEM "../tmp/uitags-nc.db">
- <!ENTITY systemtags SYSTEM "../tmp/systemtags-nc.db">
- <!ENTITY globconfs SYSTEM "../tmp/globconfs-nc.db">
- <!ENTITY catconfs SYSTEM "../tmp/catconfs-nc.db">
<!-- COMPOUNDS -->
<!ENTITY tags SYSTEM "../tmp/tags-nc.db">
+ <!ENTITY confs SYSTEM "../tmp/confs-nc.db">
]>
<targetset>
@@ -31,15 +27,9 @@
<document targetdoc="pragmas" baseuri="pragmas.html"> &pragmas; </document>
<document targetdoc="globvars" baseuri="globvars.html"> &globvars; </document>
<document targetdoc="catvars" baseuri="catvars.html"> &catvars; </document>
- <!--
- <document targetdoc="usertags" baseuri="usertags.html"> &usertags; </document>
- <document targetdoc="uitags" baseuri="uitags.html"> &uitags; </document>
- <document targetdoc="systemtags" baseuri="systemtags.html"> &systemtags; </document>
- -->
- <document targetdoc="globconfs" baseuri="globconfs.html"> &globconfs; </document>
- <document targetdoc="catconfs" baseuri="catconfs.html"> &catconfs; </document>
<!-- COMPOUNDS -->
<document targetdoc="tags" baseuri="tags.html"> &tags; </document>
+ <document targetdoc="confs" baseuri="confs.html"> &confs; </document>
</dir>
</sitemap>
1.2 +1 -1 xmldocs/glossary/ActionMap
rev 1.2, prev_rev 1.1
Index: ActionMap
===================================================================
RCS file: /var/cvs/xmldocs/glossary/ActionMap,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ActionMap 8 Dec 2004 00:11:17 -0000 1.1
+++ ActionMap 8 Dec 2004 12:39:58 -0000 1.2
@@ -4,7 +4,7 @@
<glossdef>
<para>
-The standard C<process> action has a number of associated C<FormAction> settings. Besides using Perl, Interchange tags may be used in an action, though they are not nearly as efficient.
+The standard process action has a number of associated FormAction settings. Besides using Perl, Interchange tags may be used in an action, though they are not nearly as efficient.
</para>
1.1 xmldocs/glossary/form-action
rev 1.1, prev_rev 1.0
Index: form-action
===================================================================
<glossentry id="form-action">
<glossterm>form action</glossterm>
<glossdef>
<para>
<![CDATA[
TODO format
Interchange form processing is based on an C<action> and a C<todo>. The
predefined actions at the first level are:
process process a todo
search form-based search
scan path-based search
order order an item
minimate get access to a database via MiniMate
You can define any action you desire with C<ActionMap>.
The C<process> action has a second C<todo> level called with C<mv_todo>
or C<mv_doit>. The C<mv_todo> takes preference over C<mv_doit>, which
can be used to set a default if no C<mv_todo> is set.
The action can be specified either with:
=over 4
=item page name
Calling the page "search" will cause the search action, C<process>
will cause a form process action, etc. Examples:
<FORM ACTION="/cgi-bin/simple/search" METHOD=POST>
<INPUT NAME=mv_searchspec>
</FORM>
The above is a complete search in Interchange - it causes a simple text
search of the default products database(s). Normally you don't use
hard-coded paths, but use a minivend tag to specify it for portability:
<FORM ACTION="[area search]" METHOD=POST>
<INPUT NAME=mv_searchspec>
</FORM>
You will often see the tag C<[process]> in Interchange forms. The above
can be called equivalently with:
<FORM ACTION="[process]" METHOD=POST>
<INPUT TYPE=hidden NAME=mv_todo VALUE=search>
<INPUT NAME=mv_searchspec>
</FORM>
=item mv_action
Setting the special variable C<mv_action> causes the page name to
be ignored as the action source. The above forms can use this as
a synonym:
<FORM ACTION="[area foo]" METHOD=post>
<INPUT TYPE=hidden NAME=mv_action VALUE=search>
<INPUT NAME=mv_searchspec>
</FORM>
The page name will be used to set C<mv_nextpage> if it is not
otherwise defined; if C<mv_nextpage> is present in the form it
will be ignored.
=back
The second level C<todo> for the C<process> action has these
defined by default:
search Trigger a search
submit submit a form for validation (and possibly a final order)
go Go to C<mv_nextpage>
return Go to C<mv_nextpage>
set Update a database table
refresh Go to C<mv_orderpage|mv_nextpage> and check for
ordered items
cancel Erase the user session
If you define a page name as an action with C<ActionMap>, or use
of Interchange's predefined action C<process>, it will cause form processing.
first level is setting the special page name C<process>, or speciis set to do a form C<process>, the for
Interchange form can be used for any number of actions. The actions
are mapped by the I<ActionMap> directive in the catalog configuration
file, and are selected on the form with either the F<mv_todo> or F<mv_doit>
variables.
To set a default action for a C<process> form, set the variable C<mv_doit> as
a hidden variable:
<INPUT TYPE=hidden NAME=mv_doit VALUE=refresh>
When the F<mv_todo> value is not found, the I<refresh> action defined
in F<mv_doit> will be used instead.
More on the defined actions:
=over 4
=item cancel
All user information is erased, and the shopping cart is emptied. The
user is then sent to mv_nextpage.
=item refresh
Checks for newly-ordered items in C<mv_order_item>, looking for on-the-fly
items if that is defined, then updates the shopping cart with any changed
quantities or options. Finally updates the user variables and returns
to the page defined in mv_orderpage or mv_nextpage (in that order of
preference).
=item return
Updates the user variables and returns to the page defined
in mv_nextpage.
=item search
The shopping cart and user variables are updated, then the form
variables are interpreted and the search specification contained
therein is dispatched to the search engine - results are returned
on the defined search page (set by F<mv_search_page> or the search
page directives).
=item submit
Submit the form for order processing. If no order profile is defined
with the C<mv_order_profile> variable, the order is checked to see
if the current cart contains any items and the order is submitted.
If there is an order profile defined, the form will be checked against
the definition in the order profile and submitted if the pragma &final
is set to B<yes>. If &final is set to B<no> (the default), and the
check succeeds, the user will be routed to the Interchange page defined in
mv_successpage, or mv_nextpage. Finally, if the check fails, the user
will be routed to mv_failpage or mv_nextpage in that order.
=back
]]>
</para>
</glossdef>
</glossentry>
1.1 xmldocs/glossary/link-program
rev 1.1, prev_rev 1.0
Index: link-program
===================================================================
<glossentry id="link-program">
<glossterm>link program</glossterm>
<glossdef>
<para>
</para>
</glossdef>
</glossentry>
1.2 +2 -7 xmldocs/refs/AcceptRedirect
rev 1.2, prev_rev 1.1
Index: AcceptRedirect
===================================================================
RCS file: /var/cvs/xmldocs/refs/AcceptRedirect,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- AcceptRedirect 30 Nov 2004 22:46:22 -0000 1.1
+++ AcceptRedirect 8 Dec 2004 12:39:58 -0000 1.2
@@ -39,15 +39,10 @@
__END__
-__NAME__ example
-<example>
- <title>Enabling AcceptRedirect</title>
- <para>
- Put any of the following lines in &ccf;:
- </para>
+__NAME__ example: Enabling AcceptRedirect
+Put any of the following lines in &ccf;:
<programlisting>
AcceptRedirect Yes
</programlisting>
-</example>
__END__
1.2 +3 -6 xmldocs/refs/AllowGlobal
rev 1.2, prev_rev 1.1
Index: AllowGlobal
===================================================================
RCS file: /var/cvs/xmldocs/refs/AllowGlobal,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- AllowGlobal 9 Nov 2004 23:16:16 -0000 1.1
+++ AllowGlobal 8 Dec 2004 12:39:58 -0000 1.2
@@ -24,13 +24,10 @@
Don't use this directive unless the catalog user is completely trusted.
__END__
-__NAME__ example
-<example>
- <title></title>
- <programlisting>
+__NAME__ example: Defining AllowGlobal
+<programlisting>
AllowGlobal tutorial1 tutorial2
- </programlisting>
-</example>
+</programlisting>
__END__
1.2 +3 -6 xmldocs/refs/Capability
rev 1.2, prev_rev 1.1
Index: Capability
===================================================================
RCS file: /var/cvs/xmldocs/refs/Capability,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Capability 30 Nov 2004 22:46:22 -0000 1.1
+++ Capability 8 Dec 2004 12:39:58 -0000 1.2
@@ -24,12 +24,9 @@
configuration.
__END__
-__NAME__ example
-<example>
- <title>Testing for existence of Archive::Zip Perl module</title>
- <programlisting>
+__NAME__ example: Testing for existence of Archive::Zip Perl module
+<programlisting>
Capability module Archive::Zip
- </programlisting>
-</example>
+</programlisting>
__END__
1.3 +8 -6 xmldocs/refs/CheckHTML
rev 1.3, prev_rev 1.2
Index: CheckHTML
===================================================================
RCS file: /var/cvs/xmldocs/refs/CheckHTML,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CheckHTML 30 Nov 2004 22:46:22 -0000 1.2
+++ CheckHTML 8 Dec 2004 12:39:58 -0000 1.3
@@ -42,15 +42,17 @@
unneccesary performance degradation. The additional process spawn
(and the time it takes to complete) every time a page is visited is
very costly.
+</para><para>
+<emphasis role='bold'>
+Additionally, this directive currently appears to be broken
+(it simply never gets called).
+</emphasis>
__END__
-__NAME__ example
-<example>
- <title></title>
- <programlisting>
+__NAME__ example: Enabling CheckHTML
+<programlisting>
CheckHTML /usr/local/bin/weblint -s -
- </programlisting>
-</example>
+</programlisting>
__END__
1.3 +3 -6 xmldocs/refs/ConfigAllAfter
rev 1.3, prev_rev 1.2
Index: ConfigAllAfter
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigAllAfter,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ConfigAllAfter 20 Nov 2004 14:40:40 -0000 1.2
+++ ConfigAllAfter 8 Dec 2004 12:39:58 -0000 1.3
@@ -16,13 +16,10 @@
or force your settings over user's configuration.
__END__
-__NAME__ example
-<example>
- <title></title>
- <programlisting>
+__NAME__ example: Setting ConfigAllAfter
+<programlisting>
ConfigAllAfter check_actions.cfg check_variables.cfg
- </programlisting>
-</example>
+</programlisting>
__END__
1.2 +3 -6 xmldocs/refs/ConfigAllBefore
rev 1.2, prev_rev 1.1
Index: ConfigAllBefore
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigAllBefore,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ConfigAllBefore 9 Nov 2004 23:16:16 -0000 1.1
+++ ConfigAllBefore 8 Dec 2004 12:39:58 -0000 1.2
@@ -18,13 +18,10 @@
Specify configuration files to read as a part of every catalog's configuration, before any other corresponding catalog config files are processed.
__END__
-__NAME__ example
-<example>
- <title></title>
- <programlisting>
+__NAME__ example: Setting ConfigAllBefore
+<programlisting>
ConfigAllBefore set_actions.cfg set_variables.cfg
- </programlisting>
-</example>
+</programlisting>
__END__
1.2 +3 -6 xmldocs/refs/ConfigParseComments
rev 1.2, prev_rev 1.1
Index: ConfigParseComments
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigParseComments,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ConfigParseComments 29 Oct 2004 20:23:10 -0000 1.1
+++ ConfigParseComments 8 Dec 2004 12:39:58 -0000 1.2
@@ -32,10 +32,8 @@
__END__
-__NAME__ example
-<example>
- <title></title>
- <programlisting>
+__NAME__ example: Config parser behavior with ConfigParseComments disabled
+<programlisting>
ConfigParseComments No
#include comment
@@ -43,7 +41,6 @@
# You better prepare the file named 'comment' for the following one:
include comment
- </programlisting>
-</example>
+</programlisting>
__END__
1.2 +3 -6 xmldocs/refs/DataTrace
rev 1.2, prev_rev 1.1
Index: DataTrace
===================================================================
RCS file: /var/cvs/xmldocs/refs/DataTrace,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DataTrace 9 Nov 2004 23:16:16 -0000 1.1
+++ DataTrace 8 Dec 2004 12:39:58 -0000 1.2
@@ -35,16 +35,13 @@
defined, and <option>DebugFile</option> properly set.
__END__
-__NAME__ example
-<example>
- <title></title>
- <programlisting>
+__NAME__ example: Enabling DataTrace
+<programlisting>
Variable DEBUG 1
DebugFile /tmp/icdebug
DataTrace 1
- </programlisting>
-</example>
+</programlisting>
__END__
1.2 +3 -6 xmldocs/refs/DebugFile
rev 1.2, prev_rev 1.1
Index: DebugFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/DebugFile,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DebugFile 9 Nov 2004 23:16:16 -0000 1.1
+++ DebugFile 8 Dec 2004 12:39:58 -0000 1.2
@@ -39,13 +39,10 @@
script for managing debug statements.
__END__
-__NAME__ example
-<example>
- <title></title>
- <programlisting>
+__NAME__ example: Setting DebugFile
+<programlisting>
Variable DEBUG 1
DebugFile /tmp/icdebug
- </programlisting>
-</example>
+</programlisting>
__END__
1.2 +2 -5 xmldocs/refs/DisplayErrors
rev 1.2, prev_rev 1.1
Index: DisplayErrors
===================================================================
RCS file: /var/cvs/xmldocs/refs/DisplayErrors,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DisplayErrors 30 Nov 2004 22:46:22 -0000 1.1
+++ DisplayErrors 8 Dec 2004 12:39:58 -0000 1.2
@@ -25,13 +25,10 @@
operation.
__END__
-__NAME__ example
-<example>
- <title>Enabling DisplayErrors</title>
- <para>Put the following in &gcf;</para>
+__NAME__ example: Enabling DisplayErrors
+<para>Put the following in &gcf;</para>
<programlisting>
DisplayErrors Yes
</programlisting>
-</example>
__END__
1.2 +3 -6 xmldocs/refs/DumpStructure
rev 1.2, prev_rev 1.1
Index: DumpStructure
===================================================================
RCS file: /var/cvs/xmldocs/refs/DumpStructure,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DumpStructure 9 Nov 2004 23:16:16 -0000 1.1
+++ DumpStructure 8 Dec 2004 12:39:58 -0000 1.2
@@ -21,12 +21,9 @@
DEBUG, DataTrace, DebugFile
__END__
-__NAME__ example
-<example>
- <title></title>
- <programlisting>
+__NAME__ example: Enabling DumpStructure
+<programlisting>
DumpStructure Yes
- </programlisting>
-</example>
+</programlisting>
__END__
1.2 +3 -6 xmldocs/refs/Environment
rev 1.2, prev_rev 1.1
Index: Environment
===================================================================
RCS file: /var/cvs/xmldocs/refs/Environment,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Environment 29 Oct 2004 23:21:16 -0000 1.1
+++ Environment 8 Dec 2004 12:39:58 -0000 1.2
@@ -15,12 +15,9 @@
__END__
-__NAME__ example
-<example>
- <title></title>
- <programlisting>
+__NAME__ example: Setting Environment directive
+<programlisting>
Environment MOD_PERL REMOTE_USER PGPPATH
- </programlisting>
-</example>
+</programlisting>
__END__
1.2 +3 -6 xmldocs/refs/ErrorFile
rev 1.2, prev_rev 1.1
Index: ErrorFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/ErrorFile,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ErrorFile 29 Oct 2004 23:21:17 -0000 1.1
+++ ErrorFile 8 Dec 2004 12:39:58 -0000 1.2
@@ -22,12 +22,9 @@
__END__
-__NAME__ example
-<example>
- <title></title>
- <programlisting>
+__NAME__ example: Setting ErrorFile
+<programlisting>
ErrorLog /var/log/interchange/error.log
- </programlisting>
-</example>
+</programlisting>
__END__
1.3 +3 -6 xmldocs/refs/HitCount
rev 1.3, prev_rev 1.2
Index: HitCount
===================================================================
RCS file: /var/cvs/xmldocs/refs/HitCount,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- HitCount 9 Nov 2004 23:16:16 -0000 1.2
+++ HitCount 8 Dec 2004 12:39:58 -0000 1.3
@@ -22,12 +22,9 @@
TrackFile
__END__
-__NAME__ example
-<example>
- <title></title>
- <programlisting>
+__NAME__ example: Enabling HitCount
+<programlisting>
HitCount Yes
- </programlisting>
-</example>
+</programlisting>
__END__
1.2 +4 -7 xmldocs/refs/HouseKeeping
rev 1.2, prev_rev 1.1
Index: HouseKeeping
===================================================================
RCS file: /var/cvs/xmldocs/refs/HouseKeeping,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- HouseKeeping 30 Oct 2004 12:32:56 -0000 1.1
+++ HouseKeeping 8 Dec 2004 12:39:58 -0000 1.2
@@ -18,12 +18,9 @@
__END__
-__NAME__ example
-<example>
- <title></title>
- <programlisting>
-HouseKeepign 5
- </programlisting>
-</example>
+__NAME__ example: Adjusting the HouseKeeping interval
+<programlisting>
+HouseKeeping 5
+</programlisting>
__END__
1.2 +2 -7 xmldocs/refs/IpHead
rev 1.2, prev_rev 1.1
Index: IpHead
===================================================================
RCS file: /var/cvs/xmldocs/refs/IpHead,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- IpHead 6 Dec 2004 13:55:15 -0000 1.1
+++ IpHead 8 Dec 2004 12:39:58 -0000 1.2
@@ -31,16 +31,11 @@
host name lookups.
__END__
-__NAME__ example
-<example>
- <title>Enabling IpHead directive</title>
- <para>
- Put the following in &gcf;:
- </para>
+__NAME__ example: Enabling IpHead
+Put the following in &gcf;:
<programlisting>
DomainTail No
IpHead Yes
</programlisting>
-</example>
__END__
1.2 +5 -9 xmldocs/refs/IpQuad
rev 1.2, prev_rev 1.1
Index: IpQuad
===================================================================
RCS file: /var/cvs/xmldocs/refs/IpQuad,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- IpQuad 6 Dec 2004 13:55:15 -0000 1.1
+++ IpQuad 8 Dec 2004 12:39:58 -0000 1.2
@@ -22,8 +22,8 @@
In other words, with an IPV4 address (32 bit address, consisting of
four dot-quads) of value
<systemitem class='ipadress'>127.0.0.1</systemitem> and &conf-IpQuad; of
-<literal>2</literal>,
-<systemitem class='ipadress'><emphasis role='bold'>127.0.</emphasis></systemitem>
+<literal>3</literal>,
+<systemitem class='ipadress'><emphasis role='bold'>127.0.0.</emphasis></systemitem>
would be enough to qualify the user session.
__END__
@@ -32,16 +32,12 @@
host name lookups.
__END__
-__NAME__ example
-<example>
- <title>Enabling IpHead directive</title>
- <para>
- Put the following in &gcf;:
- </para>
+__NAME__ example: Setting IpQuad
+Put the following in &gcf;:
<programlisting>
DomainTail No
IpHead Yes
+IpQuad 3
</programlisting>
-</example>
__END__
1.2 +5 -7 xmldocs/refs/Locale
rev 1.2, prev_rev 1.1
Index: Locale
===================================================================
RCS file: /var/cvs/xmldocs/refs/Locale,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Locale 6 Dec 2004 18:27:48 -0000 1.1
+++ Locale 8 Dec 2004 12:39:58 -0000 1.2
@@ -15,15 +15,13 @@
The content is usually loaded from a file.
__END__
-__NAME__ example
-<example>
- <title>Defining Locale</title>
- <para>
- Put the following in &gcf;:
- </para>
+__NAME__ example: Defining Locale
+Put the following in &gcf;:
<programlisting>
Locale <locale.error
</programlisting>
-</example>
__END__
+__NAME__ missing
+The description doesnt seem to match the description of the same variable when set in catalog.cfg
+__END__
1.2 +2 -7 xmldocs/refs/LockType
rev 1.2, prev_rev 1.1
Index: LockType
===================================================================
RCS file: /var/cvs/xmldocs/refs/LockType,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- LockType 6 Dec 2004 13:55:15 -0000 1.1
+++ LockType 8 Dec 2004 12:39:58 -0000 1.2
@@ -37,15 +37,10 @@
<literal>fcntl</literal> locking for sessions on a per-catalog basis only.
__END__
-__NAME__ example
-<example>
- <title>Setting LockType</title>
- <para>
- Put the following in &gcf;:
- </para>
+__NAME__ example: Setting LockType
+Put the following in &gcf;:
<programlisting>
LockType fcntl
</programlisting>
-</example>
__END__
1.2 +4 -11 xmldocs/refs/LockoutCommand
rev 1.2, prev_rev 1.1
Index: LockoutCommand
===================================================================
RCS file: /var/cvs/xmldocs/refs/LockoutCommand,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- LockoutCommand 6 Dec 2004 13:55:15 -0000 1.1
+++ LockoutCommand 8 Dec 2004 12:39:58 -0000 1.2
@@ -40,20 +40,13 @@
__END__
-__NAME__ example
-<example>
- <title>Preventing access to the system with ipfwadm</title>
- <para>
- Put the following in &gcf;:
- </para>
+__NAME__ example: Preventing access to the system with ipfwadm
+Put the following in &gcf;:
<programlisting>
LockoutCommand ipfwadm -I -i deny -S %s
</programlisting>
- <para>
- Note that the <command>ipfwadm</command> filtering system was used in Linux
- 2.0.* kernels, and is now largely obsolete.
- </para>
-</example>
+Note that the <command>ipfwadm</command> filtering system was used in Linux
+2.0.* kernels, and is now largely obsolete.
__END__
__NAME__ missing
1.2 +2 -7 xmldocs/refs/MaxRequestsPerChild
rev 1.2, prev_rev 1.1
Index: MaxRequestsPerChild
===================================================================
RCS file: /var/cvs/xmldocs/refs/MaxRequestsPerChild,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- MaxRequestsPerChild 6 Dec 2004 18:27:48 -0000 1.1
+++ MaxRequestsPerChild 8 Dec 2004 12:39:58 -0000 1.2
@@ -30,15 +30,10 @@
__END__
-__NAME__ example
-<example>
- <title>Setting MaxRequestsPerChild </title>
- <para>
- Put the following in &gcf;:
- </para>
+__NAME__ example: Setting MaxRequestsPerChild
+Put the following in &gcf;:
<programlisting>
MaxRequestsPerChild 100
</programlisting>
-</example>
__END__
1.2 +2 -7 xmldocs/refs/MaxServers
rev 1.2, prev_rev 1.1
Index: MaxServers
===================================================================
RCS file: /var/cvs/xmldocs/refs/MaxServers,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- MaxServers 6 Dec 2004 18:27:48 -0000 1.1
+++ MaxServers 8 Dec 2004 12:39:58 -0000 1.2
@@ -35,15 +35,10 @@
__END__
-__NAME__ example
-<example>
- <title>Setting MaxServers</title>
- <para>
- Put the following in &gcf;:
- </para>
+__NAME__ example: Setting MaxServers
+Put the following in &gcf;:
<programlisting>
MaxServers 20
</programlisting>
-</example>
__END__
1.2 +2 -7 xmldocs/refs/NoAbsolute
rev 1.2, prev_rev 1.1
Index: NoAbsolute
===================================================================
RCS file: /var/cvs/xmldocs/refs/NoAbsolute,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- NoAbsolute 6 Dec 2004 13:55:15 -0000 1.1
+++ NoAbsolute 8 Dec 2004 12:39:58 -0000 1.2
@@ -28,15 +28,10 @@
__END__
-__NAME__ example
-<example>
- <title>Enabling NoAbsolute</title>
- <para>
- Put the following in &gcf;:
- </para>
+__NAME__ example: Enabling NoAbsolute
+Put the following in &gcf;:
<programlisting>
NoAbsolute Yes
</programlisting>
-</example>
__END__
1.2 +2 -7 xmldocs/refs/NoCache
rev 1.2, prev_rev 1.1
Index: NoCache
===================================================================
RCS file: /var/cvs/xmldocs/refs/NoCache,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- NoCache 5 Dec 2004 23:11:51 -0000 1.1
+++ NoCache 8 Dec 2004 12:39:58 -0000 1.2
@@ -17,15 +17,10 @@
__END__
-__NAME__ example
-<example>
- <title>Setting NoCache</title>
- <para>
- Put the following in &ccf;:
- </para>
+__NAME__ example: Setting NoCache
+Put the following in &ccf;:
<programlisting>
NoCache ord special
</programlisting>
-</example>
__END__
1.2 +3 -6 xmldocs/refs/PIDcheck
rev 1.2, prev_rev 1.1
Index: PIDcheck
===================================================================
RCS file: /var/cvs/xmldocs/refs/PIDcheck,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- PIDcheck 30 Oct 2004 12:32:56 -0000 1.1
+++ PIDcheck 8 Dec 2004 12:39:58 -0000 1.2
@@ -41,12 +41,9 @@
__END__
-__NAME__ example
-<example>
- <title></title>
- <programlisting>
+__NAME__ example: Setting PIDcheck
+<programlisting>
PIDcheck 300
- </programlisting>
-</example>
+</programlisting>
__END__
1.2 +3 -6 xmldocs/refs/PIDfile
rev 1.2, prev_rev 1.1
Index: PIDfile
===================================================================
RCS file: /var/cvs/xmldocs/refs/PIDfile,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- PIDfile 30 Oct 2004 12:32:56 -0000 1.1
+++ PIDfile 8 Dec 2004 12:39:58 -0000 1.2
@@ -23,12 +23,9 @@
__END__
-__NAME__ example
-<example>
- <title></title>
- <programlisting>
+__NAME__ example: Setting PIDfile
+<programlisting>
PIDfile /var/run/interchange/interchange.pid
- </programlisting>
-</example>
+</programlisting>
__END__
1.2 +1 -4 xmldocs/refs/Require
rev 1.2, prev_rev 1.1
Index: Require
===================================================================
RCS file: /var/cvs/xmldocs/refs/Require,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Require 30 Nov 2004 22:46:22 -0000 1.1
+++ Require 8 Dec 2004 12:39:58 -0000 1.2
@@ -25,14 +25,11 @@
sure they will have all the needed facilities available.
__END__
-__NAME__ example
-<example>
- <title>Requireing features</title>
+__NAME__ example: Requireing features
<programlisting>
Require module Archive::Zip
Require usertag table_editor
Require globalsub file_info
</programlisting>
-</example>
__END__
1.2 +2 -7 xmldocs/refs/SeparateItems
rev 1.2, prev_rev 1.1
Index: SeparateItems
===================================================================
RCS file: /var/cvs/xmldocs/refs/SeparateItems,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SeparateItems 5 Dec 2004 23:11:51 -0000 1.1
+++ SeparateItems 8 Dec 2004 12:39:58 -0000 1.2
@@ -26,15 +26,10 @@
__END__
-__NAME__ example
-<example>
- <title>Enabling SeparateItems</title>
- <para>
- Put the following in &ccf;:
- </para>
+__NAME__ example: Enabling SeparateItems
+Put the following in &ccf;:
<programlisting>
SeparateItems Yes
</programlisting>
-</example>
__END__
1.2 +2 -7 xmldocs/refs/SessionDB
rev 1.2, prev_rev 1.1
Index: SessionDB
===================================================================
RCS file: /var/cvs/xmldocs/refs/SessionDB,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SessionDB 5 Dec 2004 23:11:51 -0000 1.1
+++ SessionDB 8 Dec 2004 12:39:58 -0000 1.2
@@ -24,15 +24,10 @@
Using this directive (and DBI sessions in general) is not recommended.
__END__
-__NAME__ example
-<example>
- <title>Setting SessionDB</title>
- <para>
- Put the following in &ccf;:
- </para>
+__NAME__ example: Setting SessionDB
+Put the following in &ccf;:
<programlisting>
SessionDB sessions
</programlisting>
-</example>
__END__
1.2 +2 -7 xmldocs/refs/SessionDatabase
rev 1.2, prev_rev 1.1
Index: SessionDatabase
===================================================================
RCS file: /var/cvs/xmldocs/refs/SessionDatabase,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SessionDatabase 5 Dec 2004 23:11:51 -0000 1.1
+++ SessionDatabase 8 Dec 2004 12:39:58 -0000 1.2
@@ -34,15 +34,10 @@
__END__
-__NAME__ example
-<example>
- <title>Setting SessionDatabase</title>
- <para>
- Put the following in &ccf;:
- </para>
+__NAME__ example: Setting SessionDatabase
+Put the following in &ccf;:
<programlisting>
SessionDatabase session-data
</programlisting>
-</example>
__END__
1.2 +2 -7 xmldocs/refs/SessionExpire
rev 1.2, prev_rev 1.1
Index: SessionExpire
===================================================================
RCS file: /var/cvs/xmldocs/refs/SessionExpire,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SessionExpire 5 Dec 2004 23:11:51 -0000 1.1
+++ SessionExpire 8 Dec 2004 12:39:58 -0000 1.2
@@ -33,15 +33,10 @@
the customer's cart and session values will be reset.
__END__
-__NAME__ example
-<example>
- <title>Setting SessionExpire</title>
- <para>
- Put the following in &ccf;:
- </para>
+__NAME__ example: Setting SessionExpire
+Put the following in &ccf;:
<programlisting>
SessionExpire 20 minutes
</programlisting>
-</example>
__END__
1.2 +3 -8 xmldocs/refs/SessionLockFile
rev 1.2, prev_rev 1.1
Index: SessionLockFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/SessionLockFile,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SessionLockFile 5 Dec 2004 23:11:51 -0000 1.1
+++ SessionLockFile 8 Dec 2004 12:39:58 -0000 1.2
@@ -22,15 +22,10 @@
the pathname can be absolute if desired.
__END__
-__NAME__ example
-<example>
- <title>Setting SessionLockFile</title>
- <para>
- Put the following in &ccf;:
- </para>
+__NAME__ example: Setting SessionLockFile
+Put the following in &ccf;:
<programlisting>
-SessionExpire session-data.lock
+SessionLockFile session-data.lock
</programlisting>
-</example>
__END__
1.4 +2 -9 xmldocs/refs/Variable
rev 1.4, prev_rev 1.3
Index: Variable
===================================================================
RCS file: /var/cvs/xmldocs/refs/Variable,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Variable 8 Dec 2004 09:51:54 -0000 1.3
+++ Variable 8 Dec 2004 12:39:58 -0000 1.4
@@ -48,17 +48,10 @@
__END__
-__NAME__ example
-<example>
- <title>Defining a variable</title>
- <para>
- Put the following in &ccf;:
- </para>
+__NAME__ example: Defining a variable
+Put the following in &ccf;:
<programlisting>
Variable EMAIL root@&def-domain;
</programlisting>
-<para>
-</para>
-</example>
__END__
1.1 xmldocs/refs/ActionMap
rev 1.1, prev_rev 1.0
Index: ActionMap
===================================================================
UNVERIFIED
__NAME__ purpose
modify or define custom Interchange form actions
__END__
__NAME__ see also
AddDirective,CodeDef,UserTag
__END__
#__NAME__ synopsis
#<group choice='req'>
# <arg choice='plain'>No</arg>
# <arg choice='plain'>Yes</arg>
#</group>
#__END__
__NAME__ description
Allows setting of Interchange form actions, usually with a Perl subroutine.
</para><para>
Some of the predefined actions (which you might recognize from special
page names that you access in your catalog) are:
<itemizedlist>
<listitem><para>
<literal>process</literal> - Perform a processing function
</para></listitem>
<listitem><para>
<literal>order</literal> - Order items
</para></listitem>
<listitem><para>
<literal>scan</literal> - Search based on path info
</para></listitem>
<listitem><para>
<literal>search</literal> - Search based on submitted form variables
</para></listitem>
</itemizedlist>
For an introduction to Action Maps, see &glos-form-action;s glossary
entry.
__END__
__NAME__ example: Ignoring the Order action
Put the following in &ccf;:
<programlisting>
ActionMap order sub { 1 }
</programlisting>
Since we effectively turned Order into a no-operation action, the usual
order link such as
<code><![CDATA[<A HREF="[area order/nextpage]">Go to the next page</A>]]></code>
would be equivalent to <code><![CDATA[[page order/nextpage]Go to the next page</a>]]></code>.
__END__
More information about the docs
mailing list