Formatted Search

Inline search feature allows flexible formatting of search result

The default output format of a %SEARCH{...}% is a table consisting of topic names and topic summaries. Use the format="..." parameter to customize the search result. The format parameter typically defines a bullet or a table row containing macros, such as %SEARCH{ "food" format="| $topic | $summary |" }%. See %SEARCH{...}% for other search parameters, such as separator="".

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:* |"

Format tokens that can be used in the header string:

2. footer="..." parameter

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

Format tokens that can be used in the footer string:

3. format="..." parameter

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

Format tokens that can be used in the format string:

Examples

Here are some samples of formatted searches. The SearchPatternCookbook has other examples, such as creating a picklist of usernames, searching for topic children and more.

Bullet list showing topic name and summary

Write this:

%SEARCH{ "VarREMOTE" scope="topic" nosearch="on" nototal="on" header="| *Topic* | *Summary* |" format="| [[$topic]] | $summary |"  footer="| *Topics found* | *$ntopics* |"  }%

To get this:

Table showing form field values of topics with a form

In a web where there is a form that contains a TopicClassification field, an OperatingSystem field and an OsVersion field we could write:

| *Topic:* | *OperatingSystem:* | *OsVersion:* |
%SEARCH{ "[T]opicClassification.*?value=\"[P]ublicFAQ\"" scope="text" type="regex" 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:\* FrequentlyAskedQuestions" scope="text" type="regex" nosearch="on" nototal="on" header="FAQs:" format="   * $pattern(.*?FAQ\:[\n\r]*([^\n\r]+).*) [[$topic][Answer...]]" footer="Found $ntopics FAQ topics" }%

To get this:

FAQs:

• How can I create a simple data form based application? Answer...
• How do I delete or rename a topic? Answer...
• How do I delete or rename a file attachment? Answer...
• I would like to install Foswiki on my server. Can I get the source? Answer...
• Why does the topic revision not increase when I edit a topic? Answer...
• Foswiki 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...
• So what is this WikiWiki thing exactly? 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" separator=", " }%
• 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\" separator=\", \" }$nop%" nosearch="on" nototal="on" }%

To get this:

• AccessControl is referenced by:
  • CommandAndCGIScripts, CompleteDocumentation, DataForms, DefaultPreferences, DevelopingPlugins, FileAttachment, InstallationGuide, Macros, MainFeatures, ManagingTopics, ManagingUsers, ReferenceManual, ReleaseHistory, ReleaseNotes01x00, SitePermissions, SiteTools, TopicsAndWebs, TwentyMinuteTutorial, UserAuthentication, VarSEARCH, WebPreferences, WebPreferencesHelp, WikiWord
• BeginnersStartHere is referenced by:
  • MacrosQuickStart, NewUserTemplate, ReleaseNotes01x00, UsersGuide, WebLeftBarExample, WebStatistics, WelcomeGuest
• FormattedSearch is referenced by:
  • AccessControl, BookView, CommandAndCGIScripts, CompleteDocumentation, DataForms, EditTablePlugin, FormatTokens, MetaData, MySideBarTemplate, NatEditHelpText, NatEditWordHelpText, QuerySearch, ReferenceManual, ReleaseHistory, ReleaseNotes01x00, RenderListPlugin, SearchHelp, SearchPatternCookbook, SiteTools, SpreadSheetPlugin, TagMePlugin, TwistyPlugin, VarMETA, VarMETASEARCH, VarSEARCH, VarURLPARAM, WebLeftBarExample, WebStatistics
• VarCachePluginTest is referenced by:
• WabiSabi is referenced by:
  • WabiSabi, WhatIsWikiWiki
• WelcomeGuest is referenced by:
  • BeginnersStartHere, MySideBarTemplate, NewUserTemplate, StartingPoints, UsersGuide, WebHome, WebPreferences, WebStatistics, WhatIsWikiWiki, YouAreHere
• WhatIsWikiWiki is referenced by:
• WikiCulture is referenced by:
  • AccessControl, BeginnersStartHere, WabiSabi, WelcomeGuest, WhatIsWikiWiki

Note: Nested search can be slow, especially if you nest more then 3 times. Nesting is limited to 16 levels. For each new nesting level you need to "escape the escapes", e.g. write $dollarpercntSEARCH{ for level three, $dollardollarpercntSEARCH{ for level four, etc.

Most recently changed pages

Write this:

%SEARCH{ "\.*" scope="topic" type="regex" nosearch="on" nototal="on" order="modified" reverse="on"  format="| [[$topic]] | $wikiusername  | $date |" limit="7" }%

To get this:

Search with conditional output

A regular expression search is flexible, but there are limitations. For example, you cannot show all topics that are up to exactly one week old, or create a report that shows all records with invalid form fields or fields within a certain range, etc. You need some additional logic to format output based on a condition:

1. Specify a search which returns more hits then you need
2. For each search hit apply a spreadsheet formula to determine if the hit is needed
3. If needed, format and output the result
4. Else supress the search hit

This requires the Foswiki:Extensions.SpreadSheetPlugin. The following example shows all topics that are up to exactly one week old.

Write this:

%CALC{$SET(weekold, $TIMEADD($TIME(), -7, day))}%
%SEARCH{ "." scope="topic" type="regex" nosearch="on" nototal="on" order="modified" reverse="on" format="$percntCALC{$IF($TIME($date) < $GET(weekold), <nop>, | [[$topic]] | $wikiusername | $date | $rev |)}$percnt" limit="100" }%

• The first line sets the weekold variable to the serialized date of exactly one week ago
• The SEARCH has a deferred CALC. The $percnt makes sure that the CALC gets executed once for each search hit
• The CALC compares the date of the topic with the weekold date
• If topic is older, a <nop> is returned, which gets removed at the end of the rendering process
• Otherwise, the search hit is formatted and returned

To get this:

Embedding search forms to return a formatted result

Use an HTML form and an embedded formatted search on the same topic. You can link them together with an %URLPARAM{"..."}% macro. Example:

Write this:

<form action="%SCRIPTURLPATH{"view"}%/%WEB%/%TOPIC%">
Find Topics: 
<input type="text" name="q" size="32" value="%URLPARAM{"q" encode="entity"}%" />&nbsp;<input type="submit" class="foswikiSubmit" value="Search" />
</form>
Result:
%SEARCH{ search="%URLPARAM{"q" encode="quote"}%" type="keyword" format="   * $web.$topic: %BR% $summary" nosearch="on" }%

To get this: