[docs] xmldocs - racke modified 2 files

[docs at icdevgroup.org]

User:      racke
Date:      2005-09-22 13:43:51 GMT
Modified:  .        Makefile
Added:     guides   search.xml
Log:
new search guide added

Revision  Changes    Path
1.73      +1 -1      xmldocs/Makefile


rev 1.73, prev_rev 1.72
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.72
retrieving revision 1.73
diff -u -r1.72 -r1.73
--- Makefile	21 Sep 2005 12:07:25 -0000	1.72
+++ Makefile	22 Sep 2005 13:43:51 -0000	1.73
@@ -13,7 +13,7 @@
 #############################################################
 # Base definitions
 SYMBOL_TYPES= pragmas vars tags confs filters
-GUIDES      = iccattut programming-style upgrade faq index optimization
+GUIDES      = iccattut programming-style upgrade faq index optimization search
 HOWTOS      = howtos
 GLOSSARY    = glossary
 ALL_DOCS    = $(GLOSSARY) $(HOWTOS) $(GUIDES) $(SYMBOL_TYPES)



1.1                  xmldocs/guides/search.xml


rev 1.1, prev_rev 1.0
Index: search.xml
===================================================================
<?xml version="1.0" standalone="no"?>

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook-Interchange XML V4.2//EN"
	"../docbook/docbookxi.dtd">

<article id='search'>

<articleinfo>
	<title>Interchange Guides: Search</title>
	<titleabbrev>search</titleabbrev>

	<copyright>
		<year>2005</year>
		<holder>Interchange Development Group</holder>
	</copyright>

	<authorgroup>
		<author>
			<firstname>Stefan</firstname><surname>Hornburg</surname>
			<email>racke at linuxia.de</email>
		</author>
	</authorgroup>


	<legalnotice>
		<para>
		This documentation is free; you can redistribute it and/or modify
		it under the terms of the &GNU; General Public License as published by
		the Free Software Foundation; either version 2 of the License, or
		(at your option) any later version.
		</para>
		<para>
		It is distributed in the hope that it will be useful,
		but WITHOUT ANY WARRANTY; without even the implied warranty of
		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
		GNU General Public License for more details.
		</para>
	</legalnotice>

	<abstract>
		<para>
		</para>
	</abstract>

</articleinfo>


<sect1>
	<title>Search</title>

	<sect2>
		<title>Swish</title>
<para>

To use, you must add to interchange.cfg:
<screen>
	Require module Vend::Swish
	AddDirective Swish hash
	Variable swish Vend::Swish
</screen>
  The search is called with st=swish (or mv_searchtype=swish).

</para>
<para>
 The fields to return are configurable, and default to;
<screen>
	rf=code score title url mod_date filesize
	fn=code score title url mod_date filesize
</screen>
  These correspond to:
<screen>
			code		swishreccount
			score		swishrank
			url			swishdocpath
			title		swishtitle
			filesize	swishdocsize
			mod_date	swishlastmodified
</screen>
</para>
	</sect2>
</sect1>

</article>