NOTIFYTOPIC -- name of the notify topic
- Syntax:
%NOTIFYTOPIC%
- Expands to:
WebNotify
, renders as WebNotify - Related: HOMETOPIC, STATISTICSTOPIC, TOPIC
PLUGINVERSION -- the version of the TWiki Plugin API
- This is the
$TWiki::Plugins::VERSION
number, also indicating the version of the TWikiFuncModule - Syntax:
%PLUGINVERSION{}%
- Expands to:
1.025
- Related: PLUGINVERSION{"name"}, WIKIVERSION
PLUGINVERSION{"name"} -- the version of an installed Plugin
- Syntax:
%PLUGINVERSION{"name"}%
- Example:
%PLUGINVERSION{"DefaultPlugin"}%
expands to1.021
- Related: PLUGINVERSION, WIKIVERSION
PUBURL -- the base URL of attachments
- Syntax:
%PUBURL%
- Expands to:
http://www.denx.de/wiki/pub
- Example: You can refer to a file attached to another topic with
%PUBURL%/%WEB%/OtherTopic/image.gif
- Related: ATTACHURL, PUBURLPATH, SCRIPTURL, FileAttachments
PUBURLPATH -- the base URL path of attachments
- Syntax:
%PUBURLPATH%
- Expands to:
/wiki/pub
- Related: ATTACHURL, PUBURL, FileAttachments
REMOTE_ADDR -- environment variable
- Syntax:
%REMOTE_ADDR%
- Expands to:
23.20.245.192
- Related: HTTP_HOST, REMOTE_PORT, REMOTE_USER
REMOTE_PORT -- environment variable
- Syntax:
%REMOTE_PORT%
- Expands to:
52528
- Related: HTTP_HOST, REMOTE_ADDR, REMOTE_USER
REMOTE_USER -- environment variable
- Syntax:
%REMOTE_USER%
- Expands to:
- Related: HTTP_HOST, REMOTE_ADDR, REMOTE_PORT, USERNAME, WIKINAME, WIKIUSERNAME
REVINFO -- revision information of current topic
- Syntax:
%REVINFO%
- Expands to:
r1.1 - 14 Aug 2004 - 07:54 - PeterThoeny
- Related: REVINFO{"format"}
REVINFO{"format"} -- formatted revision information of topic
- Syntax:
%REVINFO{"format"}%
- Supported parameters:
Parameter: Description: Default: "format"
Format of revision information, see supported variables below "r1.$rev - $date - $wikiusername"
web="..."
Name of web Current web topic="..."
Topic name Current topic rev="1.5"
Specific revison number Latest revision - Supported variables in format:
Variable: Unit: Example $date
Revision date 11 Jul 2004
$rev
Revison number. Prefix r1.
to get the usualr1.5
format5
$topic
Topic name Current topic $username
Login username of revision jsmith
$web
Name of web Current web $wikiname
WikiName of revision JohnSmith
$wikiusername
WikiName with Main web prefix Main.JohnSmith
- Example:
%REVINFO{"$date - $wikiusername" rev="1.1"}%
returns revision info of first revision - Related: REVINFO
SCRIPTURL -- script URL of DENX
- Syntax:
%SCRIPTURL%
- Expands to:
http://www.denx.de/wiki
- Example: To get the authenticated version of current topic write
%SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC%
which expands tohttp://www.denx.de/wiki/viewauth/TWiki/TWikiVariablesNtoZ
- Related: PUBURL, SCRIPTSUFFIX, SCRIPTURLPATH
SCRIPTURLPATH -- script URL path of DENX
- Syntax:
%SCRIPTURLPATH%
- Expands to:
/wiki
- Related: PUBURLPATH, SCRIPTURL
SCRIPTSUFFIX -- script suffix
- Some DENX installations require a file extension for CGI scripts like
.pl
or.cgi
- Syntax:
%SCRIPTSUFFIX%
- Expands to:
- Related: SCRIPTURL
SEARCH{"text"} -- search content
- Inline search, shows a search result embedded in a topic
- Syntax:
%SEARCH{"text" ...}%
- Supported parameters: [1]
Parameter: Description: Default: "text"
Search term. Is a keyword search, literal search or regular expression search, depending on the type
parameter. SearchHelp has morerequired 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 type="keyword"
type="literal"
type="regex"
Do a keyword search like soap "web service" -shampoo
; a literal search likeweb service
; or RegularExpression search likesoap;web service;!shampoo
%SEARCHVAR- DEFAULTTYPE%
preferences setting (literal)scope="topic"
scope="text"
scope="all"
Search topic name (title); the text (body) of topic; or all (both) "text"
order="topic"
order="created"
order="modified"
order="editby"
order=
"formfield(name)"Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of TWikiForms. The sorting is done web by web; in case you want to sort across webs, create a formatted table and sort it with TablePlugin's initsort Sort by topic name limit="all"
limit="16"
Limit the number of results returned. This is done after sorting if order
is specifiedAll results 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 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 header="..."
format="..."
Custom format results: see FormattedSearch for usage, variables & examples Results in table expandvariables="on"
Expand variables before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin %CALC{}%
instead of the formulaRaw text 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"
- Example:
%SEARCH{"wiki" web="Main" scope="topic"}%
- Example with format:
%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%" }%
- Related: METASEARCH, TOPICLIST, WEBLIST, FormattedSearch
- [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 aNOSEARCHALL=on
variable in its WebPreferences
SERVERTIME -- server time
- Syntax:
%SERVERTIME%
- Expands to:
24 Apr 2018 - 16:11
- Related: DISPLAYTIME, GMTIME, SERVERTIME{"format"}
SERVERTIME{"format"} -- formatted server time
- Same format qualifiers as
%GMTIME%
- Syntax:
%SERVERTIME{"format"}%
- Example:
%SERVERTIME{"$hou:$min"}%
expands to16:11
- Related: DISPLAYTIME, GMTIME, SERVERTIME
SPACEDTOPIC -- topic name, spaced and encoded
- The current topic name with added spaces, for regular expression search of Ref-By
- Syntax:
%SPACEDTOPIC%
- Expands to:
TWiki%20*Variables%20*Nto%20*Z
- Related: TOPIC
STARTINCLUDE -- start position of topic text if included
- If present in included topic, start to include text from this location up to the end, or up to the location of the
%STOPINCLUDE%
variable. A normal view of the topic shows everyting exept the%STARTINCLUDE%
variable itself. - Syntax:
%STARTINCLUDE%
- Related: INCLUDE, STOPINCLUDE
STATISTICSTOPIC -- name of statistics topic
- Syntax:
%STATISTICSTOPIC%
- Expands to:
WebStatistics
, renders as WebStatistics - Related: HOMETOPIC, NOTIFYTOPIC, TOPIC
STOPINCLUDE -- end position of topic text if included
- If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the
%STOPINCLUDE%
variable itself. - Syntax:
%STOPINCLUDE%
- Related: INCLUDE, STARTINCLUDE
TOC -- table of contents of current topic
- Syntax:
%TOC%
- Related: TOC{"SomeTopic"}
TOC{"Topic"} -- table of contents
- Syntax:
%TOC{"SomeTopic" ...}%
- Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax (
"---++ text"
) and HTML ("<h2>text</h2>"
) are taken into account. Any heading text after"!!"
is excluded from the TOC; for example, write"---+!! text"
if you do not want to list a header in the TOC - Supported parameters:
Parameter: Description: Default: "TopicName"
topic name Current topic web="Name"
Name of web Current web depth="2"
Limit depth of headings shown in TOC 6 title="Some text"
Title to appear at top of TOC none - Example:
%TOC{depth="2"}%
- Example:
%TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
- Example: see TWiki:Sandbox.TestTopicInclude
- Related: TOC
TOPIC -- name of current topic
- Syntax:
%TOPIC%
- Expands to:
TWikiVariablesNtoZ
, renders as TWikiVariablesNtoZ - Related: BASETOPIC, INCLUDINGTOPIC, TOPICLIST, WEB
TOPICLIST{"format"} -- topic index of a web
- The "format" defines the format of one topic item. It may include variables: The
$name
variable gets expanded to the topic name; the$web
variable gets expanded to the name of the web. - Syntax:
%TOPICLIST{"format" ...}%
- Supported parameters:
Parameter: Description: Default: "format"
Format of one line, may include $name
and$web
variables"$name"
format="format"
(Alternative to above) "$name"
separator=", "
line separator "\n"
(new line)web="Name"
Name of web Current web - Example:
%TOPICLIST{" * $web.$name"}%
creates a bullet list of all topics - Example:
%TOPICLIST{separator=", "}%
creates a comma separated list of all topics - Example:
%TOPICLIST{" <option>$name</option>"}%
creates an option list (for drop down menus) - Related: SEARCH, WEBLIST
TWIKIWEB -- name of TWiki documentation web
- The web containing all documentation and site-wide preference settings for DENX
- Syntax:
%TWIKIWEB%
- Expands to:
TWiki
- Related: MAINWEB
URLPARAM{"name"} -- get value of a URL parameter
- Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting
- Syntax:
%URLPARAM{"name"}%
- Supported parameters:
Parameter: Description: Default: "name"
The name of a URL parameter required default="..."
Default value in case parameter is empty or missing empty string newline="<br />"
Convert newlines in textarea to other delimiters no conversion encode="entity"
Encode special characters into HTML entities, like a double quote into "
. This is needed if text is put into an HTML form fieldno encoding encode="url"
Encode special characters for URL parameter use, like a double quote into %22
no encoding multiple="on"
multiple="[[$item]]"
If set, gets all selected elements of a <select multiple="multiple">
tag. A format can be specified, with$item
indicating the element, e.g.multiple="Option: $item"
first element separator=", "
Separator between multiple selections. Only relevant if multiple is specified "\n"
(new line) - Example:
%URLPARAM{"skin"}%
returnsprint
for a.../view/TWiki/TWikiVariablesNtoZ?skin=print
URL. Test this: - Related: SEARCH, FormattedSearch
USERNAME -- your login username
- TWiki makes names available in three formats: USERNAME like
jsmith
, WIKINAME likeJohnSmith
and WIKIUSERNAME likeMain.JohnSmith
. A user is a TWikiGuest in case the topic is not authenticated - Syntax:
%USERNAME%
- Expands to:
guest
- Related: REMOTE_USER, WIKINAME, WIKIUSERNAME, TWikiUserAuthentication
VAR{"NAME" web="Web"} -- get a preference value from another web
- Syntax:
%VAR{"NAME" web="Web"}%
- Example: To get
%WEBBGCOLOR%
of the Main web write%VAR{"WEBBGCOLOR" web="Main"}%
, which expands to#FFEFA6
- Related: WEBPREFSTOPIC
WEB -- name of current web
- Syntax:
%WEB%
- Expands to:
TWiki
- Related: BASEWEB, INCLUDINGWEB, TOPIC
WEBLIST{"format"} -- index of all webs
- List of all webs. Hidden webs are excluded, e.g. webs with a
NOSEARCHALL=on
preference variable. The"format"
defines the format of one web item. The$name
variable gets expanded to the name of the web,$qname
gets expanded to double quoted name,$marker
tomarker
where web matchesselection
. - Syntax:
%WEBLIST{"format" ...}%
- Supported parameters:
Parameter: Description: Default: "format"
Format of one line, may include $name
variable"$name"
format="format"
(Alternative to above) "$name"
separator=", "
line separator "\n"
(new line)webs="public"
comma sep list of Web, public expands to all non-hidden "public"
marker="selected"
Text for $marker
where item matchesselection
, otherwise equals""
"selected"
selection="%WEB%"
Current value to be selected in list section="%WEB%"
- Example:
%WEBLIST{" * [[$name.WebHome]]"}%
creates a bullet list of all webs. - Example:
%WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="TWiki" separator=" "}%
Dropdown of all public Webs + Trash Web, current Web highlighted. - Related: TOPICLIST, SEARCH
WEBPREFSTOPIC -- name of web preferences topic
- Syntax:
%WEBPREFSTOPIC%
- Expands to:
WebPreferences
, renders as WebPreferences - Related: HOMETOPIC, WIKIPREFSTOPIC, VAR
WIKIHOMEURL -- site home URL
- The base URL of DENX, is the link of the Home icon in the upper left corner, defined in TWiki.cfg
- Syntax:
%WIKIHOMEURL%
- Expands to:
http://www.denx.de/wiki
- Related: WIKITOOLNAME
WIKINAME -- your Wiki username
- The WikiName is the same as %USERNAME% if not defined in the TWikiUsers topic
- Syntax:
%WIKINAME%
- Expands to:
guest
- Related: REMOTE_USER, USERNAME, WIKIUSERNAME, WIKIUSERSTOPIC
WIKIPREFSTOPIC -- name of site-wide preferences topic
- Syntax:
%WIKIPREFSTOPIC%
- Expands to:
TWikiPreferences
, renders as TWikiPreferences - Related: HOMETOPIC, WEBPREFSTOPIC
WIKITOOLNAME -- name of your TWiki site
- Syntax:
%WIKITOOLNAME%
- Expands to:
DENX
- Related: WIKIHOMEURL, WIKIVERSION
WIKIUSERNAME -- your Wiki username with web prefix
- Your %WIKINAME% with Main web prefix, useful to point to your DENX home page
- Syntax:
%WIKIUSERNAME%
- Expands to:
Main.guest
, renders as Main.guest - Related: REMOTE_USER, USERNAME, WIKINAME
WIKIUSERSTOPIC -- name of topic listing all registers users
- Syntax:
%WIKIUSERSTOPIC%
- Expands to:
TWikiUsers
, with Main prefix renders as TWikiUsers - Related: WIKIUSERNAME
WIKIVERSION -- the version of the installed TWiki engine
- Syntax:
%WIKIVERSION%
- Expands to:
04 Sep 2004 $Rev: 1742 $
- Related: PLUGINVERSION, WIKITOOLNAME