TWiki Variables » Search » Category: UI& Visualization

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
  Additional parameters can be supplied; they will be added to the HTML input field or the rectangular color block.
  class	CSS class of input field or the rectangular color block	(none)	class="twikiInputField"
  value	Initial color value, in hexadecimal notation for the combination of Red, Green, and Blue color values (RGB).	(none)	value="#0000ff"
  name	Name of input field	(required)	name="text_color"
  size	Size of input field, in number of characters	(browser default)	size="8"
  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"

• 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)

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)

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: 8 variables

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart