> > |
META TOPICPARENT |
name="TWikiVariablesSearch" |
Variables in this category:
AQUA -- start aqua colored text
BB -- bullet with line break
- Line break and bullet without indentation.
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%BB%
- Expands to:
•
- Category: FormattingAndRenderingVariables
- Related: BB2, BB3, BB4, BR, BULLET, CARET, LAQUO, NBSP, PARENTBC, RAQUO, VBAR, TWikiPreferences rendering shortcuts (this topic)
BB2 -- level 2 bullet with line break
- Line break and bullet, level 2.
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%BB2%
- Expands to:
•
- Category: FormattingAndRenderingVariables
- Related: BB, BB3, BB4, BR, BULLET, CARET, LAQUO, NBSP, PARENTBC, RAQUO, VBAR, TWikiPreferences rendering shortcuts (this topic)
BB3 -- level 3 bullet with line break
- Line break and bullet, level 3.
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%BB3%
- Expands to:
•
- Category: FormattingAndRenderingVariables
- Related: BB, BB2, BB4, BR, BULLET, CARET, LAQUO, NBSP, PARENTBC, RAQUO, VBAR, TWikiPreferences rendering shortcuts (this topic)
BB4 -- level 4 bullet with line break
- Line break and bullet, level 4.
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%BB4%
- Expands to:
•
- Category: FormattingAndRenderingVariables
- Related: BB, BB2, BB3, BR, BULLET, CARET, LAQUO, NBSP, PARENTBC, RAQUO, VBAR, TWikiPreferences rendering shortcuts (this topic)
BLACK -- start black colored text
BLUE -- start blue colored text
BR -- line break
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%BR%
- Expands to:
- Category: FormattingAndRenderingVariables
- Related: BB, BB2, BB3, BB4, BULLET, CARET, LAQUO, NBSP, PARENTBC, RAQUO, VBAR, TWikiPreferences rendering shortcuts (this topic)
BROWN -- start brown colored text
BUBBLESIG -- show bubble box and user signature with profile picture icon
BULLET -- bullet sign
- Bullet sign, useful to create a bullet list in a TWiki table, such as
| %BULLET% One %BB% Two %BB% Three |
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%BULLET%
- Expands to: •
- Category: FormattingAndRenderingVariables
- Related: BB, BB2, BB3, BB4, BR, CARET, LAQUO, NBSP, PARENTBC, RAQUO, VBAR, TWikiPreferences rendering shortcuts (this topic)
CARET -- caret symbol
- The caret variable can be used in TWiki tables.
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%CARET%
- Expands to: ^
- Category: FormattingAndRenderingVariables
- Related: BB, BB2, BB3, BB4, BR, BULLET, LAQUO, NBSP, PARENTBC, RAQUO, VBAR, TWikiPreferences rendering shortcuts (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)
COPY -- Copyright symbol
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%COPY%
- Expands to: ©
- Category: FormattingAndRenderingVariables
- Related: BB, BB2, BB3, BB4, BR, BULLET, LAQUO, NBSP, PARENTBC, RAQUO, REG, TM, VBAR, TWikiPreferences rendering shortcuts (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:
Parameter | Description | Default | Example<-- --> | class | CSS class of input field. | "twikiInputField" | class="dateField" | 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" | 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" | Additional HTML input field attributes, such as alt , disabled , maxlength , onblur , onchange , onfocus , readonly , style , tabindex , title | | | 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)
ENDBG -- end background color section
ENDCOLOR -- end colored text
-
ENDCOLOR is a rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%RED% red text %ENDCOLOR%
- Expands to: red text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Category: FormattingAndRenderingVariables
- Related: VarENDBG, VarAQUA, VarBLACK, VarBLUE, VarBROWN, VarGRAY, VarGREEN, VarLIME, VarMAROON, VarNAVY, VarOLIVE, VarORANGE, VarPINK, VarPURPLE, VarRED, VarSILVER, VarTEAL, VarWHITE, VarYELLOW, TWikiPreferences rendering shortcuts, StandardColors (this topic)
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 with "quotes" and 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)
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:
<input type="text" name="Address" value="%FORMFIELD{ "Address" encode="html" }%" />
- Category: DatabaseAndFormsVariables, DevelopmentVariables, FormattingAndRenderingVariables
- Related: EDITFORMFIELD, ENCODE, ENTITY, 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
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%H%
- Expands to:
- Category: FormattingAndRenderingVariables
- Related: I, ICON, M, N, P, Q, S, T, U, WIP, X, Y, TWikiDocGraphics (this topic)
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 Main.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
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%I%
- Expands to:
- Category: FormattingAndRenderingVariables
- Related: H, ICON, M, N, P, Q, S, T, U, WIP, X, Y, TWikiDocGraphics (this topic)
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 %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:
-
%ICON{"pdf"}% returns:
-
%ICON{"smile.pdf"}% returns:
-
%ICON{"/home/sweet/home.pdf"}% returns:
-
%ICON{"http://twiki.org/doc/xhtml.xsl"}% returns:
-
%ICON{"bubble" format="$description icon is defined in $web.$topic"}% returns: Speech bubble icon is defined in TWikiDocGraphics
- Graphic samples:
arrowbright , bubble , choice-yes , hand
- File type samples:
bmp , doc , gif , hlp , html , mp3 , pdf , ppt , txt , xls , xml , 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://www.xpdays.de/twiki/pub/TWiki/TWikiDocGraphics/arrowbright.gif
-
%ICONURL{"novel.pdf"}% returns https://www.xpdays.de/twiki/pub/TWiki/TWikiDocGraphics/pdf.gif
-
%ICONURL{"/queen/boheme.mp3"}% returns https://www.xpdays.de/twiki/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:
- 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:
- Category: ApplicationsAndComponentsVariables, FormattingAndRenderingVariables
- Related: JQENDTAB, JQENDTABPANE, JQTAB, JQueryPlugin (this topic)
LAQUO -- left double angle quote
- This variable is typically used in breadcrumbs.
- Syntax:
%LAQUO%
- Expands to: «
- Type: Preference variable - TWikiRenderingShortcut.
- Category: FormattingAndRenderingVariables
- Related: BB, BB2, BB3, BB4, BR, BULLET, NBSP, PARENTBC, RAQUO, VBAR, TWikiPreferences rendering shortcuts (this topic)
LIME -- start lime colored text
M -- moved to... icon
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%M%
- Expands to:
- Category: FormattingAndRenderingVariables
- Related: H, I, ICON, N, P, Q, S, T, U, WIP, X, Y, TWikiDocGraphics (this topic)
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 0.
-
%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
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%N%
- Expands to:
- Category: FormattingAndRenderingVariables, SkinsAndTemplatesVariables
- Related: H, I, ICON, M, P, Q, S, T, U, WIP, X, Y, TWikiDocGraphics (this topic)
NAVY -- start navy blue colored text
NBSP -- non-breaking space
- The WYSIWYG editor tends to change
into normal space. Use this variable where non-breaking space needs to be retained, such as in empty table headings.
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
'%NBSP%'
- Expands to: ' ' (HTML entity
)
- Category: FormattingAndRenderingVariables
- Related: BB, BB2, BB3, BB4, BR, BULLET, CARET, LAQUO, PARENTBC, RAQUO, VBAR, TWikiPreferences rendering shortcuts (this topic)
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
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%P%
- Expands to:
- Category: FormattingAndRenderingVariables
- Related: H, I, ICON, M, N, Q, S, T, U, WIP, X, Y, TWikiDocGraphics (this topic)
PARENTBC -- parent breadcrumbs for headings
- Add
%PARENTBC% to a heading of a topic to show the breadcrumb of its parents. Parent topics are linked, topic names are shown spaced out in a smaller font, and are separated by » quotes. In addition, a parentlist SetGetPlugin variable is set to the parent list, and a parent variable is set to the immediate parent. This can be retrieved later in the topic using %GET{parentlist}% and %GET{parent}% , respectively.
- Syntax:
%PARENTBC%
- Example raw text:
---+ %PARENTBC% Myself and me
- Expands to:
- Type: Preference variable - TWikiRenderingShortcut.
- Category: FormattingAndRenderingVariables
- Related: BB, BB2, BB3, BB4, BR, BULLET, LAQUO, NBSP, PARENTTOPIC, RAQUO, VBAR, TWikiPreferences rendering shortcuts (this topic)
PINK -- start pink colored text
PURPLE -- start purple colored text
Q -- question icon
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%Q%
- Expands to:
- Category: FormattingAndRenderingVariables
- Related: H, I, ICON, M, N, P, S, T, U, WIP, X, Y, TWikiDocGraphics (this topic)
RAQUO -- right double angle quote
- This variable is typically used in breadcrumbs.
- Syntax:
%RAQUO%
- Expands to: »
- Type: Preference variable - TWikiRenderingShortcut.
- Category: FormattingAndRenderingVariables
- Related: BB, BB2, BB3, BB4, BR, BULLET, LAQUO, NBSP, PARENTBC, VBAR, TWikiPreferences rendering shortcuts (this topic)
RED -- start red colored text
REDBG -- start red colored background section
REG -- Registered Trademark symbol
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%REG%
- Expands to: ®
- Category: FormattingAndRenderingVariables
- Related: BB, BB2, BB3, BB4, BR, BULLET, COPY, LAQUO, NBSP, PARENTBC, RAQUO, TM, VBAR, TWikiPreferences rendering shortcuts (this topic)
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
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%S%
- Expands to:
- Category: FormattingAndRenderingVariables
- Related: H, I, ICON, M, N, P, Q, T, U, WIP, X, Y, TWikiDocGraphics (this topic)
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 | ' ' |
- 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
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%T%
- Expands to:
- Category: FormattingAndRenderingVariables
- Related: H, I, ICON, M, N, P, Q, S, U, WIP, X, Y, TWikiDocGraphics (this topic)
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
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%TM%
- Expands to: ™
- Category: FormattingAndRenderingVariables
- Related: BB, BB2, BB3, BB4, BR, BULLET, COPY, LAQUO, NBSP, PARENTBC, RAQUO, REG, VBAR, TWikiPreferences rendering shortcuts (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)
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
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%U%
- Expands to:
- Category: FormattingAndRenderingVariables
- Related: H, I, ICON, M, N, P, Q, S, T, WIP, X, Y, TWikiDocGraphics (this topic)
USERSIG -- show user signature with profile picture icon
VBAR -- vertical bar
- The vertical bar variable can be used in TWiki tables.
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%VBAR%
- Expands to: |
- Category: FormattingAndRenderingVariables
- Related: BB, BB2, BB3, BB4, BR, BULLET, CARET, LAQUO, NBSP, PARENTBC, RAQUO, TWikiPreferences rendering shortcuts (this topic)
WHITE -- start white colored text
WIP -- work in progress icon
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%WIP%
- Expands to:
- Category: FormattingAndRenderingVariables
- Related: H, I, ICON, M, N, P, Q, S, T, U, X, Y, TWikiDocGraphics (this topic)
X -- warning icon
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%X%
- Expands to:
- Category: FormattingAndRenderingVariables
- Related: H, I, ICON, M, N, P, Q, S, T, U, WIP, Y, TWikiDocGraphics (this topic)
Y -- "yes" icon
- Type: Preference variable - TWikiRenderingShortcut.
- Syntax:
%Y%
- Expands to:
- Category: FormattingAndRenderingVariables
- Related: H, I, ICON, M, N, P, Q, S, T, U, WIP, X, TWikiDocGraphics (this topic)
YELLOW -- start yellow colored text
Total: 80 variables
Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart |