Difference: FormattedSearch (22 vs. 23)
Revision 2302 Nov 2011 - TWikiContributor
| Line: 1 to 1 | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TWiki Formatted Search | |||||||||||||||||||||||||
| Line: 11 to 11 | |||||||||||||||||||||||||
Syntax | |||||||||||||||||||||||||
| Changed: | |||||||||||||||||||||||||
| < < | Two parameters can be used to specify a customized search result: | ||||||||||||||||||||||||
| > > | Three parameters can be used to customize a search result: | ||||||||||||||||||||||||
1. | |||||||||||||||||||||||||
| Line: 23 to 23 | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
| Changed: | |||||||||||||||||||||||||
| < < | 2.
| ||||||||||||||||||||||||
| Name: | Expands To: |
|---|---|
$web |
Name of the web |
$ntopics |
Number of topics found in current web |
$nhits |
Number of hits if multiple="on". Cumulative across all topics in current web. Identical to $ntopics unless multiple="on" |
$n or $n() |
New line. Use $n() if followed by alphanumeric character, e.g. write Foo$n()Bar instead of Foo$nBar |
$nop or $nop() |
Is a "no operation". This variable gets removed; useful for nested search |
$quot or \" |
Double quote (") |
$aquot |
Apostrophe quote (') |
$percnt |
Percent sign (%) |
$dollar |
Dollar sign ($) |
$lt |
Less than sign (<) |
$gt |
Greater than sign (>) |
3. format="..." parameter
>
2. format="..." parameter
Example:
format="| $topic | $summary |" $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 |
>
$topic(40, ...) |
Topic name, shortened to 40 characters with "..." indication |
$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. |
$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 |
>
$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: • $query(attachments.arraysize) returns the number of files attached to the current topic • $query(attachments[name~'*.gif'].size) returns an array with size of all .gif attachments, such as 848, 1425, 923 • $query(parent.name) is equivalent to $parent |
$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.• Specify a RegularExpression that covers the whole text (topic or line), which typically starts with .*, and must end in .* • Put text you want to keep in parenthesis, like $pattern(.*?(from here.*?to here).*) • Example: $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extracts the e-mail address from a bullet of format * Email: ... • 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 • Limitation: Do not use .*) inside the pattern, e.g. $pattern(.*foo(.*)bar.*) does not work, but $pattern(.*foo(.*?)bar.*) does • 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 |
$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. |
$nhits |
Number of hits if multiple="on". Cumulative across all topics in current web. Identical to $ntopics unless multiple="on" |
$n or $n() |
New line. Use $n() if followed by alphanumeric character, e.g. write Foo$n()Bar instead of Foo$nBar |
$nop or $nop() |
Is a "no operation". This variable gets removed; useful for nested search |
$quot or \" |
Double quote (") |
$aquot |
Apostrophe quote (') |
$percnt |
Percent sign (%) |
$dollar |
Dollar sign ($) |
$lt |
Less than sign (<) |
$gt |
Greater than sign (>) |
>
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 |
$nhits |
Number of hits if multiple="on". Cumulative across all topics in current web. Identical to $ntopics unless multiple="on" |
$n or $n() |
New line. Use $n() if followed by alphanumeric character, e.g. write Foo$n()Bar instead of Foo$nBar |
$nop or $nop() |
Is a "no operation". This variable gets removed; useful for nested search |
$quot or \" |
Double quote (") |
$aquot |
Apostrophe quote (') |
$percnt |
Percent sign (%) |
$dollar |
Dollar sign ($) |
$lt |
Less than sign (<) |
$gt |
Greater than sign (>) |
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 creating a picklist of usernames, searching for topic children and more.
<
| Topic: | OperatingSystem: | OsVersion: |
|---|---|---|
| IncorrectDllVersionW32PTH10DLL | OsWin | 95/98 |
| WinDoze95Crash | OsWin | 95 |
>
| Topic: | OperatingSystem | OsVersion |
|---|---|---|
| IncorrectDllVersionW32PTH10DLL | OsWin | 95/98 |
| WinDoze95Crash | OsWin | 95 |
Extract some text from a topic using regular expression
View topic | History: r28 < r27 < r26 < r25 | More topic actions...
Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.FormattedSearch.