TWiki Variables » Search » Category: Development

CALC{"formula"} -- add spreadsheet calculations to tables

• The %CALC{formula}% variable is handled by the SpreadSheetPlugin. Around 100 functions are available, such as $ABS(), $EXACT(), $EXISTS(), $GET()/$SET(), $IF(), $LOG(), $LOWER(), $PERCENTILE(), $TIME(), $VALUE().
• Syntax: %CALC{formula}%
• Examples:
  • %CALC{$SUM($ABOVE())}% returns the sum of all cells above the current cell
  • %CALC{$EXISTS(Web.SomeTopic)}% returns 1 if the topic exists
  • %CALC{$UPPER(Collaboration)}% returns COLLABORATION
• Note: The CALC variable is handled with delay compared to other TWiki variables. You may get unexpected results if you nest CALC inside other variables (such as %INCLUDE{%CALC{...}%}%) because it does not get evaluated inside-out & left-to-right like ordinary TWiki variables. Use CALCULATE if you nest variables.
• Category: DevelopmentVariables, TablesAndSpreadsheetsVariables
• Related: CALCULATE, IF, IfStatements, SpreadSheetPlugin (this topic)

CALCULATE{"formula"} -- handle spreadsheet calculations outside tables

• The %CALCULATE{formula}% variable is handled by the SpreadSheetPlugin. Around 100 functions are available, such as $ABS(), $EXACT(), $EXISTS(), $GET()/$SET(), $IF(), $LOG(), $LOWER(), $PERCENTILE(), $TIME(), $VALUE().
• Syntax: %CALC{formula}%
• Examples:
  • %CALC{$EXISTS(Web.SomeTopic)}% returns 1 if the topic exists
  • %CALC{$UPPER(Collaboration)}% returns COLLABORATION
• Note: The CALCULATE variable is handled inside-out & left-to-right like ordinary TWiki variables, but it does not support functions that refer to table cells, such as $LEFT() or $T(). Use CALC instead.
• Category: DevelopmentVariables, TablesAndSpreadsheetsVariables
• Related: CALC, IF, IfStatements, SpreadSheetPlugin (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)

EDITFORMFIELD{"fieldname" form=""} -- render an input field specified in a form template topic

• Use this to create HTML forms that update TWikiForms, such as a custom "create new topic" form, or a topic header that allows users to change some form values at the top of the page. A valid form is composed of a start form type, various form fields, a submit type, and an end form type.
• Syntax:
  • %EDITFORMFIELD{"fieldname" form="...Form"}% - create form field defined in a TWiki Form template
  • %EDITFORMFIELD{"fieldname" topic="..."}% - create form field based on a topic that has a TWiki Form & initialize its value
  • %EDITFORMFIELD{"fieldname" type="..."}% - create an HTML input field
• Supported parameters:

  Parameter:	Description:	Default:
  "fieldname"	The name of a TWiki form field or HTML form field.	Required
  form="..."	Name of form template topic, such as "BugForm". Specify topic name or Web.TopicName	Either form or topic is required unless type is specified
  topic="..."	Name of topic containing form, such as "Bug1234". Specify topic name or Web.TopicName
  format="..."	Format string. Supported variables: • $inputfield - rendered form input field. • $title - raw field name (includes space and other special characters). • $name - field name (sanitized title). • $size - size of field or selector. • $value - initial value, or select options. • $tooltip - tooltip message. • $attributes - type attributes, such as H for hidden, M for mandatory. • $extra - extra information, such as * for mandatory field. See details in TWikiForms#FormFieldTypes. This parameter is ignored if type="..." is specified.	"$inputfield"
  value="..."	Initial value of input field. If omitted and if topic="..." is specified, the value is taken from the named form field.	""
  type="start"	Special case: Start an HTML form. Parameters: "form" type="start" action="save" topic="..." method="" onsubmit="" onreset="" • action: Specify a TWiki script (view, edit, save, ...), or a full action URL, default "view". • topic: Specify topic name or Web.TopicName, default current topic; ignored if full action URL is provided. • method: HTML form action method, default "post" for save action, else "get". • onsubmit: Execute JavaScript when the form is submitted, optional. • onreset: Execute JavaScript when the reset button is clicked, optional.	""
  type="end"	Special case: End an HTML form. Parameters: "form" type="end"	""
  type="..."	Special case: Create an input field regardless of the type defined in the TWikiForm. Used mainly for hidden fields and submit button. The nameless parameter is the field name. Supported types: • "fieldname" type="hidden" value="..." - hidden input field. • "fieldname" type="submit" value="..." - submit button, value is button label. • "fieldname" type="button" value="..." onclick="..." - regular button, value is button label. • "fieldname" type="text" value="..." size="80" - text input field. • "fieldname" type="checkbox" value="..." text="..." - checkbox, text is display text. • "fieldname" type="radio" value="..." text="..." - radio button, text is display text. • In addition, any valid XHML and HTML5 input type is supported, such as type="date", type="file", type="image". Additional type-specific parameters can be supplied, such as alt="", checked="checked", class="", max="", min="", src="", style="", width="". Consult HTML documentation.	""

• Example: %EDITFORMFIELD{ "ReleaseType" form="PackageForm" value="Beta-1" }%
• Example: Custom form in an included header to update some values of the base topic
  %EDITFORMFIELD{ "form" type="start" action="save" topic="%BASEWEB%.%BASETOPIC%" method="post" }%
| Priority: | %EDITFORMFIELD{ "Priority" topic="%BASETOPIC%" }% |
| Status:   | %EDITFORMFIELD{ "Status"   topic="%BASETOPIC%" }% |
|  | %EDITFORMFIELD{ "form" type="submit" value="Update" }% |
%EDITFORMFIELD{ "Updated" type="hidden" value="%SERVERTIME{$year-$mo-$day}%" }%
%EDITFORMFIELD{ "form" type="end" }%
• Category: DatabaseAndFormsVariables, DevelopmentVariables, EditingAndContentUpdateVariables
• Related: EDITTABLE, FORMFIELD, METASEARCH, SEARCH, FormattedSearch, QuerySearch, SearchHelp, TWikiForms, TWikiScripts, TWikiTemplates (this topic)

ENTITY{string} -- encode a string to HTML entities

• Encode "special" characters to HTML entities. Useful to encode text properly for HTML input fields.
• Encoded characters:
  • all non-printable ASCII characters below space, including newline ("\n") and linefeed ("\r")
  • Space
  • HTML special characters "<", ">", "&", single quote (') and double quote (")
  • TWiki special characters "%", "[", "]", "@", "_", "*", "=" and "|"
• Syntax: %ENTITY{string}%
• Example: %ENTITY{text with "quotes" and
newline}% expands to text with "quotes" and
newline
• Notes:
  • To protect against cross-site scripting (XSS), always entity encode text intended for HTML input fields. This is especially true if text is received dynamically via URLPARAM or the like.
    Example: <input type="text" name="address" value="%ENTITY{any text}%" />
  • %ENTITY{string}% is roughly equivalent to %ENCODE{ "string" type="html" }%, but the latter cannot handle strings that have double quotes embedded in it.
• Category: DevelopmentVariables, FormattingAndRenderingVariables, ExportAndPublishingVariables
• Related: ENCODE, FORMFIELD, QUERYPARAMS, URLPARAM (this topic)

EXAMPLEVAR -- example variable

• The %EXAMPLEVAR{}% variable is handled by the EmptyPlugin
• Syntax: %EXAMPLEVAR{"text" format="..."}%
• Parameter text="..." - example text.
• Parameter format="..." - format of report.
• Example: %EXAMPLEVAR{"hello" format="| $topic: $summary |"}%
• Category: DevelopmentVariables
• Related: EmptyPlugin (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.	(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)

• Example: %GET{"lunch"}% returns Sushi if the following has been previously set:
  %SET{ "lunch" value="Sushi" }% - see more examples
• Category: ApplicationsAndComponentsVariables, DevelopmentVariables
• Related: IF, SET, SETGETDUMP, SetGetPlugin, SpreadSheetPlugin#FuncGET (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. 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. See important notes.	"0"

• Example: %SET{"lunch" value="Sushi"}% - see more examples.
• Category: ApplicationsAndComponentsVariables, DevelopmentVariables
• Related: GET, IF, SETGETDUMP, SetGetPlugin, SpreadSheetPlugin#FuncSET (this topic)

SETGETDUMP{...} -- dump persistent variables

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

  Parameter	Description	Default
  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#FuncSET (this topic)

USERREPORT -- show user reports with profile pictures

• Show various user reports documented in UserReports
• Syntax: %USERREPORT{ action="..." ... }%
• Overview of actions with parameters:

  Report	action=	Parameters
  Show a simple list of registered users	"user_list"	search, limit, sort, reverse
  Show the profile picture image of a user	"profile_picture"	user, height, width, title
  Show slim, one line height user boxes	"slim_box_start" "slim_box" or "slim_box_list" "slim_box_end"	style user, style users, style none
  Show small, two line height user boxes	"small_box_start" "small_box" or "small_box_list" "small_box_end"	style user, style users, style none
  Show users in business card format	"business_card_start" "business_card" or "business_card_list" "business_card_end"	style user, style users, style none
  Show a selector to pick a user, for use in HTML forms	"select_one_user"	name, selected, users
  Show rows of checkboxes to select users, for use in HTML forms	"select_users"	name, selected, users, colums, style

• Example: %USERREPORT{ action="user_list" search="jane" limit="5" }%
• Category: AdministrationVariables, DevelopmentVariables, UsersAndAuthenticationVariables
• Related: BUBBLESIG, SEARCH, USERSIG, UserList, UserReports (this topic)

Total: 10 variables

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart