TWiki> TWiki Web>TWikiVariables>TWikiVariablesSearch>FormattingAndRenderingVariables (11 Nov 2012, TWikiContributor)

TWiki Variables » Search » Category: Formatting & Rendering

Variables in this category:

AQUA -- start aqua colored text

BB -- bullet with line break

BB2 -- level 2 bullet with line break

BB3 -- level 3 bullet with line break

BB4 -- level 4 bullet with line break

BLACK -- start black colored text

BLUE -- start blue colored text

BR -- line break

BROWN -- start brown colored text

BUBBLESIG -- show bubble box and user signature with profile picture icon

  • Syntax: %BUBBLESIG{WikiName}% or %BUBBLESIG{WikiName - YYYY-MM-DD}%
  • The parameter can be either just the WikiName of a user, or by convention the WikiName followed by a dash and the date
  • Example:
    -- %BUBBLESIG{TWikiGuest - 22 Nov 2024}%
  • Expands to:
    -- TWiki Guest - 22 Nov 2024
  • Category: EditingAndContentUpdateVariables, FormattingAndRenderingVariables, UsersAndAuthenticationVariables
  • Related: USERREPORT, USERSIG, UserList, UserReports (this topic)

BULLET -- bullet sign

CARET -- caret symbol

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)

COPY -- Copyright symbol

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

ENDBG -- end background color section

ENDCOLOR -- end colored text

ENDCOLUMNS -- end a responsive multi-column page layout

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&#32;with&#32;&#34;quotes&#34;&#32;and&#10;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.
  • Category: DevelopmentVariables, FormattingAndRenderingVariables, ExportAndPublishingVariables
  • Related: ENCODE, FORMFIELD, QUERYPARAMS, URLPARAM (this topic)

FORM{} -- render a TWiki form for view

  • Show a table containing data of a TWiki form attached to a topic
  • Syntax: %FORM{topic="..." formfields="..." ...}%
  • Supported parameters:
    Parameter: Description: Default:
    "..." or
    topic="..."     		Name of topic containing the TWiki form, such as "Bug1234". Specify topic name or Web.TopicName Current topic
    rev="..." Get the form from the specified topic revision, range "1" to top revision of topic. "0" is equivalent to the top revision The rev URL parameter value if present, else the top revision
    formfields="..., ..." Specify names of TWiki form fields to show, in sequence. The all token shows all remaining fields. "all"
    header="..." Form header, typically containing the form name. If "on", the default format "|  *[[$formweb.$formtopic][$formtopic]]*  ||" is used. If "none", the header is suppressed. Supported variables:
    • $formweb - name of web containing the form definition.
    • $formtopic - name of topic containing the form definition.     		"on"
    format="..." Format of one form field. Supported variables:
    • $title - raw field name (includes space and other special characters).
    • $name - field name (sanitized title).
    • $type - form field type.
    • $size - size of field or selector.
    • $value - form field value.
    • $value(20, -<br />) - value hyphenated every 20 characters using separator -<br />.
    • $value(30, ...) - value shortened to 30 characters.
    • $length - length of form field value.
    • $tooltip - tooltip message.
    • $attributes - type attributes, such as H for hidden, M for mandatory.
    • $formweb - name of web containing the form definition.
    • $formtopic - name of topic containing the form definition.
    See details in TWikiForms.     		"| $title: | $value |"
    separator="..." Line separator. Variable $br expands to <br /> tag, and $n to a newline. "$n"
    default="..." Text shown when no form or form fields are found ""
    newline="$br" Convert newlines in textarea to other delimiters. Variable $br expands to <br /> tag, and $n to a newline. Other text is encoded based on encode parameter. "$br" if format is a TWiki table, else "\n"
    encode="html" Encode special characters in form field value into HTML entities. Additional encodings available: encode="quote", encode="moderate", encode="safe", encode="entity" and encode="url". See ENCODE for details. "" (no encoding)
    showhidden="..." Set to "on" to show also hidden form fields. ""
  • Examples:
    • %FORM{topic="%INCLUDINGTOPIC%"}% - show form data of the including topic (typically used in an included header)
    • %FORM{topic="Projects.SushiProject" formfields="Title, Status, Deadline" header="none"}% - show a subset of form fields
    • %FORM{format="$name" header="none" separator=", "}% - get all visible form field names as a list
  • Category: DatabaseAndFormsVariables, DevelopmentVariables, FormattingAndRenderingVariables
  • Related: EDITFORM, EDITFORMFIELD, ENCODE, ENTITY, FORMFIELD, META, METASEARCH, SEARCH, TWikiForms, FormattedSearch, QuerySearch, SearchHelp (this topic)

