QuickSearchPlugin

Provides a small subset of the functionality of with an emphasis on speed.

Syntax Rules

Adds the following tags:

• %QUICKSEARCH% - displays either the names of topics matching the search or the total number of such topics.

Attributes:

• web - specify web or webs to be searched (same syntax as )

• nototal - disable the listing of totals at the end of the list

• totalonly - disable the listing of topic names, only return the number of matches

• search - required string to search

• regex - treat search string as a regular expression

• casesensitive - perform case sensitive search

Formatting is based on a template (quicksearch.tmpl) where the only fields updated are webname (Plugins) and topic name (QuickSearchPlugin). If the totalonly attribute is set (e.g. totalonly="on") then just the number of matched topics is returned, this allows you to put search totals in tables, etc.

Plugin Installation Instructions

• Download the ZIP file from the Plugin web (see below). Contents:

• Unzip QuickSearchPlugin.zip in your twiki installation directory.

• Add Plugins.QuickSearchPlugin to the INSTALLEDPLUGINS variable in TWikiPreferences (or any WebPreferences topic).

• If you see the count of topics in the plugin web here:

%QUICKSEARCH{search="*"}%

then installation was successful

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Add quick and dirty search capability to topics. Implements small subset of regular %SEARCH% facility.

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins

-- DaveAlsup - 12 Mar 2002