[interchange-docs] xmldocs - docelic modified 12 files

docs at icdevgroup.org docs at icdevgroup.org
Thu May 4 17:16:33 EDT 2006


User:      docelic
Date:      2006-05-04 21:16:33 GMT
Modified:  .        TODO
Modified:  docbook  literals.ent
Modified:  guides   index.xml search.xml
Modified:  refs     CodeDef MaxServers dbi_quote.filter dump.tag
Modified:           time.tag timed-build.tag
Modified:  whatsnew WHATSNEW.xml
Added:     pending  list-of-search-related-mv-vars
Log:
Okay, we're back in business. Log as usual:

- TODO: add few items to the list that are soon to be programmed
- Add SWISH-E entity (&SWISH-E; - links to swish website, displays "Swish-e")
- Add search guide in index.html
- Remove mv_ variable descriptions from search guide, and only provide
  placeholders for links to appropriate mv_ reference pages (agreed with
  Racke to do it this way)
- Sanitize Swish examples in search.html (Avoid TABs in programlistings)
- Hide SYNOPSIS in CodeDef and example in dbi_quote until they're fixed
- Slight adjustment to dump.tag
- Slight rewording in time.tag, timed-build.tag

Revision  Changes    Path
1.85      +12 -0     xmldocs/TODO


rev 1.85, prev_rev 1.84
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -r1.84 -r1.85
--- TODO	29 Mar 2006 21:17:14 -0000	1.84
+++ TODO	4 May 2006 21:16:33 -0000	1.85
@@ -1,6 +1,18 @@
 - in iccattut, s/item-field/item-param/ at least on some places. 
 - Make xmldocs tarball in ftp autoupdated
 - Change -latest to version number in tarball download
+- In iccattut examples (files/*), replace catalog setting of ErrorFile,
+  TrackFile and similar directives with relative filenames. Also see how
+  Jon's file layout restructuring affects the examples
+- In reference pages, make special string, such as __FNAME__, that expands
+  to name of the filename. Will speed up writing and eliminate errors such
+  as copying "Setting ErrorFile" and forgetting to replace ErrorFile with
+  another name. (With this option, both files would just have
+  "Setting __FNAME__", and would magically work).
+- Parse default value for config directives (at least in cases where the
+  value is a simple oneliner), and display it as a special field in the
+  reference page.
+- bin/whatsnew-update didn't pick up User: from messages
 
 Outstanding:
 =======



1.35      +1 -0      xmldocs/docbook/literals.ent


rev 1.35, prev_rev 1.34
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.34
retrieving revision 1.35
diff -u -r1.34 -r1.35
--- literals.ent	9 Apr 2006 00:20:03 -0000	1.34
+++ literals.ent	4 May 2006 21:16:33 -0000	1.35
@@ -35,6 +35,7 @@
 <!ENTITY QBOOKS "<ulink url='http://quickbooks.intuit.com/'>Intuit QuickBooks</ulink>">
 <!ENTITY SOAP "<ulink url='http://www.w3.org/TR/soap/'>SOAP</ulink>">
 <!ENTITY WP "<ulink url='http://www.wikipedia.org/'>Wikipedia</ulink>">
+<!ENTITY SWISH-E "<ulink url='http://www.swish-e.org/'>Swish-e</ulink>">
 
 
 



1.10      +9 -10     xmldocs/guides/index.xml


rev 1.10, prev_rev 1.9
Index: index.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/index.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- index.xml	9 Apr 2006 00:20:04 -0000	1.9
+++ index.xml	4 May 2006 21:16:33 -0000	1.10
@@ -114,10 +114,10 @@
 
 				<entry>
 					<emphasis role='bold'>
-						Programming Style
+						Search Tutorial
 					</emphasis><sbr/>
-					<ulink url="programming-style/index.html">Multi-HTML</ulink> |
-					<ulink url="programming-style.html">HTML</ulink>
+					<ulink url="search/index.html">Multi-HTML</ulink> |
+					<ulink url="search.html">HTML</ulink>
 				</entry>
 			</row>
 
@@ -142,10 +142,10 @@
 
 				<entry>
 					<emphasis role='bold'>
-						Upgrade Guide
+						Programming Style
 					</emphasis><sbr/>
-					<ulink url="upgrade/index.html">Multi-HTML</ulink> |
-					<ulink url="upgrade.html">HTML</ulink>
+					<ulink url="programming-style/index.html">Multi-HTML</ulink> |
+					<ulink url="programming-style.html">HTML</ulink>
 				</entry>
 			</row>
 
@@ -168,12 +168,11 @@
 				</entry>
 
 				<entry>
-				<!--
 					<emphasis role='bold'>
+						Upgrade Guide
 					</emphasis><sbr/>
-					<ulink url=".html">HTML</ulink> |
-					<ulink url="/">Multi-HTML</ulink>
-				-->
+					<ulink url="upgrade/index.html">Multi-HTML</ulink> |
+					<ulink url="upgrade.html">HTML</ulink>
 				</entry>
 			</row>
 



1.8       +194 -566  xmldocs/guides/search.xml


rev 1.8, prev_rev 1.7
Index: search.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/search.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- search.xml	4 Apr 2006 11:25:20 -0000	1.7
+++ search.xml	4 May 2006 21:16:33 -0000	1.8
@@ -6,11 +6,12 @@
 <article id='search'>
 
 <articleinfo>
-	<title>Interchange Guides: Search</title>
+	<title>Interchange Guides: Search Tutorial</title>
 	<titleabbrev>search</titleabbrev>
 
 	<copyright>
-		<year>2005, 2006</year>
+		<year>2005</year>
+		<year>2006</year>
 		<holder>Interchange Development Group</holder>
 	</copyright>
 
@@ -39,592 +40,219 @@
 
 	<abstract>
 		<para>
+		The purpose of this document is to describe the search "subsystem" in
+		&IC; and link together all search-related topics.
 		</para>
 	</abstract>
 
 </articleinfo>
 
 
-<sect1>
-	<title>Search</title>
-	
-	<sect2>
-	  <title>Search Reference</title>
-	  <table><title>Search Parameters</title>
-		<tgroup cols="5">
-		  <thead>
-			<row>
-			  <entry>Parameter</entry>
-			  <entry>Shorthand</entry>
-			  <entry>Type</entry>
-			  <entry>Default</entry>
-			  <entry>Description</entry>
-			</row>
-		  </thead>
-		  <tbody>
-			<row>
-			  <entry>mv_all_chars</entry>
-			  <entry>ac</entry>
-			</row>
-			<row>
-			  <entry>mv_base_directory</entry>
-			  <entry>bd</entry>
-			</row>
-			<row>
-			  <entry>mv_begin_string</entry>
-			  <entry>bs</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_cache_key</entry>
-			  <entry>ck</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_coordinate</entry>
-			  <entry>co</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_case</entry>
-			  <entry>cs</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_verbatim_columns</entry>
-			  <entry>cv</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_dict_end</entry>
-			  <entry>de</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_dict_fold</entry>
-			  <entry>df</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_dict_limit</entry>
-			  <entry>di</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_dict_look</entry>
-			  <entry>dl</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_raw_dict_look</entry>
-			  <entry>DL</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_dict_order</entry>
-			  <entry>do</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_record_delim</entry>
-			  <entry>dr</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_exact_match</entry>
-			  <entry>em</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_spelling_errors</entry>
-			  <entry>er</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_field_file</entry>
-			  <entry>ff</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_search_file</entry>
-			  <entry>fi</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_field_title</entry>
-			  <entry>ft</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_first_match</entry>
-			  <entry>fm</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_field_names</entry>
-			  <entry>fn</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_head_skip</entry>
-			  <entry>hs</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_index_delim</entry>
-			  <entry>ix</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_search_label</entry>
-			  <entry>lb</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_like_field</entry>
-			  <entry>lf</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_list_only</entry>
-			  <entry>lo</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_search_line_return</entry>
-			  <entry>lr</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_like_spec</entry>
-			  <entry>ls</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_more_alpha</entry>
-			  <entry>ma</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_more_alpha_chars</entry>
-			  <entry>mc</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_more_decade</entry>
-			  <entry>md</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_more_id</entry>
-			  <entry>mi</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_matchlimit</entry>
-			  <entry>ml</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_max_matches</entry>
-			  <entry>mm</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_more_matches</entry>
-			  <entry>MM</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_profile</entry>
-			  <entry>mp</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_min_string</entry>
-			  <entry>ms</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_negate</entry>
-			  <entry>ne</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_negate</entry>
-			  <entry>ng</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_no_hide</entry>
-			  <entry>nh</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_no_more</entry>
-			  <entry>nm</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_nextpage</entry>
-			  <entry>np</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_next_search</entry>
-			  <entry>ns</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_numeric</entry>
-			  <entry>nu</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_column_op</entry>
-			  <entry>op</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_orsearch</entry>
-			  <entry>os</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>prefix</entry>
-			  <entry>pf</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_more_permanent</entry>
-			  <entry>pm</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_return_all</entry>
-			  <entry>ra</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_return_delim</entry>
-			  <entry>rd</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_search_reference</entry>
-			  <entry>re</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_return_fields</entry>
-			  <entry>rf</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_range_alpha</entry>
-			  <entry>rg</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_range_look</entry>
-			  <entry>rl</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_range_min</entry>
-			  <entry>rm</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_return_file_name</entry>
-			  <entry>rn</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_return_reference</entry>
-			  <entry>rr</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_return_spec</entry>
-			  <entry>rs</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_range_max</entry>
-			  <entry>rx</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_small_data</entry>
-			  <entry>sd</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_searchspec</entry>
-			  <entry>se</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_search_field</entry>
-			  <entry>sf</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_search_group</entry>
-			  <entry>sg</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_search_immediate</entry>
-			  <entry>si</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_start_match</entry>
-			  <entry>sm</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_search_page</entry>
-			  <entry>sp</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_sql_query</entry>
-			  <entry>sq</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_search_relate</entry>
-			  <entry>sr</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_searchtype</entry>
-			  <entry>st</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_substring_match</entry>
-			  <entry>su</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_sort_field</entry>
-			  <entry>tf</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_sort_option</entry>
-			  <entry>to</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_unique</entry>
-			  <entry>un</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-			<row>
-			  <entry>mv_value</entry>
-			  <entry>va</entry>
-			  <entry></entry>
-			  <entry></entry>
-			  <entry></entry>
-			</row>
-
-		  </tbody>
-		</tgroup>
-	  </table>
-	</sect2>
-
-	<sect2>
-		<title>Swish</title>
-<para>
-The Swish search module allows you to search index files generated
-by Swish-e <ulink url="http://www.swish-e.org/"/>.
-</para>
-<para>
+<section>
+	<title>Searching using Swish-e</title>
+	<!-- TODO : move to HOWTO -->
+	<para>
+	The Swish search module allows you to search index files generated
+	by &SWISH-E;.
+	</para>
 
-First of all, enable Swish search in your interchange.cfg:
+	<para>
+	To enable any Swish searching, modify your &gcf; to add:
 <programlisting>
 Require module Vend::Swish
 AddDirective Swish hash
 Variable swish Vend::Swish
 </programlisting>
-</para>
+	</para>
 
-<para>
-Now you can configure Swish search in your catalog.cfg:
+	<para>
+	To configure your catalog to use Swish, modify the appropriate &ccf; and add:
 <programlisting>
 Swish command /usr/bin/swish-e
 Swish index products/swish-e.db
 </programlisting>
-</para>
+	</para>
 
-<para>
-  The search is called with st=swish (or mv_searchtype=swish).
+	<para>
+	Finally, in search parameters, use <literal>mv_searchtype=swish</literal> or
+	the shorthand notation <literal>st=swish</literal>.
+	</para>
+
+
+	<para>
+	The fields to be returned from Swish to &IC; are configurable, and default to:
 
-</para>
-<para>
- The fields to return are configurable, and default to;
 <programlisting>
-	rf=code score title url mod_date filesize
-	fn=code score title url mod_date filesize
+mv_return_fields=code score title url mod_date filesize
+mv_field_names==code score title url mod_date filesize
 </programlisting>
-  These correspond to:
+
+	These correspond to:
 <programlisting>
-			code		swishreccount
-			score		swishrank
-			url			swishdocpath
-			title		swishtitle
-			filesize	swishdocsize
-			mod_date	swishlastmodified
+  code      swishreccount
+  score     swishrank
+  url       swishdocpath
+  title     swishtitle
+  filesize  swishdocsize
+  mod_date  swishlastmodified
 </programlisting>
-</para>
-	</sect2>
-</sect1>
+	</para>
+</section>
+
+
+<section>
+	<title>Search Reference</title>
+
+	<itemizedlist>
+		<listitem><para>mv_all_chars</para>
+		</listitem>
+		<listitem><para>mv_base_directory</para>
+		</listitem>
+		<listitem><para>mv_begin_string</para>
+		</listitem>
+		<listitem><para>mv_cache_key</para>
+		</listitem>
+		<listitem><para>mv_coordinate</para>
+		</listitem>
+		<listitem><para>mv_case</para>
+		</listitem>
+		<listitem><para>mv_verbatim_columns</para>
+		</listitem>
+		<listitem><para>mv_dict_end</para>
+		</listitem>
+		<listitem><para>mv_dict_fold</para>
+		</listitem>
+		<listitem><para>mv_dict_limit</para>
+		</listitem>
+		<listitem><para>mv_dict_look</para>
+		</listitem>
+		<listitem><para>mv_raw_dict_look</para>
+		</listitem>
+		<listitem><para>mv_dict_order</para>
+		</listitem>
+		<listitem><para>mv_record_delim</para>
+		</listitem>
+		<listitem><para>mv_exact_match</para>
+		</listitem>
+		<listitem><para>mv_spelling_errors</para>
+		</listitem>
+		<listitem><para>mv_field_file</para>
+		</listitem>
+		<listitem><para>mv_search_file</para>
+		</listitem>
+		<listitem><para>mv_field_title</para>
+		</listitem>
+		<listitem><para>mv_first_match</para>
+		</listitem>
+		<listitem><para>mv_field_names</para>
+		</listitem>
+		<listitem><para>mv_head_skip</para>
+		</listitem>
+		<listitem><para>mv_index_delim</para>
+		</listitem>
+		<listitem><para>mv_search_label</para>
+		</listitem>
+		<listitem><para>mv_like_field</para>
+		</listitem>
+		<listitem><para>mv_list_only</para>
+		</listitem>
+		<listitem><para>mv_search_line_return</para>
+		</listitem>
+		<listitem><para>mv_like_spec</para>
+		</listitem>
+		<listitem><para>mv_more_alpha</para>
+		</listitem>
+		<listitem><para>mv_more_alpha_chars</para>
+		</listitem>
+		<listitem><para>mv_more_decade</para>
+		</listitem>
+		<listitem><para>mv_more_id</para>
+		</listitem>
+		<listitem><para>mv_matchlimit</para>
+		</listitem>
+		<listitem><para>mv_max_matches</para>
+		</listitem>
+		<listitem><para>mv_more_matches</para>
+		</listitem>
+		<listitem><para>mv_profile</para>
+		</listitem>
+		<listitem><para>mv_min_string</para>
+		</listitem>
+		<listitem><para>mv_negate</para>
+		</listitem>
+		<listitem><para>mv_negate</para>
+		</listitem>
+		<listitem><para>mv_no_hide</para>
+		</listitem>
+		<listitem><para>mv_no_more</para>
+		</listitem>
+		<listitem><para>mv_nextpage</para>
+		</listitem>
+		<listitem><para>mv_next_search</para>
+		</listitem>
+		<listitem><para>mv_numeric</para>
+		</listitem>
+		<listitem><para>mv_column_op</para>
+		</listitem>
+		<listitem><para>mv_orsearch</para>
+		</listitem>
+		<listitem><para>prefix</para>
+		</listitem>
+		<listitem><para>mv_more_permanent</para>
+		</listitem>
+		<listitem><para>mv_return_all</para>
+		</listitem>
+		<listitem><para>mv_return_delim</para>
+		</listitem>
+		<listitem><para>mv_search_reference</para>
+		</listitem>
+		<listitem><para>mv_return_fields</para>
+		</listitem>
+		<listitem><para>mv_range_alpha</para>
+		</listitem>
+		<listitem><para>mv_range_look</para>
+		</listitem>
+		<listitem><para>mv_range_min</para>
+		</listitem>
+		<listitem><para>mv_return_file_name</para>
+		</listitem>
+		<listitem><para>mv_return_reference</para>
+		</listitem>
+		<listitem><para>mv_return_spec</para>
+		</listitem>
+		<listitem><para>mv_range_max</para>
+		</listitem>
+		<listitem><para>mv_small_data</para>
+		</listitem>
+		<listitem><para>mv_searchspec</para>
+		</listitem>
+		<listitem><para>mv_search_field</para>
+		</listitem>
+		<listitem><para>mv_search_group</para>
+		</listitem>
+		<listitem><para>mv_search_immediate</para>
+		</listitem>
+		<listitem><para>mv_start_match</para>
+		</listitem>
+		<listitem><para>mv_search_page</para>
+		</listitem>
+		<listitem><para>mv_sql_query</para>
+		</listitem>
+		<listitem><para>mv_search_relate</para>
+		</listitem>
+		<listitem><para>mv_searchtype</para>
+		</listitem>
+		<listitem><para>mv_substring_match</para>
+		</listitem>
+		<listitem><para>mv_sort_field</para>
+		</listitem>
+		<listitem><para>mv_sort_option</para>
+		</listitem>
+		<listitem><para>mv_unique</para>
+		</listitem>
+		<listitem><para>mv_value</para>
+		</listitem>
+	</itemizedlist>
+</section>
 
 </article>



1.1                  xmldocs/pending/list-of-search-related-mv-vars


rev 1.1, prev_rev 1.0
Index: list-of-search-related-mv-vars
===================================================================
mv_all_chars
mv_base_directory
mv_begin_string
mv_cache_key
mv_coordinate
mv_case
mv_verbatim_columns
mv_dict_end
mv_dict_fold
mv_dict_limit
mv_dict_look
mv_raw_dict_look
mv_dict_order
mv_record_delim
mv_exact_match
mv_spelling_errors
mv_field_file
mv_search_file
mv_field_title
mv_first_match
mv_field_names
mv_head_skip
mv_index_delim
mv_search_label
mv_like_field
mv_list_only
mv_search_line_return
mv_like_spec
mv_more_alpha
mv_more_alpha_chars
mv_more_decade
mv_more_id
mv_matchlimit
mv_max_matches
mv_more_matches
mv_profile
mv_min_string
mv_negate
mv_negate
mv_no_hide
mv_no_more
mv_nextpage
mv_next_search
mv_numeric
mv_column_op
mv_orsearch
mv_more_permanent
mv_return_all
mv_return_delim
mv_search_reference
mv_return_fields
mv_range_alpha
mv_range_look
mv_range_min
mv_return_file_name
mv_return_reference
mv_return_spec
mv_range_max
mv_small_data
mv_searchspec
mv_search_field
mv_search_group
mv_search_immediate
mv_start_match
mv_search_page
mv_sql_query
mv_search_relate
mv_searchtype
mv_substring_match
mv_sort_field
mv_sort_option
mv_unique
mv_value



1.4       +4 -2      xmldocs/refs/CodeDef


rev 1.4, prev_rev 1.3
Index: CodeDef
===================================================================
RCS file: /var/cvs/xmldocs/refs/CodeDef,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- CodeDef	11 Apr 2006 15:51:35 -0000	1.3
+++ CodeDef	4 May 2006 21:16:33 -0000	1.4
@@ -6,14 +6,16 @@
 CodeDef,UserTag,Filter,ActionMap,FormAction,GlobalSub,ItemAction,CoreTag
 __END__
 
-__NAME__ synopsis
+
+Fix the entry, then insert the missing _ at the beginning of line
+_NAME__ synopsis
 <group choice='req'>
 	<arg choice='plain'>
 		<literal>Sub</literal>
 		<replaceable>perl_code</replaceable>
 	</arg>
 </group>
-__END__
+_END__
 
 __NAME__ description
 A generic &PERL; subroutine mapper which allows mapping of subroutines to



1.4       +0 -2      xmldocs/refs/MaxServers


rev 1.4, prev_rev 1.3
Index: MaxServers
===================================================================
RCS file: /var/cvs/xmldocs/refs/MaxServers,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- MaxServers	20 Apr 2006 12:37:03 -0000	1.3
+++ MaxServers	4 May 2006 21:16:33 -0000	1.4
@@ -22,8 +22,6 @@
 If more requests are pending, they will be queued within the defined
 capability of the Operating System (usually 5 pending requests) until the
 server's "usage count" drops.
-</para><para>
-The default for &conf-MaxServers; is 10.
 __END__
 
 __NAME__ notes



1.4       +2 -1      xmldocs/refs/dbi_quote.filter


rev 1.4, prev_rev 1.3
Index: dbi_quote.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/dbi_quote.filter,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- dbi_quote.filter	11 Apr 2006 15:51:35 -0000	1.3
+++ dbi_quote.filter	4 May 2006 21:16:33 -0000	1.4
@@ -34,7 +34,8 @@
 __END__
 
 
-__NAME__ example: Filter example
+Fix the entry, then insert the missing _ at the beginning of line
+_NAME__ example: Filter example
 <programlisting><![CDATA[
 [cgi name=code set="That's all" hide=1]
 



1.4       +2 -2      xmldocs/refs/dump.tag


rev 1.4, prev_rev 1.3
Index: dump.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/dump.tag,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- dump.tag	8 Apr 2006 22:09:04 -0000	1.3
+++ dump.tag	4 May 2006 21:16:33 -0000	1.4
@@ -1,5 +1,5 @@
 __NAME__ purpose
-perform dump of user session
+perform dump (display) of user session
 __END__
 
 
@@ -17,7 +17,7 @@
 	None (all keys)
 	</entry>
 	<entry>
-	Dump just one named variable from the user session.
+	Dump just one named variable from the user &glos-session.
 	</entry>
 
 </row> 



1.7       +10 -7     xmldocs/refs/time.tag


rev 1.7, prev_rev 1.6
Index: time.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/time.tag,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- time.tag	11 Apr 2006 09:02:00 -0000	1.6
+++ time.tag	4 May 2006 21:16:33 -0000	1.7
@@ -1,5 +1,5 @@
 __NAME__ purpose
-display formatted date similar to strftime POSIX function
+display formatted date, similar to strftime POSIX function
 __END__
 
 __NAME__ synopsis 
@@ -200,11 +200,14 @@
 
 
 __NAME__ description
-The tag displays date and time values formatted similar to the strftime
-function, see &glos-time; glossary entry for format specifiers. The date can
-be specified with the <literal>time=</literal> parameter and manipulated
-with the <literal>adjust=</literal> parameter. The current date is used as
-default.
+The tag displays date and time values, formatted similar to the 
+<function>strftime(3)</function> function.
+The date can
+be specified with the <literal>time=</literal> parameter and adjusted
+with the <literal>adjust=</literal> parameter.
+The current date and time is the assumed default.
+</para><para>
+See &glos-time; glossary entry for a list and description of format specifiers.
 __END__
 
 
@@ -213,7 +216,7 @@
 applied at the end (the timezone will not be changed for the invocation
 of time function). This means you shouldn't use any format that uses
 timezone information. For the timezone to enter calculations, either use 
-<literal>tz=</literal>, or manage the system yourself.
+<literal>tz=</literal>, or manage the calculation yourself.
 </para><para>
 The timezone can be set globally for the &IC; installation by defining
 the <envar>TZ</envar> environment variable and restarting Interchange.



1.4       +7 -4      xmldocs/refs/timed-build.tag


rev 1.4, prev_rev 1.3
Index: timed-build.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/timed-build.tag,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- timed-build.tag	26 Apr 2006 12:06:53 -0000	1.3
+++ timed-build.tag	4 May 2006 21:16:33 -0000	1.4
@@ -1,5 +1,5 @@
 __NAME__ purpose
-caches result of ITL parsing in file
+save output of Interchange interpolation to named file (cache pages)
 __END__
 
 __NAME__ synopsis 
@@ -18,7 +18,7 @@
 	<!-- DFL -->
 	</entry>
 	<entry>
-	name of cache file
+	Cache filename.
 	</entry>
 
 </row> 
@@ -151,8 +151,11 @@
 	60
 	</entry>
 	<entry>
-	number of minutes the cache file is kept, 0 means infinitely 
+	Number of minutes the cache file is kept. A value of
+	<literal>0</literal> means infinitely.
 	</entry>
+	<!-- TODO how about making this a interchange interval so '60 minutes' or
+	'7 days' is possible to be specified? -->
 
 </row> 
 <row>
@@ -195,4 +198,4 @@
 </row> 
 &ROW_INTERPOLATE_0;
 &ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__



1.7       +164 -0    xmldocs/whatsnew/WHATSNEW.xml


rev 1.7, prev_rev 1.6
Index: WHATSNEW.xml
===================================================================
RCS file: /var/cvs/xmldocs/whatsnew/WHATSNEW.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- WHATSNEW.xml	28 Mar 2006 11:02:52 -0000	1.6
+++ WHATSNEW.xml	4 May 2006 21:16:33 -0000	1.7
@@ -54,6 +54,170 @@
 <!-- AUTO UPDATER -->
 <para><literallayout>
 <emphasis role='bold'>
+Developer: jon
+Date: 2006-04-27 21:00:09 GMT
+Modified:  dist/lib/UI/pages/admin ship_data.html</emphasis>
+Remove admin FedEx support, since fedex-query tag is now gone.
+</literallayout></para>
+
+
+<para><literallayout>
+<emphasis role='bold'>
+Developer: racke
+Date: 2006-04-18 09:17:39 GMT
+Modified:  lib/Vend Swish.pm</emphasis>
+don't consider missing matches as search error
+</literallayout></para>
+
+
+<para><literallayout>
+<emphasis role='bold'>
+Developer: racke
+Date: 2006-04-11 14:43:57 GMT
+Modified:  .        MANIFEST
+Modified:  code/Filter date_change.filter
+Removed:   code/Filter date_change_null.filter</emphasis>
+merge date_change/date_change_null filters, code supplied by Jon Jensen
+with one modification: second shift() removed
+</literallayout></para>
+
+
+<para><literallayout>
+<emphasis role='bold'>
+Developer: racke
+Date: 2006-04-11 07:55:52 GMT
+Modified:  dist/standard catalog.cfg</emphasis>
+use email ordercheck in common order profile for email address
+</literallayout></para>
+
+
+<para><literallayout>
+<emphasis role='bold'>
+Developer: racke
+Date: 2006-04-07 13:53:23 GMT
+Modified:  lib/Vend Swish.pm</emphasis>
+complete mapping of Swish-e auto properties
+</literallayout></para>
+
+
+<para><literallayout>
+<emphasis role='bold'>
+Developer: jon
+Date: 2006-04-05 17:40:39 GMT
+Modified:  lib/Vend/Table Editor.pm</emphasis>
+Correct display of "Are you sure you want to delete $SKU" dialog when
+multi-part primary keys are used.
+
+Problem found and fixed by Jeff Boes (jeff at endpoint.com). Thanks!
+</literallayout></para>
+
+
+<para><literallayout>
+<emphasis role='bold'>
+Developer: heins
+Date: 2006-04-05 15:31:38 GMT
+Modified:  lib/Vend Util.pm</emphasis>
+* Allow limiting of size of logData error message.
+
+  Limit  logdata_error_length  80
+</literallayout></para>
+
+
+<para><literallayout>
+<emphasis role='bold'>
+Developer: heins
+Date: 2006-04-05 14:42:20 GMT
+Modified:  lib/Vend Cart.pm Data.pm Dispatch.pm Error.pm File.pm
+Modified:           Interpolate.pm Session.pm Ship.pm
+Modified:  lib/Vend/Table DB_File.pm GDBM.pm SDBM.pm</emphasis>
+* Add lockout to list of SpecialSub routines allowed.
+
+* If user-configured lockout routine returns true, it replaces the
+  current routine completely. If it returns false, the normal one
+  is run as well.
+
+* Move the logging out of Vend::Dispatch to the do_lockout routine, so
+  that you can avoid the log entry if your user-configured routine handles
+  the lockout.
+
+* Make the number of seconds for robot reset adjustable from its
+  current hardcoded 30:
+
+    Limit   lockout_reset_seconds
+
+  Maybe that should be robot_reset_seconds, I don't know.
+
+* Change use of $Vend::Cfg-&gt;{Limit}{member} to $::Limit-&gt;{member}. As
+  Limit is used in iterative routines like chain_cost, this should
+  improve performance.
+</literallayout></para>
+
+
+<para><literallayout>
+<emphasis role='bold'>
+Developer: racke
+Date: 2006-04-04 19:07:48 GMT
+Modified:  lib/Vend Config.pm</emphasis>
+ensure that TrackFile is a relative path to catalog root
+parse_relative_dir now issues a meaningful error message
+</literallayout></para>
+
+
+<para><literallayout>
+<emphasis role='bold'>
+Developer: racke
+Date: 2006-04-03 21:23:40 GMT
+Modified:  .        MANIFEST
+Modified:  lib/Vend Order.pm
+Added:     code/OrderCheck always_pass.oc</emphasis>
+breakout always_pass order check
+</literallayout></para>
+
+
+<para><literallayout>
+<emphasis role='bold'>
+Developer: kwalsh
+Date: 2006-04-01 10:39:27 GMT
+Modified:  dist/lib/UI ui.cfg
+Modified:  dist/lib/UI/locales en_US.cfg
+Added:     dist/lib/UI/locales en_GB.cfg</emphasis>
+    * Added en_GB "translation": English (British)
+
+    * Modified en_US to change the name from "English" to "English (US)"
+</literallayout></para>
+
+
+<para><literallayout>
+<emphasis role='bold'>
+Developer: racke
+Date: 2006-03-30 15:51:50 GMT
+Modified:  lib/Vend Util.pm</emphasis>
+fix weird error with missing frac digits in UI typically caused by missing
+locale in Debian installations, reported by Michael Hess on IRC (among
+others)
+</literallayout></para>
+
+
+<para><literallayout>
+<emphasis role='bold'>
+Developer: heins
+Date: 2006-03-28 17:02:47 GMT
+Modified:  dist/src/mod_perl2 README
+Modified:  dist/src/mod_perl2/Interchange Link.pm
+Added:     dist/src/mod_perl2/Interchange
+Added:              Link.pm.mod_perl-1.999_21_and_before</emphasis>
+* Make Interchange::Link compatibile with mod_perl2 greater than
+  1.999_22. Thanks to Ryan Perry &lt;<a href="http://www.icdevgroup.org/mailman/listinfo/interchange-cvs">rperry at madisonip.com</a>&gt;.
+
+* Add version of the Link.pm module for earlier mod_perl 1.999_21 and
+  before.
+
+* Adjust docs.
+</literallayout></para>
+
+
+<para><literallayout>
+<emphasis role='bold'>
 Developer: racke
 Date: 2006-03-27 14:14:41 GMT
 Modified:  dist/standard/products locale.txt</emphasis>








More information about the docs mailing list