TWiki Formatted Search Results

Inline search feature allows flexible formatting of search result

The %SEARCH{...}% variable documented in TWikiVariables has a fixed format for the search result, that is, a table consisting of topic names and topic summaries. Use the format="..." parameter to specify a customized format of the search result. The string of the format parameter is typically a bullet list or table row containing variables (such as %SEARCH{ "food" format="| $topic | $summary |" }%).

Syntax

Two parameters can be used to specify a customized search result:

1. header="..." parameter

Use the header paramter to specify the header of a search result. It should correspond to the format of the format parameter. This parameter is optional.
Example: header="| *Topic:* | *Summary:* |"

2. format="..." parameter

Use the format parameter to specify the format of one search hit.
Example: format="| $topic | $summary |"

Variables that can be used in the format string:

Name:	Expands To:
`$web`	Name of the web
`$topic`	Topic name
`$topic(20)`	Topic name, "`-` " hyphenated each 20 characters
`$topic(30, -<br />)`	Topic name, hyphenated each 30 characters with separator "`-<br />`"
`$topic(40, ...)`	Topic name, shortended to 40 characters with "`...`" indication
`$text`	Formatted topic text
`$locked`	LOCKED flag (if any)
`$date`	Time stamp of last topic update, like `07 May 2009 - 00:33`
`$isodate`	Time stamp of last topic update, like `2009-05-07T00:33Z`
`$rev`	Number of last topic revision, like `1.4`
`$wikiusername`	Wiki user name of last topic update, like `Main.JohnSmith`
`$username`	User name of last topic update, like `JohnSmith`
`$summary`	Topic summary
`$formfield(name)`	The field value of a form field; for example, `$formfield(TopicClassification)` would get expanded to `PublicFAQ`. This applies only to topics that have a TWikiForm
`$formfield(name, 10)`	Form field value, "`-` " hyphenated each 10 characters
`$formfield(name, 20, -<br />)`	Form field value, hyphenated each 20 characters with separator "`-<br />`"
`$formfield(name, 30, ...)`	Form field value, shortended to 30 characters with "`...`" indication
`$pattern(reg-exp)`	A regular expression pattern to extract some text from a topic. For example, `$pattern(.?\.?Email\:\s([^\n\r]+).)` extracts the email address from a bullet of format ` Email: ...`.
`$n` or `$n()`	New line
`$nop` or `$nop()`	Is a "no operation". This variable gets removed; useful for nested search
`$quot`	Double quote (`"`). Alternatively write `\"` to escape it
`$percnt`	Percent sign (`%`)
`$dollar`	Dollar sign (`$`)

Note: For $pattern(reg-exp), specify a RegularExpression that scans from start to end and contains the text you want to keep in parenthesis, like $pattern(.*?(from here.*?to here).*). You need to make sure that the integrity of a web page is not compromised; for example, if you include a table make sure to include everything including the table end tag.

Examples

Bullet list showing topic name and summary

Write this:

%SEARCH{ "FAQ" scope="topic" nosearch="on" nototal="on" header=" * *Topic: Summary:*" format=" * [[$topic]]: $summary" }%

To get this:

Topic: Summary:
TWikiFAQ: Frequently Asked Questions About TWiki This is a real FAQ, and also a demo of one easily implemented knowledge base solution. See how it's done, click Edit . SEARCH ...
TWikiFaqTemplate: FAQ: Answer: Back to: NOP TWikiFAQ WIKIUSERNAME DATE
TextFormattingFAQ: Text Formatting FAQ The most frequently asked questions about text formatting are answered. Also, TextFormattingRules contains the complete TWiki shorthand system ...

Table showing form field values of topics with a form

Write this in the Know web:

| *Topic:* | *OperatingSystem:* | *OsVersion:* |
%SEARCH{ "[T]opicClassification.*?value=\"[P]ublicFAQ\"" scope="text" regex="on" nosearch="on" nototal="on" format="| [[$topic]] | $formfield(OperatingSystem) | $formfield(OsVersion) |" }%

To get this:

Topic:	OperatingSystem:	OsVersion:
IncorrectDllVersionW32PTH10DLL	OsWin	95/98
WinDoze95Crash	OsWin	95

Extract some text from a topic using regular expression

Write this:

%SEARCH{ "__Back to\:__ TWikiFAQ" scope="text" regex="on" nosearch="on" nototal="on" header="TWiki FAQs:" format=" * $pattern(.*?FAQ\:[\n\r]*([^\n\r]+).*) [[$topic][Answer...]]" }%

To get this:

TWiki FAQs:

How do I delete or rename a topic? Answer...
Why does the topic revision not increase when I edit a topic? Answer...
TWiki has a GPL (GNU General Public License). What is GPL? Answer...
I've problems with the WebSearch. There is no Search Result on any inquiry. By clicking the Index topic it's the same problem. Answer...
What happens if two of us try to edit the same topic simultaneously? Answer...
I would like to install TWiki on my server. Can I get the source? Answer...
So what is this WikiWiki thing exactly? Answer...
Everybody can edit any page, this is scary. Doesn't that lead to chaos? Answer...

Nested Search

Search can be nested. For example, search for some topics, then form a new search for each topic found in the first search. The idea is to build the nested search string using a formatted search in the first search.

Here is an example. Let's search for all topics that contain the word "culture" (first search), and let's find out where each topic found is linked from (second search).

First search:
- %SEARCH{ "culture" format=" * $topic is referenced by: (list all references)" nosearch="on" nototal="on" }%
Second search. For each hit we want this search:
- %SEARCH{ "(topic found in first search)" format=" $topic" nosearch="on" nototal="on" }%
Now let's nest the two. We need to escape the second search, e.g. the first search will build a valid second search string. Note that we escape the second search so that it does not get evaluated prematurely by the first search:
- Use $percnt to escape the leading percent of the second search
- Use \" to escape the double quotes
- Use $dollar to escape the $ of $topic
- Use $nop to escape the }% sequence

Write this:

%SEARCH{ "culture" format=" * $topic is referenced by:$n * $percntSEARCH{ \"$topic\" format=\" $dollartopic\" nosearch=\"on\" nototal=\"on\" }$nop%" nosearch="on" nototal="on" }%

To get this:

FormattedSearch is referenced by:
- BatchUploadPlugin EditTablePlugin ManagingWebs RenderListPlugin TWikiDocumentation TWikiForms TWikiFuncModule TWikiHistory TWikiUpgradeGuide TWikiUpgradeTo01Dec2001 TWikiVariables TextFormattingRules WelcomeGuest
TWikiAccessControl is referenced by:
- CommentPlugin EditTablePlugin FileAttachment MainFeatures ManagingTopics TWikiAccessControl TWikiDocumentation TWikiForms TWikiFuncModule TWikiHistory TWikiPreferences TWikiTopics TWikiTutorial TWikiUpgradeTo01Dec2000 TWikiUpgradeTo01Dec2001 TWikiUserAuthentication TWikiVariables WebPreferences WebStatistics WelcomeGuest WikiCulture WikiWord
TWikiSite is referenced by:
- InstantEnhancements InterwikiPlugin ManagingWebs StartingPoints TWikiDocumentation TWikiGlossary TWikiInstallationGuide TWikiPreferences TWikiSite TWikiSiteTools TWikiTopics TWikiTutorial TWikiUpgradeTo01Dec2000 WabiSabi WebHome WebSiteTools WebStatistics WelcomeGuest WhatIsWikiWiki WikiCulture WikiReferences
WabiSabi is referenced by:
- AppendixFileSystem TWikiSite WabiSabi WikiCulture
WelcomeGuest is referenced by:
- StartingPoints TWikiSite TWikiUpgradeTo01Dec2000 WebHome WebPreferences WebStatistics WhatIsWikiWiki WikiCulture YouAreHere
WikiCulture is referenced by:
- TWikiAccessControl TWikiSite WabiSabi WelcomeGuest

-- PeterThoeny - 16 May 2002

----- Revision r1.8 - 17 May 2002 - 06:57 - PeterThoeny

This website has been archived and is no longer maintained.