TWiki Variables » Search » Category: UI& Visualization

CHART{ attributes } -- create area, bar, line and scatter charts to visualize TWiki tables

• The %CHART{}% variable is handled by the ChartPlugin.
• Syntax: %CHART{ attributes }% - supported attributes are documented in ChartPlugin
• Example: %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" }%
• Category: ChartingAndDrawingVariables, UIAndVisualizationVariables
• Related: ChartPlugin, ChartPluginTests, SpreadSheetPlugin (this topic)

CODE{"language"} -- format and syntax highlight code fragments

• The %CODE{}% and %ENDCODE% variables is handled by the BeautifierPlugin.
• Syntax: %CODE{"language"}% ...code... %ENDCODE%
• Parameters:

  Parameter	Description	Default
  "language"	Beautify language. Available languages: bash, c++, c#, java, javascript, lua, makefile, perl, plsql, php3, phython, scheme, tcl, html, xml, verilog, vhdl	(none, required)

• Example:                   • Expands to:

  %CODE{"cpp"}% void foo() {   print("Do stuff.\n"); } %ENDCODE%

  void foo() { print("Do stuff.\n"); }

• Category: FormattingAndRenderingVariables, UIAndVisualizationVariables
• Related: BeautifierPlugin (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)

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)

DRAWING -- vector drawing editor and clickable maps for diagrams and workflows

• The %DRAWING{}% variable is handled by the TWikiDrawPlugin.
• Syntax: %DRAWING{ name }%
• Parameter:

  Parameter	Description	Default
  "..."	Name of drawing. Allowed characters are A-Z, a-z, 0-9, ., _, -.	"untitled"

• Example: %DRAWING{"workflow"}%
• Category: ChartingAndDrawingVariables, EditingAndContentUpdateVariables, UIAndVisualizationVariables
• Related: TWikiDrawPlugin (this topic)

FLOWCHART{} -- create a flowchart from topic text

• The %FLOWCHART{}%, %FLOWCHART_START% and %FLOWCHART_STOP% variables are handled by the FlowchartPlugin.
• Syntax: %FLOWCHART{}% ... %FLOWCHART_START% ... %FLOWCHART_STOP%
• Parameters of %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

• Example:
  %FLOWCHART%
%FLOWCHART_START%
---++ Flowchart Start
  * Type: Start
---++ Question 1
  * Type: Question
  * Yes: trunk1
  * No: trunk2
---++ Start of Trunk 1
  * Id: trunk1
  * Color: 70B070
---++ End of Trunk 1
  * Type: End
---++ Start of Trunk 2
  * Id: trunk2
  * Color: E0B040
---++ End of Trunk 2
  * Type: End
%FLOWCHART_STOP%
• Category: FormattingAndRenderingVariables, UIAndVisualizationVariables
• Related: FlowchartPlugin, FlowchartPluginExample (this topic)

GAUGE{ attributes } -- create graphical images of gauges, typically used for dashboards

• The %GAUGE{}% variable is handled by the GaugePlugin.
• Syntax: %GAUGE{ type="..." name="..." value="..." }%
• Supported attributes:

  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 gauge For 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

• Examples:
  • %GAUGE{ type="tambar" name="t1" scale="0, 10, 20, 40" value="27" }% shows
  • %GAUGE{ type="trend" name="t2" value="-3" }% shows
• Category: ChartingAndDrawingVariables, FormattingAndRenderingVariables, UIAndVisualizationVariables
• Related: GaugePlugin, GaugePluginTests (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)

QRCODE -- create QR Code (a matrix barcode) in TWiki pages

• The %QRCODE{}% variable is handled by the QRCodePlugin
• Syntax: %QRCODE{ "..." ... }%
• Parameter "..." - text to encode as QR Code.
• Parameter ecc="..." - error Correction Capability. Valid values "L", "M", "Q", "H". Default "M".
• Parameter version="..." - symbol version of QR Code, or size of matrix. Valid values "1" ... "40", and "auto" for automatic versioning. Default "8".
• Parameter size="..." - module size, e.g. pixel size of a block (bit) that makes up the matrix of the barcode. Default "4".
• Parameter 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='' />".
• Example: %QRCODE{ "http://twiki.org/" version="2" size="3" }% returns above QR Code.
• Category: ExportAndPublishingVariables, FormattingAndRenderingVariables, UIAndVisualizationVariables
• Related: QRCodePlugin (this topic)

SLIDESHOWEND -- end slideshow

• The %SLIDESHOWEND% variable is handled by the SlideShowPlugin
• Syntax: %SLIDESHOWEND%
• Example: See SLIDESHOWSTART
• Category: FormattingAndRenderingVariables, UIAndVisualizationVariables
• Related: SLIDESHOWSTART, SlideShowPlugin (this topic)

SLIDESHOWSTART -- convert a topic with headings into a slideshow

• The %SLIDESHOWSTART% variable is handled by the SlideShowPlugin
• Syntax: %SLIDESHOWSTART%
• Syntax: %SLIDESHOWSTART{ template="MyOwnSlideTemplate" }%
• Example:
  %SLIDESHOWSTART%
---++ Sample Slide 1
    * Bullet 1
    * Bullet 2
---++ Sample Slide 2
    * Bullet 1
    * Bullet 2
%SLIDESHOWEND%
• Category: FormattingAndRenderingVariables, UIAndVisualizationVariables
• Related: SLIDESHOWEND, SlideShowPlugin (this topic)

TOC -- table of contents of current topic

• 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".
• Syntax: %TOC%
• Category: FormattingAndRenderingVariables, UIAndVisualizationVariables
• Related: INCLUDE, TOC{"Topic"} (this topic)

TOC{"Topic"} -- table of contents

• 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".
• Syntax: %TOC{"SomeTopic" ...}%
• Supported parameters:

  Parameter:	Description:	Default:
  "TopicName"	Topic name	Current topic
  web="Name"	Name of web	Current web
  depth="2"	Limit depth of headings shown in TOC	TOC_MAX_DEPTH if defined. Otherwise 6
  mindepth="2"	Specify the minimum depth of headings	TOC_MIN_DEPTH if defined. Otherwise 1
  title="Some text"	Title to appear at top of TOC	none (TOC_TITLE setting)
  style="..."	Style to apply to the TOC	none (TOC_STYLE setting)

• Example: %TOC{depth="2"}%
• Example: %TOC{"TWikiDocumentation" web="TWiki" title="Contents:" style="float: right;"}%
• Category: FormattingAndRenderingVariables, UIAndVisualizationVariables
• Related: INCLUDE, TOC (this topic)

Total: 14 variables

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart