TWikiScripts (edit)

Formatting help:

bold put word/phrase in asterisks: *your phrase*
bullet list 3 spaces, asterisk, 1 space: * your text
headings 3 dashes, 1 to 6 pluses, 1 space: ---++ Your Heading
italic put word/phrase in underscores: _your words_
site links use topic name: WebHome or [[WebHome][Our homepage]]
external links http://google.com/ or [[http://google.com/][link to Google]]
monospaced put word/phrase in equal signs: =your words=
paragraphs separate with blank line
More formatting help and hints on good style

<h1><a name="TWiki_CGI_and_Command_Line_Scrip"></a> TWiki CGI and Command Line Scripts </h1>
<p />
<em>Programs on the TWiki server performing actions such as rendering, saving and renaming topics.</em>
<p />
The TWiki scripts are located in the <code>twiki/bin</code> and <code>twiki/tools</code> directories. This topic describes the interfaces to some of those scripts. All scripts in the <code>twiki/bin</code> directory can be called from the CGI (<a href="http://en.wikipedia.org/wiki/Common_Gateway_Interface" target="_blank">Common Gateway Interface<img height="12" border="0" alt="" src="/twiki/pub/TWiki/TWikiDocGraphics/external-link.gif" width="13" /></a>) environment or from the command line. The scripts in the <code>twiki/tools</code> directory can only be called from the command line.
<p />
<div class="twikiToc"><span class="twikiTocTitle">On this page:</span> <ul>
<li> <a href="?template=edit#CGI_Scripts"> CGI Scripts</a> <ul>
<li> <a href="?template=edit#General_Information"> General Information</a> <ul>
<li> <a href="?template=edit#CGI_environment"> CGI environment</a>
</li> <li> <a href="?template=edit#Command_line"> Command-line</a>
</li> <li> <a href="?template=edit#Common_parameters"> Common parameters</a>
</li></ul> 
</li> <li> <a href="?template=edit#attach"> attach</a>
</li> <li> <a href="?template=edit#changes"> changes</a>
</li> <li> <a href="?template=edit#configure"> configure</a>
</li> <li> <a href="?template=edit#edit"> edit</a>
</li> <li> <a href="?template=edit#login"> login</a>
</li> <li> <a href="?template=edit#logon"> logon</a>
</li> <li> <a href="?template=edit#manage"> manage</a> <ul>
<li> <a href="?template=edit#action_createweb"> action=createweb</a>
</li> <li> <a href="?template=edit#action_renameweb"> action=renameweb</a>
</li> <li> <a href="?template=edit#action_editSettings"> action=editSettings</a>
</li> <li> <a href="?template=edit#action_saveSettings"> action=saveSettings</a>
</li> <li> <a href="?template=edit#action_bulkRegister"> action=bulkRegister</a>
</li> <li> <a href="?template=edit#action_changePassword"> action=changePassword</a>
</li> <li> <a href="?template=edit#action_resetPassword"> action=resetPassword</a>
</li> <li> <a href="?template=edit#action_delete_UserAccount"> action=deleteUserAccount</a>
</li></ul> 
</li> <li> <a href="?template=edit#oops"> oops</a>
</li> <li> <a href="?template=edit#preview"> preview</a>
</li> <li> <a href="?template=edit#rdiff"> rdiff</a>
</li> <li> <a href="?template=edit#register"> register</a>
</li> <li> <a href="?template=edit#rename"> rename</a>
</li> <li> <a href="?template=edit#copy"> copy</a>
</li> <li> <a href="?template=edit#mdrepo"> mdrepo</a>
</li> <li> <a href="?template=edit#rest"> rest</a> <ul>
<li> <a href="?template=edit#Invocation_Examples"> Invocation Examples</a>
</li></ul> 
</li> <li> <a href="?template=edit#save"> save</a>
</li> <li> <a href="?template=edit#search"> search</a>
</li> <li> <a href="?template=edit#statistics"> statistics</a>
</li> <li> <a href="?template=edit#upload"> upload</a>
</li> <li> <a href="?template=edit#view"> view</a>
</li> <li> <a href="?template=edit#viewfile"> viewfile</a>
</li></ul> 
</li> <li> <a href="?template=edit#Command_Line_Scripts"> Command Line Scripts</a> <ul>
<li> <a href="?template=edit#geturl_pl"> geturl.pl</a>
</li> <li> <a href="?template=edit#rewriteshebang_pl"> rewriteshebang.pl</a>
</li> <li> <a href="?template=edit#tick_twiki_pl"> tick_twiki.pl</a>
</li></ul> 
</li></ul> 
</div>
<p />
<a name="CgiScripts"></a>
<h2><a name="CGI_Scripts"></a> CGI Scripts </h2>
<p />
Details on CGI scripts located in the <code>twiki/bin</code> directory.
<p />
<a name="GeneralInformation"></a>
<h3><a name="General_Information"></a> General Information </h3>
<p />
<a name="CgiEnvironment"></a>
<h4><a name="CGI_environment"></a> CGI environment </h4>
<p />
In the CGI environment parameters are passed to the scripts via the URL and URL parameters. Environment variables are also used to determine the user performing the action. If the environment is not set up, the default TWiki user is used (usually <code>guest</code>).
<p />
<a name="CommandLine"></a>
<h4><a name="Command_line"></a> Command-line </h4>
<p />
You <strong>must</strong> have the <code>twiki/bin</code> directory on the perl path to run the scripts from the command line. To avoid issues with file permissions, run the scripts as the web server user such as <code>nobody</code> or <code>www</code>.
<p />
Parameters are passed on the command line using '-name' - for example,
<pre>
$ cd /usr/local/twiki/bin
$ save -topic MyWeb.MyTopic -user admin -method POST -action save -text "New text of the topic"
</pre>
All parameters require a value, even if that is the empty string.
<p />
<a name="CommonParameters"></a>
<h4><a name="Common_parameters"></a> Common parameters </h4>
<p />
All the scripts accept a number of common parameters. The first two components of the URL after the script name are taken as the web and the topic, respectively. Standard URL parameters are:
<p />
<table id="table1" border="1" cellspacing="0" cellpadding="0" rules="all" class="twikiTable">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th valign="top" bgcolor="#687684" class="twikiTableCol0 twikiFirstCol"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=1;up=0#sorted_table"><font color="#ffffff">Parameter</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol1"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=1;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Description</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol2 twikiLastCol"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=1;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>topic</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#ffffff"> If this is set to a URL, TWiki will immediately redirect to that URL. Otherwise it overrides the URL and is taken as the topic name (you can pass Web.TopicName) </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>user</code> </td>
<td bgcolor="#edf4f9" class="twikiTableCol1" valign="top"> Command-line only; set the name of the user performing the action. Note: this usage is inherently insecure, as it bypasses webserver login constraints. For this reason only authorized users should be allowed to execute scripts from the command line. </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9" valign="top"> <code>TWikiAdminGroup</code> </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>method</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> Commad-line only; set the HTTP request method. Some scripts requires the POST method under certain circumstances. In such a case, you need to specify the POST method to run the script from a command line. </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top"> <code>GET</code> </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>skin</code> </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> Overrides the default skin path (see <a href="/twiki/bin/view/TWiki/TWikiSkins" class="twikiLink">TWikiSkins</a>) </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9" valign="top">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol twikiLast" bgcolor="#ffffff" valign="top"> <code>cover</code> </td>
<td valign="top" class="twikiTableCol1 twikiLast" bgcolor="#ffffff"> Specifies temporary skin path to prepend to the skin path for this script only (see <a class="twikiLink" href="/twiki/bin/view/TWiki/TWikiSkins">TWikiSkins</a>) </td>
<td valign="top" class="twikiTableCol2 twikiLastCol twikiLast" bgcolor="#ffffff">   </td>
</tr></table>
<p />
<a name="AttachScript"></a>
<h3><a name="attach"></a> <code>attach</code> </h3>
<p />
Despite the name, this script doesn't actually attach a file to a topic - for that, use <code>upload</code>. This script is part of the transactions sequence executed when a file is uploaded from the browser. it just generates the "new attachment" page for a topic.
<p />
<table class="twikiTable" rules="all" cellpadding="0" cellspacing="0" id="table2" border="1">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th valign="top" bgcolor="#687684" class="twikiTableCol0 twikiFirstCol"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=2;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Parameter</font></a> </th>
<th valign="top" class="twikiTableCol1" bgcolor="#687684"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=2;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Description</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol2 twikiLastCol"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=2;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol twikiLast"> <code>filename</code> </td>
<td class="twikiTableCol1 twikiLast" bgcolor="#ffffff" valign="top"> Name of existing attachment (if provided, this is a "manage attachment" action) </td>
<td valign="top" class="twikiTableCol2 twikiLastCol twikiLast" bgcolor="#ffffff"> none (in which case this is a "new attachment" action) </td>
</tr></table>
<p />
<a name="ChangesScript"></a>
<h3><a name="changes"></a> <code>changes</code> </h3>
<p />
Shows all the changes in the given web. 
<p />
The <code>changes</code> script can receive one parameter:
<p />
<table cellpadding="0" cellspacing="0" id="table3" border="1" class="twikiTable" rules="all">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th valign="top" bgcolor="#687684" class="twikiTableCol0 twikiFirstCol"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=3;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Parameter</font></a> </th>
<th valign="top" class="twikiTableCol1" bgcolor="#687684"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=3;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Description</font></a> </th>
<th class="twikiTableCol2 twikiLastCol" bgcolor="#687684" valign="top"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=3;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol twikiLast" bgcolor="#ffffff" valign="top"> <code>minor</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1 twikiLast"> If 0, show only major changes. If 1, show all the changes (both minor and major) </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol twikiLast"> 0 </td>
</tr></table>
<p />
The main difference between invoking this script and using <a href="/twiki/bin/view/TWiki/WebChanges" class="twikiLink">WebChanges</a> is that <a class="twikiLink" href="/twiki/bin/view/TWiki/WebChanges">WebChanges</a> is based on a <code>%SEARCH%</code>, while this script reads the <code>changes</code> file in each web, making it much faster.
<p />
<strong><em>Note:</em></strong> The result from <code>changes</code> script and the topic <a href="/twiki/bin/view/TWiki/WebChanges" class="twikiLink">WebChanges</a> can be different, if the <code>changes</code> file is deleted from a web. In particular, in new installations the <code>changes</code> script will return no results while the <a href="/twiki/bin/view/TWiki/WebChanges" class="twikiLink">WebChanges</a> topic will.
<p />
<a name="ConfigureScript"></a>
<h3><a name="configure"></a> <code>configure</code> </h3>
<p />
<code>configure</code> is the browser script used for inspection and configuration of the TWiki configuration. None of the parameters to this script are useable for any purpose except <code>configure</code>. See <a href="/twiki/bin/configure" target="_top">configure</a>.
<p />
<a name="EditScript"></a>
<h3><a name="edit"></a> <code>edit</code> </h3>
<p />
The <code>edit</code> script understands the following parameters, typically supplied by HTML input fields:
<p />
<table cellpadding="0" border="1" id="table4" cellspacing="0" rules="all" class="twikiTable">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th class="twikiTableCol0 twikiFirstCol" bgcolor="#687684" valign="top"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=4;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Parameter</font></a> </th>
<th valign="top" class="twikiTableCol1" bgcolor="#687684"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=4;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Description</font></a> </th>
<th valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#687684"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=4;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>action</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> 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. You can change the Edit/Edit Raw buttons to always append the action parameter in skins like Pattern and Classic by setting the topic or preference variable <a class="twikiLink" href="/twiki/bin/view/TWiki/VarEDITACTION">EDITACTION</a> to the value <code>text</code> or <code>form</code>. To edit the topic once the EDITACTION is defined as form simply remove the action=form from the browser URL of the edit script and reload the edit window </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol" valign="top">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9" valign="top"> <code>onlynewtopic</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> If set, error if topic already exists </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>onlywikiname</code> </td>
<td bgcolor="#ffffff" class="twikiTableCol1" valign="top"> If set, error if topic name is not a <a href="/twiki/bin/view/TWiki/WikiWord" class="twikiLink">WikiWord</a> </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol" valign="top">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9" valign="top"> <code>templatetopic</code> </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> The name of the template topic, copied to get the initial content (new topic <em>only</em>) </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>text</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> Initial text for the topic </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol"> <code>topicparent</code> </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> The parent topic </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> <code>formtemplate</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> Name of the form to instantiate in the topic. Overrides the form set in the <code>templatetopic</code> if defined. (will remove the form is set to 'none') </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9" valign="top"> <code>template</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> Specify a different skin template, overriding the 'edit' template the edit script would normally use. Use this for specialized templates in a TWiki Application. This parameter is not commonly used. </td>
<td bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol" valign="top">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff"> <code>contenttype</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#ffffff"> Optional parameter that defines the application type to write into the CGI header. Defaults to <code>text/html</code>. May be used to invoke alternative client applications </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9"> <code>anyname</code> </td>
<td bgcolor="#edf4f9" class="twikiTableCol1" valign="top"> Any parameter can passed to the new topic; if the template topic contains <code>%URLPARAM{"anyname"}%</code>, it will be replaced by its value </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>breaklock</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> If set, any lease conflicts will be ignored, and the edit will proceed even if someone is already editing the topic. </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol" valign="top">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>redirectto</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol1"> If the user continues from edit to save, and if the save (or cancels the edit) process is successful, save will redirect to this topic or URL. The parameter value can be a <code>TopicName</code>, a <code>Web.TopicName</code>, or a URL.<br />  <strong><em>Note:</em></strong> Redirect to a URL only works if it is enabled in <code>configure</code> (Security setup > Miscellaneous <code>{AllowRedirectUrl}</code>). </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol twikiLast" valign="top"> <code>t</code> </td>
<td valign="top" class="twikiTableCol1 twikiLast" bgcolor="#ffffff"> Provide a unique URL each time a topic is edited, typically specifying parameter <code>t=%SERVERTIME{$epoch}%</code> in an edit link. This is done to prevent browsers from caching an edit session, which could result in editing outdated content. The parameter name and value is arbitrary, but must be unique each time. </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol twikiLast" valign="top">   </td>
</tr></table>
<p />
Form field values are passed in parameters named 'field' - for example, if I have a field <code>Status</code> the parameter name is <code>Status</code>. <ol>
<li> The first sequence of ten or more <code>X</code> characters in the topic name will be converted on save to a number such that the resulting topic name is unique in the target web.
</li></ol> 
<p />
<strong><em>Note:</em></strong> Most skins support the definition of <code>EDIT_SKIN</code>, which is used as the value of the <code>cover</code> parameter in <code>edit</code> URLs. This allows you to override the default edit skin on a web, topic or user basis.
<p />
<a name="LoginScript"></a>
<h3><a name="login"></a> <code>login</code> </h3>
<p />
Used for logging in when TWiki login is being used (e.g TemplateLoginManager).
<table cellpadding="0" border="1" id="table5" cellspacing="0" rules="all" class="twikiTable">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th class="twikiTableCol0 twikiFirstCol" bgcolor="#687684" valign="top"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=5;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Parameter</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol1"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=5;up=0#sorted_table"><font color="#ffffff">Description</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol2 twikiLastCol"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=5;up=0#sorted_table"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff"> <code>origurl</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#ffffff"> URL that was being accessed when an access violation occurred. the login process will redirect to this URL if it is successful </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol"> none </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9" valign="top"> <code>username</code> </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> username of user logging in </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9"> none </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol twikiLast"> <code>password</code> </td>
<td bgcolor="#ffffff" class="twikiTableCol1 twikiLast" valign="top"> password of user logging in </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol twikiLast" valign="top"> none </td>
</tr></table>
<p />
<a name="LogonScript"></a>
<h3><a name="logon"></a> <code>logon</code> </h3>
<p />
Used for logging in when Web Server authentication is being used (e.g. ApacheLoginManager). The script does nothing; it is purely a placeholder for triggering the login process. The webserver will be set up to require a valid user to access this script, thus triggering the webserver login process.
<p />
<a name="ManageScript"></a>
<h3><a name="manage"></a> <code>manage</code> </h3>
<p />
Performs a range of management functions.
<table cellpadding="0" border="1" id="table6" cellspacing="0" rules="all" class="twikiTable">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#687684"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=6;up=0#sorted_table"><font color="#ffffff">Parameter</font></a> </th>
<th class="twikiTableCol1" bgcolor="#687684" valign="top"> <a rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=6;up=0#sorted_table" title="Sort by this column"><font color="#ffffff">Description</font></a> </th>
<th class="twikiTableCol2 twikiLastCol" bgcolor="#687684" valign="top"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=6;up=0#sorted_table"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol twikiLast"> <code>action</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1 twikiLast"> One of <code>createweb</code>, <code>renameweb</code>, <code>deleteUserAccount</code>, <code>editSettings</code> or <code>saveSettings</code> </td>
<td valign="top" class="twikiTableCol2 twikiLastCol twikiLast" bgcolor="#ffffff"> none </td>
</tr></table>
<p />
<strong><em>Note:</em></strong> The <code>manage</code> script can only be called via http POST method for <code>createweb</code> <code>renameweb</code>, and <code>deleteUserAccount</code>.
<p />
<a name="ActionCreateweb"></a>
<h4><a name="action_createweb"></a> <code>action=createweb</code> </h4>
<p />
<table cellspacing="0" id="table7" border="1" cellpadding="0" class="twikiTable" rules="all">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th class="twikiTableCol0 twikiFirstCol" bgcolor="#687684" valign="top"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=7;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Parameter</font></a> </th>
<th bgcolor="#687684" class="twikiTableCol1" valign="top"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=7;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Description</font></a> </th>
<th class="twikiTableCol2 twikiLastCol" bgcolor="#687684" valign="top"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=7;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff"> <code>newweb</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> Name of the new web </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol" valign="top"> '' </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9" valign="top"> <code>baseweb</code> </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> Name of the web to copy to create the new web </td>
<td bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol" valign="top"> '' </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff"> <code>webbgcolor</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> value for WEBBGCOLOR </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol" valign="top"> '' </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol"> <code>sitemapwhat</code> </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> Value for SITEMAPWHAT </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9"> '' </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol twikiLast" bgcolor="#ffffff"> <code>nosearchall</code> </td>
<td valign="top" class="twikiTableCol1 twikiLast" bgcolor="#ffffff"> Value for NOSEARCHALL </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol twikiLast"> '' </td>
</tr></table>
<p />
<a name="ActionRenameweb"></a>
<h4><a name="action_renameweb"></a> <code>action=renameweb</code> </h4>
<p />
<table rules="all" class="twikiTable" cellpadding="0" border="1" id="table8" cellspacing="0">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th bgcolor="#687684" class="twikiTableCol0 twikiFirstCol" valign="top"> <a rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=8;up=0#sorted_table" title="Sort by this column"><font color="#ffffff">Parameter</font></a> </th>
<th valign="top" class="twikiTableCol1" bgcolor="#687684"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=8;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Description</font></a> </th>
<th class="twikiTableCol2 twikiLastCol" bgcolor="#687684" valign="top"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=8;up=0#sorted_table"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> <code>newsubweb</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#ffffff"> Name of the web after move </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top"> '' </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol"> <code>newparentweb</code> </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> New parent web name </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol"> '' </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol twikiLast" bgcolor="#ffffff" valign="top"> <code>confirm</code> </td>
<td class="twikiTableCol1 twikiLast" bgcolor="#ffffff" valign="top"> If defined, requires a second level of confirmation.  Supported values are "getlock", "continue", and "cancel" </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol twikiLast" valign="top"> '' </td>
</tr></table>
<p />
<a name="ActionEditSettings"></a>
<h4><a name="action_editSettings"></a> <code>action=editSettings</code> </h4>
<p />
No parameters
<p />
<a name="ActionSaveSettings"></a>
<h4><a name="action_saveSettings"></a> <code>action=saveSettings</code> </h4>
<p />
<table cellpadding="0" cellspacing="0" id="table9" border="1" class="twikiTable" rules="all">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th class="twikiTableCol0 twikiFirstCol" bgcolor="#687684" valign="top"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=9;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Parameter</font></a> </th>
<th valign="top" class="twikiTableCol1" bgcolor="#687684"> <a rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=9;up=0#sorted_table" title="Sort by this column"><font color="#ffffff">Description</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol2 twikiLastCol"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=9;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> <code>text</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#ffffff"> Text of the topic </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top"> '' </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9" valign="top"> <code>originalrev</code> </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> Revision that the edit started on </td>
<td bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol" valign="top"> Most recent revision </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol twikiLast" bgcolor="#ffffff"> <code>redirectto</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1 twikiLastCol twikiLast"> If the savesettings process is successful, save will redirect to this topic or URL. The parameter value can be a <code>TopicName</code>, a <code>Web.TopicName</code>, or a URL.<br />  <strong><em>Note:</em></strong> Redirect to a URL only works if it is enabled in <code>configure</code> (Security setup > Miscellaneous <code>{AllowRedirectUrl}</code>). </td>
</tr></table>
All other parameters may be interpreted as form fields, depending on the current form definition in the topic.
<p />
<a name="ActionBulkRegister"></a>
<h4><a name="action_bulkRegister"></a> <code>action=bulkRegister</code> </h4>
<p />
See <a href="/twiki/bin/view/TWiki/BulkRegistration" class="twikiLink">BulkRegistration</a>.
<table rules="all" class="twikiTable" cellpadding="0" id="table10" border="1" cellspacing="0">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#687684"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=10;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Parameter</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol1"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=10;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Description</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol2 twikiLastCol"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=10;up=0#sorted_table"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>OverwriteHomeTopics</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> Whether to overwrite existing home topics or not </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top"> false </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>EmailUsersWithDetails</code> </td>
<td bgcolor="#edf4f9" class="twikiTableCol1" valign="top"> Whether to mail registered users or not </td>
<td bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol" valign="top"> false </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol twikiLast"> <code>LogTopic</code> </td>
<td valign="top" class="twikiTableCol1 twikiLast" bgcolor="#ffffff"> Topic to save the log in </td>
<td valign="top" class="twikiTableCol2 twikiLastCol twikiLast" bgcolor="#ffffff"> Same as topic name, with 'Result' appended. </td>
</tr></table>
<p />
<a name="ActionChangePassword"></a>
<h4><a name="action_changePassword"></a> <code>action=changePassword</code> </h4>
<p />
Change password, email address, or both, of a user.
<table cellpadding="0" border="1" id="table11" cellspacing="0" rules="all" class="twikiTable">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#687684"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=11;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Parameter</font></a> </th>
<th class="twikiTableCol1" bgcolor="#687684" valign="top"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=11;up=0#sorted_table"><font color="#ffffff">Description</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol2 twikiLastCol"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=11;up=0#sorted_table"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>username</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#ffffff"> god alone knows </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol"> <em>none</em> </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9" valign="top"> <code>oldpassword</code> </td>
<td bgcolor="#edf4f9" class="twikiTableCol1" valign="top"> current password </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol"> <em>none</em> </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>password</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> new password </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol"> <em>none</em> </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9"> <code>passwordA</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol1"> new password confirmation </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol"> <em>none</em> </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol twikiLast"> <code>email</code> </td>
<td bgcolor="#ffffff" class="twikiTableCol1 twikiLast" valign="top"> new email address </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol twikiLast"> <em>none</em> </td>
</tr></table>
<code>password, =passwordA</code> and <code>email</code> are optional. If neither or <code>password</code> and <code>passwordA</code> is set, then the user password is left unchanged. If <code>email</code> is unset, their email is left unchanged.
<p />
<a name="ActionResetPassword"></a>
<h4><a name="action_resetPassword"></a> <code>action=resetPassword</code> </h4>
<p />
Reset the password for a single or multiple users
<table cellspacing="0" id="table12" border="1" cellpadding="0" class="twikiTable" rules="all">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th valign="top" bgcolor="#687684" class="twikiTableCol0 twikiFirstCol"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=12;up=0#sorted_table"><font color="#ffffff">Parameter</font></a> </th>
<th bgcolor="#687684" class="twikiTableCol1" valign="top"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=12;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Description</font></a> </th>
<th bgcolor="#687684" class="twikiTableCol2 twikiLastCol" valign="top"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=12;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> <code>LoginName</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#ffffff"> <strong>list</strong> of usernames to reset </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol"> none - error if not set </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td class="twikiTableCol0 twikiFirstCol twikiLast" bgcolor="#edf4f9" valign="top"> <code>Introduction</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol1 twikiLast"> message to be sent alongside the reset, most often used to announce to the user that they have been given an account. </td>
<td bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol twikiLast" valign="top"> '' </td>
</tr></table>
<p />
This is used by <a href="/twiki/bin/view/TWiki/BulkResetPassword" class="twikiLink">BulkResetPassword</a> and <a href="/twiki/bin/view/TWiki/ResetPassword" class="twikiLink">ResetPassword</a>. Only administrators can provide a list of <a class="twikiLink" href="/twiki/bin/view/TWiki/LoginName">LoginNames</a>, non-admins can only provide a single <a class="twikiLink" href="/twiki/bin/view/TWiki/LoginName">LoginName</a>. 
<p />
<a href="/twiki/bin/view/TWiki/BulkRegistration" class="twikiLink">BulkRegistration</a> provides the means to create multiple accounts but it does not announce those accounts to the users who own them. <a class="twikiLink" href="/twiki/bin/view/TWiki/BulkResetPassword">BulkResetPassword</a> is used to assign the passwords, the Introduction is used to explain why they are receiving the mail.
<p />
<a name="ActionDeleteUserAccount"></a>
<h4><a name="action_delete_UserAccount"></a> <code>action=deleteUserAccount</code> </h4>
<p />
Unregisters (removes) the currently logged-in user.
<table cellspacing="0" border="1" id="table13" cellpadding="0" class="twikiTable" rules="all">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#687684"> <a rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=13;up=0#sorted_table" title="Sort by this column"><font color="#ffffff">Parameter</font></a> </th>
<th class="twikiTableCol1" bgcolor="#687684" valign="top"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=13;up=0#sorted_table"><font color="#ffffff">Description</font></a> </th>
<th class="twikiTableCol2 twikiLastCol" bgcolor="#687684" valign="top"> <a rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=13;up=0#sorted_table" title="Sort by this column"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol twikiLast" bgcolor="#ffffff" valign="top"> <code>password</code> </td>
<td class="twikiTableCol1 twikiLast" bgcolor="#ffffff" valign="top"> Users' password </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol twikiLast"> none </td>
</tr></table>
<p />
<a name="OopsScript"></a>
<h3><a name="oops"></a> <code>oops</code> </h3>
<p />
This script is mainly used for rendering pages containing error messages, though it is also used for some functional actions such as manage pages (move topic etc).
<p />
<code>oops</code> templates are used with the <code>oops</code> script to generate system messages. This is done to make internationalization or other local customizations simple. 
<p />
The <code>oops</code> script supports the following parameters:
<p />
<table cellpadding="0" cellspacing="0" border="1" id="table14" class="twikiTable" rules="all">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th class="twikiTableCol0 twikiFirstCol" bgcolor="#687684" valign="top"> <a rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=14;up=0#sorted_table" title="Sort by this column"><font color="#ffffff">Parameter</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol1"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=14;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Description</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol2 twikiLastCol"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=14;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff"> <code>template</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> Name of the template file to display </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol"> <code>def</code> </td>
<td bgcolor="#edf4f9" class="twikiTableCol1" valign="top"> Optional, can be set to the name of a single definition within <code>template</code>. This definition will be instantiated in the <code>template</code> wherever <code>%INSTANTIATE%</code> is seen. This lets you use a single template file for many messages. For an example, see <code>oopsmanagebad.tmpl</code>. </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol twikiLast" bgcolor="#ffffff"> <code>paramN</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1 twikiLast"> Where N is an integer from 1 upwards. These values will be substituted into <code>template</code> for <code>%PARAM1%</code> etc. </td>
<td class="twikiTableCol2 twikiLastCol twikiLast" bgcolor="#ffffff" valign="top">   </td>
</tr></table>
<p />
<a name="PreviewScript"></a>
<h3><a name="preview"></a> <code>preview</code> </h3>
<p />
This script is <em>deprecated</em>. Its functions are covered by the <code>save</code> script.
<p />
<a name="RdiffScript"></a>
<h3><a name="rdiff"></a> <code>rdiff</code> </h3>
<p />
Renders the differences between version of a TWiki topic
<p />
<table cellpadding="0" id="table15" border="1" cellspacing="0" rules="all" class="twikiTable">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th bgcolor="#687684" class="twikiTableCol0 twikiFirstCol" valign="top"> <a rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=15;up=0#sorted_table" title="Sort by this column"><font color="#ffffff">Parameter</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol1"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=15;up=0#sorted_table"><font color="#ffffff">Description</font></a> </th>
<th valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#687684"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=15;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> rev1 </td>
<td bgcolor="#ffffff" class="twikiTableCol1" valign="top"> the higher revision </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> rev2 </td>
<td bgcolor="#edf4f9" class="twikiTableCol1" valign="top"> the lower revision </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> render </td>
<td bgcolor="#ffffff" class="twikiTableCol1" valign="top"> the rendering style {sequential, sidebyside, raw, debug} </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol" valign="top"> DIFFRENDERSTYLE, <code>sequential</code> </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> type </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> {history, diff, last} history diff, version to version, last version to previous </td>
<td bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol" valign="top"> <code>diff</code> </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol twikiLast" bgcolor="#ffffff" valign="top"> context </td>
<td bgcolor="#ffffff" class="twikiTableCol1 twikiLast" valign="top"> number of lines of context </td>
<td class="twikiTableCol2 twikiLastCol twikiLast" bgcolor="#ffffff" valign="top">   </td>
</tr></table>
TODO: <ul>
<li> add a {word} render style
</li></ul> 
<p />
<a name="RegisterScript"></a>
<h3><a name="register"></a> <code>register</code> </h3>
<p />
<table cellpadding="0" border="1" id="table16" cellspacing="0" rules="all" class="twikiTable">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th class="twikiTableCol0 twikiFirstCol" bgcolor="#687684" valign="top"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=16;up=0#sorted_table"><font color="#ffffff">Parameter</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol1"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=16;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Description</font></a> </th>
<th bgcolor="#687684" class="twikiTableCol2 twikiLastCol" valign="top"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=16;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>action</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> <code>register</code> or <code>verify</code> or <code>resetPassword</code> or <code>approve</code> </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol twikiLast" bgcolor="#edf4f9"> <code>topicparent</code> </td>
<td valign="top" class="twikiTableCol1 twikiLast" bgcolor="#edf4f9"> The parent topic of the new user profile page </td>
<td valign="top" class="twikiTableCol2 twikiLastCol twikiLast" bgcolor="#edf4f9"> <code>{UsersTopicName}</code> configure setting </td>
</tr></table>
<p />
<strong><em>Note:</em></strong> The <code>register</code> script can only be called via http POST method, not GET. Make sure to specify the <code>"post"</code> method if you call the <code>register</code> script via a form action.
<p />
<a name="RenameScript"></a>
<h3><a name="rename"></a> <code>rename</code> </h3>
<p />
Used for renaming topics and attachments.
<p />
<table border="1" id="table17" cellspacing="0" cellpadding="0" rules="all" class="twikiTable">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th bgcolor="#687684" class="twikiTableCol0 twikiFirstCol" valign="top"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=17;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Parameter</font></a> </th>
<th valign="top" class="twikiTableCol1" bgcolor="#687684"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=17;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Description</font></a> </th>
<th class="twikiTableCol2 twikiLastCol" bgcolor="#687684" valign="top"> <a rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=17;up=0#sorted_table" title="Sort by this column"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>skin</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> skin(s) to use </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol" valign="top">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9" valign="top"> <code>newweb</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol1"> new web name </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>newtopic</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> new topic name </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol" valign="top">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>breaklock</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9">   </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>attachment</code> </td>
<td bgcolor="#ffffff" class="twikiTableCol1" valign="top">   </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9"> <code>confirm</code> </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> if defined, requires a second level of confirmation </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff"> <code>currentwebonly</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> if defined, searches current web only for links to this topic </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>nonwikiword</code> </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> if defined, a non-wikiword is acceptable for the new topic name </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9" valign="top">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff"> <code>redirectto</code> </td>
<td bgcolor="#ffffff" class="twikiTableCol1" valign="top"> If the rename process is successful, rename will redirect to this topic or URL. The parameter value can be a <code>TopicName</code>, a <code>Web.TopicName</code>, or a URL.<br />  <strong><em>Note:</em></strong> Redirect to a URL only works if it is enabled in <code>configure</code> (Security setup > Miscellaneous <code>{AllowRedirectUrl}</code>). </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol twikiLast" bgcolor="#edf4f9"> <code>disablefixlinks</code> </td>
<td valign="top" class="twikiTableCol1 twikiLast" bgcolor="#edf4f9"> Bypass fixing WikiWord links in the rename destination topic if rename is done across webs. Fixing links in the renamed topic such as from SomeLink to Otherweb.SomeLink is usually desirable so that links in the copied topic still point to the same target </td>
<td valign="top" class="twikiTableCol2 twikiLastCol twikiLast" bgcolor="#edf4f9"> <code>off</code> (links are fixed) </td>
</tr></table>
<p />
<strong><em>Note:</em></strong> The <code>rename</code> script can only be called via http POST method, not GET. Make sure you specify <code>method="post"</code> if you call the <code>rename</code> script via a form action.
<p />
<a name="CopyScript"></a>
<h3><a name="copy"></a> <code>copy</code> </h3>
<p />
Used for copying the current topic in its entirety including its history and attachments.
<p />
<table cellpadding="0" border="1" id="table18" cellspacing="0" rules="all" class="twikiTable">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#687684"> <a rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=18;up=0#sorted_table" title="Sort by this column"><font color="#ffffff">Parameter</font></a> </th>
<th valign="top" class="twikiTableCol1" bgcolor="#687684"> <a rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=18;up=0#sorted_table" title="Sort by this column"><font color="#ffffff">Description</font></a> </th>
<th class="twikiTableCol2 twikiLastCol" bgcolor="#687684" valign="top"> <a rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=18;up=0#sorted_table" title="Sort by this column"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>newweb</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> destination web name </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol"> current web </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol"> <code>newtopic</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> destination topic name </td>
<td bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol" valign="top"> current topic </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>nonwikiword</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> if defined, a non-wikiword is acceptable for the destination topic name </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol"> <code>redirectto</code> </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> If the copy process is successful, copy will redirect to this topic or URL. The parameter value can be a <code>TopicName</code>, a <code>Web.TopicName</code>, or a URL.<br />  <strong><em>Note:</em></strong> Redirect to a URL only works if it is enabled in <code>configure</code> (Security setup > Miscellaneous <code>{AllowRedirectUrl}</code>). </td>
<td bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol" valign="top">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>overwrite</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> By default, copy does not happen if the destination topic already exists. If this parameter is <code>'on'</code>, the destination topic is deleted if exists before copying takes place </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol"> <code>off</code> (no overwrite) </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol twikiLast" valign="top"> <code>disablefixlinks</code> </td>
<td class="twikiTableCol1 twikiLast" bgcolor="#edf4f9" valign="top"> Bypass fixing WikiWord links in the copy destination topic if copy is done across webs. Fixing links in the copied topic such as from SomeLink to Otherweb.SomeLink is usually desirable so that links in the copied topic still point to the same target </td>
<td bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol twikiLast" valign="top"> <code>off</code> (links are fixed) </td>
</tr></table>
<p />
<a name="MdrepoScript"></a>
<h3><a name="mdrepo"></a> <code>mdrepo</code> </h3>
<p />
Used to retrieve and update data in <a class="twikiLink" href="/twiki/bin/view/TWiki/MetadataRepository">MetadataRepository</a>.
Please read <a href="/twiki/bin/view/TWiki/MetadataRepository#mdrepo_script_from_command_line" class="twikiAnchorLink">MetadataRepository#mdrepo_script_from_command_line</a> and <a href="/twiki/bin/view/TWiki/MetadataRepository#mdrepo_script_from_browser" class="twikiAnchorLink">MetadataRepository#mdrepo_script_from_browser</a>.
<p />
<a name="RestScript"></a>
<h3><a name="rest"></a> <code>rest</code> </h3>
<p />
This REST (<a href="http://en.wikipedia.org/wiki/REST" target="_blank">Representational State Transfer<img height="12" border="0" alt="" src="/twiki/pub/TWiki/TWikiDocGraphics/external-link.gif" width="13" /></a>) script can be invoked via http in the same way as the other TWiki scripts (see <strong>Invocation Examples</strong>, below) to execute a function that is associated to a "subject" and a "verb" (see below). These functions are usually registered by plugins using the <code>TWiki::Func::registerRESTHandler</code> method. The <code>rest</code> script will print the result directly to the browser unless the <code>endPoint</code> parameter is specified, in which case it will output a redirect to the given topic.
<p />
The <code>rest</code> script supports the following parameters:
<table cellspacing="0" id="table19" border="1" cellpadding="0" class="twikiTable" rules="all">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff"> <code>username</code> </td>
<td bgcolor="#ffffff" class="twikiTableCol1 twikiLastCol" valign="top"> If <code>TemplateLogin</code>, or a similar login manager not embedded in the web server, is used, then you need to pass a username and password to the server. The <code>username</code> and <code>password</code> parameters are used for this purpose. </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol"> <code>password</code> </td>
<td valign="top" class="twikiTableCol1 twikiLastCol" bgcolor="#edf4f9"> See <code>username</code> </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>topic</code> </td>
<td class="twikiTableCol1 twikiLastCol" bgcolor="#ffffff" valign="top"> If defined as the full name (including web) of a topic, then when the script starts up plugins will be passed this as the "current" topic. If not defined, then <a href="/twiki/bin/view/Main/WebHome" class="twikiLink">Main.WebHome</a> will be passed to plugins. </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol twikiLast"> <code>endPoint</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol1 twikiLastCol twikiLast"> Where to redirect the response once the request is served, in the form "Web.Topic" </td>
</tr></table>
<p />
The function is free to use any other query parameters for its own purposes.
<p />
<strong><em><img src="/twiki/pub/TWiki/TWikiDocGraphics/warning.gif" alt="ALERT!" title="ALERT!" width="16" height="16" border="0" /> Note:</em></strong> The <code>rest</code> script should <strong>always</strong> require authentication in any TWiki that has logins. Otherwise there is a risk of opening up major security holes. So make sure you add it to the list of authenticated scripts if you are using <code>ApacheLogin</code>.
<p />
<h4><a name="Invocation_Examples"></a> Invocation Examples </h4>
<p />
The <code>rest</code> script assumes that it will be called with URL in the form:
<p />
<code>http://my.host/bin/rest/<subject>/<verb></code>
<p />
where <code><subject></code> must be the <a href="/twiki/bin/view/TWiki/WikiWord" class="twikiLink">WikiWord</a> name of one of the installed <a class="twikiLink" href="/twiki/bin/view/TWiki/TWikiPlugins">TWikiPlugins</a>, and the <code><verb></code> is the alias for the function registered using the <code>TWiki::Func::registerRESTHandler</code> method. The <code><subject></code> and <code><verb></code> are then used to lookup and call the registered function.
<p />
<code><subject></code> and <code><verb></code> are checked for illegal characters exactly in the same way as the web and topic names.
<p />
As an example, the <a href="/twiki/bin/view/TWiki/EmptyPlugin" class="twikiLink">EmptyPlugin</a> has registered a function to be used with the <code>rest</code> script under the subject <strong>EmptyPlugin</strong> and the verb <strong>example</strong>. Click below to see the <code>rest</code> script in action (run as <a class="twikiLink" href="/twiki/bin/view/Main/TWikiGuest">TWikiGuest</a>).
<p />
<a href="http://lofgren6.omega34.dyndns.org/twiki/bin/rest/EmptyPlugin/example?debugenableplugin=EmptyPlugin" target="_top">Call the Plugin</a>
<p />
Note that for Plugins to register REST handlers, they must be enabled in <code>configure</code>.
<p />
<a name="SaveScript"></a>
<h3><a name="save"></a> <code>save</code> </h3>
<p />
The <code>save</code> script performs a range of save-related functions, as selected by the <code>action</code> parameter.
<p />
<table cellpadding="0" cellspacing="0" id="table20" border="1" class="twikiTable" rules="all">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#687684"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=20;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Parameter</font></a> </th>
<th bgcolor="#687684" class="twikiTableCol1" valign="top"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=20;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Description</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol2 twikiLastCol"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=20;up=0#sorted_table"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> <code>action_save=1</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> <strong>default</strong>; save, return to view, dontnotify is <code>off</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9" valign="top"> <code>action_quietsave=1</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> save, and return to view, <code>dontnotify</code> is <code>on</code> </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>action_checkpoint</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> save and redirect to the edit script, <code>dontnotify</code> is <code>on</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>action_cancel</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> exit without save, return to view </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> <code>action_preview</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> preview edited text </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9"> <code>action_addform</code> </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> Redirect to the "change form" page. </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9" valign="top">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> <code>action_replaceform...</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> Redirect to the "change form" page. </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>action_delRev</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> <strong>Administrators only</strong> delete the most recent revision of the topic - all other parameters are ignored. You have to be an administrator to use this, and not all store implementations will support it. </td>
<td bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol" valign="top">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> <code>action_repRev</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#ffffff"> <strong>Administrators only</strong> replace the text of the most recent revision of the topic with the text in the <code>text</code> parameter. <code>text</code> must included embedded meta-data tags. All other parameters are ignored. You have to be an administrator to use this, and not all store implementations will support it. </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol"> <code>onlynewtopic</code> </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> If set, error if topic already exists </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>onlywikiname</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> If set, error if topic name is not a <a class="twikiLink" href="/twiki/bin/view/TWiki/WikiWord">WikiWord</a> </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9"> <code>dontnotify</code> </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> if defined, suppress change notification </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>templatetopic</code> </td>
<td bgcolor="#ffffff" class="twikiTableCol1" valign="top"> Name of a topic to use as a template for the text and form (new topic <em>only</em>) </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9"> <code>text</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> New text of the topic </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>forcenewrevision</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> if set, forces a revision even if TWiki thinks one isn't needed </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol" valign="top">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9"> <code>topicparent</code> </td>
<td bgcolor="#edf4f9" class="twikiTableCol1" valign="top"> If 'none' remove any current topic parent. If the name of a topic, set the topic parent to this. </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9" valign="top">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> <code>formtemplate</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#ffffff"> if defined, use the named template for the form (will remove the form is set to 'none') </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol"> <code>editaction</code> </td>
<td class="twikiTableCol1" bgcolor="#edf4f9" valign="top"> When action is <code>checkpoint</code>, <code>add form</code> or <code>replace form...</code>, this is used as the <code>action</code> parameter to the <code>edit</code> script that is redirected to after the save is complete. </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> <code>originalrev</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#ffffff"> Revision on which the edit started. </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol" valign="top">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>edit</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> The script to use to edit the topic when action is <code>checkpoint</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol"> <code>edit</code> </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>editparams</code> </td>
<td bgcolor="#ffffff" class="twikiTableCol1" valign="top"> The parameter string to use to edit the topic </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol twikiLast" bgcolor="#edf4f9"> <code>redirectto</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol1 twikiLast"> The save process will redirect to this topic or URL if it is successful. (Typically this would be the URL that was being viewed when edit was invoked). The parameter value can be a <code>TopicName</code>, a <code>Web.TopicName</code>, or a URL.<br />  <strong><em>Note:</em></strong> Redirect to a URL only works if it is enabled in <code>configure</code> (Security setup > Miscellaneous <code>{AllowRedirectUrl}</code>). </td>
<td bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol twikiLast" valign="top"> view topic being edited </td>
</tr></table>
<p />
Any errors will cause a redirect to an <code>oops</code> page.
<p />
The parameters are interpreted in according to the following rules.
<p /> <ol>
<li> The first sequence of ten or more <code>X</code> characters in the topic name will be converted to a number such that the resulting topic name is unique in the target web.
</li> <li> When the action is <code>save</code>, <code>checkpoint</code>, <code>quietsave</code>, or <code>preview</code>: <ol>
<li> The new text is taken from the <code>text</code> parameter, if it is defined, <ul>
<li> otherwise it is taken from the <code>templatetopic</code>, if it is defined, (new topic <em>only</em>)
</li> <li> otherwise it is taken from the previous version of the topic, if any,
</li></ul> 
</li> <li> The name of the new form is taken from the <code>formtemplate</code>, if defined <ul>
<li> otherwise it is taken from the <code>templatetopic</code>, if defined, (new topic <em>only</em>)
</li> <li> otherwise it is taken from the previous version of the topic, if any,
</li> <li> otherwise no form is attached.
</li></ul> 
</li> <li> The value for each field in the form is taken from the query, if it is defined <ul>
<li> otherwise it is taken from the <code>templatetopic</code>, if defined, (new topic <em>only</em>)
</li> <li> otherwise it is taken from the previous version of the topic, if any,
</li> <li> otherwise it defaults to the empty string.
</li></ul> 
</li></ol> 
</li></ol> 
<p />
Merging is only enabled if the topic text comes from <code>text</code> and <code>originalrev</code> 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.
<p />
Form field values are passed in parameters named 'field' - for example, if I have a field <code>Status</code> the parameter name is <code>Status</code>.
<p />
<strong><em><img src="/twiki/pub/TWiki/TWikiDocGraphics/warning.gif" alt="ALERT!" title="ALERT!" width="16" height="16" border="0" /> Note:</em></strong> The <code>save</code> script can only be called via http POST method, not GET. Make sure to specify the <code>"post"</code> method if you call the <code>save</code> script via a form action. Example:
<pre>
<form name="new" action="%SCRIPTURLPATH{save}%/Sandbox/" method="post">
    ...
