Skip to main content.
home | support | download

Back to List Archive

Re: Very minor documentation fix

From: Rodney Barnett <rbarnett(at)not-real.neuromics.com>
Date: Tue Aug 20 2002 - 14:56:10 GMT
Quoting Bill Moseley <moseley@hank.org>:

> At 11:18 AM 08/19/02 -0700, Rodney Barnett wrote:
> >I'm new to swish, but saw the encouragement for documentation fixes
> >in the README, so here's a very small one for the lastest development
> >snapshot...
<snip>
> Thanks Rodney!
> 
> That prompted a few other edits, too.

All the better; it was such a small change.

> Any and all comments are more than welcome.  If you see anything
> else that is confusing or is out of place or just lacking, please
> don't hesitate to post.
> 
> -- 
> Bill Moseley
> mailto:moseley@hank.org

Okay, here's a mixture of questions and comments...

I'm using the prog method to index my documents.  It would be very
convenient to be able to pass command line parameters to my script, but I
don't see any way to do that.  Am I missing something?

Looks like there's no official way to specify a title for an XML document.
The documentation for the -x option even includes "(html only)" after the
description of swishtitle.  However, I did find that if I include a title
in the form "<swishtitle>my title</swishtitle>" in my XML document, it
goes into the swishtitle property.  Is this a loophole that might be closed
at some point?  Seems to me there ought to be a way to specify a title
for every document.  Is there some other way that I haven't found?

In the documentation of the -x option, it says "Note: In swish-e 2.2 all
user properties are String type. This may change in future...," but the
documentation of the configuration file includes the PropertyNamesNumeric
and PropertyNamesDate directives.  Should the note be removed?

PropertyNames is listed three times conescutively in the HTML alphabetical
list of configuration file directives.  Looks like the second two are for
PropertyNamesCompareCase and PropertyNamesIgnoreCase, but the HTML links
are broken.  I'm not familiar enough with PODs to suggest what to do about
it.

A couple more small documentation fixes...

--- SWISH-CONFIG.pod.orig       Thu Aug 15 03:15:07 2002
+++ SWISH-CONFIG.pod    Tue Aug 20 08:26:31 2002
@@ -341,7 +341,7 @@
 L<PropertyNames|/"item_PropertyNamesIgnoreCase"> *list of meta names*
 =item *

-L<PropertyNamesDates|/"item_PropertyNamesDates"> *list of meta names*
+L<PropertyNamesDate|/"item_PropertyNamesDate"> *list of meta names*

 =item *

@@ -937,7 +937,7 @@

 will find "foo" in the body, the title, or any meta tags.

-Currently, there's no way do prevent Swish-e from indexing
+Currently, there's no way to prevent Swish-e from indexing
 the title contents along with the body contents, but see
 L<UndefinedMetaTags|/"item_UndefinedMetaTags"> for how to control the
 indexing of meta tags.

Rodney
Received on Tue Aug 20 14:59:38 2002