|
|
Note: This topic is included by TWikiVariables
NOP -- template text not to be expanded in instantiated topics - Syntax:
%NOP% - Syntax:
%NOP{...}% - Available in template topics only. See TWikiTemplates#HtmlTemplates for details. In normal topic text, simply expands to whatever is in the curly braces (if anything).
NOTIFYTOPIC -- name of the notify topic
PLUGINDESCRIPTIONS -- list of plugin descriptions - Syntax:
%PLUGINDESCRIPTIONS% - Expands to:
- CommentPlugin (Dakar, 6827): Allows users to quickly post comments to a page without an edit/preview/save cycle.
- EditTablePlugin (Dakar, 6827): Edit TWiki tables using edit fields, date pickers and drop down boxes
- ExifMetaDataPlugin (1.010): Displays EXIF data for jpeg images attached to a topic.
- GuidPlugin: (disabled)
- HeadlinesPlugin (1.95, 7779): Build news portals that show headline news based on RSS news feeds from news sites.
- InterwikiPlugin (Dakar, $Rev: 7873$): Link
ExternalSite:Page text to external sites based on aliases defined in the %RULESTOPIC% topic - PreferencesPlugin (Dakar, 6827): Allows editing of preferences using fields predefined in a form
- RedirectPlugin (1.000): This plugin allows one to produce TWiki topics that automatically redirect to other TWiki topics or URLs.
- SlideShowPlugin (Dakar, $Rev: 7873$): Create web based presentations based on topics with headings.
- SmiliesPlugin (Dakar, 6827): Render smilies as icons, like
:-) for  or :cool: for :cool: - SpreadSheetPlugin (Dakar, 6827): Add spreadsheet calculation like
"$SUM( $ABOVE() )" to tables located in FS topics. - TablePlugin (Dakar, 6850): Control attributes of tables and sorting of table columns
- Related: ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINVERSION
PLUGINVERSION -- the version of the TWiki Plugin API - This is the
$TWiki::Plugins::VERSION number, also indicating the version of the Func module - Syntax:
%PLUGINVERSION% - Expands to:
1.1 - Related: PLUGINVERSION{"name"}, WIKIVERSION
PLUGINVERSION{"name"} -- the version of an installed Plugin
PUBURL -- the base URL of attachments - Syntax:
%PUBURL% - Expands to:
https://fs.rainysky.org/pub - Example: You can refer to a file attached to another topic with
%PUBURL%/%WEB%/OtherTopic/image.gif - Related: ATTACHURL, PUBURLPATH, SCRIPTURL, FileAttachments
PUBURLPATH -- the base URL path of attachments
QUERYSTRING -- full, unprocessed string of parameters to this URL - Syntax: %QUERYSTRING%
- Expands to:
sortcol=2;table=3;up=0 - String of all the URL parameters that were on the URL used to get to the current page. For example, if you add ?name=Samantha;age=24;eyes=blue to this URL you can see this in action. This string can be appended to a URL to pass parameter values on to another page.
-
 Note: URLs built this way are typically restricted in length, typically to 2048 characters. If you need more space than this, you will need to use an HTML form and %URLPARAM{}%. - Related: URLPARAM
