[interchange-docs] xmldocs - docelic modified 2 files

docs at icdevgroup.org docs at icdevgroup.org
Mon Nov 5 16:06:00 EST 2007


User:      docelic
Date:      2007-11-05 21:06:00 GMT
Modified:  refs     log.tag table-organize.tag
Log:
* Updated [log] tag according to racke's diff in RT.
  Closes #110: no examples for log.tag

* Minor formatting fix for table-organize

Revision  Changes    Path
1.5       +39 -11    xmldocs/refs/log.tag


rev 1.5, prev_rev 1.4
Index: log.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/log.tag,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- log.tag	13 Dec 2006 22:48:11 -0000	1.4
+++ log.tag	5 Nov 2007 21:05:59 -0000	1.5
@@ -63,8 +63,8 @@
 	Special actions to perform on the log message before writing to the
 	log file. By default, this includes removing leading and trailing whitespace,
 	and forcing every <literal>\r\n</literal> sequence to a single Unix
-	line-feed character (<literal>\n</literal>). Use "<literal>nostrip</literal>"
-	to prevent stripping.
+	line-feed character (<literal>\n</literal>). Use a value of
+	"<literal>nostrip</literal>" to prevent default processing.
 	</entry>
 
 </row> 
@@ -80,18 +80,18 @@
 	<!-- REQ -->
 	</entry>
 	<entry>
-	<!-- DFL -->
+	<literal>text</literal>
 	</entry>
 	<entry>
 	Log type to produce. Possible options are <literal>text</literal>
-	(the usual), <literal>quot</literal> (quotes each field, where fields
-	are separated by <option>record_delim</option>), <literal>error</literal>
-	(formats and logs message like standard Interchange error message) and
+	(standard), <literal>quot</literal> (quotes each field, where fields
+	are separated by <option>delimiter</option>), <literal>error</literal>
+	(formats and logs message like the standard Interchange error message) and
 	<literal>debug</literal> (formats and logs message like standard
 	Interchange debug message). Options <literal>error</literal> and
 	<literal>debug</literal> actually invoke &IC;'s 
 	<function>logError</function> or <function>logDebug</function> functions
-	in addition to writing to the specified log file.
+	in addition to writing to the log file (if any was specified).
 	</entry>
 
 </row> 
@@ -110,7 +110,8 @@
 	&NEWLINE;
 	</entry>
 	<entry>
-	Record delimiter.
+	Line delimiter. Allows the tag to identify multiple "records" in input
+	submitted at once.
 	</entry>
 
 </row> 
@@ -126,10 +127,10 @@
 	<!-- REQ -->
 	</entry>
 	<entry>
-	<!-- DFL -->
+	&TAB;
 	</entry>
 	<entry>
-	Line delimiter.
+	Field delimiter. Allows the tag to identify fields within the line.
 	</entry>
 
 </row> 
@@ -143,7 +144,7 @@
 __END__
 
 __NAME__ description
-The &tag-__FILENAME__; tag is used to write custom, possibly multiline,
+The &tag-__FILENAME__; tag can be used to write custom, possibly multiline,
 log messages to arbitrary log files.
 __END__
 
@@ -151,3 +152,30 @@
 __NAME__ missing
 in sub log (Interpolate), qw/delim record_delim/ should be qw/delimiter record_delim/, right ?
 __END__
+
+
+__NAME__ example: Log message to catalog's error.log
+<programlisting>
+[log type=error]
+An error occured.
+[/log]
+</programlisting>
+
+Or the same example that &glos-interpolate;s message text:
+
+<programlisting>
+[log type=error interpolate=1]
+An error occured, inform [value fname] at [value email].
+[/log]
+</programlisting>
+__END__
+
+
+__NAME__ example: Log to custom log
+<programlisting>
+[log file=var/log/custom.log]
+Custom log message.
+[/log]
+</programlisting>
+__END__
+



1.6       +4 -1      xmldocs/refs/table-organize.tag


rev 1.6, prev_rev 1.5
Index: table-organize.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/table-organize.tag,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- table-organize.tag	5 Nov 2007 20:12:52 -0000	1.5
+++ table-organize.tag	5 Nov 2007 21:05:59 -0000	1.6
@@ -6,7 +6,10 @@
 <row>
 
 	<entry>
-	cols | columns
+		<group>
+			<arg choice='plain'>cols</arg>
+			<arg choice='plain'>columns</arg>
+		</group>
 	</entry>
 	<entry>
 	yes








More information about the docs mailing list