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.

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

This is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see customization. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your WebPreferences.

Set to "on" to disable the automatic form that encloses your comment block - remember to insert <form> tags yourself! See CommentPluginExamples#noform for an example.

"off"

nopost

Set to "on" to disable insertion of the posted text into the topic.

"off"

remove

Set to "on" to remove the comment prompt after the first time it is clicked.

"off"

button

Button label text

"Add comment"

emailto

Send comment by email. Use comma "," to seperate multiple email addresses. This feature is disabled by default. To enable this feature, please set up "$TWiki::cfg{Plugins}{CommentPlugin}{EmailEnabled} = 1;".

DASHBOARD -- build a dashboard with banner and boxes

Use this variable to quickly create dashboards for intranet home, team homepages, project homepages and knowledge bases. See the TWikiDashboardAddOn for details on enabling and using the %DASHBOARD{...}% variable.

Encode special characters into HTML entities, like a double quote into &#034;. Does not encode newline (\n) or linefeed (\r).

type="url"

type="entity"extra=" $n$r"

For type="entity" only, use the extra parameter to encode additional characters to HTML numeric entities. Formatting tokens can be used, such as "$n" for newline. Note that type="entity" extra=" $n$r" is equivalent to type="html".

type="url"extra=""

type="html"

Encode special characters into HTML entities. In addition to type="entity", it also encodes space, \n and \r. Useful to encode text properly in HTML input fields. See equivalent ENTITY.

type="url"

type="json"

Escape double quotes and backslashes with backslashes (\" and \\, respectively), escape non-printable characters with hex code \u0000 ... \u001F, does not change other characters. Use this to properly escape text for a JSON string. Example result: This is a string with \"quoted\" and \\backslashed\\ text.

type="url"

type="csv"

Escape single quotes and double quotes by repeating them, other characters do not change. Use this to properly escape fields in CSV reports that output comma-separated values, such as "field 1","field 2 with ''single'' and ""double"" quotes".

type="url"

type="search"

Special encoding used for SEARCH: Substitute % characters into non-printable characters, so that TWikiVariables are no longer expanded. Also escapes quotes. Used to feed a search string from a URLPARAM into SEARCH without expanding any variables, such as when searching for %BR%.

type="url"

newline="..."

Replace a newline with the specified value before encoding. Please note that newline="<br/>" does not bring <br/> to the output because < and > are encoded (except with the quotes and csv types). To have <br/> in the output, you need to specify newline="$br". However, newline="$br" does not work in combination with type="url" (the defautl type). This shouldn't be a problem because it's very rare to need to have <br/> encoded in a URL. In addition to $br, $n has a special meaning in a newline parameter value - $n results in a newline in the output. This parameter is expected to be used in combination with the moderate, safe, entity, or html type. With the other types, it causes unuseful results.

Values of HTML input fields should be encoded as "html". A shorter %ENTITY{any text}% can be used instead of the more verbose %ENCODE{ "any text" type="html" }%. Example: <input type="text" name="address" value="%ENTITY{any text}%" />

Name of variable, such as menu. May optionally contain a JSON path, such as menu.File.Open.

(required)

format="..."

Format with supported variables: • $name for variable name • $value for variable value • $isdefined expanding to 1 or 0 depending if variable is defined or not • $isset expanding to 1 or 0 depending if variable is logically true or false • $ispersistent expanding to 1 or 0 depending if variable is persistent or not • 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

INCLUDE{"page"} -- include other topic, attachment, or web page

The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%

"Web.Topic"

A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%

"http://..."

A full qualified URL, i.e. %INCLUDE{"http://twiki.org:80/index.html"}%. Supported content types are text/html and text/plain by default. See allowanytype. if the URL resolves to an attachment file on the server this will automatically translate to a server-side include.

attachment="filename.ext"

Include the specified attachment instead of topic text. The attachment content is subject to processing just like when topic text is included. For example, text up to %STARTINCLUDE% is excluded. When including an attachment, you can do without topic specification - %INCLUDE{attachment="filename.ext"}% works, which results in including the attachment of the same topic.

allowanytype="on"

Suppress the content type checking in including the web page specified by a URL.

disabled

charset="CHARSET"

Specify the charset of the included content so that a proper charset conversion happens when it's different from the site charset. Needless to say, this works for a TWiki topic, a topic attachment, and a content specified with a URL. This parameter overrides otherwise specified or implied charset.

none

pattern="..."

Include a subset of a topic or a web page. Specify a RegularExpression that scans from start ('^') to end and contains the text you want to keep in parenthesis, e.g., pattern="^.*?(from here.*?to here).*". IncludeTopicsAndWebPages has more.

none

headingoffset="2"

Adjust the level of headings in the included topic. A "2" or "+2" increases the level by two, e.g. a ---+ H1 turns into a ---+++ H3. Positive and negative values are supported. Adjusted min and max levels are H1 and H6, respectively.

no adjustment

hidetoc="on"

Remove %TOC% in included content. Useful to show table of contents in individual topics, while suppressing them if included in a big master document.

TOC_HIDE_IF_ INCLUDED setting

rev="2"

Include a previous topic revision; N/A for URLs

top revision

raw="on" (for HTTP inclusion)

When a page is included via HTTP, normally URCS will process it, doing the following: 1) Alter relative links to point back to originating host, 2) Remove some basic HTML tags (html, head, body, script) and finally 3) Remove newlines from HTML tags spanning multiple lines. If you prefer to include exactly what is in the source of the originating page set this to on. raw="on" is short for disableremoveheaders="on", disableremovescript="on", disableremovebody="on", disablecompresstags="on" and disablerewriteurls="on".

disabled

raw="on" (for topic or attachment inclusion)

When a topic is included, normally TWiki variables in the included topic are expanded in the context of the included topic. If raw="on" is specified, that variable expansion does not happen. You may wonder what's that for and what are the implications, which are found out on IncludeTopicRaw. Because of the "in the raw" nature of the parameter, if it's specified, parameters such as encode, headingoffset, hidetoc, newline, nofinalnewline, and section are ignored.

disabled

literal="on"

While using the raw option will indeed include the raw content, the included content will still be processed and rendered like regular topic content. To disable parsing of the included content, set the literal option to "on".

disabled

nofinalnewline="on"

Delete the new line at the end of the result if exists

disabled

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" and encode="url". See ENCODE for details.

no encoding

disableremoveheaders="on"

Bypass stripping headers from included HTML (everything until first </head> tag)

disabled

disableremovescript="on"

Bypass stripping all <script> tags from included HTML

disabled

disableremovebody="on"

Bypass stripping the </body> tag and everything around over and below it

Bypass fixing WikiWord links if include is done across webs. Fixing links in included text such as from SomeLink to Otherweb.SomeLink is usually desirable so that links in included text still point to the same target

Includes only the specified named section, as defined in the included 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

PARAMONE="val 1"PARAMTWO="val 2"

Any other parameter will be defined as a variable within the scope of the included topic. The example parameters on the left will result in %PARAMONE% and %PARAMTWO% being defined within the included topic. A default value for a variable can be specified in the included topic in case the corresponding parameter is not specified, such as %PARAMONE{ default="..." }%

Security Considerations:

The ability to INCLUDE arbitrary URLs, such as %INCLUDE{"http://www.google.com/"}% is turned off by default. To turn this on, ask your TWiki administrator to enable the {INCLUDE}{AllowURLs} flag in the Security setup section of configure.

JavaScript in included web pages is filtered out as a security precaution per default. Disable filtering with raw or disableremovescript parameter.

Infinite INCLUDE loop prevention:

To prevent obvious infinite INCLUDE loop, %INCLUDE{"http://THIS_SERVER/.../THIS_WEB/THIS_TOPIC}% is detected and blocked.

If the server has aliases, $TWiki::cfg{UrlHostRegex} should be set so that it matches all possible server names. e.g.

$TWiki::cfg{UrlHostRegex} = qr{http://(www\.)?domain\.com};

INCLUDE attachment: As described above, there are two ways to include an attachment. They are similar, but behave slightly differently.

attachment="filename.ext" This works in the same manner as ordinary topic text inclusion. %STARTINCLUDE% and %STOPINCLUDE% in the attachment are observed. The section parameter is observed. The variables are expanded in the context of the topic having the attachment. For example, %TOPIC% is expanded to the name of the topic having the attachment.

Specifying the URL of an attachment. (e.g. %INCLUDE{%ATTACHURL%/foo.txt}%) The attachment content is processed in the same manner as when data is retrieved from another web server. Unless raw="on" is specified, the content of <body>...</body> is extracted, all occurrences of <script>...</script> are removed. Topic context change doesn't happen because in general inclusion via HTTP doesn't cause topic context change.

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

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.

Tab 1

Tab 2

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.

Name of variable. Alphanumeric characters, dashes and underscores can be used.

(required)

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.