[interchange-docs] xmldocs - docelic modified 9 files

docs at icdevgroup.org docs at icdevgroup.org
Sat Aug 9 15:09:40 UTC 2008


User:      docelic
Date:      2008-08-09 15:09:40 GMT
Modified:  .        TODO
Modified:  guides   howtos.xml search.xml
Modified:  refs     AutoVariable checked.tag convert-date.tag
Modified:           db_columns.tag discount table-editor.tag
Log:
* Improved table-editor attribute listing
* A few simpler formatting/text fixes to a few files

Revision  Changes    Path
1.119                xmldocs/TODO


rev 1.119, prev_rev 1.118
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.118
retrieving revision 1.119
diff -u -r1.118 -r1.119
--- TODO	15 Jul 2008 12:19:39 -0000	1.118
+++ TODO	9 Aug 2008 15:09:40 -0000	1.119
@@ -6,6 +6,7 @@
 - see if the files we parse in bin/stattree in block (like parseVendConfig, parseVendInterpolate) allow some stuff to go unaccounted for mkreport
 - with tags from Interpolate.pm, context for systemtag is not always 'whole file', but can be x-y as well
 - dal autogen preskoci kontekst koji je prazan? i zasto uopce unkondicionalno
+- rijesit html_std/_ext i opcije
   ekspandira @$ctx ako moze da nema konteksta?
 - make howtos chunk
 - fix link to howtos after changing format



1.5                  xmldocs/guides/howtos.xml


rev 1.5, prev_rev 1.4
Index: howtos.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/howtos.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- howtos.xml	16 Jul 2008 13:10:25 -0000	1.4
+++ howtos.xml	9 Aug 2008 15:09:40 -0000	1.5
@@ -936,7 +936,7 @@
 
 
 
-		<qandaentry><question><para>
+		<qandaentry id=""><question><para>
 		Creating custom search routines for use in mv_column_op
 		</para></question><answer><para>
 		It is possible to define your own search functions that can be
@@ -967,15 +967,15 @@
 		</para></answer></qandaentry>
 
 
-		<qandaentry><question><para>
+		<qandaentry id="text_query"><question><para>
 		Supporting AND, OR, and other advanced search specifications
 		</para></question><answer><para>
 		You can install <classname>Text::Query</classname> Perl module
 		to enable advanced query parsing for search specifications.
 		</para><para>
 		To use <classname>Text::Query</classname>, set <mv>mv_column_op</mv>
-		to <literal>aq</literal> for advanced parsing or 
-		<literal>tq</literal> for simple parsing.
+		to "<literal>aq</literal>" for advanced parsing or 
+		"<literal>tq</literal>" for simple parsing.
 		</para><para>
 		To learn about the features "<literal>aq</literal>" and 
 		"<literal>tq</literal>" give you, see 



1.26                 xmldocs/guides/search.xml


rev 1.26, prev_rev 1.25
Index: search.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/search.xml,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- search.xml	16 Jul 2008 13:07:14 -0000	1.25
+++ search.xml	9 Aug 2008 15:09:40 -0000	1.26
@@ -204,9 +204,14 @@
 		</section>
 		<section id="mv_column_op"><title>
 		<literal>op &mdash; mv_column_op</literal></title><cmdsynopsis>
-		(<literal></literal>/<literal></literal>,
-		default <literal></literal>)</cmdsynopsis><para>
+		(<literal>rm</literal> | <literal>eq</literal> |
+		<literal>tq</literal> | <literal>aq</literal>,
+		default <literal>rm</literal>)</cmdsynopsis><para>
 		operation to perform to check field for a match.
+		</para><para>
+		For <literal>tq</literal> and <literal>aq</literal> matching
+		using <classname>Text::Query</classname> module, see 
+		<olink targetdoc="howtos" targetptr="text_query"/>.
 		</para>
 		</section>
 		<section id="mv_coordinate"><title>



1.5                  xmldocs/refs/AutoVariable


rev 1.5, prev_rev 1.4
Index: AutoVariable
===================================================================
RCS file: /var/cvs/xmldocs/refs/AutoVariable,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- AutoVariable	19 Oct 2006 19:29:54 -0000	1.4
+++ AutoVariable	9 Aug 2008 15:09:40 -0000	1.5
@@ -12,16 +12,21 @@
 
 
 __NAME__ description
-Specify list of &glos-configuration; directives that are to be automatically
-created as variable/value pairs. This allows you to conveniently
-write say, <code>__<replaceable>DIRECTIVENAME</replaceable>__</code>, and 
+Specify list of &glos-configuration; directives whose values are to be made
+available through the &glos-variable; space.
+This allows you to conveniently
+write say, <code>__<replaceable>DirectiveName</replaceable>__</code>, and 
 retrieve the corresponding configuration directive's value.
 </para><para>
-The above example, however, only works for scalar values. Since &IC; 
-also supports &glos-array;s and &glos-hash;es of values (so, all three
-basic &PERL; types), the syntax had to be extended a little. With 
-array or hashes, you need to append the index number or hash key respectively.
+To support &glos-scalar;s, &glos-array;s and &glos-hash;es of values (all
+three basic &PERL; types), the syntax had to be extended a little. With 
+array or hash &glos-configuration; directives, you need to append the index
+number or hash key respectively.
 See <xref linkend="AutoVariable_examples"/> for clarification.
+</para><para>
+Note that the behavior of &conf-__FILENAME__; is not dynamic &mdash; if need
+to re-invoke &conf-__FILENAME__; every time you want to "refresh" the 
+value visible through <code>__<replaceable>DirectiveName</replaceable>__</code>.
 __END__
 
 



1.8                  xmldocs/refs/checked.tag


rev 1.8, prev_rev 1.7
Index: checked.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/checked.tag,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- checked.tag	15 Jul 2008 12:19:39 -0000	1.7
+++ checked.tag	9 Aug 2008 15:09:40 -0000	1.8
@@ -148,6 +148,27 @@
 The tag provides "memory" for &glos-HTML; checkboxes and radio buttons.
 __END__
 
+__NAME__ example: "Memory" for checkboxes
+<programlisting><![CDATA[
+<pre>
+
+<form action="[process href="@@MV_PAGE@@"]" method="post">
+  [form-session-id]
+  <input type=hidden name=mv_todo value=refresh>
+  
+  <input type=checkbox name=checkbox1 [checked name=checkbox1 cgi=1]> Option1
+  <input type=checkbox name=checkbox2 [checked name=checkbox2 cgi=1]> Option2
+  <input type=checkbox name=checkbox3 [checked name=checkbox3 cgi=1]> Option3
+  <input type=checkbox name=checkbox4 [checked name=checkbox4 cgi=1]> Option4
+  <input type=checkbox name=checkbox5 [checked name=checkbox5 cgi=1]> Option5
+  
+  <input type=submit>
+</form>
+
+</pre>
+]]></programlisting>
+__END__
+
 __NAME__ example: Radio Button
 Displays a radio button and selects the second choice by default:
 <programlisting><![CDATA[



1.8                  xmldocs/refs/convert-date.tag


rev 1.8, prev_rev 1.7
Index: convert-date.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/convert-date.tag,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- convert-date.tag	15 Jul 2008 13:36:24 -0000	1.7
+++ convert-date.tag	9 Aug 2008 15:09:40 -0000	1.8
@@ -62,7 +62,7 @@
 	<literal>%d-%b-%Y</literal>
 	</entry>
 	<entry>
-	format string
+  POSIX strftime format specifier; see &glos-time; glossary entry.
 	</entry>
 
 </row> 



1.5                  xmldocs/refs/db_columns.tag


rev 1.5, prev_rev 1.4
Index: db_columns.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/db_columns.tag,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- db_columns.tag	15 Jul 2008 13:36:24 -0000	1.4
+++ db_columns.tag	9 Aug 2008 15:09:40 -0000	1.5
@@ -1,10 +1,14 @@
+__NAME__ purpose
+retrieve column names from a database table
+__END__
+
 __NAME__ synopsis 
 <row>
 
 	<entry>
-	<group choice='plain'>
-		<arg>name</arg>
-		<arg>table</arg>
+	<group>
+		<arg choice='plain'>name</arg>
+		<arg choice='plain'>table</arg>
 	</group>
 	</entry>
 	<entry>
@@ -17,16 +21,16 @@
 	<!-- DFL -->
 	</entry>
 	<entry>
-	<!-- DSC -->
+	Name of the &glos-database; table.
 	</entry>
 
 </row> 
 <row>
 
 	<entry>
-	<group choice='plain'>
-		<arg>fields</arg>
-		<arg>columns</arg>
+	<group>
+		<arg choice='plain'>fields</arg>
+		<arg choice='plain'>columns</arg>
 	</group>
 	</entry>
 	<entry>
@@ -39,7 +43,7 @@
 	<!-- DFL -->
 	</entry>
 	<entry>
-	<!-- DSC -->
+	Manually specify columns to be returned.
 	</entry>
 
 </row> 
@@ -58,7 +62,8 @@
 	<literal>\n</literal>
 	</entry>
 	<entry>
-	<!-- DSC -->
+	String joiner to use if column list is requested in &PERL;
+	<literal>scalar</literal> context.
 	</entry>
 
 </row> 
@@ -74,69 +79,100 @@
 	<!-- REQ -->
 	</entry>
 	<entry>
-	<!-- DFL -->
+	0
 	</entry>
 	<entry>
-	<!-- DSC -->
+	With <literal>columns=</literal>, return columns in the
+	passed order instead of table order?
 	</entry>
 
 </row> 
-<row>
+&TAG_CONTAINER;
+__END__
 
-	<entry>
-	show_error
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
+__NAME__ description
+&tag-__FILENAME__; returns the list of columns in a 
+&glos-database; table.
+__END__
 
-</row> 
-<row>
+__NAME__ notes
+A side effect of specifying <literal>passed_order=1</literal> is the
+removal of invalid column names from the <literal>columns=</literal>
+list; column names not present in the database table are filtered out,
+instead of being returned regardless.
+__END__
 
-	<entry>
-	keys
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
+__NAME__ example: looping over column list from the products table
+<programlisting><![CDATA[
+<pre>
+[loop list="[db-columns products]"]
+  Column: [loop-code]
+[/loop]
+</pre>
+]]></programlisting>
+__END__
 
-</row> 
-<row>
+__NAME__ example: looping over column list, without using db_columns
+It is possible to list table columns manually without the use of
+&tag-db_columns;. The output will be satisfactory as long as  you don't
+need db_column's <literal>columns=</literal> attribute.
+
+<programlisting><![CDATA[
+[perl tables=products]
+  $Scratch->{columns} = join ' ', $Db{products}->columns;
+  return;
+[/perl]
+
+<pre>
+[loop list="[scratch columns]"]
+  Column: [loop-code]
+[/loop]
+</pre>
+]]></programlisting>
+__END__
 
-	<entry>
-	joiner
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
 
-</row> 
-&TAG_NON_CONTAINER;
-__END__
+
+
+
+
+From docelic at mail.inet.hr  Thu Nov  4 17:16:15 2004
+From: docelic at mail.inet.hr (Davor Ocelic)
+Date: Thu Nov  4 17:16:31 2004
+Subject: [interchange-core] db_columns UI tag
+Message-ID: <20041104231615.2aee658c.docelic at mail.inet.hr>
+
+
+Hi,
+
+	The db_columns UI tag isn't documented so I can't compare the source
+	with intended behavior, but the tag has some problems:
+
+	In this code block:
+
+	if($passed_order) {
+		@col{@allcols} = @allcols;
+		@allcols = @cols;
+
+		my $found;
+		for(@cols) {
+			next unless $_ eq $key;
+			$found = 1;
+			last;
+		}
+#
+		unshift (@allcols, $key) if ! $found;
+	}
+
+
+Everything after the first line (@col{@allcols} = @allcols)
+	has no effect on the execution.
+
+	Besides, looks like the tag tries to ensure that $key is
+	always included in the set of returned column names, but
+	it doesn't succeed in doing so (at least if columns=
+			is specified by user).
+
+	Since the docs aren't available, I'd like someone more
+	familiar with this to check-in a fix if I'm right.
+



1.14                 xmldocs/refs/discount


rev 1.14, prev_rev 1.13
Index: discount
===================================================================
RCS file: /var/cvs/xmldocs/refs/discount,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- discount	15 Jul 2008 12:19:39 -0000	1.13
+++ discount	9 Aug 2008 15:09:40 -0000	1.14
@@ -93,7 +93,7 @@
 __NAME__ example: Resetting discounts
 To reset a discount, simply set it to the empty string: 
 <programlisting>
-[discount ALL_ITEMS /]
+[discount ALL_ITEMS][/discount]
 </programlisting>
 __END__
 



1.6                  xmldocs/refs/table-editor.tag


rev 1.6, prev_rev 1.5
Index: table-editor.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/table-editor.tag,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- table-editor.tag	15 Jul 2008 13:36:25 -0000	1.5
+++ table-editor.tag	9 Aug 2008 15:09:40 -0000	1.6
@@ -49,7 +49,30 @@
 <row>
 
 	<entry>
-	<group choice='plain'>
+	<group>
+	<arg choice='plain'>ui_data_fields</arg>
+	<arg choice='plain'>mv_data_fields</arg>
+	<arg choice='plain'>fields</arg>
+	</group>
+	</entry>
+	<entry>
+	Yes
+	</entry>
+	<entry>
+	No
+	</entry>
+	<entry>
+	All fields.
+	</entry>
+	<entry>
+	Fields to edit.
+	</entry>
+
+</row> 
+<row>
+
+	<entry>
+	<group>
 	<arg choice='plain'>ui_meta_view</arg>
 	<arg choice='plain'>view</arg>
 	</group>
@@ -1199,7 +1222,7 @@
 <row>
 
 	<entry>
-	"orig_$_"
+	tabbed
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -1218,7 +1241,7 @@
 <row>
 
 	<entry>
-	tabbed
+	auto_secure
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -1237,7 +1260,7 @@
 <row>
 
 	<entry>
-	auto_secure
+	keep_errors
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -1256,7 +1279,7 @@
 <row>
 
 	<entry>
-	keep_errors
+	ui_profile_success
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -1275,7 +1298,7 @@
 <row>
 
 	<entry>
-	ui_profile_success
+	mv_failpage
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -1294,7 +1317,7 @@
 <row>
 
 	<entry>
-	mv_failpage
+	orig_cancel_text
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -1313,7 +1336,7 @@
 <row>
 
 	<entry>
-	orig_cancel_text
+	orig_back_text
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -1332,7 +1355,7 @@
 <row>
 
 	<entry>
-	orig_back_text
+	action
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -1351,7 +1374,7 @@
 <row>
 
 	<entry>
-	action
+	message_label
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -1370,7 +1393,7 @@
 <row>
 
 	<entry>
-	message_label
+	all_errors
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -1389,7 +1412,7 @@
 <row>
 
 	<entry>
-	all_errors
+	color_fail
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -1407,8 +1430,11 @@
 </row> 
 <row>
 
-	<entry>
-	color_fail
+	<entry>	
+	<group>
+	<arg choice='plain'>ui_display_only</arg>
+	<arg choice='plain'>email_fields</arg>
+  </group>
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -1420,7 +1446,6 @@
 	<!-- DFL -->
 	</entry>
 	<entry>
-	<!-- DSC -->
 	</entry>
 
 </row> 







More information about the docs mailing list