%TOPIC%
if there is no INCLUDE.
%BASETOPIC%
%BASETOPIC%
in topic C is reported as A when looking at topic A, B when looking at topic B, and C when looking at topic C itself.
%WEB%
in case there is no include.
%BASEWEB%
%BASEWEB{format="..."}%
-- see WEB for format documentation
%BASEWEB%
in topic C is reported as the web of topic A when looking at topic A, the web of topic B when looking at topic B, and the web of topic C when looking at topic C itself.
%CHILDREN{...}%
Parameter: | Description: | Default: |
---|---|---|
web="%WEB%" | Wiki web. | Current web |
topic="%TOPIC%" | The topic to find the children. | Current topic |
format="..." | Custom format for each topic found. Supports same format strings as SEARCH. See FormattedSearch for usage, variables & examples | "$topic" |
separator="..." | Separator between topics. | ", " |
default="none" | Default text shown if no children found. | "" (empty) |
%CHILDREN{ topic="%TOPIC%" }%
%CONTENTMODE{web="WEB"}%
Parameter: | Description: | Default: |
---|---|---|
web | The name of the web. | The current web |
%DATE%
2024-12-25
$year-$mo-$day
%DISPLAYTIME%
2024-12-25 - 06:07
$year-$mo-$day
. The time is shown as hh:mm (24 hour clock)
$year-$mo-$day
. Same format qualifiers as %GMTIME%
%DISPLAYTIME{"format"}%
$seconds
, $minutes
, $hours
, $day
, $wday
, $dow
, $month
, $mo
, $year
, $ye
, $tz
, $iso
, $rcs
, $http
, $epoch
%DISPLAYTIME{"$hou:$min"}%
expands to 06:07
{AccessibleENV}
in the Security Settings/Miscellaneous section of configure
can be displayed. Any other variable will just be shown as an empty string, irrespective of its real value.
%ENV{MOD_PERL}%
displays as: not set
not set
.
%FAILEDPLUGINS%
%HOMETOPIC%
WebHome
, renders as WebHome
%HTTP%
%HTTP{"Header-name"}%
%HTTP% | |
%HTTP{"Accept-language"}% | |
%HTTP{"User-Agent"}% | Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com) |
COOKIE
field value cannot be retrieved. You can add or delete hidden fields by changing the {HTTP}{HiddenFields}
configuration parameter.
%HTTP_HOST%
sites.astro.caltech.edu
%HTTP%
but operates on the HTTPS environment variables present when the SSL protocol is in effect. Can be used to determine whether SSL is turned on.
%HTTPS%
%HTTPS{"Header-name"}%
COOKIE
field value cannot be retrieved. You can add or delete hidden fields by changing the {HTTP}{HiddenFields}
configuration parameter.
%TOPIC%
in case there is no include.
%INCLUDINGTOPIC%
%INCLUDINGTOPIC%
in topic C is reported as B when looking at topics A or B, and as C when looking at topic C itself.
%WEB%
if there is no INCLUDE.
%INCLUDINGWEB%
%INCLUDINGWEB{format="..."}%
-- see WEB for format documentation
%INCLUDINGWEB%
in topic C is reported as web of topic B when looking at topics A or B, and as of topic C when looking at topic C itself.
LANGUAGE
preference is set, it's used as user's language instead of any language detected from the browser.
LANGUAGE
at a non per-user way, so each user can choose his/her preferred language.
PO
files) to TWiki. Those are the languages in which TWiki's user interface is available.
%LANGUAGES{...}%
Parameter: | Description: | Default: |
---|---|---|
format | format for each item. See below for variables available in the format string. | " * $langname" |
separator | separator between items. | "\n" (newline) |
marker="selected" | Text for $marker if the item matches selection | "selected" |
selection="%LANGUAGE%" | Current language to be selected in list | (none) |
format
variables: Variable | Meaning |
---|---|
$langname | language's name, as informed by the translators |
$langtag | language's tag. Ex: en , pt-br , etc. |
<select>%LANGUAGES{format="<option $marker value='$langtag'>$langname</option>" selection="%LANGUAGE%"}%</select>
creates an option list of the available languages with the current language selected (this topic)
%LOCALSITEPREFS%
Main.TWikiPreferences
, renders as TWikiPreferences
%MDREPO{ "table" ...}%
(generic form), %MDREPO{ web="..." ...}%
(web specific form)
web="..."
parameter): Parameter | Description | Default | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
"..." | Specify the table to retrieve | This or below is required | ||||||||||||||||
table="..." | (Alternative to above) | This or above is required | ||||||||||||||||
separator="..." | The separator string of records | "$n" (new line) | ||||||||||||||||
format="..." | Format of one record. It may contain the following items. In addtion, the standard special tokens are handled accordingly.
| "| $_ | $__ |" | ||||||||||||||||
selection="..." | The record ID to be regarded as the selected. It affects how $marker in the format is evaluated. | none | ||||||||||||||||
marker="..." | Text for $marker in the format if the item matches selection | "selected" | ||||||||||||||||
filter="..." | The regular expression of record IDs to filter records. Matching is case-insensitive | none | ||||||||||||||||
exclude="..." | Comma separated list of record IDs to be excluded. You can use regular expression. If you specify Trash\d*, then Trash, Trash1, Trash2, ... are exluded but LightTrash and TrashBag are not excluded | none |
%MDREPO{"webs" filter="^A" format="| $_ | $_admin | $_master |"}%
Parameter | Description | Default |
---|---|---|
web="..." | Specify the web. If it's a subweb, the corresponding top level web is specified | This is required |
"..." | Specify the format of the return value in the same manner as the format parameter in the generic form | $__ |
default="..." | Specify the value to be returned when the specified or implied top level web does not exist in MDREPO | "" (null string) |
%MDREPO{web="Foo/Bar" "$_admin"}%
formfield
item is the most likely to be useful to casual users.
%META{ "item" ...}%
Item | Options | Description |
---|---|---|
"formfield" | name="..." : name of the field. The field value can be shortened as described in FormattedSearch for $formfield . newline="..." : by default, each newline character will be rewritten to <br /> to allow metadata that contains newlines to be used in tables, etc. $n indicates a newline character.bar="..." : by default, each vertical bar is rewritten to an HTML entity so as to not be mistaken for a table separator.encode="type" : have the value encoded in the specified type. Possible types are the same as ENCODE's. If this is specified, newline and bar options are ignored. topic="..." : Get meta info of "Topic" or "Web.Topic"; default "%BASEWEB%.%BASETOPIC%" . | Show a single form field |
"form" | topic="..." : Get meta info of "Topic" or "Web.Topic"; default "%BASEWEB%.%BASETOPIC%" . | Generates the table showing the form fields. See Form Templates |
"attachments" | all="on" to show hidden attachments.title="..." to show a title - only if attachments are displayed.template="..." to use a custom template for the rendering of attachments; default attachtables is used.topic="..." : Get meta info of "Topic" or "Web.Topic"; default "%BASEWEB%.%BASETOPIC%" . | Generates the list of attachments |
"moved" | topic="..." : Get meta info of "Topic" or "Web.Topic"; default "%BASEWEB%.%BASETOPIC%" . | Details of any topic moves |
"parent" | dontrecurse="on" : By default recurses up tree, this has some cost.nowebhome="on" : Suppress WebHome. prefix="..." : Prefix that goes before parents, but only if there are parents, default "" . format="..." : Format string used to display each parent topic where $web expands to the web name, and $topic expands to the topic name; default: "[[$web.$topic][$topic]]" suffix="..." : Suffix, only appears if there are parents; default "" . separator="..." : Separator between parents; default " > " . topic="..." : Get meta info of "Topic" or "Web.Topic"; default "%BASEWEB%.%BASETOPIC%" . | Generates the parent link |
%META{}%
is placed in an included topic. Add a topic="%WEB%.%TOPIC%"
parameter if you need meta info of the current topic.
newline
, prefix
, format
, suffix
and separator
options, such as separator="$n * "
%METASEARCH{...}%
Parameter: | Description: | Default: |
---|---|---|
type="..." | Type of search: • "topicmoved" - search for a topic that may have been moved. • "parent" - search for topics that have a specific parent i.e. its children. • "field" - search for topics that have a particular form field value (use the name and value parameters to specify which field to search). | Required |
web="%WEB%" | Wiki web to search: A web, a list of webs separated by whitespace, or all webs. | Current web |
topic="%TOPIC%" | The topic the search relates to. | Current topic |
name="..." | form field to search, for type="field" searches. May be a regular expression (see SEARCH). | |
value="..." | form field value, for type="field" searches. May be a regular expression (see SEARCH). | |
title="Title" | Text that is prefixed to any search results. | "" (empty) |
format="..." | Custom format of each search hit. Supports same format strings as SEARCH. See FormattedSearch for usage, variables & examples | "$topic" |
separator="..." | Separator between search hits. | "$n" (newline) |
default="none" | Default text shown if no search hit. | "" (empty) |
%METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%
%METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%
%METASEARCH{type="field" name="Country" value="China"}%
%NOTIFYTOPIC%
WebNotify
, renders as WebNotify
%PARENTTOPIC%
or %PARENTTOPIC{ format="..." topic="..." }%
TWikiVariables
, renders as TWikiVariables
Item | Description | Default |
---|---|---|
format="..." | Format string used to display parent topic, where $web expands to the web name, and $topic expands to the topic name. Additional formatting tokens can be used. | "$topic" (topic name) |
topic="..." | Get parent of "Topic" or "Web.Topic" | "%WEB%.%TOPIC%" (current topic) |
%PLUGINDESCRIPTIONS%
"$SUM( $ABOVE() )"
to TWiki tables or anywhere in topic text ExternalSite:Page
to link to a page on an external site based on aliases defined in a rules topic :-)
as or :eek:
as %PLUGINVERSION{"name"}%
to get the version of a specific plugin
%PLUGINVERSION{"InterwikiPlugin"}%
expands to $Rev: 29526 (2015-11-29) $
%PLUGINVERSION%
to get the version of the API
6.02
%PUBURL%
https://sites.astro.caltech.edu/twiki_outreach/pub
%PUBURL%/%WEB%/OtherTopic/image.gif
%PUBURLPATH%
/twiki_outreach/pub
%QUERYPARAMS{...}%
format="..."
format string for each entry, default $name=$value
separator="..."
separator string, default separator="$n"
(newline)
encode="..."
the encoding to apply to parameter values; see ENCODE for a description of the available encodings. If this parameter is not given, no encoding is performed.
Sequence: | Expands To: |
---|---|
$name | Name of the parameter |
$value | String value of the parameter. Multi-valued parameters will have a "row" for each value. |
$n or $n() | New line. Use $n() if followed by alphanumeric character, e.g. write Foo$n()Bar instead of Foo$nBar |
$nop or $nop() | Is a "no operation". This variable gets removed; useful for nested search |
$quot or \" | Double quote (" ) |
$aquot | Apostrophe quote (' ) |
$percnt | Percent sign (% ) |
$dollar | Dollar sign ($ ) |
$lt | Less than sign (< ) |
$gt | Greater than sign (> ) |
%QUERYPARAMS{format="<input type='hidden' name='$name' value='$value' encoding="html" />"}%
%QUERYPARAMS%
.
%QUERYSTRING%
%REMOTE_ADDR%
18.223.159.143
%REMOTE_PORT%
%REMOTE_USER%
%REVINFO%
r4 - 2012-11-15 - 06:09:07 - TWikiContributor
$year-$mo-$day
%REVINFO{"format"}%
Parameter: | Description: | Default: |
---|---|---|
"format" | Format of revision information, see supported variables below | "r$rev - $date - $time - $wikiusername" |
web="..." | Name of web | Current web |
topic="..." | Topic name | Current topic |
rev="5" | Specific revison number. Old RCS format "1.5" is also supported. | Latest revision |
Variable: | Unit: | Example |
---|---|---|
$web | Name of web | Current web |
$topic | Topic name | Current topic |
$rev | Revison number. Add prefix r to get the usual r5 format | 5 |
$username | Login username of revision | jsmith |
$wikiname | WikiName of revision | JohnSmith |
$wikiusername | WikiName with Main web prefix | Main.JohnSmith |
$date | Revision date. Actual date format defined as {DefaultDateFormat} in configure, default $year-$mo-$day | 2010-12-31 |
$time | Revision time | 23:24:25 |
$iso | Revision date in ISO date format | 2006-09-22T06:24:25Z |
$min , $sec , etc. | Same date format qualifiers as GMTIME{"format"} |
%REVINFO{"$date - $wikiusername" rev="1.1"}%
returns revision info of first revision
viewauth.cgi
)
%SCRIPTNAME%
view
.pl
or .cgi
%SCRIPTSUFFIX%
%SCRIPTURL%
https://sites.astro.caltech.edu/twiki_outreach/bin
edit
script should always be used in conjunction with ?t=%GMTIME{"$epoch"}%
to ensure pages about to be edited are not cached in the browser
edit
, save
, attach
, upload
, and rename
, the URL on the master site is returned. master="on"
parameter is specified, the URL on the master site is returned.
%SCRIPTURL{"script" ...}%
Parameter: | Description: | Default: |
---|---|---|
"script" | The name of the script | |
web="WEB" | Specifies a web | When a topic name is specified and a web is not, the current web is assumed |
topic="TOPIC" or topic="WEB.TOPIC" | Specifies a topic or both a web and a topic | |
master="on" | A URL on the master site is needed or not | off |
web="WEB"
is specified but topic
is not specified, the resulting URL ends with WEB
.
%SCRIPTURL{"viewauth"}%/%WEB%/%TOPIC%
which expands to https://sites.astro.caltech.edu/twiki_outreach/bin/viewauth/TWiki/TWikiVariablesCategoryBody
. It can be written %SCRIPTURL{"viewauth" topic="%TOPIC%"}%
as well.
http://florawiki/cgi-bin
. Then %SCRIPTURL{"edit" web="Flowers"}%
expands to http://florawiki/cgi-bin/edit/Flowers
. This is because the 'Flower' web on this site is a slave and editing needs to happen on the master site.
%SCRIPTURL{"view" web="Flowers" master="on"}%
expands to http://florawiki/cgi-bin/view/Flowers
. The view
script works on a slave site, but master="on"
parameter forces to yield the master site URL.
[[%SCRIPTURL{view}%/%WEB%/MyQuery?food=sushi][Sushi]]
%SCRIPTURLPATH{"script"}%
instead, as it works with URL rewriting much better
%SCRIPTURL%
, but doesn't include the protocol and host part of the URL
%SCRIPTURLPATH%
/twiki_outreach/bin
edit
script should always be used in conjunction with ?t=%GMTIME{"$epoch"}%
to ensure pages about to be edited are not cached in the browser
%SCRIPTURL{"script"}%
, but doesn't include the protocol and host part of the URL
%SCRIPTURL{"script"}%
, this variable is aware of ReadOnlyAndMirrorWebs. So it may return a URL of a different site.
%SCRIPTURLPATH{"script" ...}%
Parameter: | Description: | Default: |
---|---|---|
"script" | The name of the script. | |
web="WEB" | Specifies a web | When a topic name is specified and a web is not, the current web is assumed |
topic="TOPIC" or topic="WEB.TOPIC" | Specifies a topic or both a web and a topic | |
master="on" | A URL on the master site is needed or not. | off |
web="WEB"
is specified but topic
is not specified, the resulting URL ends with WEB
.
%SCRIPTURLPATH{"view"}%
expands to "/twiki_outreach/bin/view"
(This might be a null string. Hence surrounded by double quotes)
%SCRIPTURLPATH{"view" web="%WEB%"}%
expands to /twiki_outreach/bin/view/TWiki
%SCRIPTURLPATH{"view" topic="%TOPIC%"}%
expands to /twiki_outreach/bin/view/TWiki/VarSCRIPTURLPATH2
http://florawiki/cgi-bin
. Then %SCRIPTURLPATH{"edit" web="Flowers"}%
expands to http://florawiki/cgi-bin/edit/Flowers
. This is because the 'Flower' web on this site is a slave and editing needs to happen on the master site.
%SERVERTIME%
2024-12-25 - 06:07
$year-$mo-$day
%GMTIME%
%SERVERTIME{"format"}%
$seconds
, $minutes
, $hours
, $day
, $wday
, $dow
, $month
, $mo
, $year
, $ye
, $tz
, $iso
, $rcs
, $http
, $epoch
%SERVERTIME{"$hou:$min"}%
expands to 06:07
%SESSIONID%
%SESSIONVAR%
%SESSION_VARIABLE{"name"}%
- read a session variable
%SESSION_VARIABLE{"name" set="value"}%
- set a session variable
%SESSION_VARIABLE{"name" clear=""}%
- clear a session variable
%SESSION_VARIABLE{"AUTHUSER"}%
- user ID, current value:
%SESSION_VARIABLE{"SESSION_REQUEST_NUMBER"}%
- number of pages accessed by current user since login, current value:
"_NON_OF_YOUR_BUSINESS"
%SITENAME%
{ReadOnlyAndMirrorWebs}{SiteName}
if defined. Returns the null string if not.
%SITESTATISTICSTOPIC%
SiteStatistics
%USERSWEB%.%SITESTATISTICSTOPIC%
renders as SiteStatistics
%STATISTICSTOPIC%
WebStatistics
, renders as WebStatistics
%SYSTEMWEB%
TWiki
%TOPIC%
expands to the name of the topic. If you are looking at the text of an included topic, it is the name of the included topic.
%TOPIC%
TWikiVariablesCategoryBody
, renders as TWikiVariablesCategoryBody
$topic
variable gets expanded to the topic name, $marker
to marker
parameter where topic matches selection
, and $web
to the name of the web, or any of the standard FormatTokens.
%TOPICLIST{"format" ...}%
Parameter: | Description: | Default: |
---|---|---|
"format" | Format of one line, may include $web (name of web), $topic (name of the topic), $marker (which expands to marker for the item matching selection only) | "$topic" |
format="format" | (Alternative to above) | "$topic" |
separator=", " | line separator | "$n" (new line) |
marker="selected" | Text for $marker if the item matches selection | "selected" |
selection="TopicA, TopicB" | Current value to be selected in list | (none) |
web="Name" | Name of web | Current web |
%TOPICLIST{" * $web.$topic"}%
creates a bullet list of all topics
%TOPICLIST{separator=", "}%
creates a comma separated list of all topics
%TOPICLIST{" <option>$topic</option>"}%
creates an option list (for drop down menus)
<select>%TOPICLIST{" <option $marker value='$topic'>$topic</option>" separator=" " selection="%TOPIC%"}%</select>
creates an option list of web topics with the current topic selected
%TOPICTITLE%
or %TOPICTITLE{ topic="TopicName" }%
Parameter: | Description: | Default: |
---|---|---|
"..." ortopic="..." | Topic to get the title from. Can be of form TopicName or Web.TopicName . | Current topic |
encode="html" | Encode special characters into HTML entities. If a TOPICTITLE is passed into an HTML form field it should be encoded as "html" . Additional encodings: encode="quote" , encode="moderate" , encode="safe" , encode="entity" and encode="url" . See ENCODE for details. | "" (no encoding) |
%TOPICTITLE{Projects.SushiProject}%
returns Sushi Project
assuming the topic has a form field named "Title" with value "Sushi Project"
TWikiVariablesCategoryBody
%TOPICURL%
- shortcut for %SCRIPTURL{view}%/%WEB%/%TOPIC%
%SYSTEMWEB%
instead.
%URLPARAM{"name"}%
Parameter: | Description: | Default: |
---|---|---|
"name" | The name of a URL parameter | required |
newline="$br" | Convert newlines in textarea to other delimiters. Variables $br (for <br /> tag), $n (for newline) are expanded. Other text is encoded based on encode parameter. | no conversion |
encode="off" | Turn off encoding. See important security note below | encode="safe" |
encode="quote" | Escape double quotes with backslashes (\" ), does not change other characters; required when feeding URL parameters into other TWiki variables. This encoding does not protect against cross-site scripting. | encode="safe" |
encode="moderate" | Encode special characters into HTML entities for moderate cross-site scripting protection: "<" , ">" , single quote (' ) and double quote (" ) are encoded. Useful to allow TWiki variables in comment boxes. | encode="safe" |
encode="safe" | Encode special characters into HTML entities for cross-site scripting protection: "<" , ">" , "%" , single quote (' ) and double quote (" ) are encoded. | (this is the default) |
encode="entity" | Encode special characters into HTML entities. See ENCODE for details. | encode="safe" |
encode="html" | Encode special characters into HTML entities. In addition to encode="entity" , it also encodes space, newline (\n ) and linefeed (\r ). Useful to encode text properly in HTML input fields. | encode="safe" |
encode="url" | Encode special characters for URL parameter use, like a double quote into %22 | encode="safe" |
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" (newline) |
format="..." | Format the result. $value expands to the URL parameter. If multiple is specified, $value expands to the result of the concatenated items. | "$value" |
default="..." | Default value in case parameter is empty or missing. The format parameter is not applied. | empty string |
%URLPARAM{"skin"}%
returns print
for a .../view/TWiki/TWikiVariablesCategoryBody?skin=print
URL
encode="safe"
is the default, it provides a safe middle ground. The encode="entity"
is more aggressive, but some TWiki applications might not work.
"html"
. <input type="text" name="address" value="%URLPARAM{ "address" encode="html" }%" />
%SEARCH{ "%URLPARAM{ "search" encode="quotes" }%" noheader="on" }%
rev
, skin
, template
, topic
, web
; they have a special meaning in TWiki. Common parameters and view script specific parameters are documented at TWikiScripts.
%URLPARAM{
in the value of a URL parameter, it will be modified to %<nop>URLPARAM{
. This is to prevent an infinite loop during expansion.
%USERINFO%
guest, TWikiGuest,
(comma-separated list of the username, wikiusername, and emails)
$emails
, $username
, $wikiname
, $wikiusername
, $groups
and $admin
($admin returns 'true' or 'false'): %USERINFO{ format="$username is really $wikiname" }%
guest is really TWikiGuest
%USERINFO{ "TWikiGuest" format="$username is really $wikiname" }%
guest is really TWikiGuest
{AntiSpam}{HideUserDetails}
configuration option is not enabled, or if you are an admin. (User details are hidden in this TWiki)
jsmith
, WIKINAME like JohnSmith
and WIKIUSERNAME like Main.JohnSmith
. Un-authenticated users are all TWikiGuest.
%USERNAME%
guest
%USERSWEB%
Main
topic
parameter is specified, it gets the value of the specified preferences variable in the specified topic. Please note that the WebPreferences of the web of the specified topic is not examined. So the returned value may not be the same as the value of the variable when the specified topic is viewed.
topic
parameter is not specified and the web
parameter is specified, it gets the value of the specified preferences variable in the specified web, which means the specified web's WebPreferences is examined for the variable.
topic
nor web
parameter is specified, it gets the value of the specified variable in the current context -- the variable can either be a preferences variable or a session variable but cannot be a tag with a tag handler (e.g. %GMTIME%
). %VAR{"NAME"}%
is similar to %NAME%
, but they differ if NAME
is undefined, in which case %VAR{"NAME"}%
is expanded to null (zero width string) while %NAME%
remains as is (%NAME%
). %VAR{"NAME"}%
yields the same value as %IF{"defined NAME" then="$percntNAME$percnt"}%
if NAME is a variable, but the latter is cubmersome.
%VAR{"NAME" ...}%
Parameter: | Description: | Default: |
---|---|---|
"Variable" | The name of the variable to be retrieved. If not specified, %VAR{...}% is expanded to null. | required |
topic="Web.Topic" | Specifies the topic in which the specified preferences vaiable is fetched. | none |
topic="Topic" | Same as above, but the web is specified specified explicitly with the web parameter or the current web is specified. | none |
web="Web" | Specifies the web in which the specified preferences variable is fetched. | none |
default="Value" | Specifies the value to be returned if the specified variable is undefined. | "" (null string) |
ignorenull="on" | If specified, a null string ("") value is regarded as undefined. This affects whether or not the value specified by the default parameter is returned. | "off" |
%VAR{"GROUP" topic="%USERSWEB%.TWikiAdminGroup"}%
, which expands to OutreachAdmin, admin
.
%WEBBGCOLOR%
of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%
, which expands to ==
%VAR{"FOOSKIN_HTML_HEAD_HOOK" default="<nop>" ignorenull="on"}%
%WEB%
expands to the name of the web where the topic is located. If you are looking at the text of an included topic, it is the web where the included topic is located.
%WEB%
, expands to: TWiki
%WEB{format="..."}%
Parameter: | Description: | Default: |
---|---|---|
format="..." | Format, may include tokens $web (the full web path), $parents (parent webs, if any), $current (current web without parent webs), $top (top-level web with any subwebs removed) | "$web" |
%WEB%
is Engineering/TechPubs/Apps
: %WEB{format="Parent webs: $parents, current web: $current, top-level web: $top"}%
returns: Parent webs: Engineering/TechPubs, current web: Apps, top-level web: Engineering
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
.
%WEBLIST{"format" ...}%
Parameter: | Description: | Default: | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
"format" | Format of one line, may include following items. In addtion, the standard special tokens are handled accordingly.
$nop() , one of FormatTokens. e.g. $name$nop()a | "$name" | ||||||||||||||
format="format" | (Alternative to above) | "$name" | ||||||||||||||
separator=", " | Line separator | "$n" (new line) | ||||||||||||||
web="" | if you specify $web in format, it will be replaced with this | "" | ||||||||||||||
webs="public" | Comma separated list of webs. There are special webs:
NOTE 2: If MetadataRepository is used and webs are required to be registered, then cancopyto , canmoveto , and webtemplate behave differently.
| "public" | ||||||||||||||
marker="selected" | Text for $marker if the item matches selection | "selected" | ||||||||||||||
selection="%WEB%" | Current value to be selected in list | selection="%WEB%" | ||||||||||||||
subwebs="Sandbox" | Show webs that are a sub-web of this one (recursivly) | "" | ||||||||||||||
depth="1" | Specify the maximum depth of recursive search. E.g. %WEBLIST{depth="1"}% shows only top level webs. %WEBLIST{subwebs="Foo" depth="1"}% shows the direct subwebs of Foo. | (no maximum depth) | ||||||||||||||
limit="30" | Limit number of webs to show | "" (all) | ||||||||||||||
overlimit="..." | Message shown if over limit, such as: overlimit=" * [[%SYSTEMWEB%.SiteMap][More...]]" | "" |
%WEBLIST{"$listindent * [[$name.WebHome]]"}%
- creates a indented bullet list of all webs.
<form><select name="web"> %WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash, public" selection="%WEB%" separator=" "}% </select></form>
- creates a dropdown of all public webs + Trash web, with the current web highlighted.
%WEBPREFSTOPIC%
WebPreferences
, renders as WebPreferences
%WIKIHOMEURL%
/twiki_outreach/bin/view/Main/WebHome
%SCRIPTURLPATH{"view"}%/%USERSWEB%/%HOMETOPIC%
%WIKILOGOURL%
defined in WebPreferences instead.
%WIKILOGOALT%
Home - this site is powered by TWiki(R)
%WIKILOGOIMG%
https://sites.astro.caltech.edu/twiki_outreach/pub/TWiki/TWikiLogos/T-logo-140x40-t.gif
%WIKILOGOURL%
https://sites.astro.caltech.edu/twiki_outreach/bin/view/Main/WebHome
%SCRIPTURLPATH{"view"}%/%USERSWEB%/%HOMETOPIC%
%USERNAME%
if not defined in the TWikiUsers topic
%WIKINAME%
TWikiGuest
%WIKIPREFSTOPIC%
TWikiPreferences
, renders as TWikiPreferences
%WIKITOOLNAME%
TWiki
%WIKIUSERNAME%
Main.TWikiGuest
, renders as TWikiGuest
%WIKIUSERSTOPIC%
TWikiUsers
, with Main prefix renders as TWikiUsers
%WIKIVERSION%
TWiki-6.0.2, Sun, 29 Nov 2015, build 29687