Lash La Rue . TWiki . TWikiVariables (r1.45 vs. r1.46)

<<O>> Difference Topic TWikiVariables (r1.46 - 02 Dec 2001 - MikeMannix^?)

Line: 1 19 to 1 19

Changed:

<
<

>
>

Line: 212 to 213

Added:

>
>

format="..." Flexible custom result formatting: see FormattedSearch for usage Results in table

Line: 216 to 216

Deleted:

<
<

%SEARCH{... format="..."}%

Control the formatting of an embedded search. By default, the search result display format is fixed: a table with rows of topic name and topic summary. Use the format="..." parameter to specify a custom format, typically, a bullet list or table row containing variables
Ex: %SEARCH{ "food" format="| $topic | $summary |" }%)
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. Ex: header="| *Topic:* | *Summary:* |"
2. format="..." parameter
Use the format paramter to specify the format of one search hit.
Ex: 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, ex: $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.
NOTE: Sorting is nicely covered by the TablePlugin.
For how-to tips and tricks, see: TWikiVariablesExamples

Line: 269 to 244

Changed:

<
<

>
>

Line: 380 to 355

Changed:

<
<

Customizing Variables

>
>

Creating Custom Variables

Line: 382 to 357

Changed:

<
< See: TWikiVariables Examples

>
>

You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.

Example: Create a custom logo variable

To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. You also have to upload logo.gif - this can be done by attaching a file to LogoTopic (any topic name you choose):

Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif

Topic TWikiVariables . { View | Diffs | r1.46 | > | r1.45 | > | r1.44 | More }

Revision r1.45 - 30 Nov 2001 - 10:14 - MikeMannix^?
Revision r1.46 - 02 Dec 2001 - 11:58 - MikeMannix^?

	Lash La Rue . TWiki . TWikiVariables (r1.45 vs. r1.46)	Lash La Rue webs: Main \| TWiki^? \| Know^? \| Test^?
	TWiki . { Home^? \| Welcome \| Register \| Changes \| Index \| Search \| Go }