|
TWikiVariables 73 - 2004-01-18 - PeterThoeny
|
| |
| META TOPICPARENT |
name="WebHome" |
| | |
This version of TWiki - TWiki-4.3.2, Wed, 02 Sep 2009, build 18148 - expands the following variables (enclosed in % percent signs): | |
<
< | | >
> | | | | | | |
"http://..." |
A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}% |
|
pattern="..." |
A RegularExpression pattern to include a subset of a topic or page |
none |
rev="1.2" |
Include a previous topic revision; N/A for URLs |
top revision |
| |
<
< |
warn="off" |
Warn if topic include fails: Fail silently (if off); output default warning (if set to on); else, output specific text (use $topic for topic name) |
%INCLUDE- WARNING% preferences setting |
| >
> |
warn="off" |
Warn if topic include fails: Fail silently (if off); output default warning (if set to on); else, output specific text (use $topic for topic name) |
%INCLUDE- WARNING% preferences setting |
| | | | | | | %SEARCH{"text" ...}% |
Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1]
| |
<
< |
"text" |
Search term. Is a regular expression or literal, depending on the regex parameter. For regular expressions ";" is used to mean and e.g. "search;agrep" will find all topic containing search and agrep. |
required |
| >
> |
"text" |
Search term. Is a keyword search, literal search or regular expression search, depending on the type parameter. SearchHelp has more |
required |
| | |
search="text" |
(Alternative to above) |
N/A |
web="Name"
web="Main, Know"
web="all" |
Wiki web to search: A web, a list of webs separated by comma, or all webs. [2] |
Current web |
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 |
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 |
| |
<
< |
scope="topic"
scope="text" |
Search topic name (title) or in the text (body) of the topic |
Topic text (body) |
| >
> |
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 |
scope="topic"
scope="text"
scope="all" |
Search topic name (title); the text (body) of topic; or all (both) |
"text" |
| | |
order="topic"
order="modified"
order="editby"
order=
"formfield(name)" |
Sort the results of search by the topic names, last modified time, last editor, or named field of TWikiForms |
Sort by topic name |
limit="all"
limit="16" |
Limit the number of results returned |
All results |
| |
<
< |
| | |
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 |
| | |
header="..."
format="..." |
Custom format results: see FormattedSearch for usage, variables & examples |
Results in table |
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 |
separator=", " |
Line separator between hits |
Newline "$n" |
| |
<
< | Regular example: %SEARCH{"wiki" web="Main" scope="topic"}%
| >
> | Example: %SEARCH{"wiki" web="Main" scope="topic"}%
| | | Formatted example: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (displays results in a table with header - details)
 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%" }%
| | |
Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics): | |
<
< | | >
> | | | | | | | | List of preferences that are not allowed to be overridden by next level preferences |
| |
<
< | | | | Note: There are some more useful variables defined in the TWikiPreferences like %BR% for line break, colors like %RED% for colored text and small icons like %H% for a Help icon. | |
<
< | | | |
Setting Preferences |
|
|
TWikiVariables 72 - 2004-01-16 - PeterThoeny
|
| |
| META TOPICPARENT |
name="WebHome" |
| | | %ICON{"type"}% |
Small 16x16 pixel icon of common attachment types, like  bmp,  doc,  gif,  hlp,  html,  mp3,  pdf,  ppt,  txt,  xls,  xml,  zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns |
|
| |
<
< | %URLPARAM{"name"}% |
Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Parameters are name, default and newline: | | >
> | %PARAM{"name"}% |
Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. 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 to other delimiters |
no conversion |
| |
<
< | Example: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is kubrick.nat,nat, pattern | >
> |
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 |
Example: %PARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is %PARAM{"skin"}% | | | | |
<
< | %URLENCODE{"string"}% |
Encodes a string for use as a URL parameter. Ex: %URLENCODE{"spaced name"}% returns spaced%20name | | >
> | | %ENCODE{"string"}% |
Encodes a string. Supported parameters:
| Parameter: |
Description: |
Default: |
"string" |
String to encode |
required (can be empty) |
type="entity" |
Encode special characters into HTML entities, like a double quote into " |
URL encoding |
type="url" |
Encode special characters for URL parameter use, like a double quote into %22 |
(this is the default) |
Example: %ENCODE{"spaced name"}% returns spaced%20name | | |
%WIKITOOLNAME% |
The name of your TWiki site - TWiki |
| | | | Table of Contents of current topic. |
%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. Parameters are topic name, web and depth: | | >
> | 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 |
| |
<
< | Examples: %TOC{depth="2"}%, %TOC{"TWikiDocumentation" web="TWiki"}% | >
> |
title="Some text" |
Title to appear at top of TOC |
none |
Examples: %TOC{depth="2"}%, %TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}% | | |
%SEARCH{"text" ...}% |
Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1] |
| | |
-
-
Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif
| |
<
< | -- PeterThoeny - 19 Jan 2003
-- MikeMannix - 12 May 2002 | >
> | -- TWiki:Main.PeterThoeny - 14 Jan 2004
-- TWiki:Main.MikeMannix - 12 May 2002 |
|
|
TWikiVariables 71 - 2004-01-10 - PeterThoeny
|
| |
| META TOPICPARENT |
name="WebHome" |
| | | | The path of the attachment URL of the current topic, is /pub/TWiki/TWikiVariables |
%ICON{"type"}% | | |
<
< | Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, pdf, ppt, txt, wav, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns | | >
> | Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns | | | |
%URLPARAM{"name"}% |
Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Parameters are name, default and newline: |
|
|
|
TWikiVariables 70 - 2003-11-01 - PeterThoeny
|
| |
| META TOPICPARENT |
name="WebHome" |
| | |
| Parameter: |
Description: |
Default: |
"text" |
Search term. Is a regular expression or literal, depending on the regex parameter. For regular expressions ";" is used to mean and e.g. "search;agrep" will find all topic containing search and agrep. |
required |
search="text" |
(Alternative to above) |
N/A |
| |
<
< |
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 |
| >
> |
web="Name"
web="Main, Know"
web="all" |
Wiki web to search: A web, a list of webs separated by comma, or all webs. [2] |
Current web |
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 |
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 |
| | |
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"
order=
"formfield(name)" |
Sort the results of search by the topic names, last modified time, last editor, or named field of TWikiForms |
Sort by topic name |
limit="all"
limit="16" |
Limit the number of results returned |
All results |
|
|
|
|
|
 Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding TWiki? Send feedback Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiVariables
|
|