Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
TWiki CGI and Command Line Scripts | ||||||||
Line: 8 to 8 | ||||||||
Added: | ||||||||
> > | ||||||||
CGI ScriptsDetails on CGI scripts located in thetwiki/bin directory. | ||||||||
Added: | ||||||||
> > | ||||||||
General Information | ||||||||
Added: | ||||||||
> > | ||||||||
CGI environmentIn 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 (usuallyguest ). | ||||||||
Added: | ||||||||
> > | ||||||||
Command-lineYou must have thetwiki/bin 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 nobody or www . | ||||||||
Line: 25 to 29 | ||||||||
Parameters are passed on the command line using '-name' - for example,
$ cd /usr/local/twiki/bin | ||||||||
Changed: | ||||||||
< < | $ save -topic MyTopic -user admin -action save -text "New text of the topic" | |||||||
> > | $ save -topic MyTopic -user admin -method POST -action save -text "New text of the topic" | |||||||
All parameters require a value, even if that is the empty string. | ||||||||
Added: | ||||||||
> > | ||||||||
Common parametersAll 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:
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Added: | ||||||||
> > | ||||||||
Despite the name, this script doesn't actually attach a file to a topic - for that, use | ||||||||
Line: 46 to 53 | ||||||||
| ||||||||
Added: | ||||||||
> > | ||||||||
Shows all the changes in the given web. | ||||||||
Line: 59 to 67 | ||||||||
Note: The result from changes script and the topic WebChanges can be different, if the changes file is deleted from a web. In particular, in new installations the changes script will return no results while the WebChanges topic will. | ||||||||
Added: | ||||||||
> > | ||||||||
| ||||||||
Added: | ||||||||
> > | ||||||||
The | ||||||||
Line: 87 to 97 | ||||||||
Note: Most skins support the definition of EDIT_SKIN , which is used as the value of the cover parameter in edit URLs. This allows you to override the default edit skin on a web, topic or user basis. | ||||||||
Added: | ||||||||
> > | ||||||||
Used for logging in when TWiki login is being used (e.g TemplateLoginManager). | ||||||||
Line: 95 to 106 | ||||||||
| ||||||||
Added: | ||||||||
> > | ||||||||
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.
| ||||||||
Added: | ||||||||
> > | ||||||||
Performs a range of management functions. | ||||||||
Line: 107 to 120 | ||||||||
Note: The manage script can only be called via http POST method for createweb renameweb , and deleteUserAccount . | ||||||||
Added: | ||||||||
> > | ||||||||
|
Parameter | Description | Default |
---|
sitemapwhat |
Value for SITEMAPWHAT | '' |
nosearchall |
Value for NOSEARCHALL | '' |
action=renameweb
Parameter | Description | Default |
---|
newparentweb |
New parent web name | '' |
confirm |
If defined, requires a second level of confirmation. Supported values are "getlock", "continue", and "cancel" | '' |
action=editSettings
action=saveSettings
Parameter |
---|