Two parameters can be used to specify a customized search result:
Changed:
< <
1. header="..." parameter
> >
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:* |"
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:* |
Inline search feature allows flexible formatting of search result
Changed:
< <
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="".
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. 01 Nov 2024 - 01:01
$isodate
Time stamp of last topic update, e.g. 2024-11-01T01:01Z
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 removed 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 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
$quot
Double quote ("). Alternatively write \" to escape it
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 %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. 01 Nov 2024 - 01:01
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.
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
If needed, format and output the result
Else supress the search hit
This requires the TWiki:Plugins.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" regex="on" 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 TWiki 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{"..."}% variable. Example:
Topic name, hyphenated each 30 characters with separator "-<br />"
$topic(40, ...)
Topic name, shortended to 40 characters with "..." indication
$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)
Changed:
< <
$date
Time stamp of last topic update, like 01 Nov 2024 - 01:01
$isodate
Time stamp of last topic update, like 2024-11-01T01:01Z
$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. 01 Nov 2024 - 01:01
$isodate
Time stamp of last topic update, e.g. 2024-11-01T01:01Z
$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
$quot
Double quote ("). Alternatively write \" to escape it
Line: 110 to 115
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:
Changed:
< <
%SEARCH{ "(topic found in first search)" format=" $topic" nosearch="on" nototal="on" }%
> >
%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
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:
Topic name, hyphenated each 30 characters with separator "-<br />"
$topic(40, ...)
Topic name, shortended to 40 characters with "..." indication
Changed:
< <
$text
Formatted topic text
> >
$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, like 01 Nov 2024 - 01:01
$isodate
Time stamp of last topic update, like 2024-11-01T01:01Z
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
$quot
Double quote ("). Alternatively write \" to escape it
Time stamp of last topic update, like 01 Nov 2024 - 01:01
$isodate
Time stamp of last topic update, like 2024-11-01T01:01Z
$rev
Number of last topic revision, like 1.4
Added:
> >
$username
Login name of last topic update, like jsmith
$wikiname
Wiki user name of last topic update, like JohnSmith
$wikiusername
Wiki user name of last topic update, like Main.JohnSmith
Deleted:
< <
$username
User name of last topic update, like JohnSmith
$summary
Topic summary
$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
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:* |"
> >
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:* |"
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:
NatSkinFAQ: NatSkinFAQ The documentation of NatSkin is crap. I'm lost! If you need help there are a couple of options: Create a support request on TWiki:Support/WebHome ...
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 ...
TextFormattingFAQ: Text Formatting FAQ The most frequently asked questions about text formatting are answered. Also, TextFormattingRules contains the complete TWiki shorthand system ...
Line: 84 to 65
Topic: Summary:
NatSkinFAQ: NatSkinFAQ The documentation of NatSkin is crap. I'm lost! If you need help there are a couple of options: Create a support request on TWiki:Support/WebHome ...
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 ...
TextFormattingFAQ: Text Formatting FAQ The most frequently asked questions about text formatting are answered. Also, TextFormattingRules contains the complete TWiki shorthand system ...
Added:
> >
Table showing form field values of topics with a form
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).
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
Inline search feature allows flexible formatting of search result
Deleted:
< <
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 |"
Topic name, hyphenated each 30 characters with separator "-<br />"
$topic(40, ...)
Topic name, shortended to 40 characters with "..." indication
$text
Formatted topic text
$locked
LOCKED flag (if any)
Changed:
< <
$date
Time stamp of last topic update, i.e. 01 Nov 2024 - 01:01
$isodate
Time stamp of last topic update, i.e. 2024-11-01T01:01Z
$rev
Number of last topic revision, i.e. 1.4
$wikiusername
Wiki user name of last topic update, i.e. Main.JohnSmith
$username
User name of last topic update, i.e. JohnSmith
> >
$date
Time stamp of last topic update, like 01 Nov 2024 - 01:01
$isodate
Time stamp of last topic update, like 2024-11-01T01:01Z
$rev
Number of last topic revision, like 1.4
$wikiusername
Wiki user name of last topic update, like Main.JohnSmith
$username
User name of last topic update, like JohnSmith
$summary
Topic summary
Changed:
< <
$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: ....
> >
$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.
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 |" }%).
Formatted Search Using %SEARCH{... format="..."}% Variable
Added:
> >
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 |" }%).
Formatted Search Using %SEARCH{... format="..."}% Variable
Line: 14 to 14
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. I.e. 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 paramter to specify the format of one search hit. I.e. format="| $topic | $summary |"
Time stamp of last topic update, i.e. 01 Nov 2024 - 01:01
$isodate
Time stamp of last topic update, i.e. 2024-11-01T01:01Z
$rev
Number of last topic revision, i.e. 1.4
$wikiusername
Wiki user name of last topic update, i.e. Main.JohnSmith
Added:
> >
$username
User name of last topic update, i.e. JohnSmith
$summary
Topic summary
Changed:
< <
$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
> >
$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.
Line: 52 to 55
Write this in the Know web:
| *Topic:* | *OperatingSystem:* | *OsVersion:* |
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 |"
Variables that can be used in the format string:
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: ....
$locked
LOCKED flag (if any)
$web
Name of the web
$rev
Number of last topic revision, i.e. 1.4
$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
$date
Time stamp of last topic update
$topic
Topic name
$summary
Topic summary
$wikiusername
Wiki user name of last topic update, i.e. Main.JohnSmith
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.
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:
NatSkinFAQ: NatSkinFAQ The documentation of NatSkin is crap. I'm lost! If you need help there are a couple of options: Create a support request on TWiki:Support/WebHome ...
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 ...
TextFormattingFAQ: Text Formatting FAQ The most frequently asked questions about text formatting are answered. Also, TextFormattingRules contains the complete TWiki shorthand system ...
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:
This site is powered by the TWiki collaboration platform. All material on this collaboration platform is the property of the contributing authors. All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.
