Difference: TWikiSearchDotPm (1 vs. 5)

Revision 52011-04-12 - TWikiContributor

Line: 44 to 44
  Note: For legacy, if regex is defined, it will force type='regex'
Changed:
<
<		If type="word" it will be changed to type="keyword" with wordBoundaries=1. This will be used for searching with scope="text" only, because scope="topic" will do a Perl search on topic names.
>
>		If type="word" it will be changed to type="keyword" with wordBoundaries=1. This will be used for searching with scope="text" only, because scope="topic" will do a Perl search on topic names.
  SMELL: If template is defined bookview will not work

Revision 42010-05-29 - TWikiContributor

Line: 55 to 55
 
Added:
>
>

StaticMethod formatQuery ($meta,$query) -> $text

 

StaticMethod displayFormField ($meta,$args) -> $text

Parse the arguments to a $formfield specification and extract

Revision 32008-01-22 - TWikiContributor

Line: 11 to 11
 
Added:
>
>

ObjectMethod finish ()

Break circular references.

 

StaticMethod getTextPattern ($text,$pattern)

Sanitise search pattern - currently used for FormattedSearch only

Line: 32 to 37
 If inline is set, then the results are not decorated with the search template head and tail blocks.
Added:
>
>		The function will throw Error::Simple if it encounters any problems with the syntax of the search string.
 Note: If format is set, template will be ignored.

Note: For legacy, if regex is defined, it will force type='regex'

Added:
>
>		If type="word" it will be changed to type="keyword" with wordBoundaries=1. This will be used for searching with scope="text" only, because scope="topic" will do a Perl search on topic names.
 SMELL: If template is defined bookview will not work

SMELL: it seems that if you define _callback or inline then you are

Line: 44 to 54
 FIXME: callback cannot work with format parameter (consider format='| $topic |'
Added:
>
>

StaticMethod displayFormField ($meta,$args) -> $text

Parse the arguments to a $formfield specification and extract the relevant formfield from the given meta data.

  • args string containing name of form field

In addition to the name of a field args can be appended with a commas followed by a string format (\d+)([,\s*]\.\.\.)?). This supports the formatted search function $formfield and is used to shorten the returned string or a hyphenated string.

Revision 22007-01-16 - TWikiContributor

Line: 32 to 32
 If inline is set, then the results are not decorated with the search template head and tail blocks.
Changed:
<
<		SMELL: If format is set, template will be ignored.
>
>		Note: If format is set, template will be ignored.
 
Changed:
<
<		SMELL: If regex is defined, it will force type='regex'
>
>		Note: For legacy, if regex is defined, it will force type='regex'
  SMELL: If template is defined bookview will not work

Revision 12006-02-01 - TWikiContributor

Line: 1 to 1
Added:
>
>

Package TWiki::Search

This module implements all the search functionality.

On this page:

ClassMethod new ($session)

Constructor for the singleton Search engine object.

StaticMethod getTextPattern ($text,$pattern)

Sanitise search pattern - currently used for FormattedSearch only

ObjectMethod searchWeb (...)

Search one or more webs according to the parameters.

If _callback is set, that means the caller wants results as soon as they are ready. =_callback_ should be set to a reference to a function which takes _cbdata as the first parameter and remaining parameters the same as 'print'.

If _callback is set, the result is always undef. Otherwise the result is a string containing the rendered search results.

If inline is set, then the results are not decorated with the search template head and tail blocks.

SMELL: If format is set, template will be ignored.

SMELL: If regex is defined, it will force type='regex'

SMELL: If template is defined bookview will not work

SMELL: it seems that if you define _callback or inline then you are responsible for converting the TML to HTML yourself!

FIXME: callback cannot work with format parameter (consider format='| $topic |'

View topic | History: r5 < r4 < r3 < r2 | More topic actions...
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiSearchDotPm.