[Bio] / Sprout / SHWordSearch.pm Repository:
ViewVC logotype

Diff of /Sprout/SHWordSearch.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.9, Mon Jul 16 20:04:51 2007 UTC revision 1.10, Thu Dec 6 14:58:03 2007 UTC
# Line 37  Line 37 
37  B<(no operator)>: By default (when neither + nor - is specified) the word is optional, but the  B<(no operator)>: By default (when neither + nor - is specified) the word is optional, but the
38  rows that contain it are rated higher.  rows that contain it are rated higher.
39    
40  C<< > < >>: These two operators are used to change a word's contribution to the relevance value      > <: These two operators are used to change a word's contribution to the relevance value
41  that is assigned to a row. The C<< > >> operator increases the contribution and the C<< < >>  that is assigned to a row. The C<< > >> operator increases the contribution and the C<< < >>
42  operator decreases it.  operator decreases it.
43    
# Line 66  Line 66 
66    
67  =head3 Form  =head3 Form
68    
69  C<< my $html = $shelp->Form(); >>      my $html = $shelp->Form();
70    
71  Generate the HTML for a form to request a new search.  Generate the HTML for a form to request a new search.
72    
# Line 116  Line 116 
116    
117  =head3 Find  =head3 Find
118    
119  C<< my $resultCount = $shelp->Find(); >>      my $resultCount = $shelp->Find();
120    
121  Conduct a search based on the current CGI query parameters. The search results will  Conduct a search based on the current CGI query parameters. The search results will
122  be written to the session cache file and the number of results will be  be written to the session cache file and the number of results will be
# Line 179  Line 179 
179    
180  =head3 SearchTitle  =head3 SearchTitle
181    
182  C<< my $titleHtml = $shelp->SearchTitle(); >>      my $titleHtml = $shelp->SearchTitle();
183    
184  Return the display title for this search. The display title appears above the search results.  Return the display title for this search. The display title appears above the search results.
185  If no result is returned, no title will be displayed. The result should be an html string  If no result is returned, no title will be displayed. The result should be an html string
# Line 200  Line 200 
200    
201  =head3 Description  =head3 Description
202    
203  C<< my $htmlText = $shelp->Description(); >>      my $htmlText = $shelp->Description();
204    
205  Return a description of this search. The description is used for the table of contents  Return a description of this search. The description is used for the table of contents
206  on the main search tools page. It may contain HTML, but it should be character-level,  on the main search tools page. It may contain HTML, but it should be character-level,
# Line 217  Line 217 
217    
218  =head3 ProcessQuery  =head3 ProcessQuery
219    
220  C<< my $count = $shelp->ProcessQuery($rhelp, $query); >>      my $count = $shelp->ProcessQuery($rhelp, $query);
221    
222  Run through the results of a query, sending all the features retrieved to the output  Run through the results of a query, sending all the features retrieved to the output
223  cache. The number of features found will be returned to the caller.  cache. The number of features found will be returned to the caller.

Legend:
Removed from v.1.9  
changed lines
  Added in v.1.10

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3