NOP -- template text not to be expanded in instantiated topics

• Syntax: %NOP%
  • In normal topic text, expands to <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{...}% deprecated
  • In normal topic text, expands to whatever is in the curly braces (if anything).
  • Note: This is deprecated. Do not use it. Use %STARTSECTION{type="templateonly"}% .. %ENDSECTION{type="templateonly"}% instead (see TWikiTemplates for more details).
• Related: STARTSECTION, TWikiTemplates

PLUGINDESCRIPTIONS -- list of plugin descriptions

• Syntax: %PLUGINDESCRIPTIONS%
• Expands to:
  • SpreadSheetPlugin (any TWiki, 2009-11-22 (18211)): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
  • AliasPlugin (1.32, $Rev: 8756$): Define aliases which will be replaced with arbitrary strings automatically
  • BlackListPlugin (any TWiki, $Rev: 15754 (12 Dec 2008) $): Utility to keep malicious users away from a public TWiki site
  • BlogPlugin (0.61, $Rev$): Basic blogging features used to implement the BlogUp TWikiApplication
  • BreadCrumbsPlugin (v2.01, $Rev: 17469 (12 Dec 2008) $): A flexible way to display breadcrumbs navigation
  • CommentPlugin (03 Aug 2008, $Rev: 17791 (02 Sep 2009) $): Allows users to quickly post comments to a page without an edit/preview/save cycle
  • DBCachePlugin (2.01, $Rev: 16969 (12 Dec 2008) $): Lightweighted frontend to the DBCacheContrib
  • EditTablePlugin (4.9.1, $Rev: 18014 (02 Sep 2009) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
  • EmptyPlugin (TWiki-4.2, $Rev: 15942 (02 Sep 2009) $): Empty Plugin used as a template for new Plugins
  • FilterPlugin (0.94, $Rev: 8790$): Substitute and extract information from content by using regular expressions
  • FlexWebListPlugin (v1.23, $Rev: 16971 (12 Dec 2008) $): Flexible way to display hierarchical weblists
  • GluePlugin (1.5, $Rev: 8784$): Enable TWikiML to span multiple lines
  • HeadlinesPlugin (2.3, $Rev: 18123 (02 Sep 2009) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
  • IfDefinedPlugin (v1.02, $Rev: 16972 (11 Dec 2008) $): Render content conditionally
  • InterwikiPlugin (28 Feb 2009, $Rev: 14913 (17 Sep 2007) $): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
  • JQueryPlugin (0.80, $Rev: 17031 (12 Dec 2008) $): jQuery JavaScript library for TWiki
  • JQueryTwistyPlugin (1.2, $Rev: 16736 (03 Jul 2008) $): Twisty section JavaScript library to open/close content dynamically
  • NatSkinPlugin (3.00-pre20, $Rev: 16978 (12 Dec 2008) $): Theming engine for NatSkin
  • PreferencesPlugin (TWiki-4.3, $Rev: 18016 (02 Sep 2009) $): Allows editing of preferences using fields predefined in a form
  • RedDotPlugin (1.33, $Rev: 9171$): Renders edit-links as little red dots
  • RenderListPlugin (2.0, $Rev: 16235 (02 Sep 2009) $): Render bullet lists in a variety of formats
  • SlideShowPlugin (02 Aug 2008, $Rev: 17260 (02 Sep 2009) $): Create web based presentations based on topics with headings.
  • SmiliesPlugin (Dakar, $Rev: 16049 (02 Sep 2009) $): Render smilies as icons, like for  :-) or for  :eek:
  • TWikiNetSkinPlugin: (disabled)
  • TablePlugin (1.036, $Rev: 17769 (02 Sep 2009) $): Control attributes of tables and sorting of table columns
  • TagCloudPlugin (v0.30, $Rev: 9161$): Renders a tag cloud given a list of terms
  • TimeSincePlugin (0.99, $Rev: 8784$): Display time difference in a human readable way.
  • TinyMCEPlugin (03 Aug 2008, $Rev: 18146 (02 Sep 2009) $): Integration of TinyMCE with WysiwygPlugin
  • TwistyPlugin (1.4.12, $Rev: 15653 (19 Nov 2007) $): Twisty section JavaScript library to open/close content dynamically
  • UserInfoPlugin (1.50, 8832): Render information about users on your TWikiSite
  • WysiwygPlugin (18 Apr 2009, $Rev: 18083 (02 Sep 2009) $): Translator framework for Wysiwyg editors
• Related: ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINVERSION

PLUGINVERSION -- the version of a TWiki Plugin, or the TWiki Plugins API

• Syntax: %PLUGINVERSION{"name"}% to get the version of a specific plugin
• Example: %PLUGINVERSION{"InterwikiPlugin"}% expands to $Rev: 14913 (17 Sep 2007) $
• Syntax: %PLUGINVERSION% to get the version of the API
• Expands to: 1.2
• Related: WIKIVERSION, ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINDESCRIPTIONS

• Related: ATTACHURL, PUBURLPATH, SCRIPTURL, SCRIPTURLPATH, FileAttachments

• Related: ATTACHURL, PUBURL, SCRIPTURL, SCRIPTURLPATH, FileAttachments

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 ?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.
• 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 %URLPARAM{}%.
• Syntax: %QUERYSTRING%
• Expands to: skin=kubrick.nat%2Cnat
• Related: URLPARAM

SCRIPTNAME -- name of current script

• The name of the current script is shown, including script suffix, if any (for example viewauth.cgi)
• Syntax: %SCRIPTNAME%
• Expands to: rdiff
• Related: SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH

SCRIPTSUFFIX -- script suffix

• Some AVR32 Linux installations require a file extension for CGI scripts, such as .pl or .cgi
• Syntax: %SCRIPTSUFFIX%
• Expands to:
• Related: SCRIPTNAME, SCRIPTURL, SCRIPTURLPATH

SCRIPTURL -- base URL of TWiki scripts

• Related: PUBURL, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL{"script"}, SCRIPTURLPATH

SCRIPTURL{"script"} -- URL of TWiki script

• Syntax: %SCRIPTURL{"script"}%
• Expands to: https://mirror.egtvedt.no/avr32linux.org/twiki/bin/script
• Example: To get the authenticated version of the current topic you can write %SCRIPTURL{"viewauth"}%/%WEB%/%TOPIC% which expands to https://mirror.egtvedt.no/avr32linux.org/twiki/bin/viewauth/TWiki/TWikiVariablesNtoZ
• Note: In most cases you should use %SCRIPTURLPATH{"script"}% instead, as it works with URL rewriting much better
• Related: PUBURL, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH, SCRIPTURLPATH{"script"}

SCRIPTURLPATH -- base URL path of TWiki scripts

• As %SCRIPTURL%, but doesn't include the protocol and host part of the URL

• Related: PUBURLPATH, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH{"script"}

SCRIPTURLPATH{"script"} -- URL path of TWiki script

• As %SCRIPTURL{"script"}%, but doesn't include the protocol and host part of the URL
• Syntax: %SCRIPTURLPATH{"script"}%
• Expands to: /twiki/bin/script
• Related: PUBURLPATH, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL, SCRIPTURL{"script"}, SCRIPTURLPATH

• Supported parameters:

• Hint: 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%" }%

• Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates for details.

• Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates for details.

SESSION_VARIABLE -- get, set or clear a session variable

• Syntax: %SESSION_VARIABLE{"name"}%
• Syntax: %SESSION_VARIABLE{"name" set="value"}%
• Syntax: %SESSION_VARIABLE{"name" clear=""}%
• Hint: The users ID is in the AUTHUSER session variable, and is read-only
• Related: TWikiUserAuthentication, AUTHREALM, SESSIONID, SESSIONVAR, LOGIN, LOGOUT

SESSIONID -- unique ID for this session

• Syntax: %SESSIONID%
• Expand to: f2e67b4df5e49145c461c7b3dbb01ea6
• Related: TWikiUserAuthentication, AUTHREALM, SESSIONVAR, LOGIN, LOGOUT, SESSION_VARIABLE

SESSIONVAR -- name of CGI and session variable that stores the session ID

• Syntax: %SESSIONVAR%
• Expand to: TWIKISID
• Related: TWikiUserAuthentication, AUTHREALM, SESSIONID, LOGIN, LOGOUT, SESSION_VARIABLE

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

• Note: This is a deprecated variable. It can be duplicated with %ENCODE{%SPACEOUT{"%TOPIC%" separator=" *"}%}%
• Related: SPACEOUT, TOPIC, ENCODE

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: %SPACEOUT{ "%TOPIC%" }%
• Expands to: TWiki Variables Nto Z
• Supported parameters:

  Parameter:	Description:	Default:
  separator	The separator to put between words e.g. %SPACEOUT{"DogsCatsBudgies" separator=", "}% -> Dogs, Cats, Budgies	' '

• Hint: Spaced out WikiWords are not automatically linked. To SPACEOUT a WikiWord but preserve the link use "double bracket" format. For example, [[WebHome][%SPACEOUT{"WebHome"}%]] expands to Web Home
• Related: SPACEDTOPIC, $PROPERSPACE() of SpreadSheetPlugin

• 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 everything exept the %STARTINCLUDE% variable itself.
• Note: If you want more than one part of the topic included, use %STARTSECTION{type="include"}% instead

• Related: INCLUDE, STARTSECTION, STOPINCLUDE

STARTSECTION -- marks the start of a section within a topic

• Section boundaries are defined with %STARTSECTION{}% and %ENDSECTION{}%.
• 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 INCLUDE.
  • type="include" - like %STARTINCLUDE% ... %STOPINCLUDE% except that you can have as many include blocks as you want (%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.
• Syntax: %STARTSECTION{"name"}% ................ %ENDSECTION{"name"}%
• Syntax: %STARTSECTION{type="include"}% ........ %ENDSECTION{type="include"}%
• Syntax: %STARTSECTION{type="templateonly"}% ... %ENDSECTION{type="templateonly"}%
• Supported parameters:

  Parameter:	Description:	Default
  "name"	Name of the section. Must be unique inside a topic.	Generated name
  type="..."	Type of the section; type "section", "include" or "templateonly"	"section"

• Note: 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..
• Note: You can define nested sections. It is not recommended to overlap sections, although it is valid in TWiki. 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: ENDSECTION, INCLUDE, NOP, STARTINCLUDE, STOPINCLUDE

• Related: TOC{"Topic"}

• Syntax: %TOC{"SomeTopic" ...}%

• 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, ---+ Heading <!--5-->.

• Expands to: TWikiVariablesNtoZ, renders as TWikiVariablesNtoZ

• 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.

• Example: <select>%TOPICLIST{" <option $marker value='$name'>$name</option>" separator=" " selection="%TOPIC%"}%</select> creates an option list of web topics with the current topic selected

• The web containing all documentation and site-wide preference settings for AVR32 Linux

• Returns the value of a URL parameter.

• Example: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariablesNtoZ?skin=print URL
• Note: URL parameters passed into HTML form fields must be entity ENCODEd
• Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates for details.
• Note: There is a risk that this variable could be misused for cross-site scripting.
• Related: ENCODE, SEARCH, FormattedSearch, 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: %USERINFO%
• Expands to: =guest, TWikiGuest, =
• you can also use the format parameter to get different formatted results:
• Syntax: %USERINFO{format="$username is really $wikiname"}%
• Expands to guest is really TWikiGuest
• The tokens $emails, $username, $wikiname, $wikiusername, and $groups are available for use in the format string.
• Related: USERNAME, WIKINAME, WIKIUSERNAME, TWikiUserAuthentication, ChangeEmailAddress

• TWiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME like Main.JohnSmith. Un-authenticated users are all TWikiGuest.

• Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates for details.
• Related: REMOTE_USER, USERINFO, WIKINAME, WIKIUSERNAME, TWikiUserAuthentication

• Expands to: TWiki

• Example: %WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash, public" selection="TWiki" separator=" "}% creates a dropdown of all public webs + Trash web, with the current web highlighted.

WIKIHOMEURL -- site home URL deprecated

• Note: use %WIKILOGOURL% defined in WebPreferences instead.

• The WikiName is the same as %USERNAME% if not defined in the TWikiUsers topic

• Note: When used in a template topic, this variable will be expanded when the template is used to create new topic. See TWikiTemplates for details.
• Related: REMOTE_USER, USERINFO, USERNAME, WIKIUSERNAME, WIKIUSERSTOPIC

• Your %WIKINAME% with Main web prefix, useful to point to your AVR32 Linux home page

• Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates for details
• Related: REMOTE_USER, USERINFO, USERNAME, WIKINAME

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.2
• Related: PLUGINVERSION{"name"}, WIKIVERSION

PLUGINVERSION{"name"} -- the version of an installed Plugin

• Syntax: %PLUGINVERSION{"name"}%
• Example: %PLUGINVERSION{"DefaultPlugin"}% expands to 0
• Related: PLUGINVERSION, WIKIVERSION

PUBURL -- the base URL of attachments

• Syntax: %PUBURL%
• Expands to: https://mirror.egtvedt.no/avr32linux.org/twiki/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: /twiki/pub
• Related: ATTACHURL, PUBURL, FileAttachments

REMOTE_ADDR -- environment variable

• Syntax: %REMOTE_ADDR%
• Expands to: 127.0.0.1
• Related: HTTP_HOST, REMOTE_PORT, REMOTE_USER

REMOTE_PORT -- environment variable

• Syntax: %REMOTE_PORT%
• Expands to: 52435
• 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: r2 - 2005-10-27 - 01:50:17 - TWikiContributor
• 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
  $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 Main web prefix	Main.JohnSmith

• Example: %REVINFO{"$date - $wikiusername" rev="1.1"}% returns revision info of first revision
• Related: REVINFO

SCRIPTURL -- script URL of AVR32 Linux

• Syntax: %SCRIPTURL%
• Expands to: https://mirror.egtvedt.no/avr32linux.org/twiki/bin
• Example: To get the authenticated version of current topic write %SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC% which expands to https://mirror.egtvedt.no/avr32linux.org/twiki/bin/viewauth/TWiki/TWikiVariablesNtoZ
• Related: PUBURL, SCRIPTSUFFIX, SCRIPTURLPATH

SCRIPTURLPATH -- script URL path of AVR32 Linux

• Syntax: %SCRIPTURLPATH%
• Expands to: /twiki/bin
• Related: PUBURLPATH, SCRIPTURL

SCRIPTSUFFIX -- script suffix

• Some AVR32 Linux 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 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
  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 (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 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 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 a NOSEARCHALL=on variable in its WebPreferences

SERVERTIME -- server time

• Syntax: %SERVERTIME%
• Expands to: 2012-04-12 - 10:46
• Related: DISPLAYTIME, GMTIME, SERVERTIME{"format"}

SERVERTIME{"format"} -- formatted server time

• Same format qualifiers as %GMTIME%
• Syntax: %SERVERTIME{"format"}%
• Example: %SERVERTIME{"$hou:$min"}% expands to 10:46
• 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 AVR32 Linux
• 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 &#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" 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/TWiki/TWikiVariablesNtoZ?skin=print URL. Test this: kubrick.nat,nat
• Related: SEARCH, FormattedSearch

USERNAME -- your login username

• TWiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME like Main.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 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.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 AVR32 Linux, is the link of the Home icon in the upper left corner, defined in TWiki.cfg
• Syntax: %WIKIHOMEURL%
• Expands to: /twiki/bin/view
• Related: WIKITOOLNAME

WIKINAME -- your Wiki username

• The WikiName is the same as %USERNAME% if not defined in the TWikiUsers topic
• Syntax: %WIKINAME%
• Expands to: TWikiGuest
• 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: AVR32 Linux
• Related: WIKIHOMEURL, WIKIVERSION

WIKIUSERNAME -- your Wiki username with web prefix

• Your %WIKINAME% with Main web prefix, useful to point to your AVR32 Linux home page
• Syntax: %WIKIUSERNAME%
• Expands to: Main.TWikiGuest, renders as TWikiGuest
• 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: TWiki-4.3.2, Wed, 02 Sep 2009, build 18148
• Related: PLUGINVERSION, WIKITOOLNAME

-- TWiki:Main.PeterThoeny - 14 Aug 2004