[interchange-docs] xmldocs - docelic modified 24 files

docs at icdevgroup.org docs at icdevgroup.org
Thu Oct 19 16:28:16 EDT 2006


User:      docelic
Date:      2006-10-19 20:28:16 GMT
Modified:  .        TODO
Modified:  refs     Catalog ClearCache CodeDef CodeRepository
Modified:           CommonAdjust ConfDir ConfigAllAfter ConfigAllBefore
Modified:           ConfigDatabase ConfigDir ConfigParseComments
Modified:           CookieDomain CookieLogin Cookies CreditCardAuto
Modified:           CustomShipping DNSBL DataTrace Database
Modified:           DatabaseAuto DatabaseAutoIgnore DatabaseDefault
Modified:           DebugFile
Log:
* Same as previous commit, synopsis line simplification, wording improvements

Revision  Changes    Path
1.98      +1 -0      xmldocs/TODO


rev 1.98, prev_rev 1.97
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.97
retrieving revision 1.98
diff -u -r1.97 -r1.98
--- TODO	19 Oct 2006 19:29:54 -0000	1.97
+++ TODO	19 Oct 2006 20:28:13 -0000	1.98
@@ -14,6 +14,7 @@
   until the "chain" ends, which results in having many unrelated options
   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 
 
 Outstanding:
 =======



1.8       +1 -1      xmldocs/refs/Catalog


rev 1.8, prev_rev 1.7
Index: Catalog
===================================================================
RCS file: /var/cvs/xmldocs/refs/Catalog,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Catalog	19 Oct 2006 19:29:54 -0000	1.7
+++ Catalog	19 Oct 2006 20:28:13 -0000	1.8
@@ -3,7 +3,7 @@
 __END__
 
 __NAME__ see also
-FullUrl
+ConfigDatabase, FullUrl
 __END__
 
 __NAME__ synopsis



1.2       +2 -4      xmldocs/refs/ClearCache


rev 1.2, prev_rev 1.1
Index: ClearCache
===================================================================
RCS file: /var/cvs/xmldocs/refs/ClearCache,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ClearCache	22 Feb 2005 12:50:43 -0000	1.1
+++ ClearCache	19 Oct 2006 20:28:13 -0000	1.2
@@ -3,10 +3,8 @@
 __END__
 
 __NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain'>No</arg>
-	<arg choice='plain'>Yes</arg>
-</group>
+<arg choice='plain'>No</arg>
+<arg choice='plain'>Yes</arg>
 __END__
 
 __NAME__ see also



1.5       +5 -0      xmldocs/refs/CodeDef


rev 1.5, prev_rev 1.4
Index: CodeDef
===================================================================
RCS file: /var/cvs/xmldocs/refs/CodeDef,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- CodeDef	4 May 2006 21:16:33 -0000	1.4
+++ CodeDef	19 Oct 2006 20:28:13 -0000	1.5
@@ -17,6 +17,11 @@
 </group>
 _END__
 
+__NAME__ missing
+synopsis
+replace plain words with entities in description
+__END__
+
 __NAME__ description
 A generic &PERL; subroutine mapper which allows mapping of subroutines to
 &glos-ActionMap;s,



1.9       +2 -4      xmldocs/refs/CodeRepository


rev 1.9, prev_rev 1.8
Index: CodeRepository
===================================================================
RCS file: /var/cvs/xmldocs/refs/CodeRepository,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- CodeRepository	12 Oct 2006 13:51:35 -0000	1.8
+++ CodeRepository	19 Oct 2006 20:28:13 -0000	1.9
@@ -4,9 +4,7 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain'><replaceable>directory_name</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>directory_name</replaceable></arg>
 __END__
 
 
@@ -48,7 +46,7 @@
 <filename class='directory'>&glos-ICROOT;/code/Accumulated/</filename>
 directory
 (<filename class='directory'>
-<varname>$Global::TagDir</varname>/Accumulated/</filename>, to be exact)
+<varname>$Global::TagDir</varname>/Accumulated/</filename>, to be exact).
 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.4       +2 -4      xmldocs/refs/CommonAdjust


rev 1.4, prev_rev 1.3
Index: CommonAdjust
===================================================================
RCS file: /var/cvs/xmldocs/refs/CommonAdjust,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- CommonAdjust	3 Sep 2006 21:26:10 -0000	1.3
+++ CommonAdjust	19 Oct 2006 20:28:13 -0000	1.4
@@ -13,9 +13,7 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain'><literal><replaceable>&CAs;</replaceable></literal></arg>
-</group>
+<arg choice='plain'><literal><replaceable>CommonAdjust_string</replaceable></literal></arg>
 __END__
 
 
@@ -24,7 +22,7 @@
 chained item pricing scheme.
 </para><para>
 The whole pricing idea and the explanation of &CAs;s can be found under the
-&glos-price; entry in the glossary. Make sure you read it, or you'll have only
+&glos-price; &GE;. Make sure you read it, or you'll have only
 a limited success with <xref linkend="CommonAdjust_examples"/>.
 __END__
 



1.3       +1 -7      xmldocs/refs/ConfDir


rev 1.3, prev_rev 1.2
Index: ConfDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfDir,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ConfDir	22 May 2005 10:21:28 -0000	1.2
+++ ConfDir	19 Oct 2006 20:28:13 -0000	1.3
@@ -4,9 +4,7 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain'>directory</arg>
-</group>
+<arg choice='plain'>directory</arg>
 __END__
 
 
@@ -26,8 +24,4 @@
 </programlisting>
 __END__
 
-__NAME__ notes
-Make sure you don't get confused by the existence of all
-&conf-DirConfig;, &conf-ConfDir; and &conf-ConfigDir;.
-__END__
 



1.4       +1 -3      xmldocs/refs/ConfigAllAfter


rev 1.4, prev_rev 1.3
Index: ConfigAllAfter
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigAllAfter,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ConfigAllAfter	8 Dec 2004 12:39:58 -0000	1.3
+++ ConfigAllAfter	19 Oct 2006 20:28:13 -0000	1.4
@@ -3,9 +3,7 @@
 __END__
 
 __NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain' rep='repeat'><replaceable>config file</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>config_file</replaceable></arg>
 __END__
 
 



1.3       +1 -3      xmldocs/refs/ConfigAllBefore


rev 1.3, prev_rev 1.2
Index: ConfigAllBefore
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigAllBefore,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ConfigAllBefore	8 Dec 2004 12:39:58 -0000	1.2
+++ ConfigAllBefore	19 Oct 2006 20:28:13 -0000	1.3
@@ -8,9 +8,7 @@
 __END__
 
 __NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain' rep='repeat'><replaceable>config file</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>config_file</replaceable></arg>
 __END__
 
 



1.2       +2 -1      xmldocs/refs/ConfigDatabase


rev 1.2, prev_rev 1.1
Index: ConfigDatabase
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigDatabase,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ConfigDatabase	14 Dec 2005 23:10:59 -0000	1.1
+++ ConfigDatabase	19 Oct 2006 20:28:13 -0000	1.2
@@ -61,5 +61,6 @@
 __END__
 
 __NAME__ author
-__mheins__
+&__mheins__;
 __END__
+



1.4       +2 -4      xmldocs/refs/ConfigDir


rev 1.4, prev_rev 1.3
Index: ConfigDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigDir,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ConfigDir	14 Dec 2005 23:10:59 -0000	1.3
+++ ConfigDir	19 Oct 2006 20:28:13 -0000	1.4
@@ -4,9 +4,7 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain'><replaceable>directory_name</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>directory_name</replaceable></arg>
 __END__
 
 
@@ -33,7 +31,7 @@
 
 __NAME__ notes
 See the &glos-configuration; glossary entry for complete information 
-on &IC; config files.
+on &IC; config file syntax.
 </para><para>
 Make sure you don't get confused by the existence of all
 &conf-DirConfig;, &conf-ConfDir; and &conf-ConfigDir;.



1.4       +2 -4      xmldocs/refs/ConfigParseComments


rev 1.4, prev_rev 1.3
Index: ConfigParseComments
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigParseComments,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ConfigParseComments	3 Apr 2006 23:28:56 -0000	1.3
+++ ConfigParseComments	19 Oct 2006 20:28:13 -0000	1.4
@@ -4,10 +4,8 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain'>Yes</arg>
-	<arg choice='plain'>No</arg>
-</group>
+<arg choice='plain'>Yes</arg>
+<arg choice='plain'>No</arg>
 __END__
 
 __NAME__ notes



1.3       +8 -9      xmldocs/refs/CookieDomain


rev 1.3, prev_rev 1.2
Index: CookieDomain
===================================================================
RCS file: /var/cvs/xmldocs/refs/CookieDomain,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CookieDomain	18 Nov 2005 23:15:02 -0000	1.2
+++ CookieDomain	19 Oct 2006 20:28:13 -0000	1.3
@@ -4,9 +4,7 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain' rep='repeat'><replaceable>domain_name</replaceable></arg>
-</group>
+<arg choice='plain' rep='repeat'><replaceable>domain_name</replaceable></arg>
 __END__
 
 
@@ -37,6 +35,13 @@
 <literal>domain=</literal> parameter to the
 <literal>Set-Cookie</literal> directive that we send off to users'
 browsers. That's what the &conf-CookieDomain; does.
+</para><para>
+&conf-CookieDomain; accepts a space-separated list of domains to set
+cookies for, in which case the <literal>Set-Cookie: ...</literal> 
+is sent to the client for each of the specified domains. Due to the cookie
+restrictions described in <xref linkend="CookieDomain_notes"/>,
+specifying multiple domains is only rarely (if ever?) needed and
+possible to implement.
 __END__
 
 
@@ -59,12 +64,6 @@
 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>
-&conf-CookieDomain; accepts a space-separated list of domains to set
-cookies for, in which case the <literal>Set-Cookie: ...</literal> 
-is sent to the client for each of the specified domains. Due to the
-restrictions described above, specifying multiple domains is needed and
-possible to implement only rarely, if ever.
 __END__
 
 __NAME__ example: Specifying CookieDomain



1.3       +2 -4      xmldocs/refs/CookieLogin


rev 1.3, prev_rev 1.2
Index: CookieLogin
===================================================================
RCS file: /var/cvs/xmldocs/refs/CookieLogin,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CookieLogin	11 Jun 2005 08:53:41 -0000	1.2
+++ CookieLogin	19 Oct 2006 20:28:13 -0000	1.3
@@ -4,10 +4,8 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain'>0</arg>
-	<arg choice='plain'>1</arg>
-</group>
+<arg choice='plain'>No</arg>
+<arg choice='plain'>Yes</arg>
 __END__
 
 



1.4       +2 -4      xmldocs/refs/Cookies


rev 1.4, prev_rev 1.3
Index: Cookies
===================================================================
RCS file: /var/cvs/xmldocs/refs/Cookies,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Cookies	28 Jan 2006 13:45:52 -0000	1.3
+++ Cookies	19 Oct 2006 20:28:13 -0000	1.4
@@ -4,10 +4,8 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain'>1</arg>
-	<arg choice='plain'>0</arg>
-</group>
+<arg choice='plain'>Yes</arg>
+<arg choice='plain'>No</arg>
 __END__
 
 



1.3       +3 -5      xmldocs/refs/CreditCardAuto


rev 1.3, prev_rev 1.2
Index: CreditCardAuto
===================================================================
RCS file: /var/cvs/xmldocs/refs/CreditCardAuto,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CreditCardAuto	24 Mar 2006 21:12:51 -0000	1.2
+++ CreditCardAuto	19 Oct 2006 20:28:14 -0000	1.3
@@ -8,10 +8,8 @@
 __END__
 
 __NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain'>No</arg>
-	<arg choice='plain'>Yes</arg>
-</group>
+<arg choice='plain'>No</arg>
+<arg choice='plain'>Yes</arg>
 __END__
 
 
@@ -22,7 +20,7 @@
 The &conf-EncryptProgram; directive must be configured and working first.
 __END__
 
-__NAME__ example: Defining AllowGlobal
+__NAME__ example: Defining __FILENAME__
 <programlisting>
 CreditCardAuto Yes
 </programlisting>



1.2       +1 -3      xmldocs/refs/CustomShipping


rev 1.2, prev_rev 1.1
Index: CustomShipping
===================================================================
RCS file: /var/cvs/xmldocs/refs/CustomShipping,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- CustomShipping	18 Nov 2005 23:15:02 -0000	1.1
+++ CustomShipping	19 Oct 2006 20:28:14 -0000	1.2
@@ -4,9 +4,7 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain'><replaceable>SQL_query</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>SQL_query</replaceable></arg>
 __END__
 
 



1.2       +2 -4      xmldocs/refs/DNSBL


rev 1.2, prev_rev 1.1
Index: DNSBL
===================================================================
RCS file: /var/cvs/xmldocs/refs/DNSBL,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DNSBL	8 Apr 2006 23:45:55 -0000	1.1
+++ DNSBL	19 Oct 2006 20:28:14 -0000	1.2
@@ -8,13 +8,11 @@
 
 
 __NAME__ see also
-LockoutCommand
+LockoutCommand, HammerLock
 __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.4       +1 -3      xmldocs/refs/DataTrace


