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

Diff of /Sprout/SHOpSearch.pm

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

revision 1.3, Mon Aug 20 23:25:08 2007 UTC revision 1.4, Thu Dec 6 14:58:03 2007 UTC
# Line 60  Line 60 
60    
61  =head3 Form  =head3 Form
62    
63  C<< my $html = $shelp->Form(); >>      my $html = $shelp->Form();
64    
65  Generate the HTML for a form to request a new search.  Generate the HTML for a form to request a new search.
66    
# Line 131  Line 131 
131    
132  =head3 Find  =head3 Find
133    
134  C<< my $resultCount = $shelp->Find(); >>      my $resultCount = $shelp->Find();
135    
136  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
137  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 270  Line 270 
270    
271  =head3 Description  =head3 Description
272    
273  C<< my $htmlText = $shelp->Description(); >>      my $htmlText = $shelp->Description();
274    
275  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
276  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 287  Line 287 
287    
288  =head3 SortKey  =head3 SortKey
289    
290  C<< my $key = $shelp->SortKey($rhelp, $record); >>      my $key = $shelp->SortKey($rhelp, $record);
291    
292  Return the sort key for the current feature. The features are  Return the sort key for the current feature. The features are
293  sorted by sequence within operon, which is determined entirely  sorted by sequence within operon, which is determined entirely
# Line 332  Line 332 
332    
333  =head3 OutputFeature  =head3 OutputFeature
334    
335  C<< $shelp->OutputFeature($rhelp, $feature, $location, $options); >>      $shelp->OutputFeature($rhelp, $feature, $location, $options);
336    
337  Output the current feature. We use the location to compute an upstream location for the feature,  Output the current feature. We use the location to compute an upstream location for the feature,
338  and this is added to the feature data object as an extra column named C<Upstream DNA>. The operon ID  and this is added to the feature data object as an extra column named C<Upstream DNA>. The operon ID
# Line 404  Line 404 
404    
405  =head3 SearchTitle  =head3 SearchTitle
406    
407  C<< my $titleHtml = $shelp->SearchTitle(); >>      my $titleHtml = $shelp->SearchTitle();
408    
409  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.
410  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

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.4

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3