FORMFIELD{"fieldname"} -- render a field in the form attached to some topic

  • Syntax: %FORMFIELD{"fieldname"}%
  • Supported parameters:
    Parameter: Description: Default:
    "fieldname" The name of a TWiki form field required
    topic="..." Topic where form data is located. May be of the form Web.TopicName Current topic
    rev="..." Get the form field value from the specified topic revision, range "1" to top revision of topic. "0" is equivalent to the top revision The rev URL parameter value if present, otherwise the top revision
    format="..." Format string. Supported variables:
    • $value - form field value
    • $value(20, -<br />) - value hyphenated every 20 characters using separator -<br />
    • $value(30, ...) - value shortened to 30 characters
    • $length - length of value (can be used to test if value is set)
    • $title - raw field name (includes space and other special characters)
    • $name - field name (sanitized title)
    • $attributes - form field attributes
    • $formtopic - name of form definition topic     		"$value"
    default="..." Text shown when no value is defined for the field ""
    alttext="..." Text shown when field is not found in the form ""
    newline="$br" Convert newlines in textarea to other delimiters. Variable $br expands to <br /> tag, and $n to a newline. Other text is encoded based on encode parameter. no conversion
    encode="html" Encode special characters into HTML entities. If a FORMFIELD is passed into an HTML form field it should be encoded as "html". Additional encodings available: encode="quote", encode="moderate", encode="safe", encode="entity", encode="url" and encode="csv". See ENCODE for details. "" (no encoding)
  • Example: %FORMFIELD{ "ProjectName" topic="Projects.SushiProject" default="(not set)" alttext="ProjectName field not found" }%
  • Example: %FORMFIELD{ "Title" topic="%INCLUDINGTOPIC%" }%
    • Note: Specify topic="%INCLUDINGTOPIC%" if you have a base topic that includes a report topic, and in the report topic you want to reference a field of the base topic
  • Example: %FORMFIELD{ "LastName" topic="%USERSWEB%.%WIKINAME%" encode="safe" }%
    • Note: Returns the "LastName" field from your profile page TWikiGuest
    • TIP Tip: Use encode="safe" to guard against Cross-Site Scripting (XSS) attacks
  • Example: <input type="text" name="Address" value="%FORMFIELD{ "Address" encode="html" }%" />
    • Note: It is easier to use EDITFORMFIELD for custom input fields
  • Category: DatabaseAndFormsVariables, DevelopmentVariables, FormattingAndRenderingVariables
  • Related: EDITFORM, EDITFORMFIELD, ENCODE, ENTITY, FORM, META, METASEARCH, SEARCH, TWikiForms, FormattedSearch, QuerySearch, SearchHelp (this topic)

FOURCOLUMNS -- responsive four-column page layout

  • Write %FOURCOLUMNS% ...text... %ENDCOLUMNS% to get a page layout with four columns. The layout is responsive, e.g. it automatically adjusts to a lower number of columns (4 => 3 => 2 => 1) depending on the window width or screen width of the device used. The 300 pixels minimum width of a column determines the number of columns shown. Embedded images scale down automatically to the width of the screen if needed.
  • Syntax: %FOURCOLUMNS% ... %ENDCOLUMNS%
  • Example:
    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed viverra ante ac augue sagittis semper. Vestibulum sed urna quam. Phasellus eleifend dolor id dui dictum lobortis. Etiam enim erat, fermentum eget libero non, pretium vestibulum nisi. Nam eget nisi diam. Cras egestas, nibh a malesuada hendrerit, tellus turpis gravida dolor, at fermentum ipsum libero id eros. Mauris a nunc turpis. Fusce turpis dui, blandit nec maximus at, sagittis et arcu. Duis eros sapien, accumsan sed varius eget, elementum eu sapien. Nulla congue, nulla efficitur gravida porta, leo ex feugiat purus, sit amet sagittis leo arcu at magna. Pellentesque eleifend, libero quis consectetur tincidunt, orci ipsum scelerisque turpis, vulputate feugiat risus orci non odio. Integer id enim turpis. Cras et nisl quis massa ornare maximus id sit amet justo. Mauris at mi eget nisi imperdiet ullamcorper.
  • Type: Preference variable - TWikiRenderingShortcut.
  • Category: FormattingAndRenderingVariables
  • Related: TWOCOLUMNS, THREECOLUMNS, ENDCOLUMNS, TWikiPreferences rendering shortcuts (this topic)

GRAY -- start gray colored text

GREEN -- start green colored text

GROUPS -- a formatted list of groups

  • 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.
  • Syntax: %GROUPS{"format" ...}%
  • Supported parameters:
    Parameter: Description: Default:
    header="" Table header. Standard format tokens are expanded. To omit the header, specify an empty value or "none". "| *Group* | *Members* |"
    format="" 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 |"
    separator="" Line separator. Standard format tokens are expanded. "$n" (newline)
    memberlimit="" Truncate member list. Specify "all" for full list. "32"
    memberformat="" Format of one member, may include tokens:
    • $wikiusername - Web.TopicName of user
    • $wikiname - TopicName of user     		"[[$wikiusername][$wikiname]]"
    memberseparator="" Separator for members. Standard format tokens are expanded. ", "
    sort="on" 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. "off"
  • Category: FormattingAndRenderingVariables
  • Related: REMOTE_USER, USERINFO, USERNAME, WIKIUSERNAME, WIKIUSERSTOPIC (this topic)

H -- help icon

HIDE{text} -- hide content in topic view

  • 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 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.
  • Category: FormattingAndRenderingVariables
  • Related: HIDEINPRINT, NOP, STARTSECTION (this topic)

HIDEINPRINT{text} -- hide content when printing

I -- idea icon

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.
  • Syntax: %ICON{"name"}%
  • Supported parameters:
    Parameter: Description: Default:
    "name" Name of icon required
    format="..." Format of icon. Supported variables (with Person %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: Gray flag
    • %ICON{"pdf"}% returns: PDF
    • %ICON{"smile.pdf"}% returns: PDF
    • %ICON{"/home/sweet/home.pdf"}% returns: PDF
    • %ICON{"http://twiki.org/doc/xhtml.xsl"}% returns: XSL (XML style sheet)
    • %ICON{"bubble" format="$description icon is defined in $web.$topic"}% returns: Speech bubble icon is defined in TWikiDocGraphics
  • Graphic samples: Arrow blue right arrowbright, Speech bubble bubble, Yes / Done choice-yes, Pointing hand hand
  • File type samples: Bitmap bmp, Microsoft Word file doc, GIF gif, Standard help file hlp, HTML html, Waveform sound file mp3, PDF pdf, PowerPoint ppt, Text txt, Microsoft Excel Spreadsheet xls, XML xml, Compressed Zip archive zip
  • Category: FormattingAndRenderingVariables
  • Related: ICONURL, ICONURLPATH, TWikiPreferences, FileAttachments, TWikiDocGraphics (this topic)

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.)
  • Syntax: %ICONURL{"name"}%
  • Examples:
    • %ICONURL{"arrowbright"}% returns https://junobase.com/pub/TWiki/TWikiDocGraphics/arrowbright.gif
    • %ICONURL{"novel.pdf"}% returns https://junobase.com/pub/TWiki/TWikiDocGraphics/pdf.gif
    • %ICONURL{"/queen/boheme.mp3"}% returns https://junobase.com/pub/TWiki/TWikiDocGraphics/wav.gif
  • Category: FormattingAndRenderingVariables
  • Related: ICONURLPATH, ICON, TWikiPreferences, FileAttachments, TWikiDocGraphics (this topic)

ICONURLPATH{"name"} -- URL path of small documentation graphic or icon

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)

LAQUO -- left double angle quote

LIME -- start lime colored text

M -- moved to... icon

MAKETEXT -- translate text using TWiki's I18N infrastructure

  • Text in MAKETEXT is translated into another language at page view time if the user activates a language other than the default English language.
  • Syntax: %MAKETEXT{"string" args="..."}%
  • Supported parameters:
    Parameter Description Default
    "text" or string="text" The text to be displayed. none
    args="param1, param2" 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 beheer@junolink.nl.
    • %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.
  • Category: DevelopmentVariables, FormattingAndRenderingVariables
  • Related: TWiki:Codev.UserInterfaceInternationalisation (on TWiki.org), CPAN:Locale::Maketext (Maketext documentation) (this topic)

MAROON -- start maroon colored text

N -- "new" icon

NAVY -- start navy blue colored text

NBSP -- non-breaking space

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).
  • Category: FormattingAndRenderingVariables, SkinsAndTemplatesVariables
  • Related: HIDE, HIDEINPRINT, STARTSECTION, TWikiTemplates (this topic)

OLIVE -- start olive green colored text

ORANGE -- start orange colored text

P -- pencil icon

PARENTBC -- parent breadcrumbs for headings

PINK -- start pink colored text

PURPLE -- start purple colored text

Q -- question icon

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

  • QR Code example 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)

RAQUO -- right double angle quote

RED -- start red colored text

REDBG -- start red colored background section

REG -- Registered Trademark symbol

RENDERLIST -- render bullet lists in a variety of formats

  • The %RENDERLIST% variable is handled by the RenderListPlugin
  • Syntax: %RENDERLIST%
  • Syntax: %RENDERLIST{ "org" focus="Sales.WestCoastTeam" }%
  • Example:
    %RENDERLIST{ "org" }%
       * [[Eng.WebHome][Engineering]]
          * [[Eng.TechPubs][Tech Pubs]]
       * [[Sales.WestCoastTeam][Sales]]
          * [[Sales.EastCoastTeam][East Coast]]
          * [[Sales.WestCoastTeam][West Coast]]
  • Category: FormattingAndRenderingVariables
  • Related: RenderListPlugin (this topic)

S -- red star icon

SILVER -- start silver colored text

SLIDESHOWEND -- end slideshow

SLIDESHOWSTART -- convert a topic with headings into a slideshow

SPACEDTOPIC -- topic name, spaced and URL-encoded deprecated

  • The current topic name with added URL-encoded spaces, for use in regular expressions that search for backlinks to the current topic
  • Syntax: %SPACEDTOPIC%
  • Expands to: Var%20*SPACEDTOPIC
  • Note: This is a deprecated variable. It can be duplicated with %ENCODE{%SPACEOUT{"%TOPIC%" separator=" *"}%}%
  • Category: FormattingAndRenderingVariables
  • Related: SPACEOUT, TOPIC, ENCODE (this topic)

SPACEOUT{"string"} -- renders string with spaces inserted in sensible places

  • Inserts spaces between word components. Word component boundaries are transitions from lowercase to uppercase or numeric, from numeric to uppercase or lowercase, and from uppercase to numeric characters.
  • Useful for spacing out WikiWords
  • Syntax: %SPACEOUT{ "%TOPIC%" }%
  • Expands to: TWiki Variables Category Body
  • Supported parameters:
    Parameter: Description: Default:
    separator The separator to put between words e.g. %SPACEOUT{"DogsCatsBudgies" separator=", "}% -> Dogs, Cats, Budgies ' '
  • TIP 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
  • Category: FormattingAndRenderingVariables
  • Related: SPACEDTOPIC, $PROPERSPACE() of SpreadSheetPlugin (this topic)

T -- tip icon

TABLE{ attributes } -- control attributes of tables and sorting of table columns

  • The %TABLE{}% variable is handled by the TablePlugin
  • Syntax: %TABLE{ attributes }%

  • Supported attributes:
    Argument Comment Default value Example
    sort 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. unspecified caption="Users"

TEAL -- start teal colored text

