Difference: TWikiVariables (44 vs. 45)

Revision 4530 Nov 2001 - MikeMannix

Line: 1 to 1

META TOPICPARENT	name="WebHome"

Line: 12 to 12

Predefined Variables

Changed:

<
< With a couple of notable exceptions, predefined variables return set values that are defined on installation and left alone. Most are directory names and file paths, customized for your server, and only have to be updated once in the main configuration file if your server set-up changes.

>
> Most predefined variables return values that were either defined when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you control how the formatted results appear.

TWiki expands the following variables (enclosed in % percent signs):

Line: 205 to 205

`regex="on"`	RegularExpression search	Literal search
`reverse="on"`	Reverse the direction of the search	Ascending search
`casesensitive="on"`	Case sensitive search	Ignore case

Changed:

<
<

`nosummary="on"`	Show topic title only. [3]	Show topic summary
`bookview="on"`	BookView search, e.g. show complete topic text. [3]	Show topic summary.
`format="..."`	Define a FormattedSearch, i.e. `" * [[$topic]]: $summary"`. [3]	Show regular search result with topic summary
`header="..."`	Specify header of FormattedSearch, i.e. `" * Topic: Summary:"`.	Show regular header

>
>

`nosummary="on"`	Show topic title only	Show topic summary
`bookview="on"`	BookView search, e.g. show complete topic text	Show topic summary

`nosearch="on"`	Suppress search string	Show search string
`noheader="on"`	Suppress search header Topics: Changed: By:	Show search header
`nototal="on"`	Do not show number of topics found	Show number

Example: %SEARCH{"wiki" web="Main" scope="topic"}%

Changed:

<
<

>
>

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

Note: For $pattern(reg-exp), specify a RegularExpression that scans from start to end and contains the text you want to keep in parenthesis, 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?

%METASEARCH{...}%

Special search of meta data

Parameter:	Description:	Default:

Line: 235 to 260

[1] Note: The search form uses identical names for input fields.

[2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.

Deleted:

<
< [3] Note: Regular search, no summary, BookView and FormattedSearch are exclusive.

Preferences Variables

Line: 354 to 377

The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line:
[6 spaces] * [space] Set [space] VARIABLENAME [space] = [value]
Example:
- Set VARIABLENAME = value

Changed:

<
<

Creating Custom Variables

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.

>
>

Customizing Variables

Changed:

<
<

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

>
> See: TWikiVariables Examples?

Deleted:

<
< -- MikeMannix? - 30 Aug 2001

-- PeterThoeny - 13 Sep 2001

Added:

>
> -- MikeMannix? - 30 Nov 2001

View topic | History: r84 < r83 < r82 < r81 | More topic actions...

Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiVariables