Variable: | Expanded to: |
%WIKIHOMEURL% |
The base script URL of GNHLUG, is the link of the Home icon in the upper left corner, is /Main/WebHome |
%SCRIPTURL% |
The script URL of GNHLUG, is http://wiki.gnhlug.org/bin |
%SCRIPTURLPATH% |
The path of the script URL of GNHLUG, is /bin |
%SCRIPTSUFFIX% |
The script suffix, i.e. .pl , is |
%PUBURL% |
The public URL of TWiki, is http://wiki.gnhlug.org/pub |
%PUBURLPATH% |
The path of the public URL of GNHLUG, is /pub |
%ATTACHURL% |
The attachment URL of the current topic, is http://wiki.gnhlug.org/pub/TWiki/TWikiVariables Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif |
%ATTACHURLPATH% |
The path of the attachment URL of the current topic, is /pub/TWiki/TWikiVariables |
%URLPARAM{"name"}% |
Returns the value of a URL parameter. I.e. %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is |
%WIKITOOLNAME% |
Name of wiki tool, is GNHLUG |
%WIKIVERSION% |
Wiki tool version, is TWiki-6.1.0, Mon, 16 Jul 2018, build 30610 |
%USERNAME% |
Your login username, is guest |
%WIKIUSERNAME% |
Your Wiki username, if defined in TWikiUsers. Same as %USERNAME% if not defined. Is Main.TWikiGuest |
%WEB% |
The current web, is TWiki |
%BASEWEB% |
The web name where the includes started, e.g. the web of the first topic of nested includes. Same as %WEB% in case there is no include. |
%INCLUDINGWEB% |
The web name of the topic that includes the current topic. Same as %WEB% in case there is no include. |
%TOPIC% |
The current topic name, is TWikiVariables |
%BASETOPIC% |
The name of the topic where the includes started, e.g. the first topic of nested includes. Same as %TOPIC% in case there is no include. |
%INCLUDINGTOPIC% |
The name of the topic that includes the current topic. Same as %TOPIC% in case there is no include. |
%SPACEDTOPIC% |
The current topic name with added spaces, for regular expression search of Ref-By, is TWiki%20*Variables |
%GMTIME% |
GM time, is 2024-10-31 - 23:48 |
%GMTIME{"format"}% |
Formatted GM time based on time variables.
Variable: |
Unit: |
Example |
$seconds |
seconds |
59 |
$minutes |
minutes |
59 |
$hours |
hours |
23 |
$day |
day of month |
31 |
$month |
month in ISO format |
Dec |
$mo |
2 digit month |
12 |
$year |
4 digit year |
1999 |
$ye |
2 digit year |
99 |
Variables can be shortened to 3 characters. Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% is 31 Oct, 2024 - 23:48:36 |
%SERVERTIME% |
Server time, is 2024-10-31 - 19:48 |
%SERVERTIME{"format"}% |
Formatted server time. Example: %SERVERTIME{"$hou:$min"}% is 19:48 |
%HTTP_HOST% |
HTTP_HOST environment variable, is wiki.gnhlug.org |
%REMOTE_ADDR% |
REMOTE_ADDR environment variable, is 3.147.66.24 |
%REMOTE_PORT% |
REMOTE_PORT environment variable, is |
%REMOTE_USER% |
REMOTE_USER environment variable, is |
%INCLUDE{"SomeTopic"}% |
Server side include, includes another topic. The current Wiki web is searched by default. Example: %INCLUDE{"TWiki.TWikiWebsTable"}% |
%STARTINCLUDE% |
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 everyting exept the %STARTINCLUDE% variable itself. |
%STOPINCLUDE% |
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. |
%TOC% |
Table of Content of current topic. |
%TOC{"SomeTopic" ...}% |
Table of Content. 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. Parameter is composed of the topic name, followed by optional name="value" pairs:
Examples: %TOC{depth="2"}% , %TOC{"TWikiDocumentation" web="TWiki"}%
|
%SEARCH{"str" ...}% |
Inline search, shows a search result embedded in a topic. Parameter is composed of the search term (enclosed in double quotes), followed by optional name="value" pairs: [1]
Pair: |
Description: |
Default: |
search="food" |
Search term, (either regex or literal, depending on the regex parameter) |
(used if initial search term is missing) |
web="Name" web="Main Know" web="all" |
Wiki web to search: A web, a list of webs separated by whitespace, or all webs [2] |
Current web |
scope="topic" scope="text" |
Search topic name (title) or in the text (body) of the topic |
Topic text (body) |
order="topic" order="modified" order="editby" |
Sort the results of search by the topic names, last modified time, or last editor |
Sort by topic name |
limit="all" limit="16" |
Limit the number of results returned |
All results |
regex="on" |
RegularExpression search |
Literal search |
reverse="on" |
Reverse the direction of the search |
Ascending search |
casesensitive="on" |
Case sensitive search |
Ignore case |
nosummary="on" |
Show topic title only |
Show topic summary |
bookview="on" |
BookView search, e.g. show complete topic text |
Show topic summary |
nosearch="on" |
Suppress search string |
Show search string |
noheader="on" |
Suppress search header Topics: Changed: By: |
Show search header |
nototal="on" |
Do not show number of topics found |
Show number |
Example: %SEARCH{"wiki" web="Main" scope="topic"}% |
%VAR{"NAME" web="Web"}% |
Get a preference value from a web other then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}% , is #99CCFF |
: The search form uses identical names for input fields.
.
Variable: | Level: | What: |
%WIKIWEBMASTER% |
SL |
Webmaster email address (sender of email notifications) , is twiki@gnhlug.org |
%WIKIWEBLIST% |
SL |
List of GNHLUG webs (in upper right corner of topics) |
%WEBTOPICLIST% |
WL |
Common links of web (second line of topics) |
%WEBCOPYRIGHT% |
SL , WL |
Copyright notice (bottom right corner of topics) |
%WEBBGCOLOR% |
WL |
Background color of web |
%NOSEARCHALL% |
WL |
Exclude web from a web="all" search (set variable to on for hidden webs) |
%NEWTOPICBGCOLOR% |
SL , UL |
Background color of non existing topic. ( UL needs authentication for topic views ) |
%NEWTOPICFONTCOLOR% |
SL , UL |
Font color of non existing topic. ( UL needs authentication for topic views ) |
%EDITBOXWIDTH% |
SL , UL |
Horizontal size of edit box, is 70 |
%EDITBOXHEIGHT% |
SL , UL |
Vertical size of edit box, is 20 |
%ATTACHLINKBOX% |
SL , UL |
Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is: |
%HTTP_EQUIV_ON_VIEW% |
SL |
http-equiv meta tags for view, rdiff, attach, search* scripts. |
%HTTP_EQUIV_ON_EDIT% |
SL , UL |
http-equiv meta tags for edit script. |
%HTTP_EQUIV_ON_PREVIEW% |
SL , UL |
http-equiv meta tags for preview script. |
%DENYWEBCHANGE% |
WL |
List of users and groups who are not allowed to change topics in the GNHLUG web. (More in TWikiAccessControl) |
%ALLOWWEBCHANGE% |
WL |
List of users and groups who are allowed to change topics in the GNHLUG web. (More in TWikiAccessControl) |
%DENYTOPICCHANGE% |
(any topic) |
List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl) |
%ALLOWTOPICCHANGE% |
(any topic) |
List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl) |
%FINALPREFERENCES% |
SL , WL |
List of preferences that are not allowed to be overridden by next level preferences |