TWiki Formatted Search

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, encode:type)

Form field value, encoded in the specified type. Possible types are the same as in 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)

Added:

>>

$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 />"

TWiki Formatted Search

Formatted topic text. In case of a multiple="on" search, it is the line found for each search hit.

Changed:

<<

$text(encode:type)

Same as above, but encoded in the specified type. Possible types are the same as ENCODE. Though ENCODE can take the extra parameter, $text(encode:type) cannot. e.g. $text(encode:html)

>>

$text(encode:type)

Same as above, but encoded in the specified type. Possible types are the same as in ENCODE. Though ENCODE can take the extra parameter, $text(encode:type) cannot. Example: $text(encode:html)

$locked

LOCKED flag (if any)

Changed:

<<

$date

Time stamp of last topic update, e.g. 25 May 2019 - 16:06

>>

$date

Time stamp of last topic update, e.g. 2019-05-25 - 16:06

$isodate

Time stamp of last topic update, e.g. 2019-05-25T16:06Z

$rev

Number of last topic revision, e.g. 4

$username

Login name of last topic update, e.g. jsmith

Line: 61 to 61

$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 TWikiForm

Changed:

<<

$formfield(name, encode:type)

Form field value, encoded in the specified type. This is in parallel to $text(encode:type) shown above. Comma followed by encode:type can be added to the $formfield(...) syntax below as well. But it needs to be the last paramer. e.g. $formfield(Description, 20, encode:html)

>>

$formfield(name, encode:type)

Form field value, encoded in the specified type. Possible types are the same as in 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, 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: • $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

Changed:

<<

$query(query-syntax, encode:type)

QuerySearch result is encoded in the specified type. This is in parallel to $text(encode:type) mentioned above

>>

$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.• 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

Changed:

<<

$pattern(reg-exp, encode:type)

A text extracted by reg-exp is encoded in the specified type. This is in parallel to $text(encode:type) mentioned above

>>

$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

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.

Added:

>>

$text(encode:type)

Same as above, but encoded in the specified type. Possible types are the same as ENCODE. Though ENCODE can take the extra parameter, $text(encode:type) cannot. e.g. $text(encode:html)

$locked

LOCKED flag (if any)

$date

Time stamp of last topic update, e.g. 25 May 2019 - 16:06

$isodate

Time stamp of last topic update, e.g. 2019-05-25T16:06Z

Line: 59 to 61

$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 TWikiForm

Added:

>>

$formfield(name, encode:type)

Form field value, encoded in the specified type. This is in parallel to $text(encode:type) shown above. Comma followed by encode:type can be added to the $formfield(...) syntax below as well. But it needs to be the last paramer. e.g. $formfield(Description, 20, encode:html)

$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: • $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

Added:

>>

$query(query-syntax, encode:type)

QuerySearch result is encoded in the specified type. This is in parallel to $text(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.• 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

Added:

>>

$pattern(reg-exp, encode:type)

A text extracted by reg-exp is encoded in the specified type. This is in parallel to $text(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

Added:

>>

$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"

$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

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.

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

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

Line: 48 to 35

$topic

Topic name

$topic(20)

Topic name, "- " hyphenated each 20 characters

$topic(30, -<br />)

Topic name, hyphenated each 30 characters with separator "-<br />"

Changed:

<<

$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.

Line: 73 to 60

$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 />"

Changed:

<<

$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.

Line: 81 to 68

$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 (>)

Added:

>>

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

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"

Formatted topic text. In case of a multiple="on" search, it is the line found for each search hit.

$locked

LOCKED flag (if any)

$date

Time stamp of last topic update, e.g. 25 May 2019 - 16:06

Line: 64 to 64

$createwikiname

Wiki user name of topic revision 1, e.g. JohnSmith

$createwikiusername

Wiki user name of topic revision 1, e.g. Main.JohnSmith

$summary

Topic summary, just the plain text, all formatting and line breaks removed; up to 162 characters

Changed:

<<

$summary(50)

Topic summary, up to 50 characters shown

>>

$summary(50)

Topic summary, up to 50 characters shown

$summary(showvarnames)

Topic summary, with %ALLTWIKI{...}% variables shown as ALLTWIKI{...}

$summary(noheader)

Topic summary, with leading ---+ headers removedNote: The tokens can be combined, for example $summary(100, showvarnames, noheader)

$changes

Summary of changes between latest rev and previous rev

Changed:

<<

$changes(n)

Summary of changes between latest rev and rev n

>>

$changes(n)

Summary of changes between latest rev and rev n

$formname

The name of the form attached to the topic; empty if none

Changed:

<<

$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 (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.

>>

$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

$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.

$ntopics

Number of topics found in current web. This is the current topic count, not the total number of topics

$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

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

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

Line: 63 to 76

$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 (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.

Added:

>>

$ntopics

Number of topics found in current web. This is the current topic count, not the total number of topics

$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

TWiki Formatted Search

>>

TWiki 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 variables, such as %SEARCH{ "food" format="| $topic | $summary |" }%. See %SEARCH{...}% for other search parameters, such as separator="".

Syntax

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

Double quote ("). Alternatively write \" to escape it

$percnt

Percent sign (%)

$dollar

Dollar sign ($)

>>

$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 (>)

2. format="..." parameter

Line: 48 to 45

$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

Changed:

<<

$wikiusername

Wiki user name of last topic update, like Main.JohnSmith

>>

$wikiusername

Wiki user name of last topic update, like Main.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

Changed:

<<

$createwikiusername

Wiki user name of topic revision 1, e.g. Main.JohnSmith

>>

$createwikiusername

Wiki user name of topic revision 1, e.g. Main.JohnSmith

$summary

Topic summary, just the plain text, all 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{...}

Line: 66 to 63

$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 (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.

Changed:

<<

$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

Double quote ("). Alternatively write \" to escape it

$percnt

Percent sign (%)

$dollar

Dollar sign ($)

>>

$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

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 variables, such as %SEARCH{ "food" format="| $topic | $summary |" }%.

>>

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 variables, such as %SEARCH{ "food" format="| $topic | $summary |" }%. See %SEARCH{...}% for other search parameters, such as separator="".

TWiki Formatted Search Results

>>

TWiki Formatted Search

Inline search feature allows flexible formatting of search result

Changed:

<<

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 |" }%).

>>

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 variables, such as %SEARCH{ "food" format="| $topic | $summary |" }%.

Syntax

Line: 35 to 35

$locked

LOCKED flag (if any)

$date

Time stamp of last topic update, e.g. 25 May 2019 - 16:06

$isodate

Time stamp of last topic update, e.g. 2019-05-25T16:06Z

Changed:

<<

$rev

Number of last topic revision, e.g. 1.4

>>

$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 Main.JohnSmith

Changed:

<<

$createdate

Time stamp of topic revision 1.1

$createusername

Login name of topic revision 1.1, e.g. jsmith

$createwikiname

Wiki user name of topic revision 1.1, e.g. JohnSmith

$createwikiusername

Wiki user name of topic revision 1.1, e.g. Main.JohnSmith

$summary

Topic summary

>>

$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. Main.JohnSmith

$summary

Topic summary, just the plain text, all 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(noheader)

Topic summary, with leading ---+ headers removedNote: 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 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

Changed:

<<

$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 email 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

$n or $n()

New line

>>

$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.

$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

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 |" }%).

>>

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

Line: 29 to 29

$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

Added:

>>

$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.

$locked

LOCKED flag (if any)

$date

Time stamp of last topic update, e.g. 25 May 2019 - 16:06

Line: 47 to 49

$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

Changed:

<<

$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. The pattern must cover the whole text (topic or line). For example, $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extracts the email 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.

>>

$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 email 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

$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 ($)

Deleted:

<<

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

Line: 74 to 74

Table showing form field values of topics with a form

Changed:

<<

Write this in the Know web:

>>

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

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.

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:

Specify a search which returns more hits then you need

For each search hit apply a spreadsheet formula to determine if the hit is needed

Formatted topic text. In case of a multiple="on" search, it is the line found for each search hit.

$locked

LOCKED flag (if any)

Changed:

<<

$date

Time stamp of last topic update, like 25 May 2019 - 16:06

$isodate

Time stamp of last topic update, like 2019-05-25T16:06Z

$rev

Number of last topic revision, like 1.4

$username

Login name of last topic update, like jsmith

$wikiname

Wiki user name of last topic update, like JohnSmith

>>

$date

Time stamp of last topic update, e.g. 25 May 2019 - 16:06

$isodate

Time stamp of last topic update, e.g. 2019-05-25T16:06Z

$rev

Number of last topic revision, e.g. 1.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 Main.JohnSmith

Added:

>>

$createdate

Time stamp of topic revision 1.1

$createusername

Login name of topic revision 1.1, e.g. jsmith

$createwikiname

Wiki user name of topic revision 1.1, e.g. JohnSmith

$createwikiusername

Wiki user name of topic revision 1.1, e.g. Main.JohnSmith

$summary

Topic summary

Added:

>>

$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 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

Changed:

<<

$pattern(reg-exp)

A regular expression pattern to extract some text from a topic. In case of a multiple="on" search, the pattern is applied to the line found in each search hit. For example, $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extracts the email address from a bullet of format * Email: ....

>>

$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. The pattern must cover the whole text (topic or line). For example, $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extracts the email 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.

$n or $n()

New line

$nop or $nop()

Is a "no operation". This variable gets removed; useful for nested search

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:

Formatted topic text. In case of a multiple="on" search, it is the line found for each search hit.

$locked

LOCKED flag (if any)

$date

Time stamp of last topic update, like 25 May 2019 - 16:06

$isodate

Time stamp of last topic update, like 2019-05-25T16:06Z

Line: 42 to 42

$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

Changed:

<<

$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: ....

>>

$pattern(reg-exp)

A regular expression pattern to extract some text from a topic. In case of a multiple="on" search, the pattern is applied to the line found in each search hit. 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

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.

Deleted:

<<

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. We want to search for topics, do a nested search with each hit, and show the result as nested bullets. Parameters like scope="text" regex="on" nosearch="on" nototal="on" are omitted for simplicity.

First search:

%SEARCH{ "freedom" format=" * $topic" }%

Second search. For each hit we want this search:

%SEARCH{ "(topic of first search)" format=" * $topic" }%

Now we nest the searches. We need to escape the second search, e.g. the first search will build a valid second search string:

Everybody can edit any page, this is scary. Doesn't that lead to chaos? Answer...

Added:

>>

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).

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:

Overview

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

Changed:

<<

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

>>

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

1. header="..." parameter

Changed:

<<

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. I.e. header="| *Topic:* | *Summary:* |"

>>

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

Changed:

<<

Use the format paramter to specify the format of one search hit. I.e. format="| $topic | $summary |"

>>

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

The field value of a form field, i.e. $formfield(TopicClassification) would get expanded to PublicFAQ. This applies only to topics that have a TWikiForm

$pattern(reg-exp)

A regular expression pattern to extract some text from a topic, i.e. $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extracts the email address from a bullet of format * Email: ....

>>

$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.

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. We want to search for topics, do a nested search with each hit, and show the result as nested bullets. Parameters like scope="text" regex="on" nosearch="on" nototal="on" are omitted for simplicity.

First search:

%SEARCH{ "freedom" format=" * $topic" }%

Second search. For each hit we want this search:

%SEARCH{ "(topic of first search)" format=" * $topic" }%

Now we nest the searches. 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 by the first search:

$percnt to escape the leading percent of the second search

\" to escape the qouble quotes

$dollar to escape the $ of $topic

$nop to escape the }% sequence

Deleted:

<<

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

Overview

Changed:

<<

By default, the format for displaying a search result is fixed, e.g. a table with rows of topic name and topic summary. 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 (i.e. %SEARCH{ "food" format="| $topic | $summary |" }%).

>>

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 |" }%).

TWiki Formatted Search Results

Inline search feature allows flexible formatting of search result

Changed:

<<

Preface

>>

Overview

By default, the format for displaying a search result is fixed, e.g. a table with rows of topic name and topic summary. 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 (i.e. %SEARCH{ "food" format="| $topic | $summary |" }%).

The field value of a form field, i.e. $formfield(TopicClassification) would get expanded to PublicFAQ. This applies only to topics that have a TWikiForm

>>

$formfield(name)

The field value of a form field, i.e. $formfield(TopicClassification) would get expanded to PublicFAQ. This applies only to topics that have a TWikiForm

$pattern(reg-exp)

A regular expression pattern to extract some text from a topic, i.e. $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extracts the email address from a bullet of format * Email: ....

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

Preface

By default, the format for displaying a search result is fixed, e.g. a table with rows of topic name and topic summary. 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 (i.e. %SEARCH{ "food" format="| $topic | $summary |" }%).

Syntax

Two paramters 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. I.e. header="| *Topic:* | *Summary:* |"

2. format="..." parameter

Use the format paramter to specify the format of one search hit. I.e. format="| $topic | $summary |"

The field value of a form field, i.e. $formfield(TopicClassification) would get expanded to PublicFAQ. This applies only to topics that have a TWikiForm

$pattern(reg-exp)

A regular expression pattern to extract some text from a topic, i.e. $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extracts the email address from a bullet of format * Email: ....

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