THREECOLUMNS -- responsive three-column page layout

  • Write %THREECOLUMNS% ...text... %ENDCOLUMNS% to get a page layout with three columns. The layout is responsive, e.g. it automatically adjusts to a lower number of columns (3 => 2 => 1) depending on the window width or screen width of the device used. The 300 pixels minimum width of a column determines the number of columns shown. Embedded images scale down automatically to the width of the screen if needed.
  • Syntax: %THREECOLUMNS% ... %ENDCOLUMNS%
  • Example:
    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed viverra ante ac augue sagittis semper. Vestibulum sed urna quam. Phasellus eleifend dolor id dui dictum lobortis. Etiam enim erat, fermentum eget libero non, pretium vestibulum nisi. Nam eget nisi diam. Cras egestas, nibh a malesuada hendrerit, tellus turpis gravida dolor, at fermentum ipsum libero id eros. Mauris a nunc turpis. Fusce turpis dui, blandit nec maximus at, sagittis et arcu. Duis eros sapien, accumsan sed varius eget, elementum eu sapien. Nulla congue, nulla efficitur gravida porta, leo ex feugiat purus, sit amet sagittis leo arcu at magna. Pellentesque eleifend, libero quis consectetur tincidunt, orci ipsum scelerisque turpis, vulputate feugiat risus orci non odio. Integer id enim turpis. Cras et nisl quis massa ornare maximus id sit amet justo. Mauris at mi eget nisi imperdiet ullamcorper.
  • Type: Preference variable - TWikiRenderingShortcut.
  • Category: FormattingAndRenderingVariables
  • Related: TWOCOLUMNS, FOURCOLUMNS, ENDCOLUMNS, TWikiPreferences rendering shortcuts (this topic)

TM -- Trademark symbol

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)

TWIKISHEET{} -- enable TWiki Sheet (spreadsheet) and set options

  • The %TWIKISHEET{}% variable is handled by the TWikiSheetPlugin
  • Syntax: %TWIKISHEET{ parameters }%
  • Supported parameters:
    Parameter Description Example Default
    mode Mode of operation:
    • mode="classic" - regular TWiki table and an edit button; once pressed, the table switches into spreadsheet edit mode.
    • mode="toggle" - spreadsheet in read-only mode and an edit button; once pressed, the table switches into spreadsheet edit mode.
    • mode="toggle-edit" - like "toggle" but initial state is spreadsheet edit mode.
    • mode="edit" - the table is always in spreadsheet edit mode.     		mode="edit" {Plugins}
    {TWikiSheetPlugin}
    {Mode}
    configure
    setting ("toggle")
    concurrent Concurrent editing. If enabled, multiple people can edit TWiki Sheet and see each other's changes. This includes editing cells, pasting a range of cells, drag-filling cells, adding/removing rows, adding/removing columns, and undo.
    • concurrent="0" - disable concurrent editing; changes by others will be shown after a page reload.
    • concurrent="1" - enable concurrent editing; changes by others will show up while editing TWiki Sheet.     		concurrent="1" {Plugins}
    {TWikiSheetPlugin}
    {ConcurrentEdit}
    configure
    setting ("0")
    save Optionally disable save; useful to demo the plugin save="0" save="1"
    width Table width in pixels; a horizontal scrollbar is added if needed width="500" (full window width)
    height Table height in pixels; a vertical scrollbar is added if needed height="300" (full table height)
    colHeaders Set to "false" to disable the default column headers (A, B, C); set to a function for custom headers, such as:
    colHeaders="function(index) { return String.fromCharCode(65+index) + ' (' + (index + 1) + ')'; }",
    which will show headers A (1), B (2), C (3), ...     		colHeaders="false" colHeaders="true"
    rowHeaders Set to "false" to disable the default row headers (1, 2, 3) rowHeaders="false" rowHeaders="true"
    contextMenu Defines the right-click context menu; set to "false" to disable; set to array of available strings, such as:
    contextMenu="['row_above', 'row_below', 'col_left', 'col_right', 'remove_row', 'remove_col', '---------', 'undo', 'redo']"     		contextMenu="false" contextMenu="true"
    fixedRowsTop Fixed number of rows shown on top; takes effect if height parameter is used fixedRowsTop="1" (none)
    fixedColumnsLeft Fixed number of columns shown on the left; takes effect if width parameter is used fixedColumnsLeft="2" (none)
    formulas Formula support; set to "false" to disable spreadsheet calculations in table cells, such as: =SUM(A1:A8) formulas="false" formulas="true"
    maxCols Maximum number of columns maxCols="10" (unlimited)
    maxRows Maximum number of rows maxRows="1000" (unlimited)
    minSpareCols When set to 1 (or more), automatically add a new column at the right if there are no more empty columns minSpareCols="1" minSpareCols="0"
    minSpareRows When set to 1 (or more), automatically add a new row at the bottom if there are no more empty rows minSpareRows="1" minSpareRows="0"
    wordWrap Word wrap; set to "false" to disable cell content wrapping if it does not fit in the fixed column width wordWrap="false" wordWrap="true"
    more... Additional Handsontable options can be used. Notes on types of values:
    • Number value: Specify the number, such as width="500"
    • String value: Enclose the string in single quotes, such as preventOverflow="'horizontal'"
    • Boolean value: Specify "true" or "false", such as manualRowResize="true"
    • Array value: Specify the array, such as manualRowResize="[40, 50]"
    • Object value: Specify the object, such as columnSorting="{ column: 2, sortOrder: true }"
    • Function: Specify the JavaScript function, such as:
       cells="function( row, col, prop ) { var cp = {}; if( row===0 ) { cp.readOnly = true; } return cp; }"     		     
  • Example:
    %TWIKISHEET{ mode="edit" save="0" }%
    |  | 16Q1 | 16Q2 | 16Q3 | 16Q4 |
    | East: | 163 | 182 | 208 | 193 |
    | Center: | 82 | 97 | 126 | 91 |
    | West: | 217 | 231 | 294 | 249 |
    | Total: | =SUM(B2:B4) | =SUM(C2:C4) | =SUM(D2:D4) | =SUM(E2:E4) |
    | Min: | =MIN(B2:B4) | =MIN(C2:C4) | =MIN(D2:D4) | =MIN(E2:E4) |
    | Max: | =MAX(B2:B4) | =MAX(C2:C4) | =MAX(D2:D4) | =MAX(E2:E4) |     		  screenshot.png
  • Category: DatabaseAndFormsVariables, EditingAndContentUpdateVariables, FormattingAndRenderingVariables, TablesAndSpreadsheetsVariables
  • Related: See TWikiSheetPlugin for more details (this topic)

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