REMOTE_ADDR -- environment variable
REMOTE_PORT -- environment variable
REMOTE_USER -- environment variable
REVINFO -- revision information of current topic
REVINFO{"format"} -- formatted revision information of topic - Syntax:
%REVINFO{"format"}% - Supported parameters:
| Parameter: | Description: | Default: |
|---|
"format" | Format of revision information, see supported variables below | "r1.$rev - $date - $wikiusername" | web="..." | Name of web | Current web | topic="..." | Topic name | Current topic | rev="1.5" | Specific revison number | Latest revision | - Supported variables in format:
| Variable: | Unit: | Example |
|---|
$web | Name of web | Current web | $topic | Topic name | Current topic | $rev | Revison number. Prefix r1. to get the usual r1.5 format | 5 | $date | Revision date | 11 Jul 2004 | $username | Login username of revision | jsmith | $wikiname | WikiName of revision | JohnSmith | $wikiusername | WikiName with Main web prefix | Main.JohnSmith | - Example:
%REVINFO{"$date - $wikiusername" rev="1.1"}% returns revision info of first revision - Related: REVINFO
SCRIPTNAME -- name of current script - The name of the current script is shown, including script suffix, if any (for example
viewauth.cgi) - Syntax:
%SCRIPTNAME% - Expands to:
view - Related: SCRIPTSUFFIX, SCRIPTURL
SCRIPTSUFFIX -- script suffix - Some FS installations require a file extension for CGI scripts, such as
.pl or .cgi - Syntax:
%SCRIPTSUFFIX% - Expands to:
- Related: SCRIPTNAME, SCRIPTURL, SCRIPTURLPATH
SCRIPTURL -- script URL - Syntax:
%SCRIPTURL% - Expands to:
https://fs.rainysky.org/bin - Example: To get the authenticated version of current topic write
"}%L%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC% which expands to /bin/viewauth/TWiki/TWikiVariablesNtoZ - Syntax:
%SCRIPTURL{"script"}% - Expands to:
/bin/script - Example: To get the authenticated version of current topic write
%SCRIPTURL{"viewauth"}%/TWiki/TWikiVariablesNtoZ which expands to /bin/viewauth/TWiki/TWikiVariablesNtoZ - This second form of SCRIPTURL handles URL rewriting (see TWiki:TWiki.ShorterURLCookbook).
- Related: PUBURL, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURLPATH
SCRIPTURLPATH -- script URL path
SEARCH{"text"} -- search content - Inline search, shows a search result embedded in a topic
- Syntax:
%SEARCH{"text" ...}% - Supported parameters:
| Parameter: | Description: | Default: |
|---|
scope="topic"
scope="text"
scope="all" | Search topic name (title); the text (body) of topic; or all (both) | "text" | type="keyword"
type="literal"
type="regex" | Do a keyword search like soap "web service" -shampoo; a literal search like web service; or RegularExpression search like soap;web service;!shampoo | %SEARCHVAR- DEFAULTTYPE% preferences setting (literal) | nofinalnewline="on" | If on, the search variable does not end in a line by itself. Any text continuing immediately after the search variable on the same line will be rendered as part of the table generated by the search, if appropriate. | off | recurse="on" | Recurse into subwebs, if subwebs are enabled. | off | zeroresults="off" | Suppress all output if there are no hits | zeroresults="on", displays: "Number of topics: 0" | limit="all"
limit="16" | Limit the number of results returned. This is done after sorting if order is specified | All results | date="..." | limits the results to those pages with latest edit time in the given TimeInterval. | All results | topic="WebPreferences"
topic="*Bug" | Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. | All topics in a web | reverse="on" | Reverse the direction of the search | Ascending search | web="Name"
web="Main, Know"
web="all" | Comma-separated list of webs to search. The special word all means all webs that doe not have the NOSEARCHALL variable set to on in their WebPreferences. You can specifically exclude webs from an all search using a minus sign - for example, web="all,-Secretweb". | Current web | casesensitive="on" | Case sensitive search | Ignore case | search="text" | (Alternative to above) | N/A | separator=", " | Line separator between hits | Newline "$n" | excludetopic="Web*"
excludetopic="WebHome, WebChanges" | Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. | None | nonoise="on" | Shorthand for nosummary="on" nosearch="on" nototal="on" zeroresults="off" noheader="on" noempty="on" | Off | | =multiple="on" | Multiple hits per topic. Each hit can be formatted. The last token is used in case of a regular expression ";" and search | Only one hit per topic | expandvariables="on" | Expand variables before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin %CALC{}% instead of the formula | Raw text | "text" | Search term. Is a keyword search, literal search or regular expression search, depending on the type parameter. SearchHelp has more | required | header="..."
format="..." | Custom format results: see FormattedSearch for usage, variables & examples | Results in table | nototal="on" | Do not show number of topics found | Show number | noheader="on" | Suppress search header
Topics: Changed: By: | Show search header, unless seach is inline and a format is specified (Cairo compatibility) | nosearch="on" | Suppress search string | Show search string | bookview="on" | BookView search, e.g. show complete topic text | Show topic summary | nosummary="on" | Show topic title only | Show topic summary | noempty="on" | Suppress results for webs that have no hits. | Show webs with no hits | order="topic"
order="created"
order="modified"
order="editby"
order
"formfield(name)"= | Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of TWikiForms. The sorting is done web by web; if you want to sort across webs, create a formatted table and sort it with TablePlugin's initsort. Note that dates are sorted most recent date last (i.e at the bottom of the table). | Sort by topic name | - Example:
%SEARCH{"wiki" web="Main" scope="topic"}% - Example with format:
%SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (displays results in a table with header - details) -
 Hint: If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }% - Related: METASEARCH, TOPICLIST, WEBLIST, FormattedSearch
SECTION{"name"} -- marks the start of a named section
SERVERTIME -- server time
SERVERTIME{"format"} -- formatted server time - Same format qualifiers as
%GMTIME% - Syntax:
%SERVERTIME{"format"}% - Example:
%SERVERTIME{"$hou:$min"}% expands to 13:31 - Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
- Related: DISPLAYTIME, GMTIME, SERVERTIME
SESSION_VARIABLE -- get, set or clear a session variable
SESSIONID -- unique ID for this session
SESSIONVAR -- name of CGI and session variable that stores the session ID
SPACEDTOPIC -- topic name, spaced and URL-encoded - The current topic name with added spaces, for regular expression search of backlinks
- Syntax:
%SPACEDTOPIC% - Expands to:
TWiki%20*Variables%20*Nto%20*Z -
 Hint: This variable is provided almost exclusively for generating URLs for searching for backlinks to topics - Related: TOPIC
STARTINCLUDE -- start position of topic text if included - If present in included topic, start to include text from this location up to the end, or up to the location of the
%STOPINCLUDE% variable. A normal view of the topic shows everything exept the %STARTINCLUDE% variable itself. An optional parameter can be used to control whether the content is expanded. - Syntax:
%STARTINCLUDE% - Syntax:
%STARTINCLUDE{param}%- If param does not expand to a non-zero integer, then nothing will be included.
- Related: ENDSECTION, INCLUDE, SECTION, STOPINCLUDE
STATISTICSTOPIC -- name of statistics topic
STOPINCLUDE -- end position of topic text if included - If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the
%STOPINCLUDE% variable itself. - Syntax:
%STOPINCLUDE% - Related: ENDSECTION, INCLUDE, SECTION, STARTINCLUDE
TOC -- table of contents of current topic
TOC{"Topic"} -- table of contents - Syntax:
%TOC{"SomeTopic" ...}% - 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 - 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 | 6 | title="Some text" | Title to appear at top of TOC | none | - Example:
%TOC{depth="2"}% - Example:
%TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}% - Example: see TWiki:Sandbox.TestTopicInclude
- Hint: TOC will generate links to the headings, so when a reader clicks on a heading it will jump straight where that heading is anchored in the text. If you have two headings with exactly the same text, then their anchors will also be identical and they won't be able to jump to them. To make the anchors unique, you can add an invisible HTML comment to the text of the heading. This will be hidden in normal view, but will force the anchors to be different. For example, ---+ Heading <!--5-->.
- Related: TOC
TOPIC -- name of current topic
TOPICLIST{"format"} -- topic index of a web - The "format" defines the format of one topic item. It may include variables: The
$name variable gets expanded to the topic name; the $web variable gets expanded to the name of the web. - Syntax:
%TOPICLIST{"format" ...}% - Supported parameters:
| Parameter: | Description: | Default: |
|---|
"format" | Format of one line, may include $name and $web variables | "$name" | format="format" | (Alternative to above) | "$name" | separator=", " | line separator | "\n" (new line) | web="Name" | Name of web | Current web | - Example:
%TOPICLIST{" * $web.$name"}% creates a bullet list of all topics - Example:
%TOPICLIST{separator=", "}% creates a comma separated list of all topics - Example:
%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus) - Related: SEARCH, WEBLIST
TWIKIWEB -- name of TWiki documentation web - The web containing all documentation and site-wide preference settings for FS
- Syntax:
%TWIKIWEB% - Expands to:
TWiki - Related: MAINWEB
URLPARAM{"name"} -- get value of a URL parameter - Returns the value of a URL parameter.
- Syntax:
%URLPARAM{"name"}% - Supported parameters:
| Parameter: | Description: | Default: |
|---|
"name" | The name of a URL parameter | required | default="..." | Default value in case parameter is empty or missing | empty string | newline="<br />" | Convert newlines in textarea to other delimiters | no conversion | encode="entity" | Encode special characters into HTML entities, like a double quote into ". This is needed if text is put into an HTML form field | no encoding | encode="url" | Encode special characters for URL parameter use, like a double quote into %22 | no encoding | multiple="on"
multiple="[[$item]]" | If set, gets all selected elements of a <select multiple="multiple"> tag. A format can be specified, with $item indicating the element, e.g. multiple="Option: $item" | first element | separator=", " | Separator between multiple selections. Only relevant if multiple is specified | "\n" (new line) | - Example:
%URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariablesNtoZ?skin=print URL. - Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
- Note: There is a risk that this variable could be misused for cross-site scripting.
- Related: SEARCH, FormattedSearch, QUERYSTRING
USERNAME -- your login username
USERLANGUAGE -- current user's language - Returns the language code for the language used as the current user. This is the language actually used by TWiki Internationalization (e.g. in user interface).
- The language is detected from the user's browser, unless some site/web/user/session-defined setting overrides it:
- Is the
LANGUAGE preference is set, it's used as user's language instead of any language detected from the browser. - Avoid to define it
LANGUAGE at a non per-user way, so each user can choose his/her preferred language.
- Related: LANGUAGES
VAR{"NAME" web="Web"} -- get a preference value from another web - Syntax:
%VAR{"NAME" web="Web"}% - Example: To get
%WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, which expands to #FFEFA6 - Related: WEBPREFSTOPIC
WEB -- name of current web
WEBLIST{"format"} -- index of all webs - List of all webs. Hidden webs are excluded, e.g. webs with a
NOSEARCHALL=on preference variable. The "format" defines the format of one web item. The $name variable gets expanded to the name of the web, $qname gets expanded to double quoted name, $marker to marker where web matches selection. - Syntax:
%WEBLIST{"format" ...}% - Supported parameters:
| Parameter: | Description: | Default: |
|---|
"format" | Format of one line, may include $name variable. (to support HierarchicalWebs?, there are 2 added variables $webindent and $indentedname) | "$name" | format="format" | (Alternative to above) | "$name" | separator=", " | line separator | "\n" (new line) | webs="public" | comma sep list of Web, public expands to all non-hidden | "public" | marker="selected" | Text for $marker where item matches selection, otherwise equals "" | "selected" | selection="%WEB%" | Current value to be selected in list | section="%WEB%" | - Example:
%WEBLIST{" * [[$name.WebHome]]"}% creates a bullet list of all webs. - Example:
%WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted. - Related: TOPICLIST, SEARCH
WEBPREFSTOPIC -- name of web preferences topic
WIKIHOMEURL -- site home URL - Note: DEPRECATED, use
%WIKILOGOURL% defined in WebPreferences instead. This variables value is defined in lib/TWiki.cfg::$wikiHomeUrl which is marked deprecated. Will be removed in future versions.
WIKINAME -- your Wiki username
WIKIPREFSTOPIC -- name of site-wide preferences topic
WIKITOOLNAME -- name of your TWiki site
WIKIUSERNAME -- your Wiki username with web prefix - Your %WIKINAME% with Main web prefix, useful to point to your FS home page
- Syntax:
%WIKIUSERNAME% - Expands to:
Main.TWikiGuest, renders as TWikiGuest - Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details
- Related: REMOTE_USER, USERNAME, WIKINAME
WIKIUSERSTOPIC -- name of topic listing all registers users
WIKIVERSION -- the version of the installed TWiki engine
Related Topics: UserDocumentationCategory
|
Log In
TWiki Web
Users
Groups
Index
Search
Changes
Notifications
Statistics
Preferences
Main
TWiki Web
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.