This is a DistributionDocument
. This document is generated, please do not change it
. Put questions, error notes, and suggestions concerning the documentation
of this topic in the comments section below
. Use the Support
web for problems you are having using
This module implements all the search functionality.
Constructor for the singleton Search engine object.
StaticMethod getTextPattern ($text,$pattern)
Sanitise search pattern - currently used for FormattedSearch
Search one or more webs according to the parameters.
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
as the first parameter and
remaining parameters the same as 'print'.
is set, the result is always undef. Otherwise the
result is a string containing the rendered search results.
is set, then the results are not
the search template head and tail blocks.
will be ignored.
is defined, it will force type='regex'
will not work
SMELL: it seems that if you define
then you are
responsible for converting the TML to HTML yourself!
cannot work with format parameter (consider format='| $topic |'
Comments & Questions about this Distribution Document Topic