rev 1.4, prev_rev 1.3
Index: DataTrace
===================================================================
RCS file: /var/cvs/xmldocs/refs/DataTrace,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DataTrace	19 Nov 2005 17:56:31 -0000	1.3
+++ DataTrace	19 Oct 2006 20:28:14 -0000	1.4
@@ -4,9 +4,7 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain'><replaceable>granularity</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>granularity</replaceable></arg>
 __END__
 
 



1.5       +5 -0      xmldocs/refs/Database


rev 1.5, prev_rev 1.4
Index: Database
===================================================================
RCS file: /var/cvs/xmldocs/refs/Database,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Database	29 Sep 2006 21:37:48 -0000	1.4
+++ Database	19 Oct 2006 20:28:14 -0000	1.5
@@ -49,3 +49,8 @@
 </programlisting>
 __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.9       +6 -10     xmldocs/refs/DatabaseAuto


rev 1.9, prev_rev 1.8
Index: DatabaseAuto
===================================================================
RCS file: /var/cvs/xmldocs/refs/DatabaseAuto,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- DatabaseAuto	28 Sep 2006 16:34:56 -0000	1.8
+++ DatabaseAuto	19 Oct 2006 20:28:14 -0000	1.9
@@ -143,16 +143,8 @@
 ]]></programlisting>
 
 Alternatively, to dump the complete <varname>$Vend::Cfg</varname> structure,
-you could create a "<literal>cfgdump</literal>" usertag by saving the 
-following contents as <filename>code/UserTag/cfgdump.tag</filename>:
-<programlisting><![CDATA[
-UserTag cfgdump  Routine   <<EOR
-sub {
-        use Data::Dumper;
-        Dumper $Vend::Cfg;
-}
-EOR
-]]></programlisting>
+you could create a "<literal>cfgdump</literal>" usertag (see
+&howto-dump-vend-structure;).
 Then you could simply restart &IC; and call 
 <code><![CDATA[<pre>[cfgdump]</pre>]]></code> in any &IC; page, and search
 for <database>table1</database> in the output.
@@ -182,3 +174,7 @@
 &mheins;
 __END__
 
+
+__NAME__ missing
+Description of extra params, catalog, schema, name, type
+__END__



1.4       +2 -2      xmldocs/refs/DatabaseAutoIgnore


rev 1.4, prev_rev 1.3
Index: DatabaseAutoIgnore
===================================================================
RCS file: /var/cvs/xmldocs/refs/DatabaseAutoIgnore,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DatabaseAutoIgnore	13 Oct 2005 06:43:26 -0000	1.3
+++ DatabaseAutoIgnore	19 Oct 2006 20:28:14 -0000	1.4
@@ -21,8 +21,8 @@
 __END__
 
 __NAME__ notes
-This directive <emphasis role='bold'>must</emphasis> be set before
-&conf-DatabaseAuto;.
+This directive must be set before &conf-DatabaseAuto; to have meaningful
+effect.
 </para><para>
 For more about &IC; and databases, and supported formats, see &glos-database;
 glossary entry.



1.4       +5 -3      xmldocs/refs/DatabaseDefault


rev 1.4, prev_rev 1.3
Index: DatabaseDefault
===================================================================
RCS file: /var/cvs/xmldocs/refs/DatabaseDefault,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DatabaseDefault	12 Mar 2006 22:12:35 -0000	1.3
+++ DatabaseDefault	19 Oct 2006 20:28:14 -0000	1.4
@@ -49,11 +49,13 @@
 __END__
 
 __NAME__ notes
-Those defaults settings are made when the table is initially defined, so explicit
+Those default settings are made when the table is initially defined, so explicit
 settings for the database itself override the defaults, of course.
 </para><para>
-The setting must be made <emphasis role='bold'>before</emphasis> the database is defined using the
-&conf-Database; directive. For a way to clear definitions, use the &conf-Replace; directive.
+To have the intended effect, this directive must be set before the appropriate
+databases are defined with the &conf-Database; directive.
+</para><para>
+For a way to clear definitions, use the &conf-Replace; directive.
 __END__
 
 __NAME__ example: Specify default SQL connection username and password



1.4       +1 -3      xmldocs/refs/DebugFile


rev 1.4, prev_rev 1.3
Index: DebugFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/DebugFile,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DebugFile	5 Jul 2006 14:03:30 -0000	1.3
+++ DebugFile	19 Oct 2006 20:28:14 -0000	1.4
@@ -9,9 +9,7 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain'><replaceable>filename</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>filename</replaceable></arg>
 __END__
 
 








More information about the docs mailing list