TWOCOLUMNS -- responsive two-column page layout

  • Write %TWOCOLUMNS% ...text... %ENDCOLUMNS% to get a page layout with two columns. The layout is responsive, e.g. it automatically adjusts to a single column (2 => 1) depending on the window width or screen width of the device used. The 300 pixels minimum width of a column determines the number of columns shown. Embedded images scale down automatically to the width of the screen if needed.
  • Syntax: %TWOCOLUMNS% ... %ENDCOLUMNS%
  • Example:
    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed viverra ante ac augue sagittis semper. Vestibulum sed urna quam. Phasellus eleifend dolor id dui dictum lobortis. Etiam enim erat, fermentum eget libero non, pretium vestibulum nisi. Nam eget nisi diam. Cras egestas, nibh a malesuada hendrerit, tellus turpis gravida dolor, at fermentum ipsum libero id eros. Mauris a nunc turpis. Fusce turpis dui, blandit nec maximus at, sagittis et arcu. Duis eros sapien, accumsan sed varius eget, elementum eu sapien. Nulla congue, nulla efficitur gravida porta, leo ex feugiat purus, sit amet sagittis leo arcu at magna. Pellentesque eleifend, libero quis consectetur tincidunt, orci ipsum scelerisque turpis, vulputate feugiat risus orci non odio. Integer id enim turpis. Cras et nisl quis massa ornare maximus id sit amet justo. Mauris at mi eget nisi imperdiet ullamcorper.
  • Type: Preference variable - TWikiRenderingShortcut.
  • Category: FormattingAndRenderingVariables
  • Related: THREECOLUMNS, FOURCOLUMNS, ENDCOLUMNS, TWikiPreferences rendering shortcuts (this topic)

U -- "updated" icon

USERSIG -- show user signature with profile picture icon

VBAR -- vertical bar

WHITE -- start white colored text

WIP -- work in progress icon

X -- warning icon

Y -- "yes" icon

YELLOW -- start yellow colored text

Total: 83 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

Edit | Attach | Watch | Print version | History: r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r1 - 11 Nov 2012 - TWikiContributor
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2024 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.FormattingAndRenderingVariables.