Parameter: |
Description: |
Default: |
"SomeTopic" |
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/"}% |
|
pattern="..." |
A [[Main/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% [[Main/TWikiPreferences]] setting |
- Related: [[BASETOPIC|Main/WebHome#VarBASETOPIC]], [[BASEWEB|Main/WebHome#VarBASEWEB]], [[INCLUDINGTOPIC|Main/WebHome#VarINCLUDINGTOPIC]], [[INCLUDINGWEB|Main/WebHome#VarINCLUDINGWEB]], [[IncludeTopicsAndWebPages]]
Parameter: |
Description: |
Default: |
"text" |
Search term. Is a keyword search, literal search or regular expression search, depending on the type parameter. [[Main/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 |
type="keyword"
type="literal"
type="regex" |
Do a keyword search like soap "web service" -shampoo ; a literal search like web service ; or [[Main/RegularExpression]] search like soap;web service;!shampoo |
%SEARCHVAR- DEFAULTTYPE% [[Main/TWikiPreferences]] setting (%SEARCHVARDEFAULTTYPE%) |
scope="topic"
scope="text"
scope="all" |
Search topic name (title); the text (body) of topic; or all (both) |
"text" |
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 [[Main/TWikiForms]]. The sorting is done web by web; in case you want to sort across webs, create a [[Main/FormattedSearch]] table and sort it with [[Main/TablePlugin]]'s initsort |
Sort by topic name |
limit="all"
limit="16" |
Limit the number of results returned. This is done after sorting in case order is specified |
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 |
bookview="on" |
[[Main/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 |
header="..."
format="..." |
Custom format results: see [[Main/FormattedSearch]] for usage, variables & examples |
Results in table |
expandvariables="on" |
Expand variables before applying a [[Main/FormattedSearch]] on a search hit. Useful to show the expanded text, e.g. to show the result of a [[Main/SpreadSheetPlugin]] %CALC{}% instead of the formula |
Raw text |
multiple="on" |
Multiple hits per topic. Each hit can be [[Main/FormattedSearch]]. 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" |
- 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|Main/FormattedSearch]])_
- %H% 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|Main/WebHome#VarMETASEARCH]], [[TOPICLIST|Main/WebHome#VarTOPICLIST]], [[WEBLIST|Main/WebHome#VarWEBLIST]], [[FormattedSearch]]
- [1] **_Note_**: The search form uses identical names for input fields.
- [2] **_Note_**: A web can be excluded from a `web="all"` search if you define a `NOSEARCHALL=on` variable in its [[WebPreferences]]
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" %BR% 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/%WEB%/%TOPIC%?skin=print` URL. [Test this](http://www.dementia.org/twiki//viewauth/%WEB%/%TOPIC%?skin=print#VarURLPARAM):
- Related: [[SEARCH|Main/WebHome#VarSEARCH]], [[FormattedSearch]]
Variable: |
Level: |
What: |
%ALLOWTOPICCHANGE% |
(any topic) |
List of users and groups who are allowed to change the current topic. (More in [[Main/TWikiAccessControl]]) |
%ALLOWTOPICRENAME% |
(any topic) |
List of users and groups who are allowed to rename the current topic. (More in [[Main/TWikiAccessControl]]) |
%ALLOWWEBCHANGE% |
WL |
List of users and groups who are allowed to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) |
%ALLOWWEBRENAME% |
WL |
List of users and groups who are allowed to rename topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) |
%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: %ATTACHLINKBOX% |
%DENYTOPICCHANGE% |
(any topic) |
List of users and groups who are not allowed to change the current topic. (More in [[Main/TWikiAccessControl]]) |
%DENYTOPICRENAME% |
(any topic) |
List of users and groups who are not allowed to rename the current topic. (More in [[Main/TWikiAccessControl]]) |
%DENYWEBCHANGE% |
WL |
List of users and groups who are not allowed to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) |
%DENYWEBRENAME% |
WL |
List of users and groups who are not allowed to rename topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) |
%DONTNOTIFYCHECKBOX% |
SL , UL |
Default state of the "Minor Changes, Don't Notify" ([[Main/DontNotify]]) check box in preview. Check box is initially checked if Set DONTNOTIFYCHECKBOX = checked="checked" , or unchecked if empty. Value is: %DONTNOTIFYCHECKBOX% |
%EDITBOXHEIGHT% |
SL , UL |
Vertical size of edit box, is %EDITBOXHEIGHT% |
%EDITBOXWIDTH% |
SL , UL |
Horizontal size of edit box, is %EDITBOXWIDTH% |
%EDITBOXSTYLE% |
SL , UL |
Style of text edit box. Set to width: 99% for full window width (default; overwrites the EDITBOXWIDTH setting), or width: auto to disable. Value is: %EDITBOXSTYLE% |
%FINALPREFERENCES% |
SL , WL |
List of preferences that are not allowed to be overridden by next level preferences |
%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. |
%HTTP_EQUIV_ON_VIEW% |
SL |
http-equiv meta tags for view, rdiff, attach, search* scripts. |
%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 ) |
%NOSEARCHALL% |
WL |
Exclude web from a web="all" search (set variable to on for hidden webs) |
%RELEASEEDITLOCKCHECKBOX% |
SL , UL |
Default state of the "Release edit lock" ([[Main/UnlockTopic]]) check box in preview. Checkbox is initially checked if Set RELEASEEDITLOCKCHECKBOX = checked="checked" , or unchecked if empty. If checked, make sure to click on Edit to do more changes; do not go back in your browser to the edit page, or you risk that someone else will edit the topic at the same time! Value is: %RELEASEEDITLOCKCHECKBOX% |
%WEBBGCOLOR% |
WL |
Background color of web |
%WEBCOPYRIGHT% |
SL , WL |
Copyright notice (bottom right corner of topics) |
%WEBTOPICLIST% |
WL |
Common links of web (second line of topics) |
%WIKIWEBLIST% |
SL |
List of %WIKITOOLNAME% webs (in upper right corner of topics) |
%WIKIWEBMASTER% |
SL |
Webmaster email address (sender of email notifications) , is |
**_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 %H% Help icon.