Share this page

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 parameter 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:

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 an easily implemented knowledge base solution. To see how it`s done, view the source...
• TWikiFaqTemplate: FAQ: Answer: Back to: TWikiFAQ Contributors:
• TextFormattingFAQ: Text Formatting FAQ This topics lists frequently asked questions on text formatting. Text formatting applies to people who edit TWiki pages in raw edit mode. TextFormattingRules...

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:

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 can I create a simple TWiki Forms based application? Answer...
• How do I delete or rename a topic? Answer...
• How do I delete or rename a file attachment? Answer...
• Why does the topic revision not increase when I edit a topic? Answer...
• TWiki is distributed under the 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...
• What does the "T" in TWiki stand for? 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:

• ATasteOfTWiki is referenced by:
  • TWikiTemplates TWikiTutorial TWikiUsersGuide WebLeftBar WebTopMenu WelcomeGuest
• FormattedSearch is referenced by:
  • AnApplicationWithWikiForm BackupRestorePlugin BreadCrumbsPlugin CaptchaPlugin EditTablePlugin EmptyPlugin FilterPlugin FlexWebListPlugin FormatTokens GluePlugin HeadlinesPlugin IfDefinedPlugin IfStatements InterwikiPlugin ManagingWebs OrphansPlugin PreferencesPlugin QuerySearch RedDotPlugin RegularExpression RenderListPlugin SearchHelp SearchPatternCookbook SearchResultsPagination SetGetPlugin ShareMePlugin SlideShowPlugin SmiliesPlugin SpreadSheetPlugin TWikiAccessControl TWikiDocumentation TWikiForms TWikiHistory TWikiMetaData TWikiNetSkinPlugin TWikiReferenceManual TWikiReleaseNotes04x00 TWikiReleaseNotes04x01 TWikiScripts TWikiSearchDotPm TWikiSiteTools TWikiTip018 TWikiTopics TWikiUISearchDotPm TWikiVariablesQuickStart TagMePlugin TreePlugin TwistyPlugin VarCachePlugin VarEDITFORMFIELD VarFORMFIELD VarMETA VarMETASEARCH VarSEARCH VarURLPARAM WatchlistPlugin WebHome WebLeftBar WebTopMenu WelcomeGuest
• TWikiAccessControl is referenced by:
  • AllowWebCreateByUserMappingManager AutonomousWebs CopyingTopics CustomUserGroupNotations EditTablePlugin FileAttachment MainFeatures ManagingTopics ManagingUsers ManagingWebs PatternSkinCustomization SitePermissions SourceCode TWikiAccessControl TWikiDocumentation TWikiForms TWikiFuncDotPm TWikiHistory TWikiInstallationGuide TWikiPreferences TWikiReferenceManual TWikiReleaseNotes04x01 TWikiReleaseNotes04x02 TWikiReleaseNotes06x00 TWikiScripts TWikiSiteTools TWikiTopics TWikiTutorial TWikiUserAuthentication TWikiVariables TagMePlugin UserMasquerading VarHIDE VarSEARCH WebPreferences WebPreferencesHelp WikiCulture WikiWord
• TWikiSite is referenced by:
  • AdminToolsCategory InstantEnhancements InterwikiPlugin ManagingWebs SiteMap SiteStatisticsFooter StartingPoints TWikiAccessControl TWikiDocumentation TWikiGlossary TWikiI18NDotPm TWikiInstallationGuide TWikiPreferences TWikiReferenceManual TWikiRegistration TWikiReleaseNotes04x02 TWikiReleaseNotes05x00 TWikiReleaseNotes05x01 TWikiReleaseNotes06x00 TWikiScripts TWikiSite TWikiTopics TWikiTutorial TWikiUserAuthentication TWikiUsersGuide WabiSabi WebHome WebLeftBar WebSiteTools WebStatisticsFooter WebTopMenu WelcomeGuest WhatDoesTWikiStandFor WhatIsWikiWiki WikiCulture WikiReferences
• VarCachePluginTest is referenced by:
  • VarCachePlugin VarVARCACHE
• WabiSabi is referenced by:
  • TWikiSite WabiSabi WhatIsWikiWiki WikiCulture WikiReferences
• WhatIsWikiWiki is referenced by:
  • TWikiReleaseNotes04x00 WikiCulture WikiReferences
• WikiCulture is referenced by:
  • TWikiAccessControl TWikiSite WabiSabi WhatIsWikiWiki WikiReferences
• WikiReferences is referenced by:
  • TWikiSite WelcomeGuest

-- PeterThoeny - 16 May 2002