TWiki Web>TWikiVariables>TWikiVariablesSearch>ApplicationsAndComponentsVariables

TWiki Variables » Search » Category: Applications & Components

Variables in this category:

ADDTOHEAD -- add HTML to the HTML head section of the current page

  • Useful for TWiki applications to add custom CSS or JavaScript to the HTML head section of a topic. Supplied TWiki variables will be expanded. %ADDTOHEAD{}% expands in-place to an empty string, unless there is an error in which case the variable expands to an error string.
  • Syntax: %ADDTOHEAD{ "..." text="..." }%
  • Supported parameters:
    Parameter: Description: Comment:
    "..." ID of the head block, such as "MY_CSS" Optional but recommended
    text="..." HTML text to add to the head section Mutually exclusive with topic=""
    topic="Web.TopicName" Name of topic that contains the full HTML text to add to the head section, such as topic="Main.MyCssTopic" Mutually exclusive with text=""
    section="name" If topic parameter is used, includes only the specified named section, as defined in the topic by the STARTSECTION and ENDSECTION variables. Nothing is shown if the named section does not exists. section="" is equivalent to not specifying a section Optional
    requires="..., ..." Comma-separated list of other IDs this one depends on Optional
  • Category: ApplicationsAndComponentsVariables, DevelopmentVariables
  • Example: %ADDTOHEAD{ "MYBOX_CSS" text="<style type=\"text/css\"> .myBox { height: 22px; background-color: #AFB3C5; } </style>" }% (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:
    รข\x{fffd}ยข "below" - color picker is located below the input field;
    รข\x{fffd}ยข "popup" - pop-up a color picker window when clicking the button next to the input field
        (this uses very little vertical space);
    รข\x{fffd}ยข "view" - a read-only rectangular block colored in the color value (no color picker);
    รข\x{fffd}ยข "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

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:
    ParameterSorted ascending Description Default Example
    Additional HTML input field attributes, such as alt, disabled, maxlength, onblur, onchange, onfocus, readonly, style, tabindex, title    
    class CSS class of input field. "twikiInputField" class="dateField"
    format Format of resulting date value.
    รข\x{fffd}ยข %a - abbreviated weekday name
    รข\x{fffd}ยข %A - full weekday name
    รข\x{fffd}ยข %b - abbreviated month name
    รข\x{fffd}ยข %B - full month name
    รข\x{fffd}ยข %C - century number
    รข\x{fffd}ยข %d - the day of the month (00 ... 31)
    รข\x{fffd}ยข %e - the day of the month (0 ... 31)
    รข\x{fffd}ยข %H - hour (00 ... 23)
    รข\x{fffd}ยข %I - hour (01 ... 12)
    รข\x{fffd}ยข %j - day of the year ( 000 ... 366)
    รข\x{fffd}ยข %k - hour (0 ... 23)
    รข\x{fffd}ยข %l - hour (1 ... 12)
    รข\x{fffd}ยข %m - month (01 ... 12)
    รข\x{fffd}ยข %M - minute (00 ... 59)
    รข\x{fffd}ยข %n - a newline character
    รข\x{fffd}ยข %p - "PM" or "AM"
    รข\x{fffd}ยข %P - "pm" or "am"
    รข\x{fffd}ยข %S - second (00 ... 59)
    รข\x{fffd}ยข %s - number of seconds since Epoch (since Jan 01 1970 00:00:00 UTC)
    รข\x{fffd}ยข %t - a tab character
    รข\x{fffd}ยข %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.
    รข\x{fffd}ยข %u - the day of the week (1 ... 7, 1 = MON)
    รข\x{fffd}ยข %w - the day of the week (0 ... 6, 0 = SUN)
    รข\x{fffd}ยข %y - year without the century (00 ... 99)
    รข\x{fffd}ยข %Y - year including the century (ex. 2012)
    รข\x{fffd}ยข %% - a literal % character     		"%Y-%m-%d" format="%e %b %Y"
    id ID of input field, optional. "id_" + name id="idStart"
    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"
    size Size of input field, in number of characters. (calculated as needed) size="12"
    value Initial date value. "" (today) value="2012-12-31"
  • Example:
    <form action="...">
    %DATEPICKER{ name="Start_Date" }%
    <form>
  • Expands to:
  • Category: ApplicationsAndComponentsVariables, DatabaseAndFormsVariables, DateAndTimeVariables, EditingAndContentUpdateVariables, FormattingAndRenderingVariables, UIAndVisualizationVariables
  • Related: DatePickerPlugin, TWikiForms (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, such as menu. May optionally contain a JSON path, such as menu.File.Open. (required)
    format="..." Format with supported variables:
    รข\x{fffd}ยข $name for variable name
    รข\x{fffd}ยข $value for variable value
    รข\x{fffd}ยข $isdefined expanding to 1 or 0 depending if variable is defined or not
    รข\x{fffd}ยข $isset expanding to 1 or 0 depending if variable is logically true or false
    รข\x{fffd}ยข $ispersistent expanding to 1 or 0 depending if variable is persistent or not
    รข\x{fffd}ยข 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)
    store="..." Specify a store name that holds the persistent variable. This assumes the variable was previously set with the same store name. ""
  • Example: %GET{"lunch"}% returns Sushi if the following has been previously set:
    %SET{ "lunch" value="Sushi" }% - see more examples
  • JSON Syntax: %GET{ name }% - see description.
  • Example to set a JSON object and to get a JSON object with a JSON path:
    • %SET{ menu = { "File": { "New": [ "new", "F" ], "Open": [ "open", "F" ] }, "Edit": { "Copy": [ "cpy", "F" ], "Paste": [ "pst", "F" ] } } }% - set a JSON object
    • %GET{ menu.File.Open }% - returns: ["open","F"]
  • Category: ApplicationsAndComponentsVariables, DevelopmentVariables
  • Related: IF, SET, SETGETDUMP, SetGetPlugin, SpreadSheetPlugin#FuncGET (this topic)

HEADLINES{"url"} -- show RSS and ATOM feeds in TWiki pages

  • The %HEADLINES{"url"}% variable is handled by the HeadlinesPlugin.
  • Syntax: %HEADLINES{ "http://..." }%
  • Parameters: (all but the first one are optional)
    "..." Source of RSS or ATOM feed; this can be a URL (starting with http) or a web.topic location for internal feeds
    refresh="60" Refresh rate in minutes for caching feed; "0" for no caching
    limit="12" Maximum number of items shown
    header="..." Header. May include these variables:
    - $channeltitle, $title: title of channel (channel.title)
    - $channellink, $link: link of channel (channel.link)
    - $channeldescription, $description: description (channel.description)
    - $channeldate, $date: publication date of the channel (channel.pubDate)
    - $rights: copyrights of the channel (channel.copyright)
    - $imagetitle: title text for site (image.title)
    - $imagelink: link for site (image.link)
    - $imageurl: URL of image (image.url)
    - $imagedescription: description of image (image.description)
    format="..." Format of one item. May include these variables:
    - $title: news item title (item.title)
    - $link: news item link (item.link)
    - $description: news item description (item.description)
    - $date: the publication date (item.pubDate, item.date)
    - $category: the article category (item.category)
    newline="$br" Convert newlines in feed; "$br" becomes <br /> tag, default "$n" (newline)
    filter="..." Filter out content from feed; for example to delete an encoded break tag specify "&lt;br&gt;"
    Details
  • Example: %HEADLINES{ "http://slashdot.org/slashdot.rdf" header="*[[$link][$title]]:* $description" format="$t* [[$link][$title]]" limit="4" }% shows the latest Slashdot news in bullet list format
  • Category: ApplicationsAndComponentsVariables, ImportVariables
  • Related: HeadlinesPlugin (this topic)

JQENDTAB -- end a JQuery tab within a tab pane

JQENDTABPANE -- end a JQuery tab pane

JQTAB -- start a JQuery tab within a tab pane

  • This variable is handled by the JQueryPlugin. For description see JQTABPANE
  • Syntax: %JQTABPANE% %JQTAB{"Tab 1"}% ... %JQENDTAB% %JQTAB{"Tab 2"}% ... %JQENDTAB% ... %JQENDTABPANE%
  • Supported parameters:
    Parameter: Description: Default:
    "..." Name of tab, shown as tab label (required)
    before When switching tabs, this is the Javascript fragment to be executed just before the tab is displayed ""
    after This Javascript handler is to be executed after the tab has been made visible ""
    afterload This Javascript handler will be called when content loaded asynchronously has finished loading (using the url parameter described below). Depending on the network latency and server response time, this can be significantly later than execution of the after handler above ""
    url Link from where to load the content of the tab asynchronously when selecting this tab; the result of the addressed handler will replace the content area; if no url is set the content of the TAB ... ENDTAB area will be shown when the tab is selected ""
    container Container element (".someClass" or "#someID") where content will be loaded asynchronously using Ajax; this is only used together with url ".jqTabContents"
    class Add additional class to existing tab class "jqTab" ""
  • Example: See complete example at JQTABPANE
  • Example: Asynchronously load the content of TimBernersLee topic into a tab content:
    %JQTABPANE%
    %JQTAB{ "Tim Berners-Lee" url="%SCRIPTURL{view}%/TWiki/TimBernersLee?skin=text" }%
    %ICON{processing}%
    %JQENDTAB%
    %JQENDTABPANE%
  • Category: ApplicationsAndComponentsVariables, FormattingAndRenderingVariables
  • Related: JQENDTAB, JQENDTABPANE, JQTABPANE, JQueryPlugin (this topic)

JQTABPANE -- start a JQuery tab pane

  • 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.
  • Syntax: %JQTABPANE{ select="1" }% %JQTAB{"Tab 1"}% ... %JQENDTAB% %JQTAB{"Tab 2"}% ... %JQENDTAB% ... %JQENDTABPANE%
  • Supported parameter:
    Parameter: Description: Default:
    select="" Select a tab pane, default is the first tab. "1"
  • Note: A tab can be selected with a tab URL parameter using %JQTABPANE{ select="%URLPARAM{tab}%" }%
  • Example:
    %JQTABPANE%
    %JQTAB{"Tab 1"}%
    Tab 1 content...
    %JQENDTAB%
    %JQTAB{"Tab 2"}%
    Tab 2 content...
    %JQENDTAB%
    %JQENDTABPANE%
  • Renders as:

    Tab 1

    Tab 1 content...

    Tab 2

    Tab 2 content...
  • Category: ApplicationsAndComponentsVariables, FormattingAndRenderingVariables
  • Related: JQENDTAB, JQENDTABPANE, JQTAB, JQueryPlugin (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. It is also possible to set a JSON object using a JSON path. 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. Alternatively use the store parameter. See important notes. "0"
    store="..." Specify a store name to persistently store the variable, such as store="Parts". Use alphanumeric characters, dashes and underscores for the name. For better performance, store is preferred over the remember parameter if you need to store a large dataset. See important notes. ""
  • Example: %SET{"lunch" value="Sushi"}% - see more examples.
  • JSON Syntax: %SET{ name = { ... } remember="1" }% - see description.
    • An optional remember="1" or store="..." parameter can be appended. If specified, the JSON object will be stored persistently so that it can be used later in any TWiki topic.
  • Example to set, modify and get a JSON object:
    • %SET{ menu = { "File": { "New": [ "new", "F" ], "Open": [ "open", "F" ] }, "Edit": { "Copy": [ "cpy", "F" ], "Paste": [ "pst", "F" ] } } }% - set a JSON object
    • %GET{ menu }% - returns: {"File":{"New":["new","F"],"Open":["open","F"]},"Edit":{"Copy":["cpy","F"],"Paste":["pst","F"]}}
    • %SET{ menu.File.Open[1] = "T" }% - modify a JSON object
    • %GET{ menu }% - returns: {"File":{"New":["new","F"],"Open":["open","T"]},"Edit":{"Copy":["cpy","F"],"Paste":["pst","F"]}}
    • %SET{ menu.Edit.Cut = [ "cut", "T" ] }% - add to a JSON object
    • %GET{ menu }% - returns: {"File":{"New":["new","F"],"Open":["open","T"]},"Edit":{"Copy":["cpy","F"],"Paste":["pst","F"],"Cut":["cut","T"]}}
  • Category: ApplicationsAndComponentsVariables, DevelopmentVariables
  • Related: GET, IF, SETGETDUMP, SetGetPlugin, SpreadSheetPlugin#FuncSET (this topic)

SETGETDUMP{...} -- dump variables

TWISTY{ attributes } -- dynamically open and close sections of content

Total: 13 variables

Categories: Administration, Applications & Components, Attachments & Files, Charting & Drawing, Database & Forms, Date & Time, Development, Editing & Content Update, Email & Notification, Export & Publishing, Formatting & Rendering, Import, Linking & Navigation, Searching & Listing, Security & Access Control, Skins & Templates, System Information, Tables & Spreadsheets, UI& Visualization, Users & Authentication, Workflow & Automation

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart

 
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.ApplicationsAndComponentsVariables