head	1.5;
access;
symbols
	rel-2-4-3a:1.5
	rel-2-4-3:1.5
	rel-2-4-2:1.5
	rel-2-4-1:1.5
	rel-2-4-0-patches:1.5.0.2
	rel-2-4-0:1.5
	rel-2-2-3:1.4
	rel-2-2-2:1.4
	rel-2-2-1-merged:1.4
	rel-2-2-1:1.4
	rel-2-2-patches:1.4.0.2
	rel-2-2a:1.4
	rel-2-2:1.4
	rel2-2rc1:1.4;
locks; strict;
comment	@# @;


1.5
date	2003.05.13.06.11.34;	author whmoseley;	state Exp;
branches;
next	1.4;

1.4
date	2002.05.27.06.35.32;	author whmoseley;	state Exp;
branches;
next	1.3;

1.3
date	2001.04.08.21.31.59;	author whmoseley;	state Exp;
branches;
next	1.2;

1.2
date	2001.03.30.19.32.45;	author whmoseley;	state Exp;
branches;
next	1.1;

1.1
date	2001.03.28.01.41.08;	author whmoseley;	state Exp;
branches;
next	;


desc
@@


1.5
log
@Update a few more docs.
I thinned out README and INSTALL, but will have to proof read another day
and finish editing.  Just want to get stuff uploaded.  I still think INSTALL
is too verbose.

Docs are broken in a lot of places that refer to directories
"in the distribution".  Oh well.

Also added more things to the examples directory that's installed in
$prefix/share/doc/swish-e/examples.

We should add a debian rules file so can build a .deb from source.
@
text
@These are example scripts that you can use the with "prog" document source
feature of Swish-e.

The "prog" document source feature of Swish-e allow you to index any type of
document, provided you can convert the document into a format that Swish-e
can parse (text, html, or xml).

spider.pl
	Working example of a web spider.  This program is a full-featured
	spider, that is fully customizable through its configuration file.

        Note: spider.pl is installed in the scripts directory.
              Running swish-e -h will display the scripts directory.

SwishSpiderConfig.pl
	Example configuration file for the spider.pl program

file.pl 
	A very simple examle of a program that feeds documents to swish.
	Its purpose it to demonstrate how to write a program for use with
	Swish-e's "prog" input method.
	

DirTree.pl 
	A slightly more advanced example that reads a directory tree and indexes
	a few files types.  Uses the pdf2xml module for pdf files.
	Its purpose it to demonstrate how to write a program for use with
	Swish-e's "prog" input method.


MySQL.pl
	Another simple example that shows how to index data stored in a
	MySQL database.  Instructions are included on how to configure the
	swish.cgi program 


index_hypermail.pl
	An example program for indexing mailing list archives that are created
	with the popular Hypermail program.


pdf2xml.pm and pdf2html.pm
	Perl modules to convert pdf to xml documents for indexing.
	Requires the pdftotext program.  Type perldoc pdf2xml.pm
	or perldoc pdf2html.pm from the prog-bin directory for documentation.
	

doc2txt.pm
	Perl module to convert MS Word documents to text.
	Requires the catdoc program.  Type perldoc doc2txt.pm
	from the prog-bin directory for documentation.


Note: The modules to convert PDF and MS Word documents are outdated.
See SWISH::Filter for more information.
@


1.4
log
@More docs updating.
@
text
@d12 2
a13 1
	Type perldoc spider.pl from the prog-bin directory for documentation.
d32 3
a34 3
    Another simple example that shows how to index data stored in a
    MySQL database.  Instructions are included on how to configure the
    swish.cgi program 
d38 2
a39 2
    An example program for indexing mailing list archives that are created
    with the popular Hypermail program.
d53 3
@


1.3
log
@*** empty log message ***
@
text
@d4 4
d9 4
a12 1
	working example of a web spider
d15 1
a15 1
	example configuration file for the spider.pl program
d18 4
a21 1
	simple examle of a program that feeds documents to swish.
d24 1
a24 1
	simple example of that reads a directory tree and indexes
d26 14
d41 5
a45 2
pdf2xml.pm
	perl module to convert pdf to xml documents for indexing
d48 3
a50 1
	perl module to convert MS Word documents to text
@


1.2
log
@Added example programs for 'prog', and a pdf2xml conversion module
@
text
@a12 3
pdf2xml.pm
	perl module to convert pdf to xml documents for indexing

d17 5
@


1.1
log
@Still todo -- deal with -N used with -S prog
@
text
@d4 17
@

