Parameter | Description | Default |
action | Optional. Use the editaction template instead of the standard edit. If action=text, then hide the form. If action=form hide the normal text area and only edit the form. | |
onlynewtopic | If set, error if topic already exists | |
onlywikiname | If set, error if topic name is not a WikiWord | |
templatetopic | The name of the template topic, copied to get the initial content | |
text | Initial text for the topic | |
topicparent | The parent topic | |
formtemplate | Name of the form to instantiate in the topic. Overrides the form set in the templatetopic if defined. | |
contenttype | Optional parameter that defines the application type to write into the CGI header. Defaults to text/html . May be used to invoke alternative client applications | |
anyname | Any parameter can passed to the new topic; if the template topic contains %URLPARAM{"anyname"}% , it will be replaced by its value | |
breaklock | If set, any lease conflicts will be ignored, and the edit will proceed even if someone is already editing the topic. | |
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 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 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 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. | |
Parameter: | Description: | Default: |
"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" | Comma-separated list of webs to search. See 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 RegularExpression search like soap;web service;!shampoo | %SEARCHVAR- DEFAULTTYPE% preferences setting (literal) |
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 TWikiForms. The sorting is done web by web; in case you want to sort across webs, create a formatted table and sort it with 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 TimeInterval. | All results |
reverse="on" | Reverse the direction of the search | Ascending search |
casesensitive="on" | Case sensitive search | Ignore case |
bookview="on" | 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 FormattedSearch for usage, variables & examples | Results in table |
expandvariables="on" | Expand variables before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin %CALC{}% instead of the formula | Raw text |
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 |
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 /bin/view/TWiki/TWikiScripts?template=edit. This is mainly useful when you have specialised templates for a TWiki Application. | |