head	1.2;
access;
symbols;
locks; strict;
comment	@# @;


1.2
date	2006.01.31.11.11.37;	author TWikiContributor;	state Exp;
branches;
next	1.1;

1.1
date	2004.08.14.07.54.31;	author PeterThoeny;	state Exp;
branches;
next	;


desc
@none
@


1.2
log
@buildrelease
@
text
@%META:TOPICINFO{author="TWikiContributor" date="1130377817" format="1.1" version="2"}%
%META:TOPICPARENT{name="TWikiVariables"}%
__Note:__ This topic is included by TWikiVariables

-----
%STARTSECTION{type="include"}%
#VarNOP
---+++ NOP -- template text not to be expanded in instantiated topics
	* Syntax: =%<nop>NOP%=
		* In normal topic text, expands to &lt;nop>, which prevents expansion of adjacent variables and wikiwords
		* When the topic containing this is used as a template for another topic, it is removed.
	* Syntax: =%<nop>NOP{...}%= *deprecated*
		* In normal topic text, expands to whatever is in the curly braces (if anything).
		* __%X% Note:__ This is deprecated. Do not use it. Use =%<nop>STARTSECTION{type="templateonly"}%= .. =%<nop>ENDSECTION{type="templateonly"}%= instead (see TWikiTemplates for more details).
	* Related: [[#VarSTARTSECTION][STARTSECTION]], TWikiTemplates

#VarNOTIFYTOPIC
---+++ NOTIFYTOPIC -- name of the notify topic
	* Syntax: =%<nop>NOTIFYTOPIC%=
	* Expands to: =%NOTIFYTOPIC%=, renders as [[%NOTIFYTOPIC%]]
	* Related: [[#VarHOMETOPIC][HOMETOPIC]], [[#VarSTATISTICSTOPIC][STATISTICSTOPIC]], [[#VarTOPIC][TOPIC]]

#VarPLUGINDESCRIPTIONS
---+++ PLUGINDESCRIPTIONS -- list of plugin descriptions
	* Syntax: =%<nop>PLUGINDESCRIPTIONS%=
	* Expands to: %PLUGINDESCRIPTIONS%
	* Related: [[#VarACTIVATEDPLUGINS][ACTIVATEDPLUGINS]], [[#VarFAILEDPLUGINS][FAILEDPLUGINS]], [[#VarPLUGINVERSION2][PLUGINVERSION]]

#VarPLUGINVERSION
---+++ PLUGINVERSION -- the version of a TWiki Plugin, or the TWiki Plugins API
	* Syntax: =%<nop>PLUGINVERSION{"name"}%= to get the version of a specific plugin
	* Example: =%<nop>PLUGINVERSION{"InterwikiPlugin"}%= expands to =%PLUGINVERSION{"InterwikiPlugin"}%=
	* Syntax: =%<nop>PLUGINVERSION%= to get the version of the API
	* Expands to: =%PLUGINVERSION%=
	* Related: [[#VarWIKIVERSION][WIKIVERSION]], [[#VarACTIVATEDPLUGINS][ACTIVATEDPLUGINS]], [[#FAILEDPLUGINS][FAILEDPLUGINS]], [[#VarPLUGINDESCRIPTIONS][PLUGINDESCRIPTIONS]]

#VarPUBURL
---+++ PUBURL -- the base URL of attachments
	* Syntax: =%<nop>PUBURL%=
	* Expands to: =%PUBURL%=
	* Example: You can refer to a file attached to another topic with =%<nop>PUBURL%/%<nop>WEB%/OtherTopic/image.gif=
	* Related: [[#VarATTACHURL][ATTACHURL]], [[#VarPUBURLPATH][PUBURLPATH]], [[#VarSCRIPTURL][SCRIPTURL]], [[#VarSCRIPTURL][SCRIPTURLPATH]], FileAttachments

#VarPUBURLPATH
---+++ PUBURLPATH -- the base URL path of attachments
	* Syntax: =%<nop>PUBURLPATH%=
	* Expands to: =%PUBURLPATH%=
	* Related: [[#VarATTACHURL][ATTACHURL]], [[#VarPUBURL][PUBURL]], [[#VarSCRIPTURL][SCRIPTURL]], [[#VarSCRIPTURL][SCRIPTURLPATH]], FileAttachments

#VarQUERYSTRING
---+++ QUERYSTRING -- full, unprocessed string of parameters to this URL
	* String of all the URL parameters that were on the URL used to get to the current page. For example, if you add [[%SCRIPTURLPATH{"view"}%/%WEB%/%INCLUDINGTOPIC%?name=Samantha;age=24;eyes=blue#VarQUERYSTRING][?name=Samantha;age=24;eyes=blue]] to this URL you can see this in action. This string can be appended to a URL to pass parameter values on to another page.
	* __%X% Note:__ URLs built this way are typically restricted in length, typically to 2048 characters. If you need more space than this, you will need to use an HTML form and =%<nop>URLPARAM{}%=.
	* Syntax: =%<nop>QUERYSTRING%=
	* Expands to: <code> %QUERYSTRING% </code>
	* Related: [[#VarURLPARAM][URLPARAM]]
 
#VarREMOTEADDR
---+++ REMOTE_ADDR -- environment variable
	* Syntax: =%<nop>REMOTE_ADDR%=
	* Expands to: =%REMOTE_ADDR%=
	* Related: [[#VarHTTPHOST][HTTP_HOST]], [[#VarREMOTEPORT][REMOTE_PORT]], [[#VarREMOTEUSER][REMOTE_USER]]

#VarREMOTEPORT
---+++ REMOTE_PORT -- environment variable
	* Syntax: =%<nop>REMOTE_PORT%=
	* Expands to: <code>%REMOTE_PORT%</code>
	* Related: [[#VarHTTPHOST][HTTP_HOST]], [[#VarREMOTEADDR][REMOTE_ADDR]], [[#VarREMOTEUSER][REMOTE_USER]]

#VarREMOTEUSER
---+++ REMOTE_USER -- environment variable
	* Syntax: =%<nop>REMOTE_USER%=
	* Expands to: <code>%REMOTE_USER%</code>
	* Related: [[#VarHTTPHOST][HTTP_HOST]], [[#VarREMOTEADDR][REMOTE_ADDR]], [[#VarREMOTEPORT][REMOTE_PORT]], [[#VarUSERNAME][USERNAME]], [[#VarWIKINAME][WIKINAME]], [[#VarWIKIUSERNAME][WIKIUSERNAME]]

#VarREVINFO
---+++ REVINFO -- revision information of current topic
	* Syntax: =%<nop>REVINFO%=
	* Expands to: <code>%REVINFO%</code>
	* Related: [[#VarREVINFO2][REVINFO{"format"}]]

#VarREVINFO2
---+++ REVINFO{"format"} -- formatted revision information of topic
	* Syntax: =%<nop>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= | <nop>WikiName with %MAINWEB% web prefix | =%MAINWEB%.JohnSmith= |
	* Example: =%<nop>REVINFO{"$date - $wikiusername" rev="1.1"}%= returns revision info of first revision
	* Related: [[#VarREVINFO][REVINFO]]

#VarSCRIPTNAME
---+++ SCRIPTNAME -- name of current script
	* The name of the current script is shown, including script suffix, if any (for example =viewauth.cgi=)
	* Syntax: =%<nop>SCRIPTNAME%=
	* Expands to: =%SCRIPTNAME%=
	* Related: [[#VarSCRIPTSUFFIX][SCRIPTSUFFIX]], [[#VarSCRIPTURL][SCRIPTURL]], [[#VarSCRIPTURLPATH][SCRIPTURLPATH]]

#VarSCRIPTSUFFIX
---+++ SCRIPTSUFFIX -- script suffix
	* Some <nop>%WIKITOOLNAME% installations require a file extension for CGI scripts, such as =.pl= or =.cgi=
	* Syntax: =%<nop>SCRIPTSUFFIX%=
	* Expands to: <code>%SCRIPTSUFFIX%</code>
	* Related: [[#VarSCRIPTNAME][SCRIPTNAME]], [[#VarSCRIPTURL][SCRIPTURL]], [[#VarSCRIPTURLPATH][SCRIPTURLPATH]]

#VarSCRIPTURL
---+++ SCRIPTURL -- base URL of TWiki scripts
	* Syntax: =%<nop>SCRIPTURL%=
	* Expands to: =%SCRIPTURL%=
	* Related: [[#VarPUBURL][PUBURL]], [[#VarSCRIPTNAME][SCRIPTNAME]], [[#VarSCRIPTSUFFIX][SCRIPTSUFFIX]], [[#VarSCRIPTURL2][SCRIPTURL{"script"}]], [[#VarSCRIPTURLPATH][SCRIPTURLPATH]]

#VarSCRIPTURL2
---+++ SCRIPTURL{"script"} -- URL of TWiki script
	* Syntax: =%<nop>SCRIPTURL{"script"}%=
	* Expands to: =%SCRIPTURL{"script"}%=
	* Example: To get the authenticated version of the current topic you can write  =%<nop>SCRIPTURL{"viewauth"}%/%<nop>WEB%/%<nop>TOPIC%= which expands to =%SCRIPTURL{"viewauth"}%/%WEB%/%INCLUDINGTOPIC%=
	* __%X% Note:__ In most cases you should use =%<nop>SCRIPTURLPATH{"script"}%= instead, as it works with URL rewriting much better
	* Related: [[#VarPUBURL][PUBURL]], [[#VarSCRIPTNAME][SCRIPTNAME]], [[#VarSCRIPTSUFFIX][SCRIPTSUFFIX]], [[#VarSCRIPTURL][SCRIPTURL]], [[#VarSCRIPTURLPATH][SCRIPTURLPATH]], [[#VarSCRIPTURLPATH2][SCRIPTURLPATH{"script"}]]

#VarSCRIPTURLPATH
---+++ SCRIPTURLPATH -- base URL path of TWiki scripts
	* As =%<nop>SCRIPTURL%=, but doesn't include the protocol and host part of the URL
	* Syntax: =%<nop>SCRIPTURLPATH%=
	* Expands to: =%SCRIPTURLPATH%=
	* Related: [[#VarPUBURLPATH][PUBURLPATH]], [[#VarSCRIPTNAME][SCRIPTNAME]], [[#VarSCRIPTSUFFIX][SCRIPTSUFFIX]], [[#VarSCRIPTURL][SCRIPTURL]], [[#VarSCRIPTURLPATH2][SCRIPTURLPATH{"script"}]]

#VarSCRIPTURLPATH2
---+++ SCRIPTURLPATH{"script"} -- URL path of TWiki script
	* As =%<nop>SCRIPTURL{"script"}%=, but doesn't include the protocol and host part of the URL
	* Syntax: =%<nop>SCRIPTURLPATH{"script"}%=
	* Expands to: =%SCRIPTURLPATH{"script"}%=
	* Related: [[#VarPUBURLPATH][PUBURLPATH]], [[#VarSCRIPTNAME][SCRIPTNAME]], [[#VarSCRIPTSUFFIX][SCRIPTSUFFIX]], [[#VarSCRIPTURL][SCRIPTURL]], [[#VarSCRIPTURL2][SCRIPTURL{"script"}]], [[#VarSCRIPTURLPATH][SCRIPTURLPATH]]

#VarSEARCH
---+++ SEARCH{"text"} -- search content
	* Inline search, shows a search result embedded in a topic
	* Syntax: =%<nop>SEARCH{"text" ...}%=
	* Supported parameters:
	  | *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"= <br /> =web="%MAINWEB%, Know"= <br /> =web="all"= | Comma-separated list of webs to search. The special word =all= means all webs that doe *not* have the =NOSEARCHALL= variable set to =on= in their %WEBPREFSTOPIC%. You can specifically *exclude* webs from an =all= search using a minus sign - for example, =web="all,-Secretweb"=. | Current web |
	  | =topic="%WEBPREFSTOPIC%"= <br /> =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*"= <br /> =excludetopic="%HOMETOPIC%, <nop>WebChanges"= | Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. | None |
	  | =type="keyword"= <br /> =type="literal"= <br /> =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= | =%<nop>SEARCHVAR- DEFAULTTYPE%= [[TWikiPreferences][preferences]] setting (%SEARCHVARDEFAULTTYPE%) |
	  | =scope="topic"= <br /> =scope="text"= <br /> =scope="all"= | Search topic name (title); the text (body) of topic; or all (both) | ="text"= |
	  | =order="topic"= <br /> =order="created"= <br />  =order="modified"= <br /> =order="editby"= <br /> =order=<br />&nbsp;"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; if you want to sort across webs, create a [[FormattedSearch][formatted]] table and sort it with TablePlugin's initsort. Note that dates are sorted most recent date *last* (i.e at the bottom of the table). | Sort by topic name |
	  | =limit="all"= <br /> =limit="16"= | Limit the number of results returned. This is done after sorting if =order= is specified | All results |
	  | =date="..."= | limits the results to those pages with latest edit time in the given TimeInterval.  | All results |
	  | =reverse="on"= | Reverse the direction of the search | Ascending search |
	  | =casesensitive="on"= | Case sensitive search | Ignore case |
	  | =bookview="on"= | BookView search, e.g. show complete topic text | Show topic summary |
	  | =nonoise="on"= | Shorthand for =nosummary="on" nosearch="on" nototal="on" zeroresults="off" noheader="on" noempty="on"= | Off |
	  | =nosummary="on"= | Show topic title only | Show topic summary |
	  | =nosearch="on"= | Suppress search string | Show search string |
	  | =noheader="on"= | Suppress search header <br /> <span style='background: #FFB0B0;'> *Topics: Changed: By:* </span> | Show search header, unless seach is inline and a format is specified (Cairo compatibility) |
	  | =nototal="on"= | Do not show number of topics found | Show number |
	  | =zeroresults="off"= | Suppress all output if there are no hits | =zeroresults="on"=, displays: "Number of topics: 0" |
	  | =noempty="on"= | Suppress results for webs that have no hits. | Show webs with no hits |
	  | =header="..."= <br /> =format="..."= | Custom format results: see *[[FormattedSearch]]* for usage, variables &amp; 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 =%<nop>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 |
	  | =nofinalnewline="on"= | If =on=, the search variable does not end in a line by itself. Any text continuing immediately after the search variable on the same line will be rendered as part of the table generated by the search, if appropriate. | =off= |
	  | =recurse="on"= | Recurse into subwebs, if subwebs are enabled. | =off= |
	  | =separator=", "= | Line separator between hits | Newline ="$n"= |
	* Example: =%<nop>SEARCH{"wiki" web="%MAINWEB%" scope="topic"}%=
	* Example with format: =%<nop>SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="<nop>| $topic | $summary |"%= _(displays results in a table with header - [[FormattedSearch][details]])_
	* %H% Hint: If the TWiki:Plugins.TablePlugin is installed, you may set a =%<nop>TABLE{}%= variable just before the =%<nop>SEARCH{}%= to alter the output of a search.  Example: =%<nop>TABLE{ tablewidth="90%" }%=
	* Related: [[#VarMETASEARCH][METASEARCH]], [[#VarTOPICLIST][TOPICLIST]], [[#VarWEBLIST][WEBLIST]], FormattedSearch

#VarSERVERTIME
---+++ SERVERTIME -- server time
	* Syntax: =%<nop>SERVERTIME%=
	* Expands to: =%SERVERTIME%=
	* __%X% Note:__ When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
	* Related: [[#VarDISPLAYTIME][DISPLAYTIME]], [[#VarGMTIME][GMTIME]], [[#VarSERVERTIME2][SERVERTIME{"format"}]]

#VarSERVERTIME2
---+++ SERVERTIME{"format"} -- formatted server time
	* Same format qualifiers as =%<nop>GMTIME%=
	* Syntax: =%<nop>SERVERTIME{"format"}%=
	* Example: =%<nop>SERVERTIME{"$hou:$min"}%= expands to =%SERVERTIME{"$hou:$min"}%=
	* __%X% Note:__ When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
	* Related: [[#VarDISPLAYTIME][DISPLAYTIME]], [[#VarGMTIME][GMTIME]], [[#VarSERVERTIME][SERVERTIME]]

#VarSESSIONVARIABLE
---+++ SESSION_VARIABLE -- get, set or clear a session variable
	* Syntax: =%<nop>SESSION_VARIABLE{"name"}%=
	* Syntax: =%<nop>SESSION_VARIABLE{"name" set="value"}%=
	* Syntax: =%<nop>SESSION_VARIABLE{"name" clear=""}%=
	* %H% Hint: The users ID is in the =AUTHUSER= session variable, and is read-only
	* Related: TWikiUserAuthentication, [[#VarAUTHREALM][AUTHREALM]], [[#VarSESSIONID][SESSIONID]], [[#VarSESSIONVAR][SESSIONVAR]], [[#VarLOGIN][LOGIN]], [[#VarLOGOUT][LOGOUT]]

#VarSESSIONID
---+++ SESSIONID -- unique ID for this session
	* Syntax: =%<nop>SESSIONID%=
	* Expand to: <tt>%SESSIONID%</tt>
	* Related: TWikiUserAuthentication, [[#VarAUTHREALM][AUTHREALM]], [[#VarSESSIONVAR][SESSIONVAR]], [[#VarLOGIN][LOGIN]], [[#VarLOGOUT][LOGOUT]], [[#VarSESSION_VARIABLE][SESSION_VARIABLE]]

#VarSESSIONVAR
---+++ SESSIONVAR -- name of CGI and session variable that stores the session ID
	* Syntax: =%<nop>SESSIONVAR%=
	* Expand to: <tt>%SESSIONVAR%</tt>
	* Related: TWikiUserAuthentication, [[#VarAUTHREALM][AUTHREALM]], [[#VarSESSIONID][SESSIONID]], [[#VarLOGIN][LOGIN]], [[#VarLOGOUT][LOGOUT]], [[#VarSESSION_VARIABLE][SESSION_VARIABLE]]

#VarSPACEDTOPIC
---+++ SPACEDTOPIC -- topic name, spaced and URL-encoded *deprecated*
	* The current topic name with added URL-encoded spaces, for use in regular expressions that search for backlinks to the current topic
	* Syntax: =%<nop>SPACEDTOPIC%=
	* Expands to: =%SPACEDTOPIC%=
	* __%X% Note:__ This is a deprecated variable. It can be duplicated with =%<nop>ENCODE{%<nop>SPACEOUT{"%<nop>TOPIC%" separator=" *"}%}%=
	* Related: [[#VarSPACEOUT][SPACEOUT]], [[#VarTOPIC][TOPIC]], [[#VarENCODE][ENCODE]]

#VarSPACEOUT
---+++ SPACEOUT{"string"} -- renders string with spaces inserted in sensible places
	* Inserts spaces after lower case letters that are followed by a digit or a capital letter, and after digits that are followed by a capital letter.
	* Useful for spacing out WikiWords
	* Syntax: =%<nop>SPACEOUT{ "%<nop>TOPIC%" }%=
	* Expands to: =%SPACEOUT{ "%INCLUDINGTOPIC%" }%=
	* Supported parameters:
	  | *Parameter:* | *Description:* | *Default:* |
	  | =separator= | The separator to put between words e.g. %<nop>SPACEOUT{"DogsCatsBudgies" separator=", "}% -> %SPACEOUT{"DogsCatsBudgies" separator=", "}% | ' ' |
	* %T% Hint: Spaced out !WikiWords are not automatically linked. To SPACEOUT a !WikiWord but preserve the link use "double bracket" format. For example, =[<nop>[WebHome][%<nop>SPACEOUT{"Web<nop>Home"}%]]= expands to [[WebHome][%SPACEOUT{"WebHome"}%]]
	* Related: [[#VarSPACEDTOPIC][SPACEDTOPIC]], [[SpreadSheetPlugin#FuncPROPERSPACE][$PROPERSPACE()]] of SpreadSheetPlugin

#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 =%<nop>STOPINCLUDE%= variable. A normal view of the topic shows everything exept the =%<nop>STARTINCLUDE%= variable itself.
	* __Note:__ If you want more than one part of the topic included, use =%<nop>STARTSECTION{type="include"}%= instead
	* Syntax: =%<nop>STARTINCLUDE%=
	* Related: [[#VarINCLUDE][INCLUDE]], [[#VarSTARTSECTION][STARTSECTION]], [[#VarSTOPINCLUDE][STOPINCLUDE]]

#VarSTARTSECTION
---+++ STARTSECTION -- marks the start of a section within a topic
	* Section boundaries are defined with =%<nop>STARTSECTION%= and =%<nop>ENDSECTION%=.
	* Syntax: =%<nop>STARTSECTION%=
	* Syntax: =%<nop>STARTSECTION{ _parameters_ }%=
	* Supported parameters:
	  | *Parameter:* | *Description:* | *Default* |
	  | ="name"= | Name of the section. Must be unique inside a topic. | Generated name |
	  | =type="type"= | Type of the section. | =section= |
	* Sections may be given a name to help identify them, and/or a type, which changes how they are used.
		* =type="section"= - the default, used for a generic section, such as a named section used by [[#VarINCLUDE][INCLUDE]]..
		* =type="include"= - like =%<nop>STARTINCLUDE%= ... =%<nop>STOPINCLUDE%= except that you can have as many include blocks as you want (=%<nop>STARTINCLUDE%= is restricted to only one).
		* =type="templateonly"= - start position of text to be removed when a template topic is used. This is used to embed text that you _do not_ want expanded when a new topic based on the template topic is created. See TWikiTemplates for more information.
	* If a section is not given a name, it will be assigned one. Unnamed sections are assigned names starting with =_SECTION0= for the first unnamed section in the topic, =_SECTION1= for the second, etc..
	* You can define a section inside another section, or overlap sections freely. Use named sections to make sure that the correct START and ENDs are matched. Section markers are *not* displayed when a topic is viewed.
	* Related: [[#VarENDSECTION][ENDSECTION]], [[#VarINCLUDE][INCLUDE]], [[#VarSTARTINCLUDE][STARTINCLUDE]], [[#VarSTOPINCLUDE][STOPINCLUDE]]

#VarSTATISTICSTOPIC
---+++ STATISTICSTOPIC -- name of statistics topic
	* Syntax: =%<nop>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 =%<nop>STOPINCLUDE%= variable itself.
	* Syntax: =%<nop>STOPINCLUDE%=
	* Related: [[#VarINCLUDE][INCLUDE]], [[#VarSTARTINCLUDE][STARTINCLUDE]]

#VarTOC
---+++ TOC -- table of contents of current topic
	* Syntax: =%<nop>TOC%=
	* Related: [[#VarTOC2][TOC{"Topic"}]]

#VarTOC2
---+++ TOC{"Topic"} -- table of contents
	* Syntax: =%<nop>TOC{"SomeTopic" ...}%=
	* Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax (="---++ text"=) and HTML (="&lt;h2&gt;text&lt;/h2&gt;"=) 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: =%<nop>TOC{depth="2"}%=
	* Example: =%<nop>TOC{"TWikiDocumentation" web="%TWIKIWEB%" title="Contents:"}%=
	* Example: see TWiki:Sandbox.TestTopicInclude
	* %T% Hint: TOC will generate links to the headings, so when a reader clicks on a heading it will jump straight where that heading is anchored in the text. If you have two headings with exactly the same text, then their anchors will also be identical and they won't be able to jump to them. To make the anchors unique, you can add an invisible HTML comment to the text of the heading. This will be hidden in normal view, but will force the anchors to be different. For example, <tt>---+ Heading &lt;!--5--&gt;</tt>.
	* Related: [[#VarTOC][TOC]]

#VarTOPIC
---+++ TOPIC -- name of current topic
	* Syntax: =%<nop>TOPIC%=
	* Expands to: =%INCLUDINGTOPIC%=, renders as [[%INCLUDINGTOPIC%]]
	* Related: [[#VarBASETOPIC][BASETOPIC]], [[#VarINCLUDINGTOPIC][INCLUDINGTOPIC]], [[#VarTOPICLIST][TOPICLIST]], [[#VarWEB][WEB]]

#VarTOPICLIST
---+++ TOPICLIST{"format"} -- topic index of a web
	* List of all topics in a web. The "format" defines the format of one topic item. It may include variables: The =$name= variable gets expanded to the topic name, =$qname= to double quoted name, =$marker= to =marker= parameter where topic matches =selection=, and =$web= to the name of the web.
	* Syntax: =%<nop>TOPICLIST{"format" ...}%=
	* Supported parameters:
	  | *Parameter:* | *Description:* | *Default:* |
	  | ="format"= | Format of one line, may include =$web= (name of web), =$name= (name of the topic), =$qname= (name of topic in double quotes), =$marker= (which expands to =marker= for the item matching =selection= only) | ="$name"= |
	  | =format="format"= | (Alternative to above) | ="$name"= |
	  | =separator=", "= | line separator | ="$n"= (new line) |
	  | =marker="selected"= | Text for =$marker= if the item matches =selection= | ="selected"= |
	  | =selection="TopicA, !TopicB"= | Current value to be selected in list | =(none)= |
	  | =web="Name"= | Name of web | Current web |
	* Example: =%<nop>TOPICLIST{"	* $web.$name"}%= creates a bullet list of all topics
	* Example: =%<nop>TOPICLIST{separator=", "}%= creates a comma separated list of all topics
	* Example: =%<nop>TOPICLIST{" &lt;option&gt;$name&lt;/option&gt;"}%= 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 <nop>%WIKITOOLNAME%
	* Syntax: =%<nop>TWIKIWEB%=
	* Expands to: =%TWIKIWEB%=
	* Related: [[#VarMAINWEB][MAINWEB]]

#VarURLPARAM
---+++ URLPARAM{"name"} -- get value of a URL parameter
	* Returns the value of a URL parameter.
	* Syntax: =%<nop>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="&lt;br /&gt;"= | Convert newlines in textarea to other delimiters | no conversion |
	  | =encode="entity"= | Encode special characters into HTML entities. See [[#VarENCODE][ENCODE]] for more details. | no encoding |
	  | =encode="url"= | Encode special characters for URL parameter use, like a double quote into =%22= | no encoding |
	  | =multiple="on"= %BR% =multiple="[<nop>[$item]]"= | If set, gets all selected elements of a =&lt;select multiple="multiple"&gt;= 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: =%<nop>URLPARAM{"skin"}%= returns =print= for a =.../view/%WEB%/%INCLUDINGTOPIC%?skin=print= URL
	* __%X% Note:__ URL parameters passed into HTML form fields must be entity [[#VarENCODE][ENCODEd]]
	* __%X% Note:__ When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
	* __%X% Note:__ There is a risk that this variable could be misused for cross-site scripting.
	* Related: [[#VarENCODE][ENCODE]], [[#VarSEARCH][SEARCH]], FormattedSearch, [[#VarQUERYSTRING][QUERYSTRING]]

---+++ USERINFO - retrieve details about the logged in user
	* By default, the retrieved info will be formatted as a comma-separated list comprising the username, wikiusername, and emails.
	* Syntax: =%<nop>USERINFO%=
	* Expands to: =%USERINFO%=
	* you can also use the =format= parameter to get different formatted results:
	* Syntax: =%<nop>USERINFO{format="$username is really $wikiname"}%=
	* Expands to =%USERINFO{format="$username is really $wikiname"}%=
	* The tokens =$emails=, =$username=, =$wikiname=, =$wikiusername=, and =$groups= are available for use in the format string. 
	* Related: [[#VarUSERNAME][USERNAME]], [[#VarWIKINAME][WIKINAME]], [[#VarWIKIUSERNAME][WIKIUSERNAME]], TWikiUserAuthentication, ChangeEmailAddress

#VarUSERNAME
---+++ USERNAME -- your login username
	* TWiki makes names available in three formats: USERNAME like =jsmith=, WIKINAME like =JohnSmith= and WIKIUSERNAME like =%MAINWEB%.JohnSmith=. Un-authenticated users are all %MAINWEB%.TWikiGuest.
	* Syntax: =%<nop>USERNAME%=
	* Expands to: =%USERNAME%=
	* __%X% Note:__ When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
	* Related: [[#VarREMOTEUSER][REMOTE_USER]], [[#VarUSERINFO][USERINFO]], [[#VarWIKINAME][WIKINAME]], [[#VarWIKIUSERNAME][WIKIUSERNAME]], TWikiUserAuthentication

#VarUSERLANGUAGE
---+++ USERLANGUAGE -- current user's language
	* Returns the language code for the language used as the current user. This is the language actually used by TWiki Internationalization (e.g. in user interface).
	* The language is detected from the user's browser, unless some site/web/user/session-defined setting overrides it:
		* Is the =LANGUAGE= preference is set, it's used as user's language instead of any language detected from the browser.
		* Avoid to define it =LANGUAGE= at a non per-user way, so each user can choose his/her preferred language.
	* Related: [[#VarLANGUAGES][LANGUAGES]]

#VarVAR
---+++ VAR{"NAME" web="Web"} -- get a preference value from another web 
	* Syntax: =%<nop>VAR{"NAME" web="Web"}%=
	* Example: To get =%<nop>WEBBGCOLOR%= of the %MAINWEB% web write =%<nop>VAR{"WEBBGCOLOR" web="%MAINWEB%"}%=, which expands to =%VAR{"WEBBGCOLOR" web="%MAINWEB%"}%=
	* Related: [[#VarWEBPREFSTOPIC][WEBPREFSTOPIC]]

#VarWEB
---+++ WEB -- name of current web
	* Syntax: =%<nop>WEB%=
	* Expands to: =<nop>%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: =%<nop>WEBLIST{"format" ...}%=
	* Supported parameters:
	  | *Parameter:* | *Description:* | *Default:* |
	  | ="format"= | Format of one line, may include =$name= (the name of the web), $qname (the name of the web in double quotes), =$indentedname= (the name of the web with parent web names replaced by indents, for use in indented lists), and =$marker= (which expands to =marker= for the item matching =selection= only) | ="$name"= |
	  | =format="format"= | (Alternative to above) | ="$name"= |
	  | =separator=", "= | line separator | ="$n"= (new line) |
	  | =webs="public"=	| comma separated list of webs, =public= expands to all non-hidden | ="public"= |
	  | =marker="selected"= | Text for =$marker= if the item matches =selection= | ="selected"= |
	  | =selection="%<nop>WEB%"= | Current value to be selected in list | =section="%<nop>WEB%"= |
	* Example: =%<nop>WEBLIST{"	* [<nop>[$name.%HOMETOPIC%]]"}%= creates a bullet list of all webs.
	* Example: =%<nop>WEBLIST{"&lt;option $marker value=$qname&gt;$name&lt;/option&gt;" webs="Trash, public" selection="%WEB%" separator=" "}%= creates a dropdown of all public webs + Trash web, with the current web highlighted.
	* Related: [[#VarTOPICLIST][TOPICLIST]], [[#VarSEARCH][SEARCH]]

#VarWEBPREFSTOPIC
---+++ WEBPREFSTOPIC -- name of web preferences topic
	* Syntax: =%<nop>WEBPREFSTOPIC%=
	* Expands to: =%WEBPREFSTOPIC%=, renders as [[%WEBPREFSTOPIC%]]
	* Related: [[#VarHOMETOPIC][HOMETOPIC]], [[#VarWIKIPREFSTOPIC][WIKIPREFSTOPIC]], [[#VarVAR][VAR]]

#VarWIKIHOMEURL
---+++ WIKIHOMEURL -- site home URL *deprecated*
	* __%X% Note:__ use =%<nop>WIKILOGOURL%= defined in WebPreferences instead.

#VarWIKINAME
---+++ WIKINAME -- your Wiki username
	* The WikiName is the same as =%<nop>USERNAME%= if not defined in the %MAINWEB%.%WIKIUSERSTOPIC% topic
	* Syntax: =%<nop>WIKINAME%=
	* Expands to: =%WIKINAME%=
	* __%X% Note:__ When used in a template topic, this variable will be expanded when the template is used to create  new topic. See TWikiTemplates#TemplateTopicsVars for details.
	* Related: [[#VarREMOTEUSER][REMOTE_USER]], [[#VarUSERINFO][USERINFO]], [[#VarUSERNAME][USERNAME]], [[#VarWIKIUSERNAME][WIKIUSERNAME]], [[#VarWIKIUSERSTOPIC][WIKIUSERSTOPIC]]

#VarWIKIPREFSTOPIC
---+++ WIKIPREFSTOPIC -- name of site-wide preferences topic
	* Syntax: =%<nop>WIKIPREFSTOPIC%=
	* Expands to: =%WIKIPREFSTOPIC%=, renders as [[%WIKIPREFSTOPIC%]]
	* Related: [[#VarHOMETOPIC][HOMETOPIC]], [[#VarWEBPREFSTOPIC][WEBPREFSTOPIC]]

#VarWIKITOOLNAME
---+++ WIKITOOLNAME -- name of your TWiki site
	* Syntax: =%<nop>WIKITOOLNAME%=
	* Expands to: =%WIKITOOLNAME%=
	* Related: [[#VarWIKIHOMEURL][WIKIHOMEURL]], [[#VarWIKIVERSION][WIKIVERSION]]

#VarWIKIUSERNAME
---+++ WIKIUSERNAME -- your Wiki username with web prefix
	* Your %<nop>WIKINAME% with %MAINWEB% web prefix, useful to point to your <nop>%WIKITOOLNAME% home page
	* Syntax: =%<nop>WIKIUSERNAME%=
	* Expands to: =%WIKIUSERNAME%=, renders as %WIKIUSERNAME%
	* __%X% Note:__ When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details
	* Related: [[#VarREMOTEUSER][REMOTE_USER]], [[#VarUSERINFO][USERINFO]], [[#VarUSERNAME][USERNAME]], [[#VarWIKINAME][WIKINAME]]

#VarWIKIUSERSTOPIC
---+++ WIKIUSERSTOPIC -- name of topic listing all registers users
	* Syntax: =%<nop>WIKIUSERSTOPIC%=
	* Expands to: =%WIKIUSERSTOPIC%=, with %MAINWEB% prefix renders as %MAINWEB%.%WIKIUSERSTOPIC%
	* Related: [[#VarWIKIUSERNAME][WIKIUSERNAME]]

#VarWIKIVERSION
---+++ WIKIVERSION -- the version of the installed TWiki engine
	* Syntax: =%<nop>WIKIVERSION%=
	* Expands to: =%WIKIVERSION%=
	* Related: [[#VarPLUGINVERSION][PLUGINVERSION]], [[#VarWIKITOOLNAME][WIKITOOLNAME]]
%ENDSECTION{type="include"}%


__Related Topics:__ UserDocumentationCategory
@


1.1
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1092470071" format="1.0" version="1.1"}%
d6 11
a16 1
%STARTINCLUDE%
d23 6
d30 6
a35 11
---+++ PLUGINVERSION -- the version of the TWiki Plugin API
	* This is the =$TWiki::Plugins::VERSION= number, also indicating the version of the TWikiFuncModule
	* Syntax: =%<nop>PLUGINVERSION{}%=
	* Expands to: =%PLUGINVERSION{}%=
	* Related: [[#VarPLUGINVERSION2][PLUGINVERSION{"name"}]], [[#VarWIKIVERSION][WIKIVERSION]]

#VarPLUGINVERSION2
---+++ PLUGINVERSION{"name"} -- the version of an installed Plugin
	* Syntax: =%<nop>PLUGINVERSION{"name"}%=
	* Example: =%<nop>PLUGINVERSION{"DefaultPlugin"}%= expands to =%PLUGINVERSION{"DefaultPlugin"}%=
	* Related: [[#VarPLUGINVERSION][PLUGINVERSION]], [[#VarWIKIVERSION][WIKIVERSION]]
d42 1
a42 1
	* Related: [[#VarATTACHURL][ATTACHURL]], [[#VarPUBURLPATH][PUBURLPATH]], [[#VarSCRIPTURL][SCRIPTURL]], FileAttachments
d48 1
a48 1
	* Related: [[#VarATTACHURL][ATTACHURL]], [[#VarPUBURL][PUBURL]], FileAttachments
d50 8
d103 14
d118 1
a118 1
---+++ SCRIPTURL -- script URL of %WIKITOOLNAME%
d121 9
a129 2
	* Example: To get the authenticated version of current topic write =%<nop>SCRIPTURL%/viewauth%<nop>SCRIPTSUFFIX%/%<nop>WEB%/%<nop>TOPIC%= which expands to =%SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC%=
	* Related: [[#VarPUBURL][PUBURL]], [[#VarSCRIPTSUFFIX][SCRIPTSUFFIX]], [[#VarSCRIPTURLPATH][SCRIPTURLPATH]]
d132 2
a133 1
---+++ SCRIPTURLPATH -- script URL path of %WIKITOOLNAME%
d136 1
a136 1
	* Related: [[#VarPUBURLPATH][PUBURLPATH]], [[#VarSCRIPTURL][SCRIPTURL]]
d138 6
a143 6
#VarSCRIPTSUFFIX
---+++ SCRIPTSUFFIX -- script suffix
	* Some %WIKITOOLNAME% installations require a file extension for CGI scripts like =.pl= or =.cgi=
	* Syntax: =%<nop>SCRIPTSUFFIX%=
	* Expands to: <code>%SCRIPTSUFFIX%</code>
	* Related: [[#VarSCRIPTURL][SCRIPTURL]]
d149 1
a149 1
	* Supported parameters: [1]
d153 1
a153 1
	  | =web="Name"= <br /> =web="%MAINWEB%, Know"= <br /> =web="all"= | Wiki web to search: A web, a list of webs separated by comma, or =all= webs. [2] | Current web |
d158 1
a158 1
	  | =order="topic"= <br /> =order="created"= <br />  =order="modified"= <br /> =order="editby"= <br /> =order=<br />&nbsp;"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 |
d160 1
d163 2
a165 1
	  | =bookview="on"= | BookView search, e.g. show complete topic text | Show topic summary |
d167 1
a167 1
	  | =noheader="on"= | Suppress search header <br /> <span style='background: #FFB0B0;'> *Topics: Changed: By:* </span> | Show search header |
d169 2
d174 2
d179 1
a179 1
	* %H% If the TWiki:Plugins.TablePlugin is installed, you may set a =%<nop>TABLE{}%= variable just before the =%<nop>SEARCH{}%= to alter the output of a search.  Example: =%<nop>TABLE{ tablewidth="90%" }%=
a181 3
	* [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%

d186 1
d194 1
d197 20
d218 2
a219 2
---+++ SPACEDTOPIC -- topic name, spaced and encoded
	* The current topic name with added spaces, for regular expression search of Ref-By
d222 14
a235 1
	* Related: [[#VarTOPIC][TOPIC]]
d239 2
a240 1
	* If present in included topic, start to include text from this location up to the end, or up to the location of the =%<nop>STOPINCLUDE%= variable. A normal view of the topic shows everyting exept the =%<nop>STARTINCLUDE%= variable itself.
d242 18
a259 1
	* Related: [[#VarINCLUDE][INCLUDE]], [[#VarSTOPINCLUDE][STOPINCLUDE]]
d276 1
a276 1
	* Related: [[#VarTOC2][TOC{"SomeTopic"}]]
d291 1
d297 1
a297 1
	* Expands to: =%TOPIC%=, renders as [[%TOPIC%]]
d302 1
a302 1
	* 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.
d305 7
a311 5
	 | *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 |
d319 1
a319 1
	* The web containing all documentation and site-wide preference settings for %WIKITOOLNAME%
d326 1
a326 1
	* Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting
d333 1
a333 1
	  | =encode="entity"= | Encode special characters into HTML entities, like a double quote into =&amp;#034;=. This is needed if text is put into an HTML form field | no encoding |
d337 15
a351 2
	* Example: =%<nop>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
d355 1
a355 1
	* 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
d358 10
a367 1
	* Related: [[#VarREMOTEUSER][REMOTE_USER]], [[#VarWIKINAME][WIKINAME]], [[#VarWIKIUSERNAME][WIKIUSERNAME]], TWikiUserAuthentication
d378 1
a378 1
	* Expands to: =%WEB%=
d383 1
a383 1
	* 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=.
d387 1
a387 1
	  | ="format"= | Format of one line, may include =$name= variable | ="$name"= |
d389 3
a391 3
	  | =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"= |
d394 1
a394 1
	* Example: =%<nop>WEBLIST{"&lt;option $marker value=$qname&gt;$name&lt;/option&gt;" webs="Trash,public" selection="%WEB%" separator=" "}%= Dropdown of all public Webs + Trash Web, current Web highlighted.
d404 2
a405 5
---+++ 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: =%<nop>WIKIHOMEURL%=
	* Expands to: =%WIKIHOMEURL%=
	* Related: [[#VarWIKITOOLNAME][WIKITOOLNAME]]
d409 1
a409 1
	* The WikiName is the same as %<nop>USERNAME% if not defined in the %MAINWEB%.%WIKIUSERSTOPIC% topic
d412 2
a413 1
	* Related: [[#VarREMOTEUSER][REMOTE_USER]], [[#VarUSERNAME][USERNAME]], [[#VarWIKIUSERNAME][WIKIUSERNAME]], [[#VarWIKIUSERSTOPIC][WIKIUSERSTOPIC]]
d429 1
a429 1
	* Your %<nop>WIKINAME% with %MAINWEB% web prefix, useful to point to your %WIKITOOLNAME% home page
d432 2
a433 1
	* Related: [[#VarREMOTEUSER][REMOTE_USER]], [[#VarUSERNAME][USERNAME]], [[#VarWIKINAME][WIKINAME]]
d446 1
a446 1
%STOPINCLUDE%
a447 1
-- TWiki:Main.PeterThoeny - 14 Aug 2004
d449 1
@
