Beginning of documentation for debugging of changes in configuration

file. In short: what to do when WebPAC isn't behaving as you expected.

git-svn-id: file:///home/dpavlin/private/svn/webpac/trunk@227 13eb9ef6-21d5-0310-b721-a9d68796d827

diff --git a/doc/no_work.txt b/doc/no_work.txt
new file mode 100644 (file)
index 0000000..5c15d97
--- /dev/null
+++ b/doc/no_work.txt
@@ -0,0 +1,48 @@
+Mumble, mumble, NO WORK.
+
+This document will try to describe debugging procedure if you changed some
+configuration and you are not getting expected results.
+
+
+1) check if all2xml.pl returned XML error
+
+If all2xml.pl called with:
+
+ $ all2xml.pl >/dev/null
+
+produced output like:
+
+ reading ./import_xml/isis_foo.xml
+ mismatched tag at line 20, column 3, byte 545 ...
+
+you will need to examine import_xml/isis_foo.xml file which produced that error
+(which is displayed above error message). So, check line 20 and correct it.
+
+
+2) check output of all2xml.pl
+
+Create temporary file with output from all2xml.pl (which would go to swish
+when you run script run.sh) like this:
+
+ $ all2xml.pl > foo
+
+2.1) if you can't search by field you just defined
+
+Examine file foo and try to locate field which you should be in it.
+It should be named like tag in import_xml file with extension _swish
+
+  e.g. <library_swish> if tag in import_xml/isis_foo.xml is called
+  <Library>
+
+If there isn't souch tag, your definition isn't correct (did you specify
+type="swish" or didn't specify type at all so that output will go to both
+swish and index by default?)
+
+Usual probles are:
+a) too much data in one tag (often usage of tags without type and with type="display" which will *BOTH* produce output)
+b) too little output in one tag (yor forgot to specify some fields)
+
+
+
+##FIXME## This document is not finished.
+