|
|
|
TOC: No TOC in "TWiki.FormattedSearch"
|
|
Inline search feature allows flexible formatting of search result
|
|
<
< |
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
|
|
$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 |
|
|
>
> |
$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. 23 May 2012 - 10:27 |
|
|
$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. 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.%BB% Specify a RegularExpression that covers the whole text (topic or line), which typically starts with .*, and must end in .* %BB% Put text you want to keep in parenthesis, like $pattern(.*?(from here.*?to here).*) %BB% Example: $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extracts the email address from a bullet of format * Email: ... %BB% This example has non-greedy .*? patterns to scan for the first occurance of the Email bullet; use greedy .* patterns to scan for the last occurance %BB% Limitation: Do not use .*) inside the pattern, e.g. $pattern(.*foo(.*)bar.*) does not work, but $pattern(.*foo(.*?)bar.*) does %BB% Note: Make sure that the integrity of a web page is not compromised; for example, if you include an HTML table make sure to include everything including the table end tag |
|
|
$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.
|
|
Examples
|
|
Table showing form field values of topics with a form
|
|
<
< |
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:
|
|
| *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:
|
>
> |
To get this:
|
|
|
|
| OperatingSystem: |
OsVersion: |
|
|
<
< |
|
>
> |
|
|
|
|
<
< |
|
>
> |
|
|
|
|
- ATasteOfTWiki is referenced by:
- FormattedSearch is referenced by:
- EditTablePlugin, EmptyPlugin, HeadlinesPlugin, ManagingWebs, RenderListPlugin, SearchHelp, SpreadSheetPlugin, TWikiDocumentation, TWikiForms, TWikiFuncModule, TWikiHistory, TWikiMetaData, TWikiUpgradeTo01Dec2001, TWikiUpgradeTo01Feb2003, TWikiVariablesNtoZ, TextFormattingRules, WebHome, WelcomeGuest
- TWikiAccessControl is referenced by:
- CommentPlugin, EditTablePlugin, FileAttachment, MainFeatures, ManagingTopics, ManagingUsers, TWikiAccessControl, TWikiDocumentation, TWikiForms, TWikiFuncModule, TWikiHistory, TWikiPages, TWikiPreferences, TWikiPreferencesSave, TWikiTopics, TWikiTutorial, TWikiUpgradeTo01Dec2000, TWikiUpgradeTo01Dec2001, TWikiUserAuthentication, TWikiVariables, WebHome, WebPreferences, WebStatistics, WelcomeGuest, WikiCulture, WikiWord
- TWikiSite is referenced by:
- AdminTools, InstantEnhancements, InterwikiPlugin, ManagingWebs, StartingPoints, TWikiDocumentation, TWikiGlossary, TWikiInstallationGuide, TWikiPreferencesSave, TWikiSite, TWikiSiteTools, TWikiTopics, TWikiTutorial, TWikiUpgradeTo01Dec2000, WabiSabi, WebChangesAlert, WebHome, WebSiteTools, WebStatistics, WelcomeGuest, WhatIsWikiWiki, WikiCulture, WikiReferences
- WabiSabi is referenced by:
- WebStatistics is referenced by:
- AdminTools, AppendixFileSystem, SiteUsageStatistics, TWikiHistory, TWikiSiteTools, TWikiUpgradeGuide, TWikiUpgradeTo01Dec2001, TWikiUpgradeTo01Feb2003, TWikiUpgradeTo01May2000, TemplateWeb, WebMenu, WebMenuFormat, WebStatistics
- WelcomeGuest is referenced by:
- ATasteOfTWiki, NewUserTemplate, StartingPoints, TWikiSite, TWikiUpgradeTo01Dec2000, WebHome, WebLeftBar, WebMenu, WebPreferences, WebStatistics, WhatIsWikiWiki, WikiCulture, YouAreHere
- WikiCulture is referenced by:
|
|
>
> |
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.
|
|
Most recently changed pages
Write this:
|
|
Result:
Number of topics: 0
|
|
<
< |
-- TWiki:Main.PeterThoeny - 16 Mar 2004
|
>
> |
-- TWiki:Main.PeterThoeny - 26 Jul 2004
|
|
|
|
TOC: No TOC in "TWiki.FormattedSearch"
|
|
|
|
>
> |
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
- 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:
%CALC{$SET(weekold, $TIMEADD($TIME(), -7, day))}%
%CALC{$IF($TIME(01 Apr 2009 - 15:23) < $GET(weekold), , | WebStatistics | BrunoRino | 01 Apr 2009 - 15:23 | 1.278 |)}%
%CALC{$IF($TIME(08 Apr 2008 - 08:50) < $GET(weekold), , | WebChangesAlert | MarkusDolensky | 08 Apr 2008 - 08:50 | 1.18 |)}%
%CALC{$IF($TIME(18 Oct 2006 - 11:18) < $GET(weekold), , | TWikiWebsTable | BrunoRino | 18 Oct 2006 - 11:18 | 1.32 |)}%
%CALC{$IF($TIME(10 Apr 2006 - 09:48) < $GET(weekold), , | TWikiPreferences | BrunoRino | 10 Apr 2006 - 09:48 | 1.50 |)}%
%CALC{$IF($TIME(30 Mar 2006 - 14:06) < $GET(weekold), , | WebPreferences | MarkusDolensky | 30 Mar 2006 - 14:06 | 1.18 |)}%
%CALC{$IF($TIME(18 May 2005 - 09:14) < $GET(weekold), , | TWikiRegistrationPub | MarcoLeoni | 18 May 2005 - 09:14 | 1.7 |)}%
%CALC{$IF($TIME(20 Feb 2005 - 12:21) < $GET(weekold), , | TWikiRegistration | MarkusDolensky | 20 Feb 2005 - 12:21 | 1.13 |)}%
%CALC{$IF($TIME(19 Feb 2005 - 10:20) < $GET(weekold), , | SiteMap | MarkusDolensky | 19 Feb 2005 - 10:20 | 1.1 |)}%
%CALC{$IF($TIME(31 Aug 2004 - 15:49) < $GET(weekold), , | TWikiInstallationGuide | PeterThoeny | 31 Aug 2004 - 15:49 | 1.62 |)}%
%CALC{$IF($TIME(31 Aug 2004 - 06:12) < $GET(weekold), , | TWikiPreferencesSave | PeterThoeny | 31 Aug 2004 - 06:12 | 1.73 |)}%
%CALC{$IF($TIME(30 Aug 2004 - 07:14) < $GET(weekold), , | AppendixFileSystem | PeterThoeny | 30 Aug 2004 - 07:14 | 1.16 |)}%
%CALC{$IF($TIME(30 Aug 2004 - 06:26) < $GET(weekold), , | TWikiUpgradeTo01Feb2003 | PeterThoeny | 30 Aug 2004 - 06:26 | 1.5 |)}%
%CALC{$IF($TIME(29 Aug 2004 - 23:18) < $GET(weekold), , | PatternSkinPalette | ArthurClemens? | 29 Aug 2004 - 23:18 | 1.2 |)}%
%CALC{$IF($TIME(28 Aug 2004 - 07:22) < $GET(weekold), , | TWikiSiteTools | PeterThoeny | 28 Aug 2004 - 07:22 | 1.9 |)}%
%CALC{$IF($TIME(28 Aug 2004 - 05:53) < $GET(weekold), , | AccessKeys | PeterThoeny | 28 Aug 2004 - 05:53 | 1.2 |)}%
%CALC{$IF($TIME(25 Aug 2004 - 07:55) < $GET(weekold), , | WebTopBar | PeterThoeny | 25 Aug 2004 - 07:55 | 1.2 |)}%
%CALC{$IF($TIME(22 Aug 2004 - 21:54) < $GET(weekold), , | InstantEnhancements | PeterThoeny | 22 Aug 2004 - 21:54 | 1.3 |)}%
%CALC{$IF($TIME(22 Aug 2004 - 21:49) < $GET(weekold), , | ATasteOfTWiki | PeterThoeny | 22 Aug 2004 - 21:49 | 1.3 |)}%
%CALC{$IF($TIME(21 Aug 2004 - 22:16) < $GET(weekold), , | ManagingWebs | PeterThoeny | 21 Aug 2004 - 22:16 | 1.26 |)}%
%CALC{$IF($TIME(21 Aug 2004 - 21:46) < $GET(weekold), , | SmiliesPlugin | PeterThoeny | 21 Aug 2004 - 21:46 | 1.3 |)}%
%CALC{$IF($TIME(17 Aug 2004 - 05:02) < $GET(weekold), , | WebLeftBar | PeterThoeny | 17 Aug 2004 - 05:02 | 1.2 |)}%
%CALC{$IF($TIME(17 Aug 2004 - 04:47) < $GET(weekold), , | PatternSkinCss | PeterThoeny | 17 Aug 2004 - 04:47 | 1.2 |)}%
%CALC{$IF($TIME(16 Aug 2004 - 03:26) < $GET(weekold), , | WebRss | PeterThoeny | 16 Aug 2004 - 03:26 | 1.2 |)}%
%CALC{$IF($TIME(16 Aug 2004 - 02:22) < $GET(weekold), , | WikiReferences | PeterThoeny | 16 Aug 2004 - 02:22 | 1.3 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 22:33) < $GET(weekold), , | WebSiteTools | PeterThoeny | 15 Aug 2004 - 22:33 | 1.5 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 22:31) < $GET(weekold), , | WebSearch | PeterThoeny | 15 Aug 2004 - 22:31 | 1.15 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 22:25) < $GET(weekold), , | WebRssBase | PeterThoeny | 15 Aug 2004 - 22:25 | 1.5 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 22:12) < $GET(weekold), , | TWikiCss | ArthurClemens? | 15 Aug 2004 - 22:12 | 1.2 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 22:11) < $GET(weekold), , | QuietSave | PeterThoeny | 15 Aug 2004 - 22:11 | 1.1 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 21:48) < $GET(weekold), , | YouAreHere | PeterThoeny | 15 Aug 2004 - 21:48 | 1.3 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 21:42) < $GET(weekold), , | TextFormattingFAQ | PeterThoeny | 15 Aug 2004 - 21:42 | 1.17 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 21:38) < $GET(weekold), , | TextEditor | PeterThoeny | 15 Aug 2004 - 21:38 | 1.2 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 21:22) < $GET(weekold), , | TWikiTemplates | PeterThoeny | 15 Aug 2004 - 21:22 | 1.23 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 09:54) < $GET(weekold), , | TWikiMetaData | PeterThoeny | 15 Aug 2004 - 09:54 | 1.16 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 09:27) < $GET(weekold), , | TWikiFAQ | PeterThoeny | 15 Aug 2004 - 09:27 | 1.13 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 09:14) < $GET(weekold), , | TWikiContributor | PeterThoeny | 15 Aug 2004 - 09:14 | 1.12 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 09:12) < $GET(weekold), , | TWikiAdminCookBook | PeterThoeny | 15 Aug 2004 - 09:12 | 1.3 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 08:44) < $GET(weekold), , | StartingPoints | PeterThoeny | 15 Aug 2004 - 08:44 | 1.5 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 08:38) < $GET(weekold), , | SearchDoesNotWork | PeterThoeny | 15 Aug 2004 - 08:38 | 1.3 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 08:33) < $GET(weekold), , | PreviewBackground | PeterThoeny | 15 Aug 2004 - 08:33 | 1.5 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 08:15) < $GET(weekold), , | TWikiDocumentation | PeterThoeny | 15 Aug 2004 - 08:15 | 1.46 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 07:55) < $GET(weekold), , | ManagingTopics | PeterThoeny | 15 Aug 2004 - 07:55 | 1.18 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 07:36) < $GET(weekold), , | IncludeTopicsAndWebPages | PeterThoeny | 15 Aug 2004 - 07:36 | 1.7 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 07:20) < $GET(weekold), , | GoBox | PeterThoeny | 15 Aug 2004 - 07:20 | 1.2 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 07:15) < $GET(weekold), , | GnuGeneralPublicLicense | PeterThoeny | 15 Aug 2004 - 07:15 | 1.3 |)}%
%CALC{$IF($TIME(15 Aug 2004 - 07:11) < $GET(weekold), , | FileAttribute | PeterThoeny | 15 Aug 2004 - 07:11 | 1.3 |)}%
%CALC{$IF($TIME(14 Aug 2004 - 08:18) < $GET(weekold), , | TWikiSkinBrowser | PeterThoeny | 14 Aug 2004 - 08:18 | 1.3 |)}%
%CALC{$IF($TIME(14 Aug 2004 - 07:54) < $GET(weekold), , | TWikiVariablesAtoM | PeterThoeny | 14 Aug 2004 - 07:54 | 1.1 |)}%
%CALC{$IF($TIME(14 Aug 2004 - 07:35) < $GET(weekold), , | AppendixEncodeURLsWithUTF8 | PeterThoeny | 14 Aug 2004 - 07:35 | 1.1 |)}%
%CALC{$IF($TIME(08 Aug 2004 - 03:02) < $GET(weekold), , | CommentsTmpl | PeterThoeny | 08 Aug 2004 - 03:02 | 1.1 |)}%
%CALC{$IF($TIME(08 Aug 2004 - 03:00) < $GET(weekold), , | CommentPlugin | PeterThoeny | 08 Aug 2004 - 03:00 | 1.1 |)}%
%CALC{$IF($TIME(02 Aug 2004 - 05:45) < $GET(weekold), , | EditTablePlugin | PeterThoeny | 02 Aug 2004 - 05:45 | 1.9 |)}%
%CALC{$IF($TIME(31 Jul 2004 - 07:13) < $GET(weekold), , | DragonSkinSiteMap | PeterThoeny | 31 Jul 2004 - 07:13 | 1.1 |)}%
%CALC{$IF($TIME(31 Jul 2004 - 07:12) < $GET(weekold), , | DragonSkinCustomize | PeterThoeny | 31 Jul 2004 - 07:12 | 1.1 |)}%
%CALC{$IF($TIME(31 Jul 2004 - 07:08) < $GET(weekold), , | DragonSkin | PeterThoeny | 31 Jul 2004 - 07:08 | 1.1 |)}%
%CALC{$IF($TIME(28 Jul 2004 - 06:23) < $GET(weekold), , | WikiSyntaxSummary | PeterThoeny | 28 Jul 2004 - 06:23 | 1.2 |)}%
%CALC{$IF($TIME(27 Jul 2004 - 08:34) < $GET(weekold), , | PlainSkin | PeterThoeny | 27 Jul 2004 - 08:34 | 1.1 |)}%
%CALC{$IF($TIME(27 Jul 2004 - 08:29) < $GET(weekold), , | PrintSkin | PeterThoeny | 27 Jul 2004 - 08:29 | 1.1 |)}%
%CALC{$IF($TIME(27 Jul 2004 - 02:42) < $GET(weekold), , | FormattedSearch | PeterThoeny | 27 Jul 2004 - 02:42 | 1.15 |)}%
%CALC{$IF($TIME(25 Jul 2004 - 23:29) < $GET(weekold), , | TWikiSkins | PeterThoeny | 25 Jul 2004 - 23:29 | 1.15 |)}%
%CALC{$IF($TIME(16 Jul 2004 - 07:27) < $GET(weekold), , | WebSearchAdvanced | PeterThoeny | 16 Jul 2004 - 07:27 | 1.2 |)}%
%CALC{$IF($TIME(18 May 2004 - 06:44) < $GET(weekold), , | InstalledPlugins | PeterThoeny | 18 May 2004 - 06:44 | 1.2 |)}%
%CALC{$IF($TIME(08 May 2004 - 21:52) < $GET(weekold), , | FileAttachment | PeterThoeny | 08 May 2004 - 21:52 | 1.13 |)}%
%CALC{$IF($TIME(21 Mar 2004 - 08:59) < $GET(weekold), , | SlideShowPlugin | PeterThoeny | 21 Mar 2004 - 08:59 | 1.2 |)}%
%CALC{$IF($TIME(21 Mar 2004 - 08:52) < $GET(weekold), , | RenderListPlugin | PeterThoeny | 21 Mar 2004 - 08:52 | 1.7 |)}%
%CALC{$IF($TIME(21 Mar 2004 - 08:12) < $GET(weekold), , | DefaultPlugin | PeterThoeny | 21 Mar 2004 - 08:12 | 1.6 |)}%
%CALC{$IF($TIME(18 Mar 2004 - 09:04) < $GET(weekold), , | WelcomeGuest | PeterThoeny | 18 Mar 2004 - 09:04 | 1.24 |)}%
%CALC{$IF($TIME(13 Mar 2004 - 09:58) < $GET(weekold), , | GoodStyle | PeterThoeny | 13 Mar 2004 - 09:58 | 1.9 |)}%
%CALC{$IF($TIME(18 Jan 2004 - 10:04) < $GET(weekold), , | SearchHelp | PeterThoeny | 18 Jan 2004 - 10:04 | 1.1 |)}%
%CALC{$IF($TIME(17 Dec 2003 - 08:37) < $GET(weekold), , | InstallPassword | PeterThoeny | 17 Dec 2003 - 08:37 | 1.4 |)}%
%CALC{$IF($TIME(17 Dec 2003 - 08:31) < $GET(weekold), , | ChangePassword | PeterThoeny | 17 Dec 2003 - 08:31 | 1.8 |)}%
%CALC{$IF($TIME(16 Dec 2003 - 12:37) < $GET(weekold), , | GnuSkinPlugin | MarcoLeoni | 16 Dec 2003 - 12:37 | 1.6 |)}%
%CALC{$IF($TIME(16 Dec 2003 - 07:59) < $GET(weekold), , | StandardColors | PeterThoeny | 16 Dec 2003 - 07:59 | 1.6 |)}%
%CALC{$IF($TIME(16 Dec 2003 - 07:41) < $GET(weekold), , | DeleteOrRenameATopic | PeterThoeny | 16 Dec 2003 - 07:41 | 1.6 |)}%
%CALC{$IF($TIME(16 Dec 2003 - 06:56) < $GET(weekold), , | TWikiSite | PeterThoeny | 16 Dec 2003 - 06:56 | 1.23 |)}%
%CALC{$IF($TIME(04 Sep 2003 - 04:43) < $GET(weekold), , | WikiSyntax | PeterThoeny | 04 Sep 2003 - 04:43 | 1.16 |)}%
%CALC{$IF($TIME(09 May 2003 - 06:19) < $GET(weekold), , | DeleteOrRenameAnAttachment | PeterThoeny | 09 May 2003 - 06:19 | 1.1 |)}%
%CALC{$IF($TIME(15 Apr 2003 - 05:54) < $GET(weekold), , | HowToLogOff | PeterThoeny | 15 Apr 2003 - 05:54 | 1.1 |)}%
%CALC{$IF($TIME(15 Apr 2003 - 05:19) < $GET(weekold), , | RegularExpression | PeterThoeny | 15 Apr 2003 - 05:19 | 1.5 |)}%
%CALC{$IF($TIME(01 Feb 2003 - 10:03) < $GET(weekold), , | TWikiShorthand | PeterThoeny | 01 Feb 2003 - 10:03 | 1.1 |)}%
%CALC{$IF($TIME(18 Jan 2003 - 09:44) < $GET(weekold), , | WikiName | PeterThoeny | 18 Jan 2003 - 09:44 | 1.3 |)}%
%CALC{$IF($TIME(18 Jan 2003 - 09:22) < $GET(weekold), , | WikiWord | PeterThoeny | 18 Jan 2003 - 09:22 | 1.4 |)}%
%CALC{$IF($TIME(16 Jan 2003 - 14:46) < $GET(weekold), , | HeadingOutlineSample | MartinRaabe? | 16 Jan 2003 - 14:46 | 1.1 |)}%
%CALC{$IF($TIME(16 Jan 2003 - 14:44) < $GET(weekold), , | TreeBookviewOutlineSample | MartinRaabe? | 16 Jan 2003 - 14:44 | 1.1 |)}%
%CALC{$IF($TIME(17 Dec 2002 - 08:46) < $GET(weekold), , | TWikiUpgradeTo01Dec2001 | PeterThoeny | 17 Dec 2002 - 08:46 | 1.31 |)}%
%CALC{$IF($TIME(23 Oct 2002 - 05:29) < $GET(weekold), , | BookView | PeterThoeny | 23 Oct 2002 - 05:29 | 1.2 |)}%
%CALC{$IF($TIME(04 Aug 2002 - 02:58) < $GET(weekold), , | MainFeatures | PeterThoeny | 04 Aug 2002 - 02:58 | 1.1 |)}%
%CALC{$IF($TIME(16 Jul 2002 - 14:43) < $GET(weekold), , | WebMenuFormat | TWikiGuest | 16 Jul 2002 - 14:43 | 1.3 |)}%
%CALC{$IF($TIME(12 Jul 2002 - 15:48) < $GET(weekold), , | GnuSkinPluginDev | JoachimNilsson? | 12 Jul 2002 - 15:48 | 1.2 |)}%
%CALC{$IF($TIME(12 Jul 2002 - 14:14) < $GET(weekold), , | GnuSkin | JoachimNilsson? | 12 Jul 2002 - 14:14 | 1.6 |)}%
%CALC{$IF($TIME(28 Jun 2002 - 07:26) < $GET(weekold), , | TWikiLogos | PeterThoeny | 28 Jun 2002 - 07:26 | 1.1 |)}%
%CALC{$IF($TIME(12 Apr 2002 - 10:53) < $GET(weekold), , | TWikiWebsTableNew | PeterThoeny | 12 Apr 2002 - 10:53 | 1.1 |)}%
%CALC{$IF($TIME(23 Nov 2001 - 11:33) < $GET(weekold), , | TWikiVariablesExamples | MikeMannix | 23 Nov 2001 - 11:33 | 1.1 |)}%
%CALC{$IF($TIME(25 Oct 2001 - 02:07) < $GET(weekold), , | TWikiFaqTemplate | PeterThoeny | 25 Oct 2001 - 02:07 | 1.2 |)}%
%CALC{$IF($TIME(18 Sep 2001 - 06:31) < $GET(weekold), , | TWikiCategoryTable | PeterThoeny | 18 Sep 2001 - 06:31 | 1.7 |)}%
%CALC{$IF($TIME(15 Sep 2001 - 08:56) < $GET(weekold), , | TWikiImplementationNotes | MikeMannix | 15 Sep 2001 - 08:56 | 1.22 |)}%
%CALC{$IF($TIME(06 Sep 2001 - 20:25) < $GET(weekold), , | KlausWriessnegger | MikeMannix | 06 Sep 2001 - 20:25 | 1.1 |)}%
%CALC{$IF($TIME(01 Sep 2001 - 07:20) < $GET(weekold), , | TWikiUpgradeTo01May2000 | MikeMannix | 01 Sep 2001 - 07:20 | 1.4 |)}%
%CALC{$IF($TIME(01 Sep 2001 - 00:19) < $GET(weekold), , | EditDoesNotIncreaseTheRevision | PeterThoeny | 01 Sep 2001 - 00:19 | 1.2 |)}%
%CALC{$IF($TIME(16 Aug 2001 - 19:59) < $GET(weekold), , | WebChanges | PeterThoeny | 16 Aug 2001 - 19:59 | 1.3 |)}%
|
|
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:
|
|
TOC: No TOC in "TWiki.FormattedSearch"
|
|
Variables that can be used in the format string:
|
|
<
< |
$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 />" |
$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) |
|
|
<
< |
$date | Time stamp of last topic update, like 23 May 2012 - 10:27 |
$isodate | Time stamp of last topic update, like 2012-05-23T10:27Z |
$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. 23 May 2012 - 10:27 |
$isodate | Time stamp of last topic update, e.g. 2012-05-23T10:27Z |
$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 |
|
|
>
> |
$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 |
|
|
|
|
>
> |
$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 |
|
|
<
< |
$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 |
|
|
- 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" }%
|
>
> |
-
-
%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
|
|
Write this:
|
|
<
< |
%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:
|
|
<
< |
|
>
> |
- ATasteOfTWiki is referenced by:
- FormattedSearch is referenced by:
- EditTablePlugin, EmptyPlugin, HeadlinesPlugin, ManagingWebs, RenderListPlugin, SearchHelp, SpreadSheetPlugin, TWikiDocumentation, TWikiForms, TWikiFuncModule, TWikiHistory, TWikiMetaData, TWikiUpgradeTo01Dec2001, TWikiUpgradeTo01Feb2003, TWikiVariablesNtoZ, TextFormattingRules, WebHome, WelcomeGuest
- TWikiAccessControl is referenced by:
- CommentPlugin, EditTablePlugin, FileAttachment, MainFeatures, ManagingTopics, ManagingUsers, TWikiAccessControl, TWikiDocumentation, TWikiForms, TWikiFuncModule, TWikiHistory, TWikiPages, TWikiPreferences, TWikiPreferencesSave, TWikiTopics, TWikiTutorial, TWikiUpgradeTo01Dec2000, TWikiUpgradeTo01Dec2001, TWikiUserAuthentication, TWikiVariables, WebHome, WebPreferences, WebStatistics, WelcomeGuest, WikiCulture, WikiWord
- TWikiSite is referenced by:
- AdminTools, InstantEnhancements, InterwikiPlugin, ManagingWebs, StartingPoints, TWikiDocumentation, TWikiGlossary, TWikiInstallationGuide, TWikiPreferencesSave, TWikiSite, TWikiSiteTools, TWikiTopics, TWikiTutorial, TWikiUpgradeTo01Dec2000, WabiSabi, WebChangesAlert, WebHome, WebSiteTools, WebStatistics, WelcomeGuest, WhatIsWikiWiki, WikiCulture, WikiReferences
- WabiSabi is referenced by:
- WebStatistics is referenced by:
- AdminTools, AppendixFileSystem, SiteUsageStatistics, TWikiHistory, TWikiSiteTools, TWikiUpgradeGuide, TWikiUpgradeTo01Dec2001, TWikiUpgradeTo01Feb2003, TWikiUpgradeTo01May2000, TemplateWeb, WebMenu, WebMenuFormat, WebStatistics
- WelcomeGuest is referenced by:
- ATasteOfTWiki, NewUserTemplate, StartingPoints, TWikiSite, TWikiUpgradeTo01Dec2000, WebHome, WebLeftBar, WebMenu, WebPreferences, WebStatistics, WhatIsWikiWiki, WikiCulture, YouAreHere
- WikiCulture is referenced by:
|
|
Most recently changed pages
|
|
|
|
<
< |
-- TWiki:Main.PeterThoeny - 15 Dec 2003
|
>
> |
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%/view%SCRIPTSUFFIX%/%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:
Result:
Number of topics: 0
-- TWiki:Main.PeterThoeny - 16 Mar 2004
|
|
TOC: No TOC in "TWiki.FormattedSearch"
|
|
Variables that can be used in the format string:
|
|
<
< |
|
>
> |
$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 />" |
|
|
|
|
>
> |
Most recently changed pages
|
|
|
|
<
< |
-- PeterThoeny - 16 May 2002
|
>
> |
Write this:
%SEARCH{ "\.*" scope="topic" regex="on" nosearch="on" nototal="on" order="modified" reverse="on" format="| [[$topic]] | $wikiusername | $date |" limit="7" }%
To get this:
-- TWiki:Main.PeterThoeny - 15 Dec 2003
|
|
TOC: No TOC in "TWiki.FormattedSearch"
|
|
$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 |
|
>
> |
$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 23 May 2012 - 10:27 |
$isodate | Time stamp of last topic update, like 2012-05-23T10:27Z |
|
|
$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: .... |
|
>
> |
$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 |
|
|
TOC: No TOC in "TWiki.FormattedSearch"
|
|
$date | Time stamp of last topic update, like 23 May 2012 - 10:27 |
$isodate | Time stamp of last topic update, like 2012-05-23T10:27Z |
$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 |
|
|
$wikiusername | Wiki user name of last topic update, like Main.JohnSmith |
|
|
<
< |
$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 |
|
|
TOC: No TOC in "TWiki.FormattedSearch"
|
|
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.
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
|
|
TOC: No TOC in "TWiki.FormattedSearch"
|
|
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
|
|
Examples
|
|
>
> |
|
|
Bullet list showing topic name and summary
|
|
<
< |
Write this:
|
>
> |
Write this:
|
|
%SEARCH{ "FAQ" scope="topic" nosearch="on" nototal="on" header=" * *Topic: Summary:*" format=" * [[$topic]]: $summary" }%
|
|
<
< |
To get this:
|
>
> |
To get this:
|
|
- Topic: Summary:
- TWikiFAQ: Frequently Asked Questions About AVO TWiki This is a real FAQ, and also a demo of one easily implemented knowledge base solution. See how it's done, click Edit . ...
- TWikiFaqTemplate: FAQ: Answer: Back to: NOP TWikiFAQ WIKIUSERNAME DATE
- 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:
|
>
> |
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:
|
>
> |
To get this:
|
|
|
|
|
|
>
> |
|
|
Extract some text from a topic using regular expression
|
|
<
< |
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...]]" }%
|
|
<
< |
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...
|
|
>
> |
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
|
|
TOC: No TOC in "TWiki.FormattedSearch"
|
|
Inline search feature allows flexible formatting of search result
|
|
<
< |
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
|
|
<
< |
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
|
|
<
< |
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
|
|
<
< |
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:
|
|
<
< |
|
|
$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 |
$locked | LOCKED flag (if any) |
|
|
<
< |
$date | Time stamp of last topic update, i.e. 23 May 2012 - 10:27 |
$isodate | Time stamp of last topic update, i.e. 2012-05-23T10:27Z |
$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 23 May 2012 - 10:27 |
$isodate | Time stamp of last topic update, like 2012-05-23T10:27Z |
$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 |
|
|
|
|
<
< |
$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
|
|
|
|
<
< |
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:
|
|
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 - 28 Nov 2001
|
>
> |
-- PeterThoeny - 16 May 2002
|
|
TOC: No TOC in "TWiki.FormattedSearch"
|
|
$n | New line |
$web | Name of the web |
$topic | Topic name |
|
|
<
< |
$topictext | Formatted topic text |
|
>
> |
$text | Formatted topic text |
|
|
$locked | LOCKED flag (if any) |
$date | Time stamp of last topic update, i.e. 23 May 2012 - 10:27 |
$isodate | Time stamp of last topic update, i.e. 2012-05-23T10:27Z |
|
|
TOC: No TOC in "TWiki.FormattedSearch"
|
|
$n | New line |
$web | Name of the web |
$topic | Topic name |
|
|
>
> |
$topictext | Formatted topic text |
|
|
$locked | LOCKED flag (if any) |
$date | Time stamp of last topic update, i.e. 23 May 2012 - 10:27 |
$isodate | Time stamp of last topic update, i.e. 2012-05-23T10:27Z |
|
|
TOC: No TOC in "TWiki.FormattedSearch"
|
|
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 %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
|
|
|
|
<
< |
Formatted Search Using %SEARCH{... format="..."}% Variable
|
|
TOC: No TOC in "TWiki.FormattedSearch"
|
|
>
> |
TWiki Formatted Search Results
Inline search feature allows flexible formatting of search result
|
|
|
|
<
< |
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
|
|
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:* |"
|
>
> |
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 |"
|
>
> |
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:
|
|
>
> |
|
|
$web | Name of the web |
$topic | Topic name |
$locked | LOCKED flag (if any) |
|
|
<
< |
$date | Time stamp of last topic update |
|
>
> |
$date | Time stamp of last topic update, i.e. 23 May 2012 - 10:27 |
$isodate | Time stamp of last topic update, i.e. 2012-05-23T10:27Z |
|
|
$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 |
|
|
|
|
<
< |
$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.
|
|
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?) |" }%
|
>
> |
%SEARCH{ "[T]opicClassification.*?value=\"[P]ublicFAQ\"" scope="text" regex="on" nosearch="on" nototal="on" format="| [[$topic]] | $formfield(OperatingSystem) | $formfield(OsVersion) |" }%
|
|
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
|
>
> |
-- PeterThoeny - 28 Nov 2001
|
|
>
> |
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 AVO TWiki This is a real FAQ, and also a demo of one easily implemented knowledge base solution. See how it's done, click Edit . ...
- TWikiFaqTemplate: FAQ: Answer: Back to: NOP TWikiFAQ WIKIUSERNAME DATE
- 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:
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
|
|
|
