__Note:__ This topic is included by TWikiVariables ----- %STARTINCLUDE% #VarNOTIFYTOPIC ---+++ NOTIFYTOPIC -- name of the notify topic * Syntax: =%NOTIFYTOPIC%= * Expands to: =%NOTIFYTOPIC%=, renders as [[%NOTIFYTOPIC%]] * Related: [[#VarHOMETOPIC][HOMETOPIC]], [[#VarSTATISTICSTOPIC][STATISTICSTOPIC]], [[#VarTOPIC][TOPIC]] #VarPLUGINVERSION ---+++ 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: =%PLUGINVERSION{}%= * Related: [[#VarPLUGINVERSION2][PLUGINVERSION{"name"}]], [[#VarWIKIVERSION][WIKIVERSION]] #VarPLUGINVERSION2 ---+++ PLUGINVERSION{"name"} -- the version of an installed Plugin * Syntax: =%PLUGINVERSION{"name"}%= * Example: =%PLUGINVERSION{"DefaultPlugin"}%= expands to =%PLUGINVERSION{"DefaultPlugin"}%= * Related: [[#VarPLUGINVERSION][PLUGINVERSION]], [[#VarWIKIVERSION][WIKIVERSION]] #VarPUBURL ---+++ PUBURL -- the base URL of attachments * Syntax: =%PUBURL%= * Expands to: =%PUBURL%= * Example: You can refer to a file attached to another topic with =%PUBURL%/%WEB%/OtherTopic/image.gif= * Related: [[#VarATTACHURL][ATTACHURL]], [[#VarPUBURLPATH][PUBURLPATH]], [[#VarSCRIPTURL][SCRIPTURL]], FileAttachments #VarPUBURLPATH ---+++ PUBURLPATH -- the base URL path of attachments * Syntax: =%PUBURLPATH%= * Expands to: =%PUBURLPATH%= * Related: [[#VarATTACHURL][ATTACHURL]], [[#VarPUBURL][PUBURL]], FileAttachments #VarREMOTEADDR ---+++ REMOTE_ADDR -- environment variable * Syntax: =%REMOTE_ADDR%= * Expands to: =%REMOTE_ADDR%= * Related: [[#VarHTTPHOST][HTTP_HOST]], [[#VarREMOTEPORT][REMOTE_PORT]], [[#VarREMOTEUSER][REMOTE_USER]] #VarREMOTEPORT ---+++ REMOTE_PORT -- environment variable * Syntax: =%REMOTE_PORT%= * Expands to: %REMOTE_PORT% * Related: [[#VarHTTPHOST][HTTP_HOST]], [[#VarREMOTEADDR][REMOTE_ADDR]], [[#VarREMOTEUSER][REMOTE_USER]] #VarREMOTEUSER ---+++ REMOTE_USER -- environment variable * Syntax: =%REMOTE_USER%= * Expands to: %REMOTE_USER% * Related: [[#VarHTTPHOST][HTTP_HOST]], [[#VarREMOTEADDR][REMOTE_ADDR]], [[#VarREMOTEPORT][REMOTE_PORT]], [[#VarUSERNAME][USERNAME]], [[#VarWIKINAME][WIKINAME]], [[#VarWIKIUSERNAME][WIKIUSERNAME]] #VarREVINFO ---+++ REVINFO -- revision information of current topic * Syntax: =%REVINFO%= * Expands to: %REVINFO% * Related: [[#VarREVINFO2][REVINFO{"format"}]] #VarREVINFO2 ---+++ 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* | | =$web= | Name of web | Current web | | =$topic= | Topic name | Current topic | | =$rev= | Revison number. Prefix =r1.= to get the usual =r1.5= format | =5= | | =$date= | Revision date | =11 Jul 2004= | | =$username= | Login username of revision | =jsmith= | | =$wikiname= | WikiName of revision | =JohnSmith= | | =$wikiusername= | WikiName with %MAINWEB% web prefix | =%MAINWEB%.JohnSmith= | * Example: =%REVINFO{"$date - $wikiusername" rev="1.1"}%= returns revision info of first revision * Related: [[#VarREVINFO][REVINFO]] #VarSCRIPTURL ---+++ SCRIPTURL -- script URL of %WIKITOOLNAME% * Syntax: =%SCRIPTURL%= * Expands to: =%SCRIPTURL%= * Example: To get the authenticated version of current topic write =%SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC%= which expands to =%SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC%= * Related: [[#VarPUBURL][PUBURL]], [[#VarSCRIPTSUFFIX][SCRIPTSUFFIX]], [[#VarSCRIPTURLPATH][SCRIPTURLPATH]] #VarSCRIPTURLPATH ---+++ SCRIPTURLPATH -- script URL path of %WIKITOOLNAME% * Syntax: =%SCRIPTURLPATH%= * Expands to: =%SCRIPTURLPATH%= * Related: [[#VarPUBURLPATH][PUBURLPATH]], [[#VarSCRIPTURL][SCRIPTURL]] #VarSCRIPTSUFFIX ---+++ SCRIPTSUFFIX -- script suffix * Some %WIKITOOLNAME% installations require a file extension for CGI scripts like =.pl= or =.cgi= * Syntax: =%SCRIPTSUFFIX%= * Expands to: %SCRIPTSUFFIX% * Related: [[#VarSCRIPTURL][SCRIPTURL]] #VarSEARCH ---+++ 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 more | required | | =search="text"= | (Alternative to above) | N/A | | =web="Name"=
=web="%MAINWEB%, Know"=
=web="all"= | Wiki web to search: A web, a list of webs separated by comma, or =all= webs. [2] | Current web | | =topic="%WEBPREFSTOPIC%"=
=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="%HOMETOPIC%, 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 like =web service=; or RegularExpression search like =soap;web service;!shampoo= | =%SEARCHVAR- DEFAULTTYPE%= [[TWikiPreferences][preferences]] setting (%SEARCHVARDEFAULTTYPE%) | | =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 [[FormattedSearch][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 specified | All 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 formula | Raw text | | =multiple="on"= | Multiple hits per topic. Each hit can be [[FormattedSearch][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="%MAINWEB%" 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 - [[FormattedSearch][details]])_ * %H% 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: [[#VarMETASEARCH][METASEARCH]], [[#VarTOPICLIST][TOPICLIST]], [[#VarWEBLIST][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 a =NOSEARCHALL=on= variable in its %WEBPREFSTOPIC% #VarSERVERTIME ---+++ SERVERTIME -- server time * Syntax: =%SERVERTIME%= * Expands to: =%SERVERTIME%= * Related: [[#VarDISPLAYTIME][DISPLAYTIME]], [[#VarGMTIME][GMTIME]], [[#VarSERVERTIME2][SERVERTIME{"format"}]] #VarSERVERTIME2 ---+++ SERVERTIME{"format"} -- formatted server time * Same format qualifiers as =%GMTIME%= * Syntax: =%SERVERTIME{"format"}%= * Example: =%SERVERTIME{"$hou:$min"}%= expands to =%SERVERTIME{"$hou:$min"}%= * Related: [[#VarDISPLAYTIME][DISPLAYTIME]], [[#VarGMTIME][GMTIME]], [[#VarSERVERTIME][SERVERTIME]] #VarSPACEDTOPIC ---+++ SPACEDTOPIC -- topic name, spaced and encoded * The current topic name with added spaces, for regular expression search of Ref-By * Syntax: =%SPACEDTOPIC%= * Expands to: =%SPACEDTOPIC%= * Related: [[#VarTOPIC][TOPIC]] #VarSTARTINCLUDE ---+++ 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: [[#VarINCLUDE][INCLUDE]], [[#VarSTOPINCLUDE][STOPINCLUDE]] #VarSTATISTICSTOPIC ---+++ STATISTICSTOPIC -- name of statistics topic * Syntax: =%STATISTICSTOPIC%= * Expands to: =%STATISTICSTOPIC%=, renders as [[%STATISTICSTOPIC%]] * Related: [[#VarHOMETOPIC][HOMETOPIC]], [[#VarNOTIFYTOPIC][NOTIFYTOPIC]], [[#VarTOPIC][TOPIC]] #VarSTOPINCLUDE ---+++ 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: [[#VarINCLUDE][INCLUDE]], [[#VarSTARTINCLUDE][STARTINCLUDE]] #VarTOC ---+++ TOC -- table of contents of current topic * Syntax: =%TOC%= * Related: [[#VarTOC2][TOC{"SomeTopic"}]] #VarTOC2 ---+++ 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="%TWIKIWEB%" title="Contents:"}%= * Example: see TWiki:Sandbox.TestTopicInclude * Related: [[#VarTOC][TOC]] #VarTOPIC ---+++ TOPIC -- name of current topic * Syntax: =%TOPIC%= * Expands to: =%TOPIC%=, renders as [[%TOPIC%]] * Related: [[#VarBASETOPIC][BASETOPIC]], [[#VarINCLUDINGTOPIC][INCLUDINGTOPIC]], [[#VarTOPICLIST][TOPICLIST]], [[#VarWEB][WEB]] #VarTOPICLIST ---+++ 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: [[#VarSEARCH][SEARCH]], [[#VarWEBLIST][WEBLIST]] #VarTWIKIWEB ---+++ TWIKIWEB -- name of TWiki documentation web * The web containing all documentation and site-wide preference settings for %WIKITOOLNAME% * Syntax: =%TWIKIWEB%= * Expands to: =%TWIKIWEB%= * Related: [[#VarMAINWEB][MAINWEB]] #VarURLPARAM ---+++ 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 =&#034;=. This is needed if text is put into an HTML form field | no encoding | | =encode="url"= | Encode special characters for URL parameter use, like a double quote into =%22= | no encoding | | =multiple="on"= %BR% =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"}%= returns =print= for a =.../view/%WEB%/%TOPIC%?skin=print= URL. [[%SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC%?skin=print#VarURLPARAM][Test this]]: %URLPARAM{"skin"}% * Related: [[#VarSEARCH][SEARCH]], FormattedSearch #VarUSERNAME ---+++ USERNAME -- your login username * TWiki makes names available in three formats: USERNAME like =jsmith=, WIKINAME like =JohnSmith= and WIKIUSERNAME like =%MAINWEB%.JohnSmith=. A user is a %MAINWEB%.TWikiGuest in case the topic is not authenticated * Syntax: =%USERNAME%= * Expands to: =%USERNAME%= * Related: [[#VarREMOTEUSER][REMOTE_USER]], [[#VarWIKINAME][WIKINAME]], [[#VarWIKIUSERNAME][WIKIUSERNAME]], TWikiUserAuthentication #VarVAR ---+++ VAR{"NAME" web="Web"} -- get a preference value from another web * Syntax: =%VAR{"NAME" web="Web"}%= * Example: To get =%WEBBGCOLOR%= of the %MAINWEB% web write =%VAR{"WEBBGCOLOR" web="%MAINWEB%"}%=, which expands to =%VAR{"WEBBGCOLOR" web="%MAINWEB%"}%= * Related: [[#VarWEBPREFSTOPIC][WEBPREFSTOPIC]] #VarWEB ---+++ WEB -- name of current web * Syntax: =%WEB%= * Expands to: =%WEB%= * Related: [[#VarBASEWEB][BASEWEB]], [[#VarINCLUDINGWEB][INCLUDINGWEB]], [[#VarTOPIC][TOPIC]] #VarWEBLIST ---+++ 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= to =marker= where web matches =selection=. * 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 matches =selection=, otherwise equals =""= | ="selected"= | | =selection="%WEB%"= | Current value to be selected in list | =section="%WEB%"= | * Example: =%WEBLIST{" * [[$name.%HOMETOPIC%]]"}%= creates a bullet list of all webs. * Example: =%WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="%WEB%" separator=" "}%= Dropdown of all public Webs + Trash Web, current Web highlighted. * Related: [[#VarTOPICLIST][TOPICLIST]], [[#VarSEARCH][SEARCH]] #VarWEBPREFSTOPIC ---+++ WEBPREFSTOPIC -- name of web preferences topic * Syntax: =%WEBPREFSTOPIC%= * Expands to: =%WEBPREFSTOPIC%=, renders as [[%WEBPREFSTOPIC%]] * Related: [[#VarHOMETOPIC][HOMETOPIC]], [[#VarWIKIPREFSTOPIC][WIKIPREFSTOPIC]], [[#VarVAR][VAR]] #VarWIKIHOMEURL ---+++ WIKIHOMEURL -- site home URL * The base URL of %WIKITOOLNAME%, is the link of the Home icon in the upper left corner, defined in TWiki.cfg * Syntax: =%WIKIHOMEURL%= * Expands to: =%WIKIHOMEURL%= * Related: [[#VarWIKITOOLNAME][WIKITOOLNAME]] #VarWIKINAME ---+++ WIKINAME -- your Wiki username * The WikiName is the same as %USERNAME% if not defined in the %MAINWEB%.%WIKIUSERSTOPIC% topic * Syntax: =%WIKINAME%= * Expands to: =%WIKINAME%= * Related: [[#VarREMOTEUSER][REMOTE_USER]], [[#VarUSERNAME][USERNAME]], [[#VarWIKIUSERNAME][WIKIUSERNAME]], [[#VarWIKIUSERSTOPIC][WIKIUSERSTOPIC]] #VarWIKIPREFSTOPIC ---+++ WIKIPREFSTOPIC -- name of site-wide preferences topic * Syntax: =%WIKIPREFSTOPIC%= * Expands to: =%WIKIPREFSTOPIC%=, renders as [[%WIKIPREFSTOPIC%]] * Related: [[#VarHOMETOPIC][HOMETOPIC]], [[#VarWEBPREFSTOPIC][WEBPREFSTOPIC]] #VarWIKITOOLNAME ---+++ WIKITOOLNAME -- name of your TWiki site * Syntax: =%WIKITOOLNAME%= * Expands to: =%WIKITOOLNAME%= * Related: [[#VarWIKIHOMEURL][WIKIHOMEURL]], [[#VarWIKIVERSION][WIKIVERSION]] #VarWIKIUSERNAME ---+++ WIKIUSERNAME -- your Wiki username with web prefix * Your %WIKINAME% with %MAINWEB% web prefix, useful to point to your %WIKITOOLNAME% home page * Syntax: =%WIKIUSERNAME%= * Expands to: =%WIKIUSERNAME%=, renders as %WIKIUSERNAME% * Related: [[#VarREMOTEUSER][REMOTE_USER]], [[#VarUSERNAME][USERNAME]], [[#VarWIKINAME][WIKINAME]] #VarWIKIUSERSTOPIC ---+++ WIKIUSERSTOPIC -- name of topic listing all registers users * Syntax: =%WIKIUSERSTOPIC%= * Expands to: =%WIKIUSERSTOPIC%=, with %MAINWEB% prefix renders as %MAINWEB%.%WIKIUSERSTOPIC% * Related: [[#VarWIKIUSERNAME][WIKIUSERNAME]] #VarWIKIVERSION ---+++ WIKIVERSION -- the version of the installed TWiki engine * Syntax: =%WIKIVERSION%= * Expands to: =%WIKIVERSION%= * Related: [[#VarPLUGINVERSION][PLUGINVERSION]], [[#VarWIKITOOLNAME][WIKITOOLNAME]] %STOPINCLUDE% -- TWiki:Main.PeterThoeny - 14 Aug 2004