[interchange-docs] xmldocs - docelic modified 4 files
docs at icdevgroup.org
docs at icdevgroup.org
Fri Sep 29 17:37:48 EDT 2006
User: docelic
Date: 2006-09-29 21:37:48 GMT
Modified: guides search.xml
Modified: refs Database FeatureDir
Added: refs DirectiveDatabase
Log:
* small updates, more work on search reference and one config directive
Revision Changes Path
1.17 +24 -12 xmldocs/guides/search.xml
rev 1.17, prev_rev 1.16
Index: search.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/search.xml,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- search.xml 28 Sep 2006 18:15:14 -0000 1.16
+++ search.xml 29 Sep 2006 21:37:47 -0000 1.17
@@ -352,16 +352,20 @@
</listitem>
<listitem><para>
<literal>mv_head_skip</literal>
- (hs, <literal></literal>/<literal></literal>,
- default <literal></literal>) —
-
+ (hs, <replaceable>row_count</replaceable>,
+ default <literal>1</literal> for text files, <literal>0</literal>
+ otherwise) —
+ number of lines to skip at the beginning of a search index or text
+ file. &IC; normally skips one line for text-based searches
+ (<literal>st=text</literal>) to exclude the header line.
</para>
</listitem>
<listitem><para>
<literal>mv_index_delim</literal>
- (id, <literal></literal>/<literal></literal>,
- default <literal></literal>) —
-
+ (id, <replaceable>field_delimiter</replaceable>,
+ default <literal>\t</literal>) —
+ delimiter for counting fields in search index files.
+ The default, a TAB character, works well for most line-based index files.
</para>
</listitem>
<listitem><para>
@@ -429,16 +433,24 @@
</listitem>
<listitem><para>
<literal>mv_matchlimit</literal>
- (ml, <literal></literal>/<literal></literal>,
- default <literal></literal>) —
-
+ (ml, <replaceable>record_count</replaceable>,
+ default <literal>50</literal>) —
+ maximum number of records (search results) to return from a search.
+ When all the results are
+ displayed on a single page, this option is equivalent to
+ <literal>mm</literal>. When the &tag-more; tag is used
+ to display results multi-page, then this option
+ determines the number of results <emphasis>per page</emphasis>.
+ To specify unlimited, use <literal>none</literal> or
+ <literal>all</literal>, not <literal>0</literal>.
</para>
</listitem>
<listitem><para>
<literal>mv_max_matches</literal>
- (mm, <literal></literal>/<literal></literal>,
- default <literal></literal>) —
-
+ (mm, <replaceable>record_count</replaceable>,
+ default unlimited) —
+ final, maximum number of records (search results) to return from a search
+ (related option <literal>ml</literal>).
</para>
</listitem>
<listitem><para>
1.4 +3 -3 xmldocs/refs/Database
rev 1.4, prev_rev 1.3
Index: Database
===================================================================
RCS file: /var/cvs/xmldocs/refs/Database,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Database 24 Jan 2006 16:06:47 -0000 1.3
+++ Database 29 Sep 2006 21:37:48 -0000 1.4
@@ -3,9 +3,9 @@
__END__
__NAME__ synopsis
- <arg choice='plain'><replaceable>name</replaceable></arg>
- <arg choice='plain'><replaceable>source_file</replaceable></arg>
- <arg choice='plain'><replaceable>type</replaceable></arg>
+ <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>
__END__
__NAME__ see also
1.2 +4 -1 xmldocs/refs/FeatureDir
rev 1.2, prev_rev 1.1
Index: FeatureDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/FeatureDir,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- FeatureDir 20 May 2005 15:01:03 -0000 1.1
+++ FeatureDir 29 Sep 2006 21:37:48 -0000 1.2
@@ -12,7 +12,10 @@
__NAME__ description
Specify directory containing &IC; "feature" modules.
-</para><para>
+__END__
+
+
+__NAME__ notes
For an introduction to &IC; "features", please see the
&glos-feature; glossary entry.
__END__
1.1 xmldocs/refs/DirectiveDatabase
rev 1.1, prev_rev 1.0
Index: DirectiveDatabase
===================================================================
__NAME__ purpose
specify database to read configuration directives from
__END__
__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>
</group>
__END__
__NAME__ description
The &conf-__FILENAME__; configuration directive makes it possible to
read all configuration directives from a &glos-database;, instead of
from the usual &ccf; configuration file.
</para><para>
The database can (but does not have to) be previously defined with
the &conf-Database; directive. When it is, then just the table name
is required and honored. When it is not, then the &conf-Database; directive
will be automatically invoked first to register the new table, possibly with
custom text source file and table type.
</para><para>
<literal>table_source_filename</literal> defaults to
<literal><replaceable>table_name</replaceable>.txt</literal>, and
<literal>table_source_type</literal> defaults to <literal>TAB</literal>.
(The arguments are the same as for the &conf-Database; directive itself,
they are passed to it directly.)
__END__
__NAME__ notes
<!--
Using this directive, it's possible to configure catalogs that have no
&ccf; at all. How ?
-->
</para><para>
<!-- What's tha directive to load pages from DB ? -->
__END__
__NAME__ see also
Database
__END__
__NAME__ example: Defining __FILENAME__, single-step
<programlisting>
DirectiveDatabase catalog catalog.txt TAB
</programlisting>
__END__
__NAME__ example: Defining __FILENAME__, two-step
<programlisting>
Database catalog catalog.txt TAB
DirectiveDatabase catalog
</programlisting>
__END__
More information about the docs
mailing list