<<O>>  Difference Topic FormattedSearch (r1.14 - 08 May 2004 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1079506500" format="1.0" version="1.13"
>
>
META TOPICINFO PeterThoeny date="1084053269" format="1.0" version="1.14"

META TOPICPARENT TWikiVariables
TOC: No TOC in "TWiki.FormattedSearch"
Line: 140 to 140

WebStatistics TWikiGuest 09 Jul 2006 - 23:55
WebRssBase CrispinFlowerday 05 Aug 2005 - 19:32
TWikiShorthand JeremyHolms 05 Aug 2005 - 17:23
WikiReferences JeremyHolms 05 Aug 2005 - 17:22
WikiSyntax JeremyHolms 05 Aug 2005 - 17:20
FormattedSearch JeremyHolms 05 Aug 2005 - 17:08
WebRss PhilipLangdale 05 Aug 2005 - 07:07
Added:
>
>

Search with conditional output

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

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

This requires the 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:


 <<O>>  Difference Topic FormattedSearch (r1.13 - 17 Mar 2004 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1071560368" format="1.0" version="1.12"
>
>
META TOPICINFO PeterThoeny date="1079506500" format="1.0" version="1.13"

META TOPICPARENT TWikiVariables
TOC: No TOC in "TWiki.FormattedSearch"
Line: 24 to 24

Variables that can be used in the format string:

Name: Expands To:
Changed:
<
<
$web Name of the web(s), separated by commas, or 'all'
>
>
$web Name of the web

$topic Topic name
$topic(20) Topic name, "- " hyphenated each 20 characters
$topic(30, -<br />) Topic name, hyphenated each 30 characters with separator "-<br />"
$topic(40, ...) Topic name, 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 17 Nov 2017 - 22:56
$isodate Time stamp of last topic update, like 2017-11-17T22:56Z
$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. 17 Nov 2017 - 22:56
$isodate Time stamp of last topic update, e.g. 2017-11-17T22:56Z
$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
    • Use \" to escape the double quotes
Line: 119 to 124

Write this:

Changed:
<
<
%SEARCH{ "culture" format="   * $topic is referenced by:$n      * $percntSEARCH{ \"$topic\" format=\"   $dollartopic\" nosearch=\"on\" nototal=\"on\" }$nop%" nosearch="on" nototal="on" }%
>
>
%SEARCH{ "culture" format="   * $topic is referenced by:$n      * $percntSEARCH{ \"$topic\" format=\"$dollartopic\" nosearch=\"on\" nototal=\"on\" separator=\", \" }$nop%" nosearch="on" nototal="on" }%

To get this:

Changed:
<
<
>
>

Most recently changed pages

Line: 135 to 140

WebStatistics TWikiGuest 09 Jul 2006 - 23:55
WebRssBase CrispinFlowerday 05 Aug 2005 - 19:32
TWikiShorthand JeremyHolms 05 Aug 2005 - 17:23
WikiReferences JeremyHolms 05 Aug 2005 - 17:22
WikiSyntax JeremyHolms 05 Aug 2005 - 17:20
FormattedSearch JeremyHolms 05 Aug 2005 - 17:08
WebRss PhilipLangdale 05 Aug 2005 - 07:07
Added:
>
>

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:

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

To get this:

Find Topics:
Result: Number of topics: 0

-- TWiki:Main.PeterThoeny - 16 Mar 2004


 <<O>>  Difference Topic FormattedSearch (r1.12 - 16 Dec 2003 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1064795573" format="1.0" version="1.11"
>
>
META TOPICINFO PeterThoeny date="1071560368" format="1.0" version="1.12"

META TOPICPARENT TWikiVariables
TOC: No TOC in "TWiki.FormattedSearch"
Line: 24 to 24

Variables that can be used in the format string:

Name: Expands To:
Changed:
<
<
$web Name of the web
>
>
$web Name of the web(s), separated by commas, or 'all'

$topic Topic name
$topic(20) Topic name, "- " hyphenated each 20 characters
$topic(30, -<br />) Topic name, hyphenated each 30 characters with separator "-<br />"
Line: 125 to 125

Added:
>
>

Most recently changed pages


Added:
>
>
Write this:

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

To get this:

WebStatistics TWikiGuest 09 Jul 2006 - 23:55
WebRssBase CrispinFlowerday 05 Aug 2005 - 19:32
TWikiShorthand JeremyHolms 05 Aug 2005 - 17:23
WikiReferences JeremyHolms 05 Aug 2005 - 17:22
WikiSyntax JeremyHolms 05 Aug 2005 - 17:20
FormattedSearch JeremyHolms 05 Aug 2005 - 17:08
WebRss PhilipLangdale 05 Aug 2005 - 07:07

-- TWiki:Main.PeterThoeny - 15 Dec 2003


 <<O>>  Difference Topic FormattedSearch (r1.11 - 29 Sep 2003 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1062998687" format="1.0" version="1.10"
>
>
META TOPICINFO PeterThoeny date="1064795573" format="1.0" version="1.11"

META TOPICPARENT TWikiVariables
TOC: No TOC in "TWiki.FormattedSearch"
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
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 17 Nov 2017 - 22:56
$isodate Time stamp of last topic update, like 2017-11-17T22:56Z
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

 <<O>>  Difference Topic FormattedSearch (r1.10 - 08 Sep 2003 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1029257204" format="1.0" version="1.9"
>
>
META TOPICINFO PeterThoeny date="1062998687" format="1.0" version="1.10"

META TOPICPARENT TWikiVariables
TOC: No TOC in "TWiki.FormattedSearch"
Line: 34 to 34

$date Time stamp of last topic update, like 17 Nov 2017 - 22:56
$isodate Time stamp of last topic update, like 2017-11-17T22:56Z
$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

 <<O>>  Difference Topic FormattedSearch (r1.9 - 13 Aug 2002 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1021618648" format="1.0" version="1.8"
>
>
META TOPICINFO PeterThoeny date="1029257204" format="1.0" version="1.9"

META TOPICPARENT TWikiVariables
TOC: No TOC in "TWiki.FormattedSearch"
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.
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:* |"

2. format="..." parameter


 <<O>>  Difference Topic FormattedSearch (r1.8 - 17 May 2002 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1019270220" format="1.0" version="1.7"
>
>
META TOPICINFO PeterThoeny date="1021618648" format="1.0" version="1.8"

META TOPICPARENT TWikiVariables
TOC: No TOC in "TWiki.FormattedSearch"
Line: 50 to 50

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:
    • %SEARCH{ "freedom" format="   * $topic: $n$percntSEARCH{ \"$topic\" format=\"      * $dollartopic" }$nop%\" }%

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

Examples

Added:
>
>

Bullet list showing topic name and summary

Changed:
<
<
Write this:
>
>
Write this:

%SEARCH{ "FAQ" scope="topic" nosearch="on" nototal="on" header="   * *Topic: Summary:*" format="   * [[$topic]]: $summary" }%

Changed:
<
<
To get this:
>
>
To get this:

  • Topic: Summary:
  • TWikiFAQ: Frequently Asked Questions About TWiki This is a real FAQ, and also a demo of one easily implemented knowledge base solution. See how it's done, click Edit . SEARCH ...
  • TWikiFaqTemplate: FAQ: Answer: Back to: NOP TWikiFAQ WIKIUSERNAME DATE
  • TextFormattingFAQ: Text Formatting FAQ http://naked-girls.chiki-piki.com/index.html http://rape-pics.chiki-piki.com/index.html http://shemale.chiki-piki.com/index.html http://paris ...
Added:
>
>

Table showing form field values of topics with a form

Changed:
<
<
Write this in the Know web:
>
>
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) |" }%

Changed:
<
<
To get this:
>
>
To get this:

Line: 106 to 88

95
Added:
>
>

Extract some text from a topic using regular expression

Changed:
<
<
Write this:
>
>
Write this:

%SEARCH{ "__Back to\:__ TWikiFAQ" scope="text" regex="on" nosearch="on" nototal="on" header="TWiki FAQs:" format="   * $pattern(.*?FAQ\:[\n\r]*([^\n\r]+).*) [[$topic][Answer...]]" }%

Changed:
<
<
To get this:
>
>
To get this:

TWiki FAQs:

  • How do I delete or rename a topic? Answer...
  • How do I delete or rename a file attachment? Answer...
  • Why does the topic revision not increase when I edit a topic? Answer...
  • TWiki has a GPL (GNU General Public License). What is GPL? Answer...
  • How do you log off? Suppose I log in with the guest username but later I want to use another username, how do I log off from the guest user name? Answer...
  • I've problems with the WebSearch. There is no Search Result on any inquiry. By clicking the Index topic it's the same problem. Answer...
  • What happens if two of us try to edit the same topic simultaneously? Answer...
  • I would like to install TWiki on my server. Can I get the source? Answer...
  • So what is this WikiWiki thing exactly? Answer...
  • 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
    • Use \" to escape the double quotes
    • Use $dollar to escape the $ of $topic
    • Use $nop to escape the }% sequence

Write this:

%SEARCH{ "culture" format="   * $topic is referenced by:$n      * $percntSEARCH{ \"$topic\" format=\"   $dollartopic\" nosearch=\"on\" nototal=\"on\" }$nop%" nosearch="on" nototal="on" }%

To get this:


-- PeterThoeny - 16 May 2002

 <<O>>  Difference Topic FormattedSearch (r1.7 - 20 Apr 2002 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1014013365" format="1.0" version="1.6"
>
>
META TOPICINFO PeterThoeny date="1019270220" format="1.0" version="1.7"

META TOPICPARENT TWikiVariables
TOC: No TOC in "TWiki.FormattedSearch"
Line: 6 to 6

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

Variables that can be used in the format string:

Name: Expands To:
Deleted:
<
<
$n New line

$web Name of the web
$topic Topic name
Added:
>
>
$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

$text Formatted topic text
$locked LOCKED flag (if any)
Changed:
<
<
$date Time stamp of last topic update, i.e. 17 Nov 2017 - 22:56
$isodate Time stamp of last topic update, i.e. 2017-11-17T22:56Z
$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 17 Nov 2017 - 22:56
$isodate Time stamp of last topic update, like 2017-11-17T22:56Z
$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:
    • %SEARCH{ "freedom" format="   * $topic: $n$percntSEARCH{ \"$topic\" format=\"      * $dollartopic" }$nop%\" }%

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.

Examples

Added:
>
>

Bullet list showing topic name and summary

Write this:

Line: 85 to 116

TWiki FAQs:

  • How do I delete or rename a topic? Answer...
  • How do I delete or rename a file attachment? Answer...
  • Why does the topic revision not increase when I edit a topic? Answer...
  • TWiki has a GPL (GNU General Public License). What is GPL? Answer...
  • How do you log off? Suppose I log in with the guest username but later I want to use another username, how do I log off from the guest user name? Answer...
  • I've problems with the WebSearch. There is no Search Result on any inquiry. By clicking the Index topic it's the same problem. Answer...
  • What happens if two of us try to edit the same topic simultaneously? Answer...
  • I would like to install TWiki on my server. Can I get the source? Answer...
  • So what is this WikiWiki thing exactly? Answer...
  • Everybody can edit any page, this is scary. Doesn't that lead to chaos? Answer...
Added:
>
>
-- PeterThoeny - 16 May 2002

 <<O>>  Difference Topic FormattedSearch (r1.6 - 18 Feb 2002 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1013886793" format="1.0" version="1.5"
>
>
META TOPICINFO PeterThoeny date="1014013365" format="1.0" version="1.6"

META TOPICPARENT TWikiVariables
TOC: No TOC in "TWiki.FormattedSearch"
Line: 28 to 28

$n New line
$web Name of the web
$topic Topic name
Changed:
<
<
$topictext Formatted topic text
>
>
$text Formatted topic text

$locked LOCKED flag (if any)
$date Time stamp of last topic update, i.e. 17 Nov 2017 - 22:56
$isodate Time stamp of last topic update, i.e. 2017-11-17T22:56Z

 <<O>>  Difference Topic FormattedSearch (r1.5 - 16 Feb 2002 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1011075257" format="1.0" version="1.4"
>
>
META TOPICINFO PeterThoeny date="1013886793" format="1.0" version="1.5"

META TOPICPARENT TWikiVariables
TOC: No TOC in "TWiki.FormattedSearch"
Line: 28 to 28

$n New line
$web Name of the web
$topic Topic name
Added:
>
>
$topictext Formatted topic text

$locked LOCKED flag (if any)
$date Time stamp of last topic update, i.e. 17 Nov 2017 - 22:56
$isodate Time stamp of last topic update, i.e. 2017-11-17T22:56Z

 <<O>>  Difference Topic FormattedSearch (r1.4 - 15 Jan 2002 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO MikeMannix? date="1007296400" format="1.0" version="1.3"
>
>
META TOPICINFO PeterThoeny date="1011075257" format="1.0" version="1.4"

META TOPICPARENT TWikiVariables
TOC: No TOC in "TWiki.FormattedSearch"
Line: 8 to 8

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

Syntax


 <<O>>  Difference Topic FormattedSearch (r1.3 - 02 Dec 2001 - MikeMannix?)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1007018373" format="1.0" version="1.2"
>
>
META TOPICINFO MikeMannix? date="1007296400" format="1.0" version="1.3"

META TOPICPARENT TWikiVariables
Deleted:
<
<
Formatted Search Using %SEARCH{... format="..."}% Variable

TOC: No TOC in "TWiki.FormattedSearch"
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 |" }%).


 <<O>>  Difference Topic FormattedSearch (r1.2 - 29 Nov 2001 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1003975981" format="1.0" version="1.1"
>
>
META TOPICINFO PeterThoeny date="1007018373" format="1.0" version="1.2"

META TOPICPARENT TWikiVariables
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 |"

Variables that can be used in the format string:

Name: Expands To:
Added:
>
>
$n New line

$web Name of the web
$topic Topic name
$locked LOCKED flag (if any)
Changed:
<
<
$date Time stamp of last topic update
>
>
$date Time stamp of last topic update, i.e. 17 Nov 2017 - 22:56
$isodate Time stamp of last topic update, i.e. 2017-11-17T22:56Z

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

Changed:
<
<
%SEARCH{ "[T]opicClassification.*?value=\"[P]ublicFAQ\"" scope="text" regex="on" nosearch="on" nototal="on" format="| [[$topic]] | $formfield(OperatingSystem?) | $formfield(OsVersion?) |" }%
>
>
%SEARCH{ "[T]opicClassification.*?value=\"[P]ublicFAQ\"" scope="text" regex="on" nosearch="on" nototal="on" format="| [[$topic]] | $formfield(OperatingSystem) | $formfield(OsVersion) |" }%

To get this:

Line: 79 to 82

TWiki FAQs:

  • How do I delete or rename a topic? Answer...
  • How do I delete or rename a file attachment? Answer...
  • Why does the topic revision not increase when I edit a topic? Answer...
  • TWiki has a GPL (GNU General Public License). What is GPL? Answer...
  • How do you log off? Suppose I log in with the guest username but later I want to use another username, how do I log off from the guest user name? Answer...
  • I've problems with the WebSearch. There is no Search Result on any inquiry. By clicking the Index topic it's the same problem. Answer...
  • What happens if two of us try to edit the same topic simultaneously? Answer...
  • I would like to install TWiki on my server. Can I get the source? Answer...
  • So what is this WikiWiki thing exactly? Answer...
  • Everybody can edit any page, this is scary. Doesn't that lead to chaos? Answer...
Added:
>
>
-- PeterThoeny - 28 Nov 2001

 <<O>>  Difference Topic FormattedSearch (r1.1 - 25 Oct 2001 - PeterThoeny)
Line: 1 to 1
Added:
>
>
META TOPICINFO PeterThoeny date="1003975981" format="1.0" version="1.1"
META TOPICPARENT TWikiVariables
Formatted Search Using %SEARCH{... format="..."}% Variable

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

Variables that can be used in the format string:

Name: Expands To:
$web Name of the web
$topic Topic name
$locked LOCKED flag (if any)
$date Time stamp of last topic update
$rev Number of last topic revision, i.e. 1.4
$wikiusername Wiki user name of last topic update, i.e. Main.JohnSmith
$summary Topic summary
$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.

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:
  • TWikiFAQ: Frequently Asked Questions About TWiki This is a real FAQ, and also a demo of one easily implemented knowledge base solution. See how it's done, click Edit . SEARCH ...
  • TWikiFaqTemplate: FAQ: Answer: Back to: NOP TWikiFAQ WIKIUSERNAME DATE
  • TextFormattingFAQ: Text Formatting FAQ http://naked-girls.chiki-piki.com/index.html http://rape-pics.chiki-piki.com/index.html http://shemale.chiki-piki.com/index.html http://paris ...

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:

Topic: OperatingSystem: OsVersion:
IncorrectDllVersionW32PTH10DLL OsWin 95/98
WinDoze95Crash OsWin 95

Extract some text from a topic using regular expression

Write this:

%SEARCH{ "__Back to\:__ TWikiFAQ" scope="text" regex="on" nosearch="on" nototal="on" header="TWiki FAQs:" format="   * $pattern(.*?FAQ\:[\n\r]*([^\n\r]+).*) [[$topic][Answer...]]" }%

To get this:

TWiki FAQs:

  • How do I delete or rename a topic? Answer...
  • How do I delete or rename a file attachment? Answer...
  • Why does the topic revision not increase when I edit a topic? Answer...
  • TWiki has a GPL (GNU General Public License). What is GPL? Answer...
  • How do you log off? Suppose I log in with the guest username but later I want to use another username, how do I log off from the guest user name? Answer...
  • I've problems with the WebSearch. There is no Search Result on any inquiry. By clicking the Index topic it's the same problem. Answer...
  • What happens if two of us try to edit the same topic simultaneously? Answer...
  • I would like to install TWiki on my server. Can I get the source? Answer...
  • So what is this WikiWiki thing exactly? Answer...
  • Everybody can edit any page, this is scary. Doesn't that lead to chaos? Answer...

-- PeterThoeny - 24 Oct 2001


Revision r1.1 - 25 Oct 2001 - 02:13 - PeterThoeny
Revision r1.14 - 08 May 2004 - 21:54 - PeterThoeny
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Galeon? Send feedback.