</form>
</pre>
It is not possible to call <code>save</code> from an <code><a href=""></code> link. 
<p />
<a name="SearchScript"></a>
<h3><a name="search"></a> <code>search</code> </h3>
<p />
CGI gateway to the <code>%SEARCH%</code> functionality driven by the following CGI parameters:
<p />
<table cellpadding="0" id="table21" border="1" cellspacing="0" rules="all" class="twikiTable">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#687684"> <a rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=21;up=0#sorted_table" title="Sort by this column"><font color="#ffffff">Parameter:</font></a> </th>
<th class="twikiTableCol1" bgcolor="#687684" valign="top"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=21;up=0#sorted_table"><font color="#ffffff">Description:</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol2 twikiLastCol"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=21;up=0#sorted_table"><font color="#ffffff">Default:</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> <code>"text"</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> Search term. Is a keyword search, literal search or regular expression search, depending on the <code>type</code> parameter. <a class="twikiLink" href="/twiki/bin/view/TWiki/SearchHelp">SearchHelp</a> has more </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff"> required </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9"> <code>search="text"</code> </td>
<td bgcolor="#edf4f9" class="twikiTableCol1" valign="top"> (Alternative to above) </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9" valign="top"> N/A </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>web="Name"</code> <br /> <code>web="Main, Know"</code> <br /> <code>web="all"</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> Comma-separated list of webs to search. See <a class="twikiLink" href="/twiki/bin/view/TWiki/VarSEARCH">VarSEARCH</a> for more details. </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top"> Current web </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>topic="WebPreferences"</code> <br /> <code>topic="*Bug"</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9" valign="top"> All topics in a web </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff"> <code>excludetopic="Web*"</code> <br /> <code>excludetopic="WebHome, WebChanges"</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#ffffff"> Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top"> None </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9"> <code>type="keyword"</code> <br /> <code>type="literal"</code> <br /> <code>type="regex"</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol1"> Do a keyword search like <code>soap "web service" -shampoo</code>; a literal search like <code>web service</code>; or <a href="/twiki/bin/view/TWiki/RegularExpression" class="twikiLink">RegularExpression</a> search like <code>soap;web service;!shampoo</code> </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9" valign="top"> <code>%SEARCHVAR- DEFAULTTYPE%</code> <a class="twikiLink" href="/twiki/bin/view/TWiki/TWikiPreferences">preferences</a> setting (literal) </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> <code>scope="topic"</code> <br /> <code>scope="text"</code> <br /> <code>scope="all"</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> Search topic name (title); the text (body) of topic; or all (both) </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff"> <code>"text"</code> </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol"> <code>sort="topic"</code> <br /> <code>sort="created"</code> <br />  <code>sort="modified"</code> <br /> <code>sort="editby"</code> <br /> <code>sort="parent"</code> <br /> <code>sort=<br /> "formfield(name)"</code> </td>
<td bgcolor="#edf4f9" class="twikiTableCol1" valign="top"> Sort the results of search by the topic names, topic creation time, last modified time, last editor, parent topic name, or named field of <a href="/twiki/bin/view/TWiki/TWikiForms" class="twikiLink">TWikiForms</a>. The sorting is done web by web; in case you want to sort across webs, create a <a class="twikiLink" href="/twiki/bin/view/TWiki/FormattedSearch">formatted</a> table and sort it with <a href="/twiki/bin/view/TWiki/TablePlugin" class="twikiLink">TablePlugin</a>'s initsort </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol"> Sort by topic name </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>limit="all"</code> <br /> <code>limit="16"</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> Limit the number of results returned. This is done after sorting if <code>sort</code> is specified </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top"> All results </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>date="..."</code> </td>
<td bgcolor="#edf4f9" class="twikiTableCol1" valign="top"> limits the results to those pages with latest edit time in the given <a class="twikiAnchorLink" href="/twiki/bin/view/TWiki/TimeSpecifications#TimeIntervals">time interval</a>. </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9"> All results </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>reverse="on"</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#ffffff"> Reverse the direction of the search </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol"> Ascending search </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol"> <code>casesensitive="on"</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol1"> Case sensitive search </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9"> Ignore case </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>bookview="on"</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> <a class="twikiLink" href="/twiki/bin/view/TWiki/BookView">BookView</a> search, e.g. show complete topic text </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top"> Show topic summary </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>nonoise="on"</code> </td>
<td bgcolor="#edf4f9" class="twikiTableCol1" valign="top"> Shorthand for <code>nosummary="on" nosearch="on" nototal="on" zeroresults="off" noheader="on" noempty="on"</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol"> Off </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>nosummary="on"</code> </td>
<td bgcolor="#ffffff" class="twikiTableCol1" valign="top"> Show topic title only </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol" valign="top"> Show topic summary </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9"> <code>nosearch="on"</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol1"> Suppress search string </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9"> Show search string </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> <code>noheader="on"</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> Suppress search header <br /> <span style='background: #FFB0B0;'> <strong>Topics: Changed: By:</strong> </span> </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top"> Show search header </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9"> <code>nototal="on"</code> </td>
<td bgcolor="#edf4f9" class="twikiTableCol1" valign="top"> Do not show number of topics found </td>
<td bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol" valign="top"> Show number </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff"> <code>zeroresults="off"</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> Suppress all output if there are no hits </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol" valign="top"> <code>zeroresults="on"</code>, displays: "Number of topics: 0" </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9" valign="top"> <code>noempty="on"</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol1"> Suppress results for webs that have no hits. </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9"> Show webs with no hits </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>header="..."</code> <br /> <code>format="..."</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> Custom format results: see <strong><a href="/twiki/bin/view/TWiki/FormattedSearch" class="twikiLink">FormattedSearch</a></strong> for usage, variables & examples </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol" valign="top"> Results in table </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol"> <code>expandvariables="on"</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> Expand variables before applying a <a class="twikiLink" href="/twiki/bin/view/TWiki/FormattedSearch">FormattedSearch</a> on a search hit. Useful to show the expanded text, e.g. to show the result of a <a href="/twiki/bin/view/TWiki/SpreadSheetPlugin" class="twikiLink">SpreadSheetPlugin</a> <code>%CALC{}%</code> instead of the formula </td>
<td bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol" valign="top"> Raw text </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>multiple="on"</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> Multiple hits per topic. Each hit can be <a class="twikiLink" href="/twiki/bin/view/TWiki/FormattedSearch">formatted</a>. The last token is used in case of a regular expression ";" <em>and</em> search </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top"> Only one hit per topic </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9"> <code>nofinalnewline="on"</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> If <code>on</code>, 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. </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol"> <code>off</code> </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol twikiLast"> <code>separator=", "</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1 twikiLast"> Line separator between hits </td>
<td class="twikiTableCol2 twikiLastCol twikiLast" bgcolor="#ffffff" valign="top"> Newline <code>"$n"</code> </td>
</tr></table>
<p />
<a name="StatisticsScript"></a>
<h3><a name="statistics"></a> <code>statistics</code> </h3>
<p />
Refresh the <a class="twikiLink" href="/twiki/bin/view/TWiki/WebStatistics">WebStatistics</a> topics in range of webs.
<p />
<table cellpadding="0" id="table22" border="1" cellspacing="0" rules="all" class="twikiTable">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th class="twikiTableCol0 twikiFirstCol" bgcolor="#687684" valign="top"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=22;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Parameter</font></a> </th>
<th class="twikiTableCol1" bgcolor="#687684" valign="top"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=22;up=0#sorted_table"><font color="#ffffff">Description</font></a> </th>
<th bgcolor="#687684" class="twikiTableCol2 twikiLastCol" valign="top"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=22;up=0#sorted_table"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff"> <code>webs</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> comma-separated list of webs to run stats on </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol"> all accessible webs </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol twikiLast" bgcolor="#edf4f9"> <code>logdate</code> </td>
<td valign="top" class="twikiTableCol1 twikiLast" bgcolor="#edf4f9"> YYYYMM to generate statistics for </td>
<td class="twikiTableCol2 twikiLastCol twikiLast" bgcolor="#edf4f9" valign="top"> current month </td>
</tr></table>
<p />
For example: <ol>
<li> from browser <a href="http://lofgren6.omega34.dyndns.org/twiki/bin/statistics" target="_top">http://lofgren6.omega34.dyndns.org/twiki/bin/statistics</a> updates <em>all user webs</em>
</li> <li> from browser <a href="http://lofgren6.omega34.dyndns.org/twiki/bin/statistics?webs=TWiki,Main,Sandbox" target="_top">http://lofgren6.omega34.dyndns.org/twiki/bin/statistics?webs=TWiki,Main,Sandbox</a> updates <em>TWiki,Main,Sandbox</em>
</li> <li> from browser <a href="http://lofgren6.omega34.dyndns.org/twiki/bin/statistics/TWiki" target="_top">http://lofgren6.omega34.dyndns.org/twiki/bin/statistics/TWiki</a> updates TWiki
</li> <li> from command line twiki/bin/statistics updates <em>all user webs</em>
</li> <li> from command line twiki/bin/statistics -webs=TWiki,Main,Sandbox updates <em>TWiki,Main,Sandbox</em>
</li> <li> from command line twiki/bin/statistics TWiki.WebHome updates TWiki
</li></ol> 
<p />
See <a href="/twiki/bin/view/TWiki/TWikiSiteTools#WebStatistics_site_statistics" class="twikiAnchorLink">TWikiSiteTools#WebStatistics_site_statistics</a> for updating statistics using cron.
<p />
<a name="UploadScript"></a>
<h3><a name="upload"></a> <code>upload</code> </h3>
<p />
Uploads an attachment to a topic. The HTTP request is expected to be in <code>multipart/form-data</code> format.
<p />
<table class="twikiTable" rules="all" cellpadding="0" cellspacing="0" border="1" id="table23">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th class="twikiTableCol0 twikiFirstCol" bgcolor="#687684" valign="top"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=23;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Parameter</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol1"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=23;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Description</font></a> </th>
<th valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#687684"> <a rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=23;up=0#sorted_table" title="Sort by this column"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>hidefile</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> If defined, will not show file in attachment table </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol"> <code>filepath</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol1"> Local (client) path name of the file being uploaded. This is used to look up the data for the file in the HTTP query. </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> <code>filename</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> Deprecated, do not use </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9"> <code>filecomment</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> Comment to associate with file in attachment table </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff"> <code>createlink</code> </td>
<td bgcolor="#ffffff" class="twikiTableCol1" valign="top"> If defined, will create a link to file at end of topic </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff" valign="top">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>changeproperties</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol1"> If defined, this is a property change operation <strong>only</strong> - no file will be uploaded. </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol"> null </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff"> <code>updatefield</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> If defined and if the value matches the name of a form field, it will update that form field with the format defined by the <code>updateformat</code> parameter. </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" class="twikiTableCol0 twikiFirstCol twikiLast" bgcolor="#edf4f9"> <code>updateformat</code> </td>
<td valign="top" class="twikiTableCol1 twikiLast" bgcolor="#edf4f9"> Format of the value of the form field indicated by the <code>updatefield</code> parameter. The default is the name of the attached file, but can be set to include more, such as the path to the image, <code>%PUBURL%/%BASEWEB%/%BASETOPIC%/$filename</code>. </td>
<td class="twikiTableCol2 twikiLastCol twikiLast" bgcolor="#edf4f9" valign="top"> <code>$filename</code> </td>
</tr></table>
<p />
You can use a tool like <code>curl</code> to upload files from the command line using this script.
<p />
<strong><em><img src="/twiki/pub/TWiki/TWikiDocGraphics/warning.gif" alt="ALERT!" title="ALERT!" width="16" height="16" border="0" /> Note:</em></strong> The <code>upload</code> script can only be called via http POST method, not GET.
<p />
<a name="ViewScript"></a>
<h3><a name="view"></a> <code>view</code> </h3>
<p />
Used for viewing topics.
<p />
<table cellspacing="0" border="1" id="table24" cellpadding="0" class="twikiTable" rules="all">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th bgcolor="#687684" class="twikiTableCol0 twikiFirstCol" valign="top"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=24;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Parameter</font></a> </th>
<th valign="top" bgcolor="#687684" class="twikiTableCol1"> <a title="Sort by this column" rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=24;up=0#sorted_table"><font color="#ffffff">Description</font></a> </th>
<th bgcolor="#687684" class="twikiTableCol2 twikiLastCol" valign="top"> <a rel="nofollow" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=24;up=0#sorted_table" title="Sort by this column"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>raw=on</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#ffffff"> Shows the text of the topic in a scrollable textarea </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9" valign="top"> <code>raw=debug</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> As <code>raw=on</code>, but also shows the metadata (forms etc) associated with the topic. </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>raw=text</code> </td>
<td class="twikiTableCol1 twikiLastCol" bgcolor="#ffffff" valign="top"> Shows only the source of the topic, as plain text (Content-type: text/plain). Only shows the body text, <strong>not</strong> the form or other meta-data. </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol"> <code>raw=expandvariables</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> Similar to <code>raw=text</code> but TWiki variables are expanded. </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>raw=all</code> </td>
<td class="twikiTableCol1" bgcolor="#ffffff" valign="top"> Shows only the source of the topic, as plain text (Content-type: text/plain), <strong>with embedded meta-data</strong>. This may be useful if you want to extract the source of a topic to a local file on disc. </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>section</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> Allows to view only a part of the topic delimited by a named section (see <a class="twikiLink" href="/twiki/bin/view/TWiki/VarSTARTSECTION">VarSTARTSECTION</a>). If the given section is not present, no topic content is displayed. </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9" valign="top">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>contenttype</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> Allows you to specify a different <strong>Content-Type:</strong> (e.g. <code>contenttype=text/plain</code>) </td>
<td bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol" valign="top">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol" valign="top"> <code>rev</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> Revision to view (e.g. <code>rev=45</code>) </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff" valign="top"> <code>template</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#ffffff"> Allows you to specify a different skin template, overriding the 'view' template the view script would normally use. The default template is <code>view</code>. For example, you could specify <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit" target="_top">/twiki/bin/view/TWiki/TWikiScripts?template=edit</a>. This is mainly useful when you have specialized templates for a TWiki Application. </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9" valign="top"> <code>topic</code> </td>
<td valign="top" class="twikiTableCol1" bgcolor="#edf4f9"> redirects to show the specified Web.Topic, or, redirects to a URL, if allowed by <code>{AllowRedirectUrl}</code> and <code>{PermittedRedirectHostUrls}</code> configure settings </td>
<td class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9" valign="top">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" class="twikiTableCol0 twikiFirstCol" bgcolor="#ffffff"> <code>createifnotexist</code> </td>
<td bgcolor="#ffffff" class="twikiTableCol1" valign="top"> If <code>createifnotexist</code> is set to <code>1</code> and in case the topic does not exist, it is created automatically on view. Useful to create topics automatically based on a specific template (see example below). Behind the scene, the <code>view</code> script redirects first to the <code>save</code> script, passing along all URL parameters. Thus all URL parameters of the <code>save</code> script can be used, such as <code>templatetopic</code>, <code>topicparent</code> and <code>redirectto</code>. Next, the <code>save</code> script creates the topic and redirects back to the <code>view</code> script (or displays an error in case there were any issues creating the topic). </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol2 twikiLastCol">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol0 twikiFirstCol twikiLast"> <code>extralog</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol1 twikiLast"> Add additional text to TWiki log, next to the user agent string. Useful to log actions by cache scripts and crawlers. </td>
<td bgcolor="#edf4f9" class="twikiTableCol2 twikiLastCol twikiLast" valign="top">   </td>
</tr></table>
<p />
<img src="/twiki/pub/TWiki/TWikiDocGraphics/tip.gif" alt="TIP" title="TIP" width="16" height="16" border="0" /> Example use of <code>createifnotexist</code> to link to the bookmark page of a user, and to create the page on the fly if needed:<br /> 
<code>[[%SCRIPTURL{view}%/%USERSWEB%/%WIKINAME%Bookmarks?createifnotexist=1&amp;templatetopic=%SYSTEMWEB%.UserBookmarksTemplate&amp;topicparent=%WIKINAME%][Bookmarks]]</code>
<p />
<img src="/twiki/pub/TWiki/TWikiDocGraphics/warning.gif" alt="ALERT!" title="ALERT!" width="16" height="16" border="0" /> For historical reasons, the <code>view</code> script has a special interpretation of the <code>text</code> skin. In earlier TWiki versions the <code>skin=text</code> parameter was used like this:
<code>http://.../view/MyWeb/MyTopic?skin=text&contenttype=text/plain&raw=on</code>
which shows the topic as plain text; useful for those who want to download plain text for the topic.
Using <code>skin=text</code> this way is <strong>DEPRECATED</strong>, use <code>raw=text</code> instead.
<p />
<a name="ViewfileScript"></a>
<h3><a name="viewfile"></a> <code>viewfile</code> </h3>
<p />
Used for viewing attachments. Normally, a site will publish the attachments (<code>pub</code>) directory using a URL. However if it contains sensitive information, you will want to protect attachments using <a class="twikiLink" href="/twiki/bin/view/TWiki/TWikiAccessControl">TWikiAccessControls</a>. In this case, you can use the <code>viewfile</code> script to give access to attachments while still checking access controls.
<p />
<table cellpadding="0" border="1" id="table25" cellspacing="0" rules="all" class="twikiTable">
<tr class="twikiTableOdd twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<th valign="top" bgcolor="#687684" class="twikiTableCol0 twikiFirstCol"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=0;table=25;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Parameter</font></a> </th>
<th bgcolor="#687684" class="twikiTableCol1" valign="top"> <a title="Sort by this column" href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=1;table=25;up=0#sorted_table" rel="nofollow"><font color="#ffffff">Description</font></a> </th>
<th class="twikiTableCol2 twikiLastCol" bgcolor="#687684" valign="top"> <a href="/twiki/bin/view/TWiki/TWikiScripts?template=edit;sortcol=2;table=25;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Default</font></a> </th>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol"> <code>filename</code> </td>
<td valign="top" bgcolor="#ffffff" class="twikiTableCol1"> name of attachment </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#ffffff">   </td>
</tr>
<tr class="twikiTableOdd twikiTableRowdataBgSorted1 twikiTableRowdataBg1">
<td class="twikiTableCol0 twikiFirstCol" bgcolor="#edf4f9" valign="top"> <code>rev</code> </td>
<td valign="top" bgcolor="#edf4f9" class="twikiTableCol1"> Revision to view </td>
<td valign="top" class="twikiTableCol2 twikiLastCol" bgcolor="#edf4f9">   </td>
</tr>
<tr class="twikiTableEven twikiTableRowdataBgSorted0 twikiTableRowdataBg0">
<td valign="top" bgcolor="#ffffff" class="twikiTableCol0 twikiFirstCol twikiLast"> <code>debug</code> </td>
<td bgcolor="#ffffff" class="twikiTableCol1 twikiLast" valign="top"> Put debug info to the debug log </td>
<td class="twikiTableCol2 twikiLastCol twikiLast" bgcolor="#ffffff" valign="top">   </td>
</tr></table>
<p />
Instead of using the <code>filename</code> parameter, you can append the attachment name
to the end of the URL path (after the topic) e.g. <code>http://lofgren6.omega34.dyndns.org/twiki/bin/viewfile/Webname/TopicName/Attachment.gif</code>
In that case, determining the attachment file name is non-trivial -- please consider a file name having multiple dots and a file name having no dots.
As such, the process of determining the file name is put on the debug log if <code>debug=1</code> URL parameter is supplied.
<p />
<a name="CommandLineScript"></a>
<h2><a name="Command_Line_Scripts"></a> Command Line Scripts </h2>
<p />
Details on command line scripts located in the <code>twiki/tools</code> directory.
<p />
<a name="GeturlScript"></a>
<h3><a name="geturl_pl"></a> <code>geturl.pl</code> </h3>
<p />
This is a very simple script to get the content of a web site. It is marked as <em>deprecated</em> and might be removed (or enhanced) in a future TWiki release. Its functions are covered by the standard <code>wget</code> and <code>curl</code> commands. <ul>
<li> Usage:    <code>geturl.pl <host> <path> [<port> [<header>]]</code>
</li> <li> Example:  <code>geturl.pl some.domain /some/dir/file.html 80</code>
</li> <li> Will get: <code>http://some.domain:80/some/dir/file.html</code>
</li></ul> 
<p />
<a name="RewriteshebangScript"></a>
<h3><a name="rewriteshebang_pl"></a> <code>rewriteshebang.pl</code> </h3>
<p />
Simple script to rewrite the <code>#!/usr/bin/perl</code> shebang lines specific to your local Perl installation. It will rewrite the first line of all your TWiki cgi scripts so they use a different shebang line. Use it if your perl is in a non-standard location, or you want to use a different interpreter (such as 'speedy').
<p />
<a name="TickTwikiScript"></a>
<h3><a name="tick_twiki_pl"></a> <code>tick_twiki.pl</code> </h3>
<p />
This script executes a number of non-essential regular administration tasks that will help keep your TWiki healthy and happy, such as removing expired sessions and lease files.
<p />
It is intended to be run as a cron job or a scheduled task once a week. Example crontab entry:<br /> 
<code>0 0 * * 0 cd /usr/twiki/bin && perl ../tools/tick_twiki.pl</code>
<p />
<strong><em>Note:</em></strong> The script has to be run by a user who can write files created by the webserver user.
<p />
<strong><em>Related Topics:</em></strong> <a class="twikiLink" href="/twiki/bin/view/TWiki/AdminDocumentationCategory">AdminDocumentationCategory</a>, <a href="/twiki/bin/view/TWiki/DeveloperDocumentationCategory" class="twikiLink">DeveloperDocumentationCategory</a>
<p />
-- <strong><em>Contributors:</em></strong> <a href="http://twiki.org/cgi-bin/view/Main/ArthurClemens" target="_blank" title="'Main.ArthurClemens' on TWiki.org" class="interwikiLink">TWiki:Main.ArthurClemens<img height="12" border="0" alt="" src="/twiki/pub/TWiki/TWikiDocGraphics/external-link.gif" width="13" /></a>, <a href="http://twiki.org/cgi-bin/view/Main/CrawfordCurrie" target="_blank" title="'Main.CrawfordCurrie' on TWiki.org" class="interwikiLink">TWiki:Main.CrawfordCurrie<img height="12" border="0" alt="" src="/twiki/pub/TWiki/TWikiDocGraphics/external-link.gif" width="13" /></a>, <a href="http://twiki.org/cgi-bin/view/Main/MichaelDaum" target="_blank" title="'Main.MichaelDaum' on TWiki.org" class="interwikiLink">TWiki:Main.MichaelDaum<img height="12" border="0" alt="" src="/twiki/pub/TWiki/TWikiDocGraphics/external-link.gif" width="13" /></a>, <a href="http://twiki.org/cgi-bin/view/Main/PeterThoeny" target="_blank" title="'Main.PeterThoeny' on TWiki.org" class="interwikiLink">TWiki:Main.PeterThoeny<img height="12" border="0" alt="" src="/twiki/pub/TWiki/TWikiDocGraphics/external-link.gif" width="13" /></a>, <a href="http://twiki.org/cgi-bin/view/Main/RafaelAlvarez" target="_blank" title="'Main.RafaelAlvarez' on TWiki.org" class="interwikiLink">TWiki:Main.RafaelAlvarez<img height="12" border="0" alt="" src="/twiki/pub/TWiki/TWikiDocGraphics/external-link.gif" width="13" /></a>, <a href="http://twiki.org/cgi-bin/view/Main/SvenDowideit" target="_blank" title="'Main.SvenDowideit' on TWiki.org" class="interwikiLink">TWiki:Main.SvenDowideit<img height="12" border="0" alt="" src="/twiki/pub/TWiki/TWikiDocGraphics/external-link.gif" width="13" /></a>, <a href="http://twiki.org/cgi-bin/view/Main/ThomasWeigert" target="_blank" title="'Main.ThomasWeigert' on TWiki.org" class="interwikiLink">TWiki:Main.ThomasWeigert<img height="12" border="0" alt="" src="/twiki/pub/TWiki/TWikiDocGraphics/external-link.gif" width="13" /></a>, <a href="http://twiki.org/cgi-bin/view/Main/WillNorris" target="_blank" title="'Main.WillNorris' on TWiki.org" class="interwikiLink">TWiki:Main.WillNorris<img height="12" border="0" alt="" src="/twiki/pub/TWiki/TWikiDocGraphics/external-link.gif" width="13" /></a>

Your signature to copy/paste:

%FORMFIELDS%

Force new revision help

Access keys: S = Save, Q = Quiet save, K = Save and Continue, P = Preview, C = Cancel

Formatting help:

bold put word/phrase in asterisks: *your phrase*
bullet list 3 spaces, asterisk, 1 space: * your text
headings 3 dashes, 1 to 6 pluses, 1 space: ---++ Your Heading
italic put word/phrase in underscores: _your words_
site links use topic name: WebHome or [[WebHome][Our homepage]]
external links http://google.com/ or [[http://google.com/][link to Google]]
monospaced put word/phrase in equal signs: =your words=
paragraphs separate with blank line
More formatting help and hints on good style

Copyright © 1999-2024 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.TWikiScripts.