%ANCHORLINK{"AnchorExample"}%
. When hovering over text where an anchor link has been added, a icon will appear on the left side. Clicking on it will show the #AnchorExample
in the browser URL bar for easy copy & paste. The %ANCHORLINK{}%
variable is handled by the AnchorLinkPlugin.
%ANCHORLINK{"id"}%
Parameter | Description | Default | Example |
---|---|---|---|
"id" | Identifier (name) of the anchor. Use only: a-z , A-Z , 0-9 , _ , - | (required) | "Progress" |
%ANCHORLINK{"AnchorExample"}%
<a name="AnchorExample"></a>
, along with logic to show/hide the anchor link icon
%CHART{}%
variable is handled by the ChartPlugin.
%CHART{ attributes }%
- supported attributes are documented in ChartPlugin
%CHART{ type="bar" name="bar1" table="monthly_sales" data="R3:C2..R5:C4" xaxis="R1:C2..R1:C4" legend="R3:C1..R5:C1" ymin="0" width="225" height="200" }%
%CODE{}%
and %ENDCODE%
variables are handled by the SyntaxHighlightingPlugin.
%CODE{"language"}% ...code... %ENDCODE%
Parameter | Description | Default |
---|---|---|
"..." orlang="..." | Source language. Supported languages: ada , asm , awk , bash , changelog , cpp , csh , c , delphi , diffs , diff , diffu , dylan , eiffel , elisp , Name: , forth , fortran_pp , fortran , haskell , html , icon , idl , inf , javascript , java , ksh , lua , m4 , mail , makefile , matlab , nroff , oberon2 , objc , outline , oz , pascal , perl , php , postscript , pyrex , python , rfc , ruby , scheme , sh , skill , Smalltalk , sml , sql , states , synopsys , tcl , tcsh , tex , vba , verilog , vhdl , vrml , wmlscript , zsh | (none, required) |
num="..." | Show line numbers next to the source code. An integer indicates the start number. Also "on" and "off" | "off" |
step="..." | Increment line numbers with the given step. Negative numbers will decrement. | "1" |
style="..." | Style of box around the source code | light gray box |
numstyle="..." | Style of line number column | light brown box |
• Expands to: <sticky> %CODE{"cpp" num="on"}% void foo() { print("Do stuff.\n"); } %ENDCODE% </sticky> |
1void foo() { 2 print("Do stuff.\n"); 3 } |
%COLORPICKER{}%
variable is handled by the ColorPickerPlugin.
%COLORPICKER{ name="..." value="..." }%
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. |
<form action="...">
%COLORPICKER{ name="text_color" value="#123456" class="twikiInputField" type="popup" }%
<form>
%DASHBOARD{...}%
variable.
%DASHBOARD{ section="..." ... }%
%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" }%
%DATEPICKER{}%
variable is handled by the DatePickerPlugin.
%DATEPICKER{ name="..." value="..." }%
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 |
<form action="...">
%DATEPICKER{ name="Start_Date" }%
<form>
%DRAWING{}%
variable is handled by the TWikiDrawPlugin.
%DRAWING{ name }%
Parameter | Description | Default |
---|---|---|
"..." | Name of drawing. Allowed characters are A-Z , a-z , 0-9 , . , _ , - . | "untitled" |
%DRAWING{"workflow"}%
%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{}%
.
%EXECUTE{ "script" ... }%
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="2024-03-28" |
%EXECUTE{ "qa_results" date="%URLPARAM{date}%" }%
%FLOWCHART{}%
, %FLOWCHART_START%
and %FLOWCHART_STOP%
variables are handled by the FlowchartPlugin.
%FLOWCHART{}%
... %FLOWCHART_START%
... %FLOWCHART_STOP%
%FLOWCHART{}%
: Parameter | Description |
---|---|
item-w | Width for the flowchart's itens area |
item-h | Height for the flowchart's itens |
area-w | Width of the area of the flowchart's itens |
area-h | Height of the area of the flowchart's itens |
percent | Percentage of the PNG size presented in relation to the standard of the generated SVG |
text-size | Size in pixels of the font text |
tag-style | Style for the img tag |
%FLOWCHART%
%FLOWCHART_START%
---++ Flowchart Start
* Type: Start
---++ Question 1
* Type: Question
* Yes: trunk1
* No: trunk2
---++ Start of %FLOWCHART_BR% Trunk 1
* Id: trunk1
* Color: 70B070
---++ End of Trunk 1
* Type: End
---++ Start of %FLOWCHART_BR% Trunk 2
* Id: trunk2
* Color: E0B040
---++ End of Trunk 2
* Type: End
%FLOWCHART_STOP%
%GAUGE{}%
variable is handled by the GaugePlugin.
%GAUGE{ type="..." name="..." value="..." }%
Attribute | Comment | Default |
---|---|---|
type | The type of gauge, type="tambar" for target measure bar, or type="trend" for trend icon | Global TYPE setting |
name | Name to uniquely identify the gauge file that is auto-created. | None; required for tambar |
value | For tambar : The actual value of the gaugeFor trend : Positive = arrow up, 0 = arrow right, negative = arrow down | None. Show "no data" if missing |
alt | Alternate text for image | Value is value parameter |
width | Defines the width of the gauge in pixels. | Global <type>_WIDTH setting |
height | Defines the height of the gauge in pixels. | Global <type>_HEIGHT setting |
scale | For tambar : Defines the number and position of the scales. For example a value of "5, 12, 35, 57" denotes that there are three regions on the bar gauge, "5...12" , "12...35" and "35...57" . For trend : N/A | Global <type>_SCALE setting |
colors | For tambar : List of colors, each region has two colors. For trend : N/A | Global <type>_COLORS setting |
%GAUGE{ type="tambar" name="t1" scale="0, 10, 20, 40" value="27" }%
shows
%GAUGE{ type="trend" name="t2" value="-3" }%
shows
%HIERARCHICALSELECT{}%
variable is handled by the HierarchicalSelectPlugin.
%HIERARCHICALSELECT{ topic="MenuDefinition" ... }%
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 |
%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" }%
%PERCENTCOMPLETE{}%
variable is handled by the PercentCompletePlugin.
%PERCENTCOMPLETE{ name="..." value="..." }%
Parameter | Description | Default | Example |
---|---|---|---|
name | Name of selector | (required) | name="Progress" |
value | Initial value, range 0 to 100. | "0" | value="70" |
<form action="...">
%PERCENTCOMPLETE{ name="Progress" value="30" }%
<form>
%QRCODE{}%
variable is handled by the QRCodePlugin
%QRCODE{ "..." ... }%
"..."
- text to encode as QR Code.
ecc="..."
- error Correction Capability. Valid values "L"
, "M"
, "Q"
, "H"
. Default "M"
.
version="..."
- symbol version of QR Code, or size of matrix. Valid values "1"
... "40"
, and "auto"
for automatic versioning. Default "8"
.
size="..."
- module size, e.g. pixel size of a block (bit) that makes up the matrix of the barcode. Default "4"
.
format="..."
- format of HTML img
tag of generated QR Code image. Supported variables: $urlpath
- URL path of image, $width
- image width, $height
- image height. Default: "<img src='$urlpath' width='$width' height='$height' border='0' alt='' />"
.
%QRCODE{ "http://twiki.org/" version="2" size="3" }%
returns above QR Code.
%RENDERLIST%
variable is handled by the RenderFormPlugin.
%RENDERFORM{ "ATWikiFormDefinition" }%
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" |
%RENDERLIST{ "IT.HelpDeskForm" }%
%SLIDESHOWEND%
variable is handled by the SlideShowPlugin
%SLIDESHOWEND%
%SLIDESHOWSTART%
variable is handled by the SlideShowPlugin
%SLIDESHOWSTART%
%SLIDESHOWSTART{ template="MyOwnSlideTemplate" }%
%SLIDESHOWSTART%
---++ Sample Slide 1
* Bullet 1
* Bullet 2
---++ Sample Slide 2
* Bullet 1
* Bullet 2
%SLIDESHOWEND%