TWiki Variables » Search » Category: Applications & Components

AUTOCOMPLETE{} -- autocomplete input field for use in HTML forms

• Combo box input field with autocomplete. Start typing to see matching options to pick from. The %AUTOCOMPLETE{}% variable is handled by the AutocompletePlugin.
• Syntax: %AUTOCOMPLETE{ name="..." value="..." options="..., ..." }%
• Parameters:

  Parameter	Description	Default	Example
  name	Name of input field	(required)	name="Mood"
  value	Form field value	""	value="Happy"
  options	Comma-space separated list of autocomplete options. Example options when type="values" is used: options="1: One, 2: Two, 3: Three" - when a user picks option Three, the input field will have text 3 inserted.	""	options="Happy, Indifferent, Sad"
  size	Size of input field, in number of characters	"40"	size="20"
  type	Types of autocomplete: • type="" (empty): Simple autocomplete • type="restrict": Restrict input to list of autocomplete options. The value in the input field will be cleared if it does not match one of the autocomplete options. Partial input is expanded - for example if one of the options is "JavaScript" and the user typed "ja", the input field is expanded to "JavaScript" on focus loss. • type="values": Define inserted values that are different to the displayed autocomplete options. An autocomplete option is defined as value: title, where the value is the text inserted into the input field when picking the title option. • type="restrict, values": Types of autocomplete can be combined.	""	type="restrict"
  id	ID of input field	(none)	id="mood"
  class	Add additional class(es) to input field, default is "twikiInputField twikiEditFormTextField autocompleteTextField"	""	class="myClass"
  style	Add CSS to input field. A width: num; is already added, where num is calculated from the size parameter; the width can be overloaded.	""	style="color: blue;"
  selectstyle	CSS of select element	""	selectstyle="color: blue;"
  containerstyle	CSS of autocomplete container div	""	containerstyle="font-size: 90%;"
  ...	Additional HTML 4 and HTML 5 attributes can be specified for the input field: formname, maxlength, onblur, onfocus, onchange, onselect, onmouseover, onmouseout, pattern, placeholder, spellcheck, tabindex, title		placeholder="How do you feel?"

• Example:
  <form action="...">
%AUTOCOMPLETE{ name="Mood" value="Indifferent" options="Happy, Indifferent, Sad" size="10" }%
<form>
• Expands to:
  %AUTOCOMPLETE{ name="Mood" value="Indifferent" options="Happy, Indifferent, Sad" size="10" }%
• Category: ApplicationsAndComponentsVariables, DatabaseAndFormsVariables, EditingAndContentUpdateVariables, FormattingAndRenderingVariables
• Related: AutocompletePlugin, TWikiForms (this topic)

COLORPICKER{} -- color picker for use in HTML forms for TWiki applications

• The %COLORPICKER{}% variable is handled by the ColorPickerPlugin.
• Syntax: %COLORPICKER{ name="..." value="..." }%
• Parameters:

  Parameter	Description	Default	Example
  name	Name of input field	(required)	name="text_color"
  value	Initial color value, in hexadecimal notation for the combination of Red, Green, and Blue color values (RGB).	(none)	value="#0000ff"
  size	Size of input field, in number of characters	(browser default)	size="8"
  class	CSS class of input field or the rectangular color block	(none)	class="twikiInputField"
  style	Style of input field or the rectangular color block	(none)	style="width: 190px; height: 32px"
  type	Type of color widget: • "below" - color picker is located below the input field; • "popup" - pop-up a color picker window when clicking the button next to the input field     (this uses very little vertical space); • "view" - a read-only rectangular block colored in the color value (no color picker); • "view-hex" - like view, in addition shows the color value as an RGB hexadecimal code (no color picker);	type="below"	type="view-hex"
  Additional parameters can be supplied; they will be added to the HTML input field or the rectangular color block.

• Example:
  <form action="...">
%COLORPICKER{ name="text_color" value="#123456" class="twikiInputField" type="popup" }%
<form>
  Renders as:
  
  
• Category: ApplicationsAndComponentsVariables, DatabaseAndFormsVariables, EditingAndContentUpdateVariables, FormattingAndRenderingVariables, UIAndVisualizationVariables
• Related: ColorPickerPlugin, TWikiForms (this topic)

COMMENT{ attributes } -- insert an edit box into the topic to easily add comments.

• A %COMMENT% without parameters shows a simple text box.
• A %COMMENT{}% can handle the following parameters:

  Parameter	Description	Default
  type	This is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see customization. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your WebPreferences.	"below"
  default	Default text to put into the textarea of the prompt.
  target	Name of the topic to add the comment to	the current topic
  location	Regular expression specifying the comment location in the target topic. Read carefully the CommentPlugin documentation!
  mode	For compatibility with older versions only, synonymous with type
  nonotify	Set to "on" to disable change notification for target topics	"off"
  noform	Set to "on" to disable the automatic form that encloses your comment block - remember to insert <form> tags yourself! See CommentPluginExamples for an example.	"off"
  nopost	Set to "on" to disable insertion of the posted text into the topic.	"off"
  remove	Set to "on" to remove the comment prompt after the first time it is clicked.	"off"
  button	Button label text	"Add comment"
  emailto	Send comment by email. Use comma "," to seperate multiple email addresses. This feature is disabled by default. To enable this feature, please set up "$TWiki::cfg{Plugins}{CommentPlugin}{EmailEnabled} = 1;".

