TWiki Variables » Search » Category: Database & Forms

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)

DATATBL{"topic" format="..."} -- look up a table

• Look up a table in the TWiki table markup on the specified topic. And then compose an ouput in the similar manner as SEARCH{...}.
• Syntax: %DATATBL{ "topic" format="..." separator="..." }%
• Parameters:

  Parameter	Description	Default
  "topics"	comma separated topics whose first table is looked up. If multiple topics are specified, tables on the topics are combined and hanled as if there is one big table
  "escaped_variable"	Instead of comma separated topics, you can specify an escaped TWiki variable such as $percntINCLUDE{\"http://foo/bar\"}$percnt. Then the variable is expanded and the result becomes the data soruce. Read Getting table data dynamically for more information
  assumedcols="COLUMNS"	causes COLUMNS to be assumed. Read Referring to non-existent columns for more information
  evalcell="on"	causes variable expansion in table data. Read Expand variables in cells for more information	off
  COLUMN_NAME="VALUES"	select rows whose COLUMN_NAME column has either of comma separated VALUES. Read Select rows for more information
  by="COLUMN_NAME" value="VALUES"	Same as above. But if COLUMN_NAME starts with a lower case letter, this format needs to be used
  ignorenull="on"	causes null result to resort to ifnomatch value. Read Treat null value as no match for more information	off
  ignorecase="on"	causes string comparison to case insensitive	off
  sort="COLUMN" sorta="COLUMN" sortn="COLUMN"	sorts the output chunks based on a source table column. sort is for case-sensitive string sort, sorta is for case-insensitive (alphabetical) string sort, and sortn is for numeric sort. The sorting result is in the ascending order. To get the decending order, specify reverse="on" in addition	no sorting
  reverse="on"	specifies the order of output chunks to be reversed. If combined with sort="COLUMN", output chunks are sorted in the descending order
  limit="NUMBER"	specifies the maximum number of rows selected	no limit
  transposed="on"	species that the topics have transposed tables - the first column has field names and the second column has field values. Read Transposed tables for more information	off
  split="SPLIT_PATTERN"	may be used when transposed="on" (above) is specified. It specifies a pattern to split tables even within a table
  trfrom="SEARCH_LIST" trto="REPLACE_LIST" tropt="OPTIONS"	causes transliteration in the result. Read Transliteration for more information
  format="..."	specifies the format of each output chunk corresponding a selected source table row. Read Format parameter for more information	$Name
  separator="..."	specifies a separator between output chunks. This is the same as the separator parameter of SEARCH{...}	(null string)
  separatorN="..."	specifies a separator inserted every N output chunks. Read Different separators at different places for more information
  ifnomatch="STRING"	causes the STRING to be yielded when there is no matching row. Read When there is no match for more information

• Category: DevelopmentVariables, DatabaseAndFormsVariables, SearchingAndListingVariables
• Related: DataTablePlugin, SEARCH, FormattedSearch (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)

EDITTABLE{ attributes } -- edit TWiki tables using edit fields and other input fields

• The %EDITTABLE{}% variable is handled by the EditTablePlugin
• Syntax: %EDITTABLE{ attributes }%

• Supported attributes:

  Attribute	Comment	Default
  header	Specify the header format of a new table like "|*Food*|*Drink*|". Useful to start a table with only a button	(no header)
  format	The format of one column when editing the table. A cell can be a text input field, or any of these edit field types: • Text input field (1 line):   | text, <size>, <initial value> | • Textarea input field:   | textarea, <rows>x<columns>, <initial value> | • Drop down box:   | select, <size>, <option 1>, <option 2>, etc* |   * only one item can be selected • Radio buttons:   | radio, <size*>, <option 1>, <option 2>, etc |   * size indicates the number of buttons per line in edit mode • Checkboxes:   | checkbox, <size*>, <option 1>, <option 2>, etc |   * size indicates the number of checkboxes per line in edit mode • Fixed label:   | label, 0, <label text> | • Row number:   | row, <offset> | • Date:   | date, <size>, <initial value>, <DHTML date format*> |   * see Date Field Type	"text, 16" for all cells
  changerows	Rows can be added and removed if "on" Rows can be added but not removed if "add" Rows cannot be added or removed if "off"	CHANGEROWS plugin setting
  quietsave	Quiet Save button is shown if "on", hidden if "off"	QUIETSAVE plugin setting
  include	Other topic defining the EDITTABLE parameters. The first %EDITTABLE% in the topic is used. This is useful if you have many topics with the same table format and you want to update the format in one place.	(none)
  helptopic	Topic name containing help text shown below the table when editing a table. The %STARTINCLUDE% and %STOPINCLUDE% variables can be used in the topic to specify what is shown.	(no help text)
  headerislabel	Table header cells are read-only (labels) if "on"; header cells can be edited if "off" or "0"	"on"
  editbutton	Set edit button text, e.g. "Edit this table"; set button image with alt text, e.g. "Edit table, %PUBURL%/%SYSTEMWEB%/TWikiDocGraphics/edittopic.gif"; hide edit button at the end of the table with "hide" (Note: Button is automatically hidden if an edit button is present in a cell)	EDITBUTTON plugin setting
  buttonrow	Set to top to put the edit buttons above the table.	bottom
  javascriptinterface	Use javascript to directly move and delete row without page refresh. Enable with "on", disable with "off".	JAVASCRIPTINTERFACE plugin setting
  redirectto	Set up a return page after saving changes. e.g By setting redirectto="%BASEPAGE%", you can return to base page if your editable table is included by another page.	(none)

• Example:
  %EDITTABLE{ format="| text, 20 | select, 1, one, two, three |" changerows="on" }%
| *Name* | *Type* |
| Foo | two |
• Category: DatabaseAndFormsVariables, EditingAndContentUpdateVariables, TablesAndSpreadsheetsVariables
• Related: See EditTablePlugin for more details (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-01-29"

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

HIERARCHICALSELECT{ attributes } -- display hierarchical multi-level drop-down menus

• The %HIERARCHICALSELECT{}% variable is handled by the HierarchicalSelectPlugin.
• Syntax: %HIERARCHICALSELECT{ topic="MenuDefinition" ... }%
• Parameters:

  Parameter	Description	Default
  topic	Topic from which to read the menu definition	(required)
  web	Web from which to read the menu definition	current web
  key	String to use as the basis for naming of HTML form elements	Derived from menu topic
  level	If specified, select a menu level (integer starting from 0) to display	All levels
  parse_keywords	Flag: Nonzero sets parsing mode where first word of menu line is return-value keyword, remainder is text to display	Entire line used as both return value and display text

• Example with three levels:
  %HIERARCHICALSELECT{ web="TWiki" topic="HierarchicalSelectPluginExample" level="0" names="country,subdivision,region" }%
%HIERARCHICALSELECT{ web="TWiki" topic="HierarchicalSelectPluginExample" level="1" }%
%HIERARCHICALSELECT{ web="TWiki" topic="HierarchicalSelectPluginExample" level="2" }%
• Category: DatabaseAndFormsVariables, FormattingAndRenderingVariables, UIAndVisualizationVariables
• Related: HierarchicalSelectPlugin, HierarchicalSelectPluginExample, TWikiTemplates (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)

LDAP{"filter" format="format"} -- LDAP directory query

• An interface to query an LDAP directory and display the results in a TWiki topic
• Syntax: %LDAP{"filter" format="format" ...}%
• Supported parameters:

  Parameter:	Description:	Default:
  "uid=joeshmoe"	the LDAP query string	required
  filter="uid=joeshmoe"	(Alternative to above)	N/A
  host="..."	host IP or name to connect to
  port="..."	port to of the host
  version="..."	protocol version; possible values: 2,3
  ssl="..."	use ssl to bind to the server; possible values 0,1
  base="..."	base dn of the (sub)tree to search in; if base is written in brackets (e.g. 'base="(ou=people)"') then it is prepended to the default base	the default base of the LdapContrib
  scope="one"	scope of search; possible values: sub, base, one	sub
  format="..."	format string used to display a database record	$dn
  header="..."	header to prepend the output	no header
  footer="..."	footer to appended to the output	no footer
  sep="..." or separator="..."	separator between database records	$n (new line)
  sort="..."	name of attributes to sort the output	DN
  reverse="on"	reverse the result set; possible values: on, off	off
  limit="100"	maximum number of records to return	no limit
  skip="10"	number of records in the hit set to skip before displaying them	0 (nothing is skipped)
  required="..."	a comma separated list of LDAP record attributes. If specified, the LDAP query results not having all of the specified attributes are eliminated	nothing is required
  hidenull="on"	wether to hide any output on an empty hit set; possible values: on, off	off
  default="..."	when the LDAP query yields no results, the value of this parameter is returned as the search result instead of null. Naturally, if hidenull is on, default doesn't have any effect	"" (null string)
  clear="..."	comma separated list of attributes to be removed from the output if they are not resolved	nothing is cleared

• The header, format and footer format strings may contain the following variables and the standard special tokens:

  Variable:	Description:
  $count	the number of hits
  $index	the record number
  $<attr-name>	the value of the record attribute <attr-name>

• Example: %LDAP{"objectClass=posixAccount" format="| $index | $cn | $mail |"}%
• Category: DevelopmentVariables, DatabaseAndFormsVariables, SearchingAndListingVariables
• Related: LDAPUSERS, LdapNgPlugin, LdapContrib (this topic)

LDAPUSERS{...} -- LDAP user information

• List all LDAP user information. Information is drawn from cache and not from the LDAP server. Use ?refreshldap=on to update.
• Supported parameters:

  Parameter:	Description:	Default:
  format="..."	format string used to display a user record	ordered list of $displayName
  header="..."	header to prepend the output	no header
  footer="..."	footer to appended to the output	no footer
  sep="..."	separator between database records	$n (new line)
  limit="100"	maximum number of records to return	no limit
  skip="10"	number of records in the hit set to skip before displaying them	0 (nothing is skipped)
  include="..."	regular expression a user's WikiName must match to be included in the output
  exclude="..."	regular expression a user's WikiName must not match
  hideunknown="off"	on/off, enable/disable filtering out users that did not log in yet and thus have no home topic (e.g. created by TWiki:Plugins/NewUsersPlugin)	on

• The header, format and footer format strings may contain the following variables and the standard special tokens:

  Variable:	Description:
  $index	the record number
  $wikiName	the user's WikiName
  $loginName	the user's login name
  $displayName	a link pointing to the users home topic in the Main web, if it exists, and '<nop>$wikiName' otherwise
  $emails	the list of all known email addresses

• Example: %LDAPUSERS{limit="10"}%
• Category: DevelopmentVariables, DatabaseAndFormsVariables, SearchingAndListingVariables
• Related: LDAPUSERS, LdapNgPlugin, LdapContrib (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)

TWIKISHEET{} -- enable TWiki Sheet (spreadsheet) and set options

• The %TWIKISHEET{}% variable is handled by the TWikiSheetPlugin
• Syntax: %TWIKISHEET{ parameters }%
• Supported parameters:

  Parameter	Description	Example	Default
  mode	Mode of operation: • mode="classic" - regular TWiki table and an edit button; once pressed, the table switches into spreadsheet edit mode. • mode="toggle" - spreadsheet in read-only mode and an edit button; once pressed, the table switches into spreadsheet edit mode. • mode="toggle-edit" - like "toggle" but initial state is spreadsheet edit mode. • mode="edit" - the table is always in spreadsheet edit mode.	mode="edit"	{Plugins} {TWikiSheetPlugin} {Mode} configure setting ("toggle")
  concurrent	Concurrent editing. If enabled, multiple people can edit TWiki Sheet and see each other's changes. This includes editing cells, pasting a range of cells, drag-filling cells, adding/removing rows, adding/removing columns, and undo. • concurrent="0" - disable concurrent editing; changes by others will be shown after a page reload. • concurrent="1" - enable concurrent editing; changes by others will show up while editing TWiki Sheet.	concurrent="1"	{Plugins} {TWikiSheetPlugin} {ConcurrentEdit} configure setting ("0")
  save	Optionally disable save; useful to demo the plugin	save="0"	save="1"
  width	Table width in pixels; a horizontal scrollbar is added if needed	width="500"	(full window width)
  height	Table height in pixels; a vertical scrollbar is added if needed	height="300"	(full table height)
  colHeaders	Set to "false" to disable the default column headers (A, B, C); set to a function for custom headers, such as: colHeaders="function(index) { return String.fromCharCode(65+index) + ' (' + (index + 1) + ')'; }", which will show headers A (1), B (2), C (3), ...	colHeaders="false"	colHeaders="true"
  rowHeaders	Set to "false" to disable the default row headers (1, 2, 3)	rowHeaders="false"	rowHeaders="true"
  contextMenu	Defines the right-click context menu; set to "false" to disable; set to array of available strings, such as: contextMenu="['row_above', 'row_below', 'col_left', 'col_right', 'remove_row', 'remove_col', '---------', 'undo', 'redo']"	contextMenu="false"	contextMenu="true"
  fixedRowsTop	Fixed number of rows shown on top; takes effect if height parameter is used	fixedRowsTop="1"	(none)
  fixedColumnsLeft	Fixed number of columns shown on the left; takes effect if width parameter is used	fixedColumnsLeft="2"	(none)
  formulas	Formula support; set to "false" to disable spreadsheet calculations in table cells, such as: =SUM(A1:A8)	formulas="false"	formulas="true"
  maxCols	Maximum number of columns	maxCols="10"	(unlimited)
  maxRows	Maximum number of rows	maxRows="1000"	(unlimited)
  minSpareCols	When set to 1 (or more), automatically add a new column at the right if there are no more empty columns	minSpareCols="1"	minSpareCols="0"
  minSpareRows	When set to 1 (or more), automatically add a new row at the bottom if there are no more empty rows	minSpareRows="1"	minSpareRows="0"
  wordWrap	Word wrap; set to "false" to disable cell content wrapping if it does not fit in the fixed column width	wordWrap="false"	wordWrap="true"
  more...	Additional Handsontable options can be used. Notes on types of values: • Number value: Specify the number, such as width="500" • String value: Enclose the string in single quotes, such as preventOverflow="'horizontal'" • Boolean value: Specify "true" or "false", such as manualRowResize="true" • Array value: Specify the array, such as manualRowResize="[40, 50]" • Object value: Specify the object, such as columnSorting="{ column: 2, sortOrder: true }" • Function: Specify the JavaScript function, such as:    cells="function( row, col, prop ) { var cp = {}; if( row===0 ) { cp.readOnly = true; } return cp; }"

• Example:

  %TWIKISHEET{ mode="edit" save="0" }% |  | 16Q1 | 16Q2 | 16Q3 | 16Q4 | | East: | 163 | 182 | 208 | 193 | | Center: | 82 | 97 | 126 | 91 | | West: | 217 | 231 | 294 | 249 | | Total: | =SUM(B2:B4) | =SUM(C2:C4) | =SUM(D2:D4) | =SUM(E2:E4) | | Min: | =MIN(B2:B4) | =MIN(C2:C4) | =MIN(D2:D4) | =MIN(E2:E4) | | Max: | =MAX(B2:B4) | =MAX(C2:C4) | =MAX(D2:D4) | =MAX(E2:E4) |

• Category: DatabaseAndFormsVariables, EditingAndContentUpdateVariables, FormattingAndRenderingVariables, TablesAndSpreadsheetsVariables
• Related: See TWikiSheetPlugin for more details (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)

Total: 15 variables

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart