Parameter |
Description |
Default |
action_save=1 |
default; save, return to view, dontnotify is OFF |
|
action_quietsave=1 |
save, and return to view, dontnotify is ON |
|
action_checkpoint |
save and redirect to the edit script, dontnotify is ON |
|
action_cancel |
exit without save, return to view |
|
action_preview |
preview edited text |
|
action_addform |
Redirect to the "change form" page. |
|
action_replaceform... |
Redirect to the "change form" page. |
|
action_delRev |
Administrators only delete the most recent revision of the topic - all other parameters are ignored. You have to be a member of [[Main/TWikiAdminGroup]] to use this, and not all store implementations will support it. |
|
action_repRev |
Administrators only replace the text of the most recent revision of the topic with the text in the text parameter. text must included embedded meta-data tags. All other parameters are ignored. You have to be a member of [[Main/TWikiAdminGroup]] to use this, and not all store implementations will support it. |
|
onlynewtopic |
If set, error if topic already exists |
|
onlywikiname |
If set, error if topic name is not a [[Main/WikiWord]] |
|
dontnotify |
if defined, suppress change notification |
|
templatetopic |
Name of a topic to use as a template for the text and form |
|
text |
New text of the topic |
|
forcenewrevision |
if set, forces a revision even if TWiki thinks one isn't needed |
|
topicparent |
If 'none' remove any current topic parent. If the name of a topic, set the topic parent to this. |
|
formtemplate |
if defined, use the named template for the form |
|
editaction |
When action is checkpoint , add form or replace form... , this is used as the action parameter to the edit script that is redirected to after the save is complete. |
|
originalrev |
Revision on which the edit started. |
|
Any errors will cause a redirect to an `oops` page.
The parameters are interpreted in according to the following rules.
1. The first sequence of ten or more `X` characters in the topic name will be converted to a number such that the resulting topic name is unique in the target web.
2. When the action is `save`, `checkpoint`, `quietsave`, or `preview`:
1. The new text is taken from the `text` parameter, if it is defined,
- otherwise it is taken from the `templatetopic`, if it is defined,
- otherwise it is taken from the previous version of the topic, if any,
2. The name of the new form is taken from the `formtemplate`, if defined
- otherwise it is taken from the `templatetopic`, if defined,
- otherwise it is taken from the previous version of the topic, if any,
- otherwise no form is attached.
3. The value for each field in the form is taken from the query, if it is defined
- otherwise it is taken from the `templatetopic`, if defined,
- otherwise it is taken from the previous version of the topic, if any,
- otherwise it defaults to the empty string.
Merging is only enabled if the topic text comes from `text` and `originalrev` is > 0 and is not the same as the revision number of the most recent revision. If merging is enabled both the topic and the meta-data are merged.
Form field values are passed in parameters named 'field' - for example, if I have a field `Status` the parameter name is `Status`.
###
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" |
Comma-separated list of webs to search. See [[Main/TWikiVariables#VarSEARCH]] for more details. |
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 if order is specified |
All results |
date="..." |
limits the results to those pages with latest edit time in the given [[Main/TimeInterval]]. |
All results |
reverse="on" |
Reverse the direction of the search |
Ascending search |
casesensitive="on" |
Case sensitive search |
Ignore case |
bookview="on" |
[[Main/BookView]] search, e.g. show complete topic text |
Show topic summary |
nonoise="on" |
Shorthand for nosummary="on" nosearch="on" nototal="on" zeroresults="off" noheader="on" noempty="on" |
Off |
nosummary="on" |
Show topic title only |
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 |
zeroresults="off" |
Suppress all output if there are no hits |
zeroresults="on" , displays: "Number of topics: 0" |
noempty="on" |
Suppress results for webs that have no hits. |
Show webs with no hits |
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 |
nofinalnewline="on" |
If on , the search variable does not end in a line by itself. Any text continuing immediately after the search tag on the same line will be rendered as part of the table generated by the search, if appropriate. |
off |
separator=", " |
Line separator between hits |
Newline "$n" |
###
Parameter |
Description |
Default |
raw=on |
Shows the text of the topic in a scrollable textarea |
|
raw=debug |
As raw=on , but also shows the metadata (forms etc) associated with the topic. |
|
raw=text |
Shows only the source of the topic, as plain text (Content-type: text/plain). Only shows the body text, not the form or other meta-data. |
raw=all |
Shows only the source of the topic, as plain text (Content-type: text/plain), with embedded meta-data. This may be useful if you want to extract the source of a topic to a local file on disc. |
|
contenttype |
Allows you to specify a different Content-Type: (e.g. contenttype=text/plain ) |
|
rev |
Revision to view (e.g. rev=45 ) |
|
template |
Allows you to specify a different skin template, overriding the 'view' template the view script would normally use. The default template is view . For example, you could specify [[%WEB%/%TOPIC%?template=edit]]. This is mainly useful when you have specialised templates for a TWiki Application. |
|
%X% For historical reasons, the view script has a special interpretation of the `text` skin. In earlier TWiki versions the `skin=text` parameter was used like this: `http://.../view/MyWeb/MyTopic?skin=text&contenttype=text/plain&raw=on` which shows the topic as plain text; useful for those who want to download plain text for the topic. Using `skin=text` this way is **DEPRECATED**, use `raw=text` instead.
###