%META:TOPICINFO{author="TWikiContributor" date="1531612423" format="1.1" version="28"}% %META:TOPICPARENT{name="TWikiVariables"}% %STARTINCLUDE% ---+ TWiki Formatted Search _Inline search feature allows flexible formatting of search result_ The default output format of a =[[VarSEARCH][%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 variables, such as =%SEARCH{ "food" format="| $topic | $summary |" }%=. See =[[VarSEARCH][%SEARCH{...}%]]= for other search parameters, such as =separator=""=. %TOC% ---++ Syntax Three parameters can be used to customize a 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:* |"= Variables that can be used in the header string: | *Name:* | *Expands To:* | | =$web= | Name of the web | %INCLUDE{FormatTokens}% ---+++ 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, shortened to 40 characters with "..." indication | | =$topictitle= | Topic title, in order of sequence defined by: Form field named "Title", topic preference setting named TITLE, topic name | | =$parent= | Name of parent topic; empty if not set | | =$parent(20)= | Name of parent topic, same hyphenation/shortening like =$topic()= | | =$text= | Formatted topic text. In case of a =multiple="on"= search, it is the line found for each search hit. | | =$text(encode:type)= | Same as above, but encoded in the specified _type_. Possible types are the same as in [[VarENCODE][ENCODE]]. Though =ENCODE= can take the =extra= parameter, =$text(encode:type)= cannot. Example: =$text(encode:html)= | | =$locked= | LOCKED flag (if any) | | =$date= | Time stamp of last topic update, e.g. =%GMTIME{"$year-$mo-$day - $hour:$min"}%= | | =$isodate= | Time stamp of last topic update, e.g. =%GMTIME{"$year-$mo-$dayT$hour:$minZ"}%= | | =$rev= | Number of last topic revision, e.g. =4= | | =$username= | Login name of last topic update, e.g. =jsmith= | | =$wikiname= | Wiki user name of last topic update, e.g. =JohnSmith= | | =$wikiusername= | Wiki user name of last topic update, like =%USERSWEB%.JohnSmith= | | =$createdate= | Time stamp of topic revision 1 | | =$createusername= | Login name of topic revision 1, e.g. =jsmith= | | =$createwikiname= | Wiki user name of topic revision 1, e.g. =JohnSmith= | | =$createwikiusername= | Wiki user name of topic revision 1, e.g. =%USERSWEB%.JohnSmith= | | =$summary= | Topic summary, just the plain text, all TWiki variables, formatting and line breaks removed; up to 162 characters | | =$summary(50)= | Topic summary, up to 50 characters shown | | =$summary(showvarnames)= | Topic summary, with =%ALLTWIKI{...}%= variables shown as =ALLTWIKI{...}= | | =$summary(expandvar)= | Topic summary, with =%ALLTWIKI{...}%= variables expanded | | =$summary(noheader)= | Topic summary, with leading =---+ headers= removed%BR% __Note:__ The tokens can be combined, for example =$summary(100, showvarnames, noheader)= | | =$changes= | Summary of changes between latest rev and previous rev | | =$changes(n)= | Summary of changes between latest rev and rev n | | =$formname= | The name of the form attached to the topic; empty if none | | =$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 [[TWikiForms][TWikiForm]] | | =$formfield(name, encode:type)= | Form field value, encoded in the specified _type_. Possible types are the same as in [[VarENCODE][ENCODE]]: =quote=, =moderate=, =safe=, =entity=, =html=, =url= and =csv=. The =encode:type= parameter can be combined with other parameters described below, but it needs to be the last parameter. Example: =$formfield(Description, 20, encode:html)= | | =$formfield(name, render:display)= | Form field value, rendered for display. For example, a form field of type color will render as a colored box. If not specified, the raw value is returned, such as a color value =#336699=. The =render:display= parameter can be combined with other parameters, but must be used after the parameters described below. | | =$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, shortened to 30 characters with "..." indication | | =$query(query-syntax)= | Access topic meta data using SQL-like QuerySearch syntax. Example: %BB% =$query(attachments.arraysize)= returns the number of files attached to the current topic %BB% =$query(attachments[name~'*.gif'].size)= returns an array with size of all =.gif= attachments, such as =848, 1425, 923= %BB% =$query(parent.name)= is equivalent to =$parent= | | =$query(query-syntax, quote:")= | Strings in QuerySearch result are quoted with the specified quote. Useful to triple-quote strings for use in SpreadSheetPlugin's CALCULATE, such as =$query(attachments.comment, quote:''')= which returns a list of triple-quoted attachment comment strings -- the spreadhseet funcions will work properly even if comment strings contain commas and parenthesis | | =$query(query-syntax, encode:type)= | QuerySearch result is encoded in the specified _type_. This is in parallel to =$formfield(name, encode:type)= mentioned above | | =$pattern(reg-exp)= | A regular expression pattern to extract some text from a topic (does not search meta data; use =$formfield= instead). In case of a =multiple="on"= search, the pattern is applied to the line found in each search hit.%BB% Specify a RegularExpression that covers the whole text (topic or line), which typically starts with =.*=, and must end in =.*= %BB% Put text you want to keep in parenthesis, like =$pattern(.*?(from here.*?to here).*)= %BB% Example: =$pattern(.*?\*.*?Email\:\s*([^\n\r]+).*)= extracts the e-mail address from a bullet of format =* Email: ...= %BB% This example has non-greedy =.*?= patterns to scan for the first occurance of the Email bullet; use greedy =.*= patterns to scan for the last occurance %BB% Limitation: Do not use =.*)= inside the pattern, e.g. =$pattern(.*foo(.*)bar.*)= does not work, but =$pattern(.*foo(.*?)bar.*)= does %BB% Note: Make sure that the integrity of a web page is not compromised; for example, if you include an HTML table make sure to include everything including the table end tag | | =$pattern(reg-exp, encode:type)= | A text extracted by _reg-exp_ is encoded in the specified _type_. This is in parallel to =$formfield(name, encode:type)= mentioned above | | =$count(reg-exp)= | Count of number of times a regular expression pattern appears in the text of a topic (does not search meta data). Follows guidelines for use and limitations outlined above under =$pattern(reg-exp)=. Example: =$count(.*?(---[+][+][+][+]) .*)= counts the number of <H4> headers in a page. | | =$ntopics= | Number of topics found in current web. This is the current topic count, not the total number of topics | | =$tntopics= | The total number of topics matched | | =$nwebs= | The number of webs searched | | =$nhits= | Number of hits if =multiple="on"=. Cumulative across all topics in current web. Identical to =$ntopics= unless =multiple="on"= | %INCLUDE{FormatTokens}% ---+++ 3. =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* |"= Variables that can be used in the footer string: | *Name:* | *Expands To:* | | =$web= | Name of the web | | =$ntopics= | Number of topics found in current web | | =$tntopics= | The total number of topics matched | | =$nwebs= | The number of webs searched | | =$nhits= | Number of hits if =multiple="on"=. Cumulative across all topics in current web. Identical to =$ntopics= unless =multiple="on"= | %INCLUDE{FormatTokens}% ---+++ 4. =default="..."= parameter Use the default parameter to specify a default message if there are no hits in a web. This parameter is optional.
Example: =default="| *Note* | Nothing found in the [[$web.WebHome][$web]] web |"= Variables that can be used in the default string: | *Name:* | *Expands To:* | | =$web= | Name of the web | %INCLUDE{FormatTokens}% ---++ Results pagination When a search return many results, you may want to paginate them having the following line below the results. [[#A][«Prev]]   [[#A][1]]   *2*   [[#A][3]]   [[#A][4]]   [[#A][5]]   [[#A][Next»]] SearchResultsPagination describes how to do it. #EvaluationOrder ---++ Evaluation order of variables By default, variables embedded in the format parameter of =%SEARCH{}%= are evaluated once _before_ the search. This is OK for variables that do not change, such as =%SCRIPTURLPATH%=. Variables that should be evaluated once per search hit _must be escaped_. For example, to escape a conditional:
=    %IF{ "..." then="..." else="..." }%=
write this:
=    format="$percntIF{ \"...\" then=\"...\" else=\"...\" }$percnt"= ---++ Examples Here are some samples of formatted searches. The SearchPatternCookbook has other examples, such as [[SearchPatternCookbook#SearchUsernames][creating a picklist of usernames]], [[SearchPatternCookbook#SearchTopicChildren][searching for topic children]] and more. #SearchBulletList ---+++ Bullet list showing topic name and summary *Write this:* %SEARCH{ "FAQ" scope="topic" nosearch="on" nototal="on" header=" * *Topic: Summary:*" format=" * [[$topic]]: $summary" footer=" * *Topic: Summary*" }% *To get this:* %SEARCH{ "FAQ" scope="topic" nosearch="on" nototal="on" header=" * *Topic: Summary:*" format=" * [[$topic]]: $summary" footer=" * *Topic: Summary*" }% ---+++ 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: | *Topic:* | *OperatingSystem* | *OsVersion* | | [[%TOPIC%][IncorrectDllVersionW32PTH10DLL]] | [[%TOPIC%][OsWin]] | 95/98 | | [[%TOPIC%][WinDoze95Crash]] | [[%TOPIC%][OsWin]] | 95 | ---+++ Extract some text from a topic using regular expression *Write this:* %SEARCH{ "__Back to\:__ TWikiFAQ" scope="text" type="regex" nosearch="on" nototal="on" header="TWiki FAQs:" format=" * $pattern(.*?FAQ\:[\n\r]*([^\n\r]+).*) [[$topic][Answer...]]" }% *To get this:* %SEARCH{ "__Back to\:__ TWikiFAQ" scope="text" type="regex" nosearch="on" nototal="on" header="TWiki FAQs:" format=" * $pattern(.*?FAQ\:[\n\r]*([^\n\r]+).*) [[$topic][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:* %SEARCH{ "culture" format=" * $topic is referenced by:$n * $percntSEARCH{ \"$topic\" format=\"$dollartopic\" nosearch=\"on\" nototal=\"on\" separator=\", \" }$nop%" nosearch="on" nototal="on" }% __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. __Note:__ Another option, instead of a nested search, is to create a *hash*. Refer to the blog TWiki:Blog.BlogEntry201603x1. A search using hashes, if possible, may be significantly faster than a nested search. ---+++ Most recently changed pages *Write this:* %SEARCH{ "\.*" scope="topic" type="regex" nosearch="on" nototal="on" sort="modified" reverse="on" format="| [[$topic]] | $wikiusername | $date |" limit="7" }%= *To get this:* %SEARCH{ "\.*" scope="topic" type="regex" nosearch="on" nototal="on" sort="modified" reverse="on" format="| [[$topic]] | $wikiusername | $date |" limit="7" }% ---+++ 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 1. For each search hit apply a spreadsheet formula to determine if the hit is needed 1. If needed, format and output the result 1. Else supress the search hit This requires the TWiki:Plugins.SpreadSheetPlugin. The following example shows all topics in the %USERSWEB% web that have been updated in the last 7 days. *Write this:* =%CALCULATE{$SET(weekold, $TIMEADD($TIME(), -7, day))}%= %BR% =%SEARCH{ "." scope="topic" type="regex" web="%USERSWEB%" nonoise="on" sort="modified" reverse="on" format="$percntCALCULATE{$IF($TIME($date) < $GET(weekold), <nop>, | [[$web.$topic][$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 CALCULATE. The =$percnt= makes sure that the CALCULATE gets executed once for each search hit * The CALCULATE 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 TWiki rendering process * Otherwise, the search hit is formatted and returned * This example is for illustration only, it is easier to use the =date="..."= paramter in [[VarSEARCH][SEARCH]] to restrict the date. *To get this:* %CALCULATE{$SET(weekold, $TIMEADD($TIME(), -7, day))}% %SEARCH{ "." scope="topic" type="regex" web="%USERSWEB%" nonoise="on" sort="modified" reverse="on" format="$percntCALCULATE{$IF($TIME($date) < $GET(weekold), , | [[$web.$topic][$topic]] | $wikiusername | $date | $rev |)}$percnt" limit="100" }% The condition can be anything you like. To restrict search based on a date range it is easier to use the =date=""= parameter as shown in the next example. ---+++ Restrict search based on a date range A search can be restricted based on a [[TimeSpecifications][date range]]. The following example is identical to the previous one, showing all topics in the %USERSWEB% web that have been updated in the last 7 days. *Write this:* %SEARCH{ "." scope="topic" type="regex" web="%USERSWEB%" nonoise="on" sort="modified" reverse="on" format="| [[$web.$topic][$topic]] | $wikiusername | $date | $rev |" limit="100" date="P1w/$today" }%= *To get this:* %SEARCH{ "." scope="topic" type="regex" web="%USERSWEB%" nonoise="on" sort="modified" reverse="on" format="| [[$web.$topic][$topic]] | $wikiusername | $date | $rev |" limit="100" date="P1w/$today" }% ---+++ 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{"..."}%= variable. Example: *Write this:*
Find Topics:  
Result: %SEARCH{ search="%URLPARAM{"q" encode="search"}%" type="keyword" format=" * $web.$topic: %BR% $summary" nosearch="on" }% *To get this:*
Find Topics:  
Result: %SEARCH{ search="%URLPARAM{"q" encode="search"}%" type="keyword" format=" * $web.$topic: %BR% $summary" nosearch="on" }% __Related Topics:__ UserDocumentationCategory, SearchHelp, VarSEARCH, VarENCODE, SearchResultsPagination, SearchPatternCookbook, RegularExpression, QuerySearch -- __Contributors:__ TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie, TWiki:Main.SopanShewale