Aargh! I should really go to sleep or make PostgeSQL replication or something...

[webpac] / README

diff --git a/README b/README
index d3f20ca..35c2bbd 100644 (file)
--- a/README
+++ b/README
@@ -2,10 +2,45 @@ this is a free re-implementation of our searcher described at
 
 http://webpac.sf.net/
 
+
 This code is written by Dobrica Pavlinusic <dpavlin@rot13.org> and
 released under GPL v2 or later license.
 
+
 Status as of 2002-11-22:
 
 This code is *NOT* ready for production use. It's not even finished.
 But we are working on it.
+
+
+All commands have documentation embeded in them: you can try
+
+$ perldoc all2xml.pl
+
+to see it's usage.
+
+### Working notes for documentation:
+
+all2xml.conf:
+
+Type must be defined by one of files in import_xml/. However, those
+files can be in form type_something so that you can have multiple
+xml files for same data source (e.g. isis).
+
+
+### How to specify fields which have to be searched in html templates?
+
+Each query to swish database is consisted of *TWO* fields. Names
+of fields are f[nr] and v[nr] where [nr] is number between 1 and 30.
+
+Value for v field are names of tags in import_xml/*.xml file.
+Value for f field is query which will be sent to swish.
+
+If you need to show index for this field, your submit button should
+have name f[nr]_index.
+
+There are also other fields which are used specially. Best bet is
+to do grep param WebPac.pm. However, you shouldn't need to modify
+any other fields in html templates other than f[nr]* and v[nr].
+If you do, it's a BUG. Please report it to us.
+