The most current version of this feature is documented in TWikiVariables. For advanced formatting capabilities new in 01-Dec-2001 TWiki, see TWiki Search Formatting.
An
inline search displays a search result within a topic. The idea is to show a list of topics in a Wiki page that meet a certain criteria, for example all reported bugs.
An example application is a simple bug tracking system, where you set the
Topic Classification of a topic to
BugReport,
BugAssigned or
BugResolved using the category feature of TWiki. The
BugReport page shows the list of reported bugs, which can be realized with the proposed inline search feature.
Proposed syntax:
%SEARCH{"string" web="Main" scope="topic" ...}%
It is composed of the search string, followed by optional
name="value"
pairs:
Pair: |
Description: |
Default: |
web="Name" |
Specify Wiki web to search |
Current web |
scope="topic" |
Search topic name (title) |
Topic text (body) |
regex="on" |
RegularExpression search |
Literal search |
casesensitive="on" |
Case sensitive search |
Ignore case |
nosummary="on" |
Show topic title only |
Show topic summary |
nosearch="on" |
Suppress search string |
Show search string |
nototal="on" |
Do not show number of topics found |
Show number |
bookview="on" |
Show entire text of each found topic |
bookview off |
See also
SearchEnhancmentsRFC
The syntax of the
%INCLUDE%
variable needs to be changed to conform to the syntax of the inline search variable:
- Old:
%INCLUDE:"file"%
(can be used for compatibility)
- New:
%INCLUDE{"file"}%
--
PeterThoeny - 30 Jan 2000
Finished.
--
PeterThoeny - 07 Feb 2000
That's what
you thought.
--
KevinKinnell - 02 May 2000
At that time :)
Follow up in
--
PeterThoeny - 03 May 2000