• See CommentPlugin for more information
• Category: ApplicationsAndComponentsVariables, DatabaseAndFormsVariables, EditingAndContentUpdateVariables, WorkflowAndAutomationVariables
• Related: HIDE, TWikiForms (this topic)

DASHBOARD -- build a dashboard with banner and boxes

• Use this variable to quickly create dashboards for intranet home, team homepages, project homepages and knowledge bases. See the TWikiDashboardAddOn for details on enabling and using the %DASHBOARD{...}% variable.
• Syntax: %DASHBOARD{ section="..." ... }%
• Example:
  %DASHBOARD{ section="dashboard_start" }%
%DASHBOARD{ section="banner" image="..." title="..." }%
%DASHBOARD{ section="box_start" title="Box 1 title" }%
Box 1 content
%DASHBOARD{ section="box_end" }%
%DASHBOARD{ section="box_start" title="Box 2 title" }%
Box 2 content
%DASHBOARD{ section="box_end" }%
...
%DASHBOARD{ section="dashboard_end" }%
• Category: AdministrationVariables, ApplicationsAndComponentsVariables, DevelopmentVariables, FormattingAndRenderingVariables, UIAndVisualizationVariables
• Related: TWikiDashboardAddOn (this topic)

DATEPICKER{} -- pop-up calendar to select a date for use in HTML forms

• The %DATEPICKER{}% variable is handled by the DatePickerPlugin.
• Syntax: %DATEPICKER{ name="..." value="..." }%
• Parameters:

  Parameter	Description	Default	Example
  name	Name of input field. φ: No output is shown if the name parameter is missing, but the CSS and Javascript are loaded.	(requiredφ)	name="Start"
  value	Initial date value.	"" (today)	value="2012-12-31"
  format	Format of resulting date value. • %a - abbreviated weekday name • %A - full weekday name • %b - abbreviated month name • %B - full month name • %C - century number • %d - the day of the month (00 ... 31) • %e - the day of the month (0 ... 31) • %H - hour (00 ... 23) • %I - hour (01 ... 12) • %j - day of the year ( 000 ... 366) • %k - hour (0 ... 23) • %l - hour (1 ... 12) • %m - month (01 ... 12) • %M - minute (00 ... 59) • %n - a newline character • %p - "PM" or "AM" • %P - "pm" or "am" • %S - second (00 ... 59) • %s - number of seconds since Epoch (since Jan 01 1970 00:00:00 UTC) • %t - a tab character • %U, %W, %V - the week number. The week 01 is the week that has the Thursday in the current year, which is equivalent to the week that contains the fourth day of January. Weeks start on Monday. • %u - the day of the week (1 ... 7, 1 = MON) • %w - the day of the week (0 ... 6, 0 = SUN) • %y - year without the century (00 ... 99) • %Y - year including the century (ex. 2012) • %% - a literal % character	"%Y-%m-%d"	format="%e %b %Y"
  id	ID of input field, optional.	"id_" + name	id="idStart"
  size	Size of input field, in number of characters.	(calculated as needed)	size="12"
  class	CSS class of input field.	"twikiInputField"	class="dateField"
  Additional HTML input field attributes, such as alt, disabled, maxlength, onblur, onchange, onfocus, readonly, style, tabindex, title

• Example:
  <form action="...">
%DATEPICKER{ name="Start_Date" }%
<form>
• Expands to:
• Category: ApplicationsAndComponentsVariables, DatabaseAndFormsVariables, DateAndTimeVariables, EditingAndContentUpdateVariables, FormattingAndRenderingVariables, UIAndVisualizationVariables
• Related: DatePickerPlugin, TWikiForms (this topic)

EJS_INCLUDE -- execute and include topic containing EJS tags

• See TWiki06x01.EmbeddedJSPlugin for information about EJS (Embedded JavaScript) template.
• This tag is used to embed an EJS-based component topic. The JavaScript execution context (namespace) within this %EJS_INCLUDE{...}% tag is completely separate from the outside, even if the "including" topic is also EJS-enabled.
• Syntax: %EJS_INCLUDE{"ComponentTopicName" namespace="NamespaceRequiredByComponent" timeout="TimeoutInSeconds"}%
• Category: ApplicationsAndComponentsVariables, DevelopmentVariables, ImportVariables
• Related: INCLUDE (this topic)

EXECUTE{ "script" } -- safely execute shell scripts or Perl code - use TWiki as the user interface for external applications

