[interchange-docs] xmldocs - docelic modified 11 files

docs at icdevgroup.org docs at icdevgroup.org
Thu Jan 8 15:39:25 UTC 2009


User:      docelic
Date:      2009-01-08 15:39:25 GMT
Modified:  refs     DataTrace Database DatabaseAuto DatabaseAutoIgnore
Modified:           DebugFile DebugTemplate DescriptionField
Modified:           DirectiveDatabase DomainTail ErrorDestination
Modified:           ErrorFile
Log:
* Updates to D*/E* config directives

Revision  Changes    Path
1.6                  xmldocs/refs/DataTrace


rev 1.6, prev_rev 1.5
Index: DataTrace
===================================================================
RCS file: /var/cvs/xmldocs/refs/DataTrace,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- DataTrace	6 Nov 2006 18:41:20 -0000	1.5
+++ DataTrace	8 Jan 2009 15:39:25 -0000	1.6
@@ -14,11 +14,11 @@
 there's a strong chance that your problem is related to DBI.
 </para><para>
 Setting of <literal>0</literal> disables tracing.<sbr/>
-Setting of <literal>1</literal> traces DBI method calls with return values (or errors)<sbr/>
-Setting of <literal>2</literal> traces as (1) plus the parameters used in method calls<sbr/>
+Setting of <literal>1</literal> traces DBI method calls with return values (or errors).<sbr/>
+Setting of <literal>2</literal> traces as (1) plus the parameters used in method calls.<sbr/>
 Setting of <literal>3</literal> traces as (2) plus some high-level information from the driver, and some internal information from the DBI<sbr/>
 Setting of <literal>4</literal> traces as (3) plus more detailed information from the driver. Also includes DBI mutex information when using threaded Perl<sbr/>
-Setting of <literal>5</literal> traces as (4) plus more and more obscure information<sbr/>
+Setting of <literal>5</literal> traces as (4) plus more and more obscure information.<sbr/>
 </para><para>
 Trace level of <literal>1</literal> is suitable in most situations.
 __END__



1.11                 xmldocs/refs/Database


rev 1.11, prev_rev 1.10
Index: Database
===================================================================
RCS file: /var/cvs/xmldocs/refs/Database,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- Database	29 Jan 2008 19:47:56 -0000	1.10
+++ Database	8 Jan 2009 15:39:25 -0000	1.11
@@ -3,17 +3,13 @@
 __END__
 
 __NAME__ synopsis
-<group choice='plain'>
-	<arg choice='plain'><replaceable>table_name</replaceable></arg>
-	<arg choice='plain'><replaceable>table_source_file</replaceable></arg>
-	<arg choice='plain'><replaceable>table_type</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>table_name</replaceable></arg>
+<arg choice='plain'><replaceable>table_source_file</replaceable></arg>
+<arg choice='plain'><replaceable>table_type</replaceable></arg>
 <sbr/>
-<group choice='plain'>
-	<arg choice='plain'><replaceable>table_name</replaceable></arg>
-	<arg choice='plain'><replaceable>attribute</replaceable></arg>
-	<arg choice='plain'><replaceable>value</replaceable></arg>
-</group>
+<arg choice='plain'><replaceable>table_name</replaceable></arg>
+<arg choice='plain'><replaceable>attribute</replaceable></arg>
+<arg choice='plain'><replaceable>value</replaceable></arg>
 __END__
 
 __NAME__ see also
@@ -40,7 +36,7 @@
 are used to refer to the same thing &mdash; database table.
 </para><para>
 Defining databases on an &IC; (global) level
-<emphasis role='bold'>does not work</emphasis>! If you want to share
+<emphasis role='bold'>won't work</emphasis>. If you want to share
 databases among catalogs, define them in each &ccf; separately (possibly
 by including the generic file with &conf-Database; definitions).
 __END__
@@ -57,6 +53,16 @@
 </programlisting>
 __END__
 
+__NAME__ example: Automatically configure all tables from an existing PostgreSQL database
+<programlisting>
+DatabaseAutoIgnore ^sql_
+DatabaseAuto __SQLDSN__
+NoImportExternal Yes
+</programlisting>
+
+For further discussion, see &conf-DatabaseAuto;.
+__END__
+
 __NAME__ example: Definition of a Postgres database table
 <programlisting>
 #



1.13                 xmldocs/refs/DatabaseAuto


rev 1.13, prev_rev 1.12
Index: DatabaseAuto
===================================================================
RCS file: /var/cvs/xmldocs/refs/DatabaseAuto,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- DatabaseAuto	16 Mar 2008 21:29:27 -0000	1.12
+++ DatabaseAuto	8 Jan 2009 15:39:25 -0000	1.13
@@ -170,6 +170,16 @@
 &mdash; literally and in uppercase).
 __END__
 
+__NAME__ example: Automatically configure all tables from an existing PostgreSQL database
+<programlisting>
+Variable SQLDSN  dbi:Pg:dbname=DATABASE_NAME
+
+DatabaseAutoIgnore ^sql_
+DatabaseAuto __SQLDSN__
+NoImportExternal Yes
+</programlisting>
+__END__
+
 
 __NAME__ author
 &mheins;



1.7                  xmldocs/refs/DatabaseAutoIgnore


rev 1.7, prev_rev 1.6
Index: DatabaseAutoIgnore
===================================================================
RCS file: /var/cvs/xmldocs/refs/DatabaseAutoIgnore,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- DatabaseAutoIgnore	15 May 2008 22:41:25 -0000	1.6
+++ DatabaseAutoIgnore	8 Jan 2009 15:39:25 -0000	1.7
@@ -16,13 +16,14 @@
 <emphasis>all</emphasis> tables found. (For example, you will want
 to exclude tables in non-default schemas.)
 </para><para>
-Note that instead of using this directive, you may prefer to directly
-specify <literal>schema</literal> argument to the &conf-DatabaseAuto; directive.
-(&conf-DatabaseAutoIgnore; easily ignores more tables than you intend).
+A loose regex specification can easily ignore more tables than you 
+intended, and if the goal is just using tables from the public schema, you
+might prefer specifying <literal>schema</literal> argument to 
+&conf-DatabaseAuto; directly.
 __END__
 
 __NAME__ notes
-This directive must be set before &conf-DatabaseAuto; to have meaningful
+This directive must be set before &conf-DatabaseAuto; to have a meaningful
 effect.
 </para><para>
 For more about &IC; and databases, and supported formats, see &glos-database;



1.6                  xmldocs/refs/DebugFile


rev 1.6, prev_rev 1.5
Index: DebugFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/DebugFile,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- DebugFile	6 Nov 2006 18:41:20 -0000	1.5
+++ DebugFile	8 Jan 2009 15:39:25 -0000	1.6
@@ -36,7 +36,7 @@
 by default in Interchange sources, you'll probably want to use a special
 script for managing debug statements, or manually uncomment parts of 
 debugging code in question (and restart Interchange, of course &mdash;
-see &howto-daemon-control;).
+see <olink targetdoc='howtos' targetptr='daemon-control'/>).
 __END__
 
 __NAME__ example: Setting DebugFile



1.2                  xmldocs/refs/DebugTemplate


rev 1.2, prev_rev 1.1
Index: DebugTemplate
===================================================================
RCS file: /var/cvs/xmldocs/refs/DebugTemplate,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DebugTemplate	10 Nov 2007 22:25:03 -0000	1.1
+++ DebugTemplate	8 Jan 2009 15:39:25 -0000	1.2
@@ -3,15 +3,15 @@
 __END__
 
 __NAME__ synopsis
-<group rep='repeat'>
-  <arg><replaceable>time_spec</replaceable></arg>
-  <arg><literal>{CALLER0}</literal> ... <literal>{CALLER9}</literal></arg>
-  <arg><literal>{CATALOG}</literal></arg>
-  <arg><literal>{HOST}</literal></arg>
-  <arg><literal>{MESSAGE}</literal></arg>
-  <arg><literal>{PAGE}</literal></arg>
-  <arg><literal>{REMOTE_ADDR}</literal></arg>
-  <arg><literal>{TAG}</literal></arg>
+<group rep='repeat' choice='plain'>
+	<arg><replaceable>time_spec</replaceable></arg>
+	<arg choice='plain'><literal>{CALLER0}</literal> ... <literal>{CALLER9}</literal></arg>
+	<arg choice='plain'><literal>{CATALOG}</literal></arg>
+	<arg choice='plain'><literal>{HOST}</literal></arg>
+	<arg choice='plain'><literal>{MESSAGE}</literal></arg>
+	<arg choice='plain'><literal>{PAGE}</literal></arg>
+	<arg choice='plain'><literal>{REMOTE_ADDR}</literal></arg>
+	<arg choice='plain'><literal>{TAG}</literal></arg>
 </group>
 __END__
 
@@ -21,8 +21,7 @@
 
 __NAME__ description
 &conf-DebugTemplate;, a global directive, allows you to change the
-format of debug messages. The meaning of the above literal 
-elements is:
+format of debug messages.
 
 <itemizedlist>
 	<listitem><para>



1.4                  xmldocs/refs/DescriptionField


rev 1.4, prev_rev 1.3
Index: DescriptionField
===================================================================
RCS file: /var/cvs/xmldocs/refs/DescriptionField,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DescriptionField	6 Nov 2006 18:41:20 -0000	1.3
+++ DescriptionField	8 Jan 2009 15:39:25 -0000	1.4
@@ -20,10 +20,7 @@
 
 
 __NAME__ notes
-The existence of the field is not exactly crucial, but it's important
-for say, &glos-flypage;s.
-</para><para>
-It's also useful to set the directive value based on &glos-locale;,
+It's useful to set this directive based on &glos-locale;,
 allowing for locale-specific product descriptions.
 __END__
 
@@ -34,9 +31,8 @@
 
 __NAME__ example: Redefining DescriptionField
 <programlisting>
-DescriptionField opis
+DescriptionField dsc
 </programlisting>
-"Opis", for example, is a croatian equivalent of "description".
 __END__
 
 __NAME__ example: Setting DecriptionField depending on current locale



1.2                  xmldocs/refs/DirectiveDatabase


rev 1.2, prev_rev 1.1
Index: DirectiveDatabase
===================================================================
RCS file: /var/cvs/xmldocs/refs/DirectiveDatabase,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DirectiveDatabase	29 Sep 2006 21:37:48 -0000	1.1
+++ DirectiveDatabase	8 Jan 2009 15:39:25 -0000	1.2
@@ -4,15 +4,9 @@
 
 __NAME__ synopsis
 <group choice='plain'>
-  <arg choice='plain'>
-		<replaceable>table_name</replaceable>
-		<arg choice='opt'>
-			<replaceable>table_source_filename</replaceable>
-			<arg choice='opt'>
-			<replaceable>table_source_type</replaceable>
-			</arg>
-		</arg>
-	</arg>
+  <arg choice='plain'><replaceable>table_name</replaceable>
+		<arg choice='opt'><replaceable>table_source_filename</replaceable>
+			<arg choice='opt'><replaceable>table_source_type</replaceable></arg></arg></arg>
 </group>
 __END__
 



1.5                  xmldocs/refs/DomainTail


rev 1.5, prev_rev 1.4
Index: DomainTail
===================================================================
RCS file: /var/cvs/xmldocs/refs/DomainTail,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- DomainTail	15 Feb 2008 18:24:50 -0000	1.4
+++ DomainTail	8 Jan 2009 15:39:25 -0000	1.5
@@ -35,7 +35,7 @@
 </para><para>
 If you are encrypting credit cards with PGP/GPG or using payment services,
 then look at the &conf-WideOpen; directive, which
-enables even more browser compatibility, again at the cost of even more
+enables even more browser compatibility, again at the cost of some
 security.
 __END__
 



1.4                  xmldocs/refs/ErrorDestination


rev 1.4, prev_rev 1.3
Index: ErrorDestination
===================================================================
RCS file: /var/cvs/xmldocs/refs/ErrorDestination,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ErrorDestination	21 May 2005 12:51:29 -0000	1.3
+++ ErrorDestination	8 Jan 2009 15:39:25 -0000	1.4
@@ -19,6 +19,10 @@
 error-related tags of functions.
 __END__
 
+__NAME__ notes
+Specification of <literal>tag=</literal> does not currently work with
+<literal>[log type=error]...[/log]</literal>.
+__END__
 
 __NAME__ missing
 In examples, show how exactly would you call [error] tag (or whatever) to see ErrorDestination in practice
@@ -31,7 +35,8 @@
 
 __NAME__ example: Routing error messages based on error message
 <programlisting>
-ErrorDestination "Attempt to order missing product code: %s" logs/missing_product.log
+ErrorDestination "Attempt to order missing product code: %s" logs/missing_products.log
+ErrorDestination  "search error: %s" logs/search_errors.log
 </programlisting>
 __END__
 
@@ -42,3 +47,9 @@
 </programlisting>
 __END__
 
+
+__NAME__ example: Logging in Perl and specifying a custom tag
+<programlisting><![CDATA[
+::logError( 'Bad search column ' . $_, { tag => 'search' } );
+]]></programlisting>
+__END__



1.6                  xmldocs/refs/ErrorFile


rev 1.6, prev_rev 1.5
Index: ErrorFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/ErrorFile,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ErrorFile	15 Feb 2008 18:24:50 -0000	1.5
+++ ErrorFile	8 Jan 2009 15:39:25 -0000	1.6
@@ -13,6 +13,9 @@
 </para><para>
 The Interchange daemon must have the permission to create and write to the
 specified file.
+</para><para>
+When using the directive on a &glos-catalog; level, specifying absolute
+filenames might not be allowed due to &conf-NoAbsolute;.
 __END__
 
 __NAME__ see also







More information about the docs mailing list