Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
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.
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
Note: %<color>BG% section must end with %ENDBG%. If you want to switch from one background color to another one you first need to end the active background color with %ENDBG%, such as %REDBG% some text %ENDBG% %GREENBG% more text %ENDBG%.
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
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.
Note:%<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
Expands to a formatted list of user groups in your TWiki. The variable is intended to be used in TWikiGroups, to allow a group listing for various user mapping managers.
Format of one row, may include tokens: • $group - topic name of group • $grouplink - link to group • $members - list of members, up to limit • standard format tokens
"| $grouplink | $members |"
header=""
Table header. Standard format tokens are expanded. To omit the header, specify an empty value or "none".
"| *Group* | *Members* |"
memberformat=""
Format of one member, may include tokens: • $wikiusername - Web.TopicName of user • $wikiname - TopicName of user
"[[$wikiusername][$wikiname]]"
memberlimit=""
Truncate member list. Specify "all" for full list.
By default, the members of a group are listed in the same order as in the definition in the group topic. With this parameter, members are listed in the alphabetical order of their wiki names.
Text inside the HIDE is removed when viewing the topic. This can be used to remove large amounts of text from being sent to the browser, such as the user list in Main.TWikiUsers if there are many thousands of users.
Syntax: %HIDE{ any text }%
Expands to: (empty string)
Notes:
Using HIDE is not a replacement for access control, because edit and raw view still show the content.
Variables inside HIDE still get expanded because variables execute inside out, e.g. you can't use it to speed up slow variables.
<!-- HTML comments --> also hide content from the user, but unlike HIDE, HTML comments are sent to the browser.
ICON{"name"} -- small documentation graphic or icon of common attachment types
Generates the HTML img tag of a small graphic image attached to TWikiDocGraphics. Images typically have a 16x16 pixel size. You can select a specific image by name, or you can give a full file path or URL, in which case the type of the file will be used to select one of a collection of common file type icons.
Format of icon. Supported variables (with %ICON{"person"}% example): • $name - name of icon (person) • $type - type of icon (gif) • $filename - icon filename (person.gif) • $web - web where icon is defined (TWiki) • $topic - topic where icon is defined (TWikiDocGraphics) • $description - icon description (Person) • $width - width of icon ('16') • $height - height of icon ('16') • $img - full img tag of icon (<img src="... />) • $info - icon tag with usage info in title • $url - URL of icon (http://example.com/pub/TWiki/TWikiDocGraphics/person.gif) • $urlpath - URL path of icon (/pub/TWiki/TWikiDocGraphics/person.gif)
format="$img"
default="else"
Alternate icon if named icon is not defined
default="$name"
Examples:
%ICON{"flag-gray"}% returns:
%ICON{"pdf"}% returns:
%ICON{"smile.pdf"}% returns:
%ICON{"/home/sweet/home.pdf"}% returns:
%ICON{"http://twiki.org/doc/xhtml.xsl"}% returns:
%ICON{"bubble" format="$description icon is defined in $web.$topic"}% returns: Speech bubble icon is defined in TWikiDocGraphics
Graphic samples: arrowbright, bubble, choice-yes, hand
File type samples: bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip
ICONURL{"name"} -- URL of small documentation graphic or icon
Generates the full URL of a TWikiDocGraphics image, which TWiki renders as an image. The related %ICON{"name"}% generates the full HTML img tag. Specify image name or full filename (see ICON for details on filenames.)
ICONURLPATH{"name"} -- URL path of small documentation graphic or icon
Generates the URL path of a TWikiDocGraphics image, typically used in an HTML img tag. Specify image name or full filename (see ICON for details on filenames.)
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.
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
a comma-separated list of arguments to be interpolated in the string, replacing the [_N] placeholders in it.
none
Examples:
%MAKETEXT{string="Notes:"}% expands to Notes:
%MAKETEXT{"If you have any questions, please contact [_1]." args="%WIKIWEBMASTER%"}% expands to If you have any questions, please contact grammaton76@gunwiki.net.
%MAKETEXT{"Did you want to ~[~[[_1]~]~[reset [_2]'s password~]~]?" args="%SYSTEMWEB%.ResetPassword, %WIKINAME%"}% expands to Did you want to reset TWikiGuest's password?
Notes:
TWiki will translate the string to the current user's language only if it has such string in its translation table for that language.
Ampersands (&) followed by one letter (one of a...z, A...Z -- say, X) in the translatable string will be translated to <span class='twikiAccessKey'>X</span>. This is used to implement access keys. If you want to write an actual amperstand that stays just before a letter, write two consecutive amperstands (&&): they will be transformed in just one.
Square brackets ~[ and ~] in the text have a special meaning and need to be escaped using ~[ and ~], respectively.
Translatable string starting with underscores (_) are reserved. You must not use translatable phrases starting with an underscore.
Make sure that the translatable string is constant. Specially, do not include %VARIABLES% inside the translatable strings - string would not get translated because variables get expanded before the %MAKETEXT{...}% itself is handled.
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
The WYSIWYG editor tends to change into normal space. Use this variable where non-breaking space needs to be retained, such as in empty table headings.
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).
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
Add %PARENTBC% to a heading of a topic to show the breadcrumb of its parents. Parent topics are linked, topic names are shown spaced out in a smaller font, and are separated by » quotes. In addition, a parentlistSetGetPlugin variable is set to the parent list, and a parent variable is set to the immediate parent. This can be retrieved later in the topic using %GET{parentlist}% and %GET{parent}%, respectively.
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
REDBG is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of background colors.
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
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
Set table sorting by clicking headers "on" or "off".
unspecified
sort="on"
initsort
Column to sort initially ("1" to number of columns).
unspecified
initsort="2"
initdirection
Initial sorting direction for initsort, set to "up" (descending) or "down" (ascending).
unspecified
initdirection="up"
disableallsort
Disable all sorting, both initsort and header sort. This is mainly used by plugins such as the EditTablePlugin to disable sorting in a table while editing the table.
unspecified
disableallsort="on"
headerbg
Header cell background color.
"#6b7f93"
headerbg="#999999"
headerbgsorted
Header cell background color of a sorted column.
the value of headerbg
headerbgsorted="#32596c"
headercolor
Header cell text color.
"#ffffff"
headercolor="#0000cc"
databg
Data cell background color, a comma separated list. Specify "none" for no color, that is to use the color/background of the page the table is on.
"#edf4f9,#ffffff"
databg="#f2f2f2,#ffffff"
databgsorted
Data cell background color of a sorted column; see databg.
the values of databg
databgsorted="#d4e8e4,#e5f5ea"
datacolor
Data cell text color, a comma separated list.
unspecified
datacolor="#0000CC, #000000"
tableborder
Table border width (pixels).
"1"
tableborder="2"
tableframe
Table frame, set to "void" (no sides), "above" (the top side only), "below" (the bottom side only), "hsides" (the top and bottom sides only), "lhs" (the left-hand side only), "rhs" (the right-hand side only), "vsides" (the right and left sides only), "box" (all four sides), "border" (all four sides).
unspecified
tableframe="hsides"
tablerules
Table rules, set to "none" (no rules), "groups" (rules will appear between row groups and column groups only), "rows" (rules will appear between rows only), "cols" (rules will appear between columns only), "all" (rules will appear between all rows and columns).
unspecified
tablerules="rows"
cellpadding
Cell padding (pixels).
"0"
cellpadding="0"
cellspacing
Cell spacing (pixels).
"0"
cellspacing="3"
cellborder
Cell border width (pixels).
unspecified
cellborder="0"
valign
Vertical alignment of cells and headers, set to "top", "middle", "bottom" or "baseline".
unspecified
valign="top"
headervalign
Vertical alignment of header cells; overrides valign.
unspecified
headervalign="top"
datavalign
Vertical alignment of data cells; overrides valign.
unspecified
datavalign="top"
headeralign
Header cell alignment, one value for all columns, or a comma separated list for different alignment of individual columns. Set to "left", "center", "right" or "justify". Overrides individual cell settings.
unspecified
headeralign="left,right"
dataalign
Data cell alignment, one value for all columns, or a comma separated list for different alignment of individual columns. Set to "left", "center", "right" or "justify". Overrides individual cell settings.
unspecified
dataalign="center"
tablewidth
Table width: Percentage of window width, or absolute pixel value.
unspecified
tablewidth="100%"
columnwidths
Column widths: Comma delimited list of column widths, percentage or absolute pixel value.
unspecified
columnwidths="80%,20%"
headerrows
Number of header rows to exclude from sort. (will be rendered in a HTML thead section)
(determined automatically)
headerrows="2"
footerrows
Number of footer rows to exclude from sort. (will be rendered in a HTML tfoot section)
"0"
footerrows="1"
id
Unique table identifier string, used for targeting a table with CSS.
tableN (where N is the table order number on the page)
id="userTable"
summary
Table summary used by screenreaders: A summary of what the table presents. It should provide an orientation for someone who listens to the table.
unspecified
summary="List of subscribed users"
caption
Table caption: A title that will be displayed just above the table.
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
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. An abbreviated heading can be shown in the TOC, such as "---++ text!! this is excluded from TOC".
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. An abbreviated heading can be shown in the TOC, such as "---++ text!! this is excluded from TOC".
Expands to: white text (shown with a gray background here)
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
TWiki Web>TWikiVariables>TWikiVariablesSearch>FormattingAndRenderingVariables (11 Nov 2012, TWikiContributor)
TWiki Guest - 20 Jun 2026
Edit | Attach | 
Site map
Gunwiki web
User registration
Groups
Index
Search
Changes
Notifications
RSS Feed
Statistics
Preferences
Copyright © 1999-2026 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.