• Use the %EXECUTE{}% variable to safely execute shell scripts. The variable is handled by the ExecutePlugin - see plugin for details on how to configure external scripts so that they can be used in %EXECUTE{}%.
• Syntax: %EXECUTE{ "script" ... }%
• Supported parameters:

  Parameter	Explanation	Default	Example
  "name"	Name of script to execute, as defined in configure. See ExecutePlugin for details.	(none)	"test-results"
  format="..."	Format each line of the script output. The token $text expands to the text of a line. Additional FormatTokens can be used, such as $percnt for the percent sign.	"$text"	format="| $text |"
  newline="..."	Change newlines of the script output to something else. FormatTokens can be used, such as $n for newline.	"$n"	newline=", "
  ...="..."	Any other parameter can be used as parameter to the script.	(none)	date="2026-02-11"

• Example: %EXECUTE{ "qa_results" date="%URLPARAM{date}%" }%
• Category: ApplicationsAndComponentsVariables, DatabaseAndFormsVariables, DevelopmentVariables, ImportVariables, UIAndVisualizationVariables, WorkflowAndAutomationVariables
• Related: ExecutePlugin, configure (this topic)

GEOLOOKUP -- lookup geo location by IP address or domain name

• The %GEOLOOKUP{}% variable is handled by the GeoLookupPlugin
• Syntax: %GEOLOOKUP{"host" format="..."}%
• Parameters:

  Parameter	Description	Default
  "..."	Host IP address or host name	none, required
  format="..."	Format of geolocation. Supported variables: • $latitude: Latitude • $longitude: Longitude • $city: City name • $region: Region name • $country_name: Country name • $country_code: Two letter country code • $postal_code: Postal code (USA only) • $metro_code: Metropolitan code (USA only) • $area_code: Telephone area code (USA only)	"$city, $region, $country_name"

• Example: %GEOLOOKUP{"75.52.124.86"}% shows default format (city, region, country code)
• Example: %GEOLOOKUP{"75.52.124.86" format="$latitude, $longitude"}% shows comma separated Latitude and Longitude
• Category: AdministrationVariables, ApplicationsAndComponentsVariables, DevelopmentVariables, SecurityAndAccessControlVariables, UsersAndAuthenticationVariables
• Related: GeoLookupPlugin (this topic)

GET{"name"} -- get a variable

• Get the value of a named variable, previously set with %SET{}%. The %SET{}% and %GET{}% variables are handled by the SetGetPlugin.
• Syntax: %GET{ "name" default="..." }%
• Parameters:

  Parameter	Description	Default
  "name"	Name of variable, such as menu. May optionally contain a JSON path, such as menu.File.Open.	(required)
  format="..."	Format with supported variables: • $name for variable name • $value for variable value • $isdefined expanding to 1 or 0 depending if variable is defined or not • $isset expanding to 1 or 0 depending if variable is logically true or false • $ispersistent expanding to 1 or 0 depending if variable is persistent or not • all FormatTokens such as $dollar, $n, $percnt.	"$value"
  default="..."	Text shown if variable is not defined, e.g. not found. This parameter overrides the format parameter.	"" (empty string)
  store="..."	Specify a store name that holds the persistent variable. This assumes the variable was previously set with the same store name.	""

• Example: %GET{"lunch"}% returns Sushi if the following has been previously set:
  %SET{ "lunch" value="Sushi" }% - see more examples
• JSON Syntax: %GET{ name }% - see description.
• Example to set a JSON object and to get a JSON object with a JSON path:
  • %SET{ menu = { "File": { "New": [ "new", "F" ], "Open": [ "open", "F" ] }, "Edit": { "Copy": [ "cpy", "F" ], "Paste": [ "pst", "F" ] } } }% - set a JSON object
  • %GET{ menu.File.Open }% - returns: ["open","F"]
• Category: ApplicationsAndComponentsVariables, DevelopmentVariables
• Related: IF, SET, SETGETDUMP, SetGetPlugin, SpreadSheetPlugin (this topic)

HEADLINES{"url"} -- show RSS and ATOM feeds in TWiki pages

• The %HEADLINES{"url"}% variable is handled by the HeadlinesPlugin.
• Syntax: %HEADLINES{ "http://..." }%
• Parameters: (all but the first one are optional)

  "..."	Source of RSS or ATOM feed; this can be a URL (starting with http) or a web.topic location for internal feeds
  refresh="60"	Refresh rate in minutes for caching feed; "0" for no caching
  limit="12"	Maximum number of items shown
  header="..."	Header. May include these variables: - $channeltitle, $title: title of channel (channel.title) - $channellink, $link: link of channel (channel.link) - $channeldescription, $description: description (channel.description) - $channeldate, $date: publication date of the channel (channel.pubDate) - $rights: copyrights of the channel (channel.copyright) - $imagetitle: title text for site (image.title) - $imagelink: link for site (image.link) - $imageurl: URL of image (image.url) - $imagedescription: description of image (image.description)
  format="..."	Format of one item. May include these variables: - $title: news item title (item.title) - $link: news item link (item.link) - $description: news item description (item.description) - $date: the publication date (item.pubDate, item.date) - $category: the article category (item.category)
  newline="$br"	Convert newlines in feed; "$br" becomes <br /> tag, default "$n" (newline)
  filter="..."	Filter out content from feed; for example to delete an encoded break tag specify "&lt;br&gt;"
  Details

• Example: %HEADLINES{ "http://slashdot.org/slashdot.rdf" header="*[[$link][$title]]:* $description" format="$t* [[$link][$title]]" limit="4" }% shows the latest Slashdot news in bullet list format
• Category: ApplicationsAndComponentsVariables, ImportVariables
• Related: HeadlinesPlugin (this topic)

INCLUDEXML -- display any XML document in table format

• This variable is handled by the IncludeXMLPlugin. For details, see IncludeXMLPlugin
• Syntax: %INCLUDEXML{"URL or Topic" records="xpath" fields="xpaths"}%
• Example: %INCLUDEXML{"http://example.com/rss" records="item" fields="link, title, description, pubDate"}%
• Category: ApplicationsAndComponentsVariables, DevelopmentVariables, ImportVariables
• Related: INCLUDE (this topic)

JIRA -- display JIRA issues using JQL search

• JIRA issues can be displayed as a TWiki table, based on a JQL (JIRA Query Language) query. This variable is handled by the JiraPlugin.
• Syntax: %JIRA{"JIRA URL" jql="..."}%
• Category: ApplicationsAndComponentsVariables
• Example: %JIRA{"http://example.com/jira" jql="project = XYZ and status in ('In Progress')"}%
• Related: JiraPlugin (this topic)

JIRAREST{"..."} -- call JIRA issue tracker using REST API

• Interface to the Atassian JIRA issue tracker via JIRA REST API call. The %JIRAREST{}% variable is handled by the JiraRestPlugin.
• Syntax: %JIRAREST{ "..." command="..." }%
• Parameters:

  Parameter	Description	Default
  "..." or action="..."	Action to take. This is the REST method: "get" for GET, "put" for PUT, "post" for POST, and "delete" for DELETE method.	"" (no action)
  command="..."	REST command, such as: "/rest/api/2/issue/TEST-1"	(required)
  data="..."	Request body sent with REST call, such as: " { \"id\": \"10009\" } "	(required for put and post actions)
  action2="..." command2="..." data2="..."	Conduct a second action after successful execution of the first action. Use this to do multiple REST API calls in one session. No action is taken if there was an error in the first action. In the same way, action3, action4, etc can be executed.	(optional)
  user="..."	User for REST call; default is configure setting {Plugins}{JiraRestPlugin}{User}	(configure setting)
  password="..."	Password for REST call; default is configure setting {Plugins}{JiraRestPlugin}{Password}	(configure setting)

• Example: %JIRAREST{ "get" command="/rest/auth/1/session" }% - see more examples.
• Category: ApplicationsAndComponentsVariables, DatabaseAndFormsVariables, DevelopmentVariables, ImportVariables, WorkflowAndAutomationVariables
• Related: JiraRestPlugin (this topic)

JQENDTAB -- end a JQuery tab within a tab pane

• This variable is handled by the JQueryPlugin. For description see JQTABPANE
• Syntax: %JQTABPANE% %JQTAB{"Tab 1"}% ... %JQENDTAB% %JQTAB{"Tab 2"}% ... %JQENDTAB% ... %JQENDTABPANE%
• Example: See JQTABPANE
• Category: ApplicationsAndComponentsVariables, FormattingAndRenderingVariables
• Related: JQENDTABPANE, JQTAB, JQTABPANE, JQueryPlugin (this topic)

JQENDTABPANE -- end a JQuery tab pane

• This variable is handled by the JQueryPlugin. For description see JQTABPANE
• Syntax: %JQTABPANE% %JQTAB{"Tab 1"}% ... %JQENDTAB% %JQTAB{"Tab 2"}% ... %JQENDTAB% ... %JQENDTABPANE%
• Example: See JQTABPANE
• Category: ApplicationsAndComponentsVariables, FormattingAndRenderingVariables
• Related: JQENDTAB, JQTAB, JQTABPANE, JQueryPlugin (this topic)

JQPLOT -- add line, bar and pie charts using jqPlot JavaScript library

• jqPlot is a "pure javascript plotting and charting" library. This variable is handled by the JqPlotPlugin to add the required JavaScript and CSS tags to <head>.
• Syntax: %JQPLOT%, %JQPLOT{"jqPlot plugin name(s)"}%
• Example: %JQPLOT{"barRenderer, pieRenderer"}%
• Category: ChartingAndDrawingVariables, ApplicationsAndComponentsVariables, DevelopmentVariables
• Related: JqPlotPlugin, JQueryPlugin (this topic)

JQTAB -- start a JQuery tab within a tab pane

• This variable is handled by the JQueryPlugin. For description see JQTABPANE
• Syntax: %JQTABPANE% %JQTAB{"Tab 1"}% ... %JQENDTAB% %JQTAB{"Tab 2"}% ... %JQENDTAB% ... %JQENDTABPANE%
• Supported parameters:

  Parameter:	Description:	Default:
  "..."	Name of tab, shown as tab label	(required)
  before	When switching tabs, this is the Javascript fragment to be executed just before the tab is displayed	""
  after	This Javascript handler is to be executed after the tab has been made visible	""
  afterload	This Javascript handler will be called when content loaded asynchronously has finished loading (using the url parameter described below). Depending on the network latency and server response time, this can be significantly later than execution of the after handler above	""
  url	Link from where to load the content of the tab asynchronously when selecting this tab; the result of the addressed handler will replace the content area; if no url is set the content of the TAB ... ENDTAB area will be shown when the tab is selected	""
  container	Container element (".someClass" or "#someID") where content will be loaded asynchronously using Ajax; this is only used together with url	".jqTabContents"
  class	Add additional class to existing tab class "jqTab"	""

• Example: See complete example at JQTABPANE
• Example: Asynchronously load the content of TimBernersLee topic into a tab content:
  %JQTABPANE%
%JQTAB{ "Tim Berners-Lee" url="%SCRIPTURL{view}%/TWiki06x01/TimBernersLee?skin=text" }%
%ICON{processing}%
%JQENDTAB%
%JQENDTABPANE%
• Category: ApplicationsAndComponentsVariables, FormattingAndRenderingVariables
• Related: JQENDTAB, JQENDTABPANE, JQTABPANE, JQueryPlugin (this topic)

JQTABPANE -- start a JQuery tab pane

• Create nice looking horizontal tab panes in TWiki topics. Write a sequence of %JQTAB{"..."}% and %JQENDTAB% pairs, and enclose them in %JQTABPANE% and %JQENDTABPANE%. Tab panes can be nested, e.g. within one tab you can add another tab pane. These variable are handled by the JQueryPlugin.
• Syntax: %JQTABPANE{ select="1" }% %JQTAB{"Tab 1"}% ... %JQENDTAB% %JQTAB{"Tab 2"}% ... %JQENDTAB% ... %JQENDTABPANE%
• Supported parameter:

  Parameter:	Description:	Default:
  select=""	Select a tab pane, default is the first tab.	"1"

• Note: A tab can be selected with a tab URL parameter using %JQTABPANE{ select="%URLPARAM{tab}%" }%
• Example:
  %JQTABPANE%
%JQTAB{"Tab 1"}%
Tab 1 content...
%JQENDTAB%
%JQTAB{"Tab 2"}%
Tab 2 content...
%JQENDTAB%
%JQENDTABPANE%
• Renders as:

  Tab 1

  Tab 1 content...

  Tab 2

  Tab 2 content...
• Category: ApplicationsAndComponentsVariables, FormattingAndRenderingVariables
• Related: JQENDTAB, JQENDTABPANE, JQTAB, JQueryPlugin (this topic)

LOADAPP{"id"} -- Load TWiki application code from a hidden web

• Include a TWiki application topic indicated by an ID. The LOADAPP variable is handled by the LoadAppPlugin, and works similar to the INCLUDE variable.
• Syntax: %LOADAPP{"id" ...}%
• Supported parameters:

  Parameter:	Description:	Default:
  "someID"	The ID of the application snippet to include. Example: %LOADAPP{"kbHeader"}% will include the topic KnowledgeBaseHeader from the KB web, assuming the mapping 'kbHeader: KB.KnowledgeBaseHeader' is defined in configure	(required)
  section="name"	Include only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables. Nothing is shown if the named section does not exists. section="" is equivalent to not specifying a section	""
  PARAMONE="val 1" PARAMTWO="val 2"	Any other parameter will be defined as a variable within the scope of the included topic. The example parameters on the left will result in %PARAMONE% and %PARAMTWO% being defined within the included topic. A default value for a variable can be specified in the included topic in case the corresponding parameter is not specified, such as %PARAMONE{ default="..." }%	(optional)

• Example: See LoadAppPlugin
• Category: ApplicationsAndComponentsVariables, DevelopmentVariables, ImportVariables
• Related: BASETOPIC, BASEWEB, INCLUDE, INCLUDINGTOPIC, INCLUDINGWEB, STARTINCLUDE, STOPINCLUDE, STARTSECTION, ENDSECTION, IncludeTopicsAndWebPages, ParameterizedVariables, LoadAppPlugin (this topic)

NOTIFYAUTHORS{} -- show button to notify authors of a discussion thread via e-mail

• Use this plugin to add a "notify authors" button to topics. When pressed, all authors on the topic will be notified by e-mail. The %NOTIFYAUTHORS% variable is handled by the NotifyAuthorsPlugin.
• Syntax: %NOTIFYAUTHORS{ ... }%
• Parameters:

  Parameter	Description	Default
  action="" or action="showbutton"	Show "notify authors" button	""
  action="notify"	Notify all authors by e-mail. The same can be achieved with URL parameter notifyauthors_action=notify.	""
  action="getemailtemplate"	Get e-mail body from template, used in notification confirmation dialog box. Add encode="1" to entity-encode the content for an HTML textarea element.	""
  anchor="..."	After notification, jump to named anchor (omit the #)	"NotifyAuthorsButton" φ

  φ Note: The default is defined in the {Plugins}{NotifyAuthorsPlugin}{AnchorName} configure setting.
• Example:
  %NOTIFYAUTHORS%
• Expands to:
  %NOTIFYAUTHORS%
• Category: ApplicationsAndComponentsVariables, EmailAndNotificationVariables, FormattingAndRenderingVariables
• Related: NotifyAuthorsPlugin, CommentPlugin (this topic)

PERCENTCOMPLETE{} -- percent complete selector for use in HTML forms

• The %PERCENTCOMPLETE{}% variable is handled by the PercentCompletePlugin.
• Syntax: %PERCENTCOMPLETE{ name="..." value="..." }%
• Parameters:

  Parameter	Description	Default	Example
  name	Name of selector	(required)	name="Progress"
  value	Initial value, range 0 to 100.	"0"	value="70"

• Example:
  <form action="...">
%PERCENTCOMPLETE{ name="Progress" value="30" }%
<form>
• Expands to: 0% 10% 20% 30% 40% 50% 60% 70% 80% 90% 100%
• Category: ApplicationsAndComponentsVariables, DatabaseAndFormsVariables, EditingAndContentUpdateVariables, FormattingAndRenderingVariables, UIAndVisualizationVariables
• Related: PercentCompletePlugin, TWikiForms (this topic)

RENDERFORM -- render TWiki Forms data within a topic

• The %RENDERLIST% variable is handled by the RenderFormPlugin.
• Syntax: %RENDERFORM{ "ATWikiFormDefinition" }%
• Parameters:

  Parameter	Description	Default / Example
  dateformat	overwrites the JSCALENDARDATEFORMAT preference for date fields	dateformat="%d %b %Y"
  donotnotify	disables notifications	undefined / donotnotify="on"
  form	(required attribute) a name of a topic with a TWikiForms definition	undefined / form="MyTestForm"
  hidden	a comma separated list of form field names to hide in all modes	undefined / hidden="Field1,Field2"
  hideheader	if set, disables the form header	hideheader="no"
  layout	a topic with a layout (see Form Layout section); syntax: layout="<topic>#<layout name>"; if layout name is omitted a default layout will be taken	undefined / layout="TestFormLayout#test1"
  mode	render mode of the form, allowed values: create (default), edit, view (default if topic exists)	mode="create"
  onlynewtopic	disables overwrite of existing topics	onlynewtopic="on"
  onlywikiname	disallows the usage of non-TWiki.WikiWords for topic names	onlywikiname="on"
  order	changes the display order of form fields; order value is a comma separated list of field names; if the order list is incomplete all missing and unhidden form fields will be added; there are special values for order: [:alpha:], [:dalpha:], [:num:] and [:dnum:], e.g. order="[:alpha:]" to sort all fields alphanumerical	undefined / order="Field1, Field2"
  script	changes the behavior of edit/create modes; allowed values: save - saves the form data; edit - edit the resulting topic	script="save"
  template	a template name for predefined attributes	undefined / template="helpdesk"
  templatetopic	a template topic; useful for the create mode	undefined / templatetopic="MyHelpDeskTopicTemplate"
  text	the topic text; text will be ignored if a templatetopic is defined	undefined / text="my small topic text"
  topic	an existing topic for edit and view mode or a topic template name for a new topic (create mode) (e.g. TestFormDataXXXXXXXXXX)	topic="%TOPIC%XXXXXXXXXX" / topic="TestFormData%SERVERTIME{$epoch}%"
  topicparent	a topic parent; useful for the create mode; if undefined the form topic will be used	topicparent="%WEB%.%TOPIC%" / topicparent="MyHelpDesk"

• Example: %RENDERLIST{ "IT.HelpDeskForm" }%
• Category: ApplicationsAndComponentsVariables, DatabaseAndFormsVariables, EditingAndContentUpdateVariables, FormattingAndRenderingVariables, UIAndVisualizationVariables
• Related: RenderFormPlugin, TWikiForms (this topic)

REPLACETEXT -- search and replace text in a web

• The %REPLACETEXT{}% variable is handled by the ReplaceTextPlugin; this variable is typically used in conjunction with a web form
• Syntax: %REPLACETEXT{ action="..." web="..." from="..." to="..." }%
• Parameters:

  Parameter	Description	Default
  action="..."	Replace action: • "" - no action • "replace" - do replace action based on below parameters, return result message, such as:   Replaced FOO with BAR in 2 topics in Sandbox web	""
  web="..."	Name of web to search and replace text	(current web)
  topic="..."	Expert mode: Limit topics by name: A topic with asterisk wildcards, such as Bug-*, or a list of topics separated by comma	(all topics)
  filter="..."	Expert mode: Limit topics by filtering topic text with a regex filter, optional	(no filter)
  from="..."	Text to search	(none, required)
  to="..."	Replacement text	(none, required)
  search="..."	Expert mode: Use this for more complex replace using regular expression grouping etc; typically supplied via a hidden input field. Use $from to specify the search text entered by the user	"\b$from\b"
  replace="..."	Expert mode: Use this for more complex replace using regular expression grouping etc; typically supplied via a hidden input field. Use $to to specify the replacement text entered by the user, use $1, $2, etc to reference captured groups	"$to"
  dryrun="1"	Do a dry run, e.g. a search only to simulate the replace action	"0"
  showlist="1"	Show the list of topics replaced	"0"

• Example usage: See raw text of ReplaceTextPlugin
• Category: AdministrationVariables, ApplicationsAndComponentsVariables, DevelopmentVariables
• Related: ReplaceTextPlugin (this topic)

SET{"name" value="..."} -- set a variable

• Set a named variable that can be retrieved later with %GET{}%. No output is shown, e.g. %SET{}% resolves to an empty string. It is also possible to set a JSON object using a JSON path. The %SET{}% and %GET{}% variables are handled by the SetGetPlugin.
• Syntax: %SET{ "name" value="..." remember="1" }%
• Parameters:

  Parameter	Description	Default
  "name"	Name of variable. Alphanumeric characters, dashes and underscores can be used.	(required)
  value="..."	Value of variable. Escape double quotes with backslash.	(required, may be empty)
  remember="1"	If set, the variable will be stored persistently so that it can be used later in any TWiki topic. Alternatively use the store parameter. See important notes.	"0"
  store="..."	Specify a store name to persistently store the variable, such as store="Parts". Use alphanumeric characters, dashes and underscores for the name. For better performance, store is preferred over the remember parameter if you need to store a large dataset. See important notes.	""

• Example: %SET{"lunch" value="Sushi"}% - see more examples.
• JSON Syntax: %SET{ name = { ... } remember="1" }% - see description.
  • An optional remember="1" or store="..." parameter can be appended. If specified, the JSON object will be stored persistently so that it can be used later in any TWiki topic.
• Example to set, modify and get a JSON object:
  • %SET{ menu = { "File": { "New": [ "new", "F" ], "Open": [ "open", "F" ] }, "Edit": { "Copy": [ "cpy", "F" ], "Paste": [ "pst", "F" ] } } }% - set a JSON object
  • %GET{ menu }% - returns: {"File":{"New":["new","F"],"Open":["open","F"]},"Edit":{"Copy":["cpy","F"],"Paste":["pst","F"]}}
  • %SET{ menu.File.Open[1] = "T" }% - modify a JSON object
  • %GET{ menu }% - returns: {"File":{"New":["new","F"],"Open":["open","T"]},"Edit":{"Copy":["cpy","F"],"Paste":["pst","F"]}}
  • %SET{ menu.Edit.Cut = [ "cut", "T" ] }% - add to a JSON object
  • %GET{ menu }% - returns: {"File":{"New":["new","F"],"Open":["open","T"]},"Edit":{"Copy":["cpy","F"],"Paste":["pst","F"],"Cut":["cut","T"]}}
• Category: ApplicationsAndComponentsVariables, DevelopmentVariables
• Related: GET, IF, SETGETDUMP, SetGetPlugin, SpreadSheetPlugin (this topic)

SETGETDUMP{...} -- dump variables

• Dump volatile or persistent name/values previously set with %SET{}%. The %SETGETDUMP{}%, %SET{}%, and %GET{}% variables are handled by the SetGetPlugin.
• Syntax: %SETGETDUMP{ remember="1" format="..." separator="..." }%
• Parameters:

  Parameter	Description	Default
  remember="1"	Dump all persistent variables	(volatile variables)
  store="..."	Dump variables of a specific store	(volatile variables)
  format="..."	Format output using variables $name and $value	"name: $name, value: $value <br />"
  separator="..."	String used for separating entries	"\n"

• Example: %SETGETDUMP{"| $name | $value |" separator="$n"}% - see more examples.
• Category: ApplicationsAndComponentsVariables, DevelopmentVariables
• Related: GET, IF, SET, SetGetPlugin, SpreadSheetPlugin (this topic)

TWISTY{ attributes } -- dynamically open and close sections of content

• The %TWISTY{}% variable is handled by the TwistyPlugin.
• Syntax: %TWISTY{}% ... %ENDTWISTY%
• See plugin topic for explanation of variables and attributes
• Example:
  %TWISTY{}%
my twisty content
%ENDTWISTY%
• Category: FormattingAndRenderingVariables, ApplicationsAndComponentsVariables
• Related: TwistyPlugin, TwistyContrib (this topic)

VOTE{ id="..." } -- define a poll in a TWiki topic

• The %VOTE{}% variable is handled by the VotePlugin.
• Syntax: %VOTE{ id="..." select1="..., ..., ..." }%
• Parameters:

  Parameter	Description	Example
  id	The identifier of the poll. You can have multiple independent votes in the same topic.	id="Dining"
  selectN	Defines the name of a select vote, where you select one from a ranges of options. N is a number that identifies this item within the poll e.g. select1, select2 etc. You must number all select and stars parameters uniquely and sequentially (e.g. select1 stars2 select3	select1="Drink"
  optionsN	Each selectN must have a corresponding optionsN that defines a comma-separated list of the options that can be selected between.	options1="Beer,Wine,Milk"
  starsN	Defines the name of a rate vote, where you rate something by giving it a number of stars. N is a number that identifies this item within the poll e.g. select1, stars2 etc. You must number all select and stars parameters uniquely and sequentially (e.g. select1 stars2 select3	stars2="Usability"
  widthN	Each starsN must have a corresponding widthN. This gives the number of stars to show e.g. width1="5" will show 5 stars.	width2="10"
  formatN	Defines the format of the results display. See formatting results, below.	format="$large"
  chartN	Defines the format of a single bar in the results bar chart generated for the corresponding select (for select type only). See formatting results, below.	chart="<p>$option $score</p>"
  separator	Defines the string to be used to separate each row in the result.	separator="<br/>"
  global	If set to "off", this makes the id local to this topic (the default). If set to "on" it will be a global poll that can be accessed from many topics.	global="on"
  open	If set to "off" this is a closed vote. If set to "on" it is open (the default)	open="on"
  secret	If set to "off", then the database will record who voted. If set to "on", votes are secret (the default)	secret="on"
  saveto	If set to the name of a topic, the poll results will be appended to the end of that topic. The results are formatted as a TWiki table for easy post-processing.	saveto="Main.VoteResults"
  bayesian	If set to "on", rating averages will be computed using the Bayesian average of this item against all the other items that have the same item in their stars field. This requires all the participating %VOTEs to be global, or to save their results to the same place using saveto. See http://www.thebroth.com/blog/118/bayesian-rating for more information about Bayesian rating.	bayesian="off"
  submit	If set to "off", this makes the %VOTE display the results of the vote without prompting for any input. This is useful when - for example - you want to show the results of a global vote, without permitting more voting.

• Example: %VOTE{ id="FavouriteMeal" select1="Drink" options1="Beer,Wine,Milk,Water" select2="Food" options2="Steak,Bread,Pasta,Pizza" }% shows two selectors named "Drink" and "Food", respectively, and a "Vote" button
• Category: ApplicationsAndComponentsVariables, DatabaseAndFormsVariables
• Related: VotePlugin (this topic)

WORKFLOW*{} -- manage workflows

• Associate a "state" with a topic and then control the work flow that the topic progresses through as content is added. The WorkflowPlugin expands the following variables:
• Controlling topics in the workflow:
  • %WORKATTACHTOPIC% - Expands to a link that lets you attach to the topic (if the user is not able to modify the topic, either in the workflow sense or according to the standard access controls, the link will be struck out).
  • %WORKEDITTOPIC% - Expands to a link that lets you edit the topic (if the user is not able to modify the topic, either in the workflow sense or according to the standard access controls, the link will be struck out).
  • %WORKFLOWFORK{...}% - Expands to a button that will create a copy of the current topic (see below for more details)
  • %WORKFLOWTRANSITION% - Expands to either (a) a pull-down menu if the user can perform more than one transition, (b) a button if the current user can only perform one transition, or (c) empty space if the current user is not allowed to perform any action. You can change the format of the button using a CSS class.
• Querying the workflow:
  • %WORKFLOWHISTORY% - Expands to the history of state transitions the topic has undergone. The format of the history is dictated by the WORKFLOWHISTORYFORMAT (described below).
  • %WORKFLOWLASTREV_State% - Expands to the version number when the document was last in the state State.
  • %WORKFLOWLASTTIME_State% - Expands to the timestamp when the document was last in the State last state. For example, %WORKFLOWLASTTIME_APPROVED% would be replaced by the timestamp when the document was last in the APPROVED state.
  • %WORKFLOWLASTVERSION_State% - Expands to a link to the version of the document when it was last in the state State.
  • %WORKFLOWSTATE% - Expands to the current state of the document. It can also be given a topic parameter (default), in which case the state of that topic is returned.
  • %WORKFLOWSTATEMESSAGE% - Expands to the corresponding message in the state table.
• Category: ApplicationsAndComponentsVariables, EditingAndContentUpdateVariables, WorkflowAndAutomationVariables
• Related: WorkflowPlugin for details (this topic)

Total: 28 variables

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart