Difference: TWikiVariables (72 vs. 73)

Revision 732004-01-18 - PeterThoeny

Line: 1 to 1

META TOPICPARENT	name="WebHome"

On this page:

Line: 16 to 16

This version of TWiki - TWiki-6.1.0, Mon, 16 Jul 2018, build 30610 - expands the following variables (enclosed in % percent signs):

Changed:

<
<

>
>

Variable:	Expanded to:

Line: 196 to 196

`"http://..."`	A full qualified URL, i.e. `%INCLUDE{"http://twiki.org/"}%`
`pattern="..."`	A RegularExpression pattern to include a subset of a topic or page	none
`rev="1.2"`	Include a previous topic revision; N/A for URLs	top revision

Changed:

<
<

warn="off" Warn if topic include fails: Fail silently (if off); output default warning (if set to on); else, output specific text (use $topic for topic name) %INCLUDE- WARNING% preferences setting

>
>

%STARTINCLUDE%

Line: 220 to 220

%SEARCH{"text" ...}%

Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1]

Parameter:	Description:	Default:

Changed:

<
<

"text" Search term. Is a regular expression or literal, depending on the regex parameter. For regular expressions ";" is used to mean and e.g. "search;agrep" will find all topic containing search and agrep. required

>
>

"text" Search term. Is a keyword search, literal search or regular expression search, depending on the type parameter. SearchHelp has more required

`search="text"`	(Alternative to above)	N/A
`web="Name"` `web="Main, Know"` `web="all"`	Wiki web to search: A web, a list of webs separated by comma, or `all` webs. [2]	Current web
`topic="WebPreferences"` `topic="*Bug"`	Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma.	All topics in a web
`excludetopic="Web*"` `excludetopic="WebHome, WebChanges"`	Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma.	None

Changed:

<
<

scope="topic"
scope="text" Search topic name (title) or in the text (body) of the topic Topic text (body)

>
>

`type="keyword"` `type="literal"` `type="regex"`	Do a keyword search like `soap "web service" -shampoo`; a literal search like `web service`; or RegularExpression search like `soap;web service;!shampoo`	`%SEARCHVAR- DEFAULTTYPE%` preferences setting
`scope="topic"` `scope="text"` `scope="all"`	Search topic name (title); the text (body) of topic; or all (both)	`"text"`

`order="topic"` `order="modified"` `order="editby"` `order= "formfield(name)"`	Sort the results of search by the topic names, last modified time, last editor, or named field of TWikiForms	Sort by topic name
`limit="all"` `limit="16"`	Limit the number of results returned	All results

Deleted:

<
<

regex="on" RegularExpression search; also enables ";" as and Literal search

`reverse="on"`	Reverse the direction of the search	Ascending search
`casesensitive="on"`	Case sensitive search	Ignore case
`nosummary="on"`	Show topic title only	Show topic summary

Line: 239 to 239

`header="..."` `format="..."`	Custom format results: see FormattedSearch for usage, variables & examples	Results in table
`multiple="on"`	Multiple hits per topic. Each hit can be formatted. The last token is used in case of a regular expression ";" and search	Only one hit per topic
`separator=", "`	Line separator between hits	Newline `"$n"`

Changed:

<
< Regular example: %SEARCH{"wiki" web="Main" scope="topic"}%

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

Formatted example:

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

(displays results in a table with header - details)

If the TWiki:Plugins.TablePlugin

is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%

Line: 273 to 273

Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):

Changed:

<
<

>
>

Variable:	Level:	What:

Line: 377 to 377

(any topic)

List of users and groups who are allowed to rename the current topic. (More in TWikiAccessControl)

Deleted:

<
<

%FINALPREFERENCES% SL , WL List of preferences that are not allowed to be overridden by next level preferences

Deleted:

<
<

Note: There are some more useful variables defined in the TWikiPreferences like %BR% for line break, colors like %RED% for colored text and small icons like %H% for a Help icon.

Deleted:

<
<

Setting Preferences

View topic | History: r87 < r86 < r85 < r84 | More topic actions...

Copyright © 1999-2025 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.