Line: 73 to 73 | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Added: | |||||||||
> > |
| ||||||||
Return: $url URL, e.g. "http://example.com:80/cgi-bin/view.pl/Main/WebNotify"
Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002) | |||||||||
Line: 144 to 146 | |||||||||
setSessionValue( $key, $value ) -> $boolean | |||||||||
Changed: | |||||||||
< < | Set a session value via the client session module | ||||||||
> > | Set a session value. | ||||||||
| |||||||||
Line: 154 to 156 | |||||||||
clearSessionValue( $key ) -> $boolean | |||||||||
Changed: | |||||||||
< < | Clear a session value via the client session module
| ||||||||
> > | Clear a session value that was set using setSessionValue .
| ||||||||
Since: TWiki::Plugins::VERSION 1.1 | |||||||||
Line: 227 to 231 | |||||||||
| |||||||||
Added: | |||||||||
> > | NOTE: As of TWiki4.1, if $NO_PREFS_IN_TOPIC is enabled in the plugin, then
preferences set in the plugin topic will be ignored. | ||||||||
getPluginPreferencesValue( $key ) -> $value | |||||||||
Line: 238 to 245 | |||||||||
Since: TWiki::Plugins::VERSION 1.021 (27 Mar 2004) | |||||||||
Added: | |||||||||
> > | NOTE: As of TWiki4.1, if $NO_PREFS_IN_TOPIC is enabled in the plugin, then
preferences set in the plugin topic will be ignored. | ||||||||
getPreferencesFlag( $key, $web ) -> $value | |||||||||
Line: 253 to 263 | |||||||||
| |||||||||
Added: | |||||||||
> > | NOTE: As of TWiki4.1, if $NO_PREFS_IN_TOPIC is enabled in the plugin, then
preferences set in the plugin topic will be ignored. | ||||||||
getPluginPreferencesFlag( $key ) -> $boolean | |||||||||
Line: 264 to 277 | |||||||||
Since: TWiki::Plugins::VERSION 1.021 (27 Mar 2004) | |||||||||
Added: | |||||||||
> > | NOTE: As of TWiki4.1, if $NO_PREFS_IN_TOPIC is enabled in the plugin, then
preferences set in the plugin topic will be ignored. | ||||||||
getWikiToolName( ) -> $name | |||||||||
Line: 473 to 490 | |||||||||
Since: TWiki::Plugins::VERSION 1.000 (14 Jul 2001) | |||||||||
Changed: | |||||||||
< < | checkTopicEditLock( $web, $topic ) -> ( $oopsUrl, $loginName, $unlockTime ) | ||||||||
> > | checkTopicEditLock( $web, $topic, $script ) -> ( $oopsUrl, $loginName, $unlockTime ) | ||||||||
Check if a lease has been taken by some other user.
( $oopsUrl, $loginName, $unlockTime ) - The $oopsUrl for calling redirectCgiQuery(), user's $loginName , and estimated $unlockTime in minutes, or ( '', '', 0 ) if no lease exists. | |||||||||
Added: | |||||||||
> > |
| ||||||||
Since: TWiki::Plugins::VERSION 1.010 (31 Dec 2002) | |||||||||
Line: 814 to 841 | |||||||||
Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002) | |||||||||
Changed: | |||||||||
< < | redirectCgiQuery( $query, $url ) | ||||||||
> > | redirectCgiQuery( $query, $url, $passthru ) | ||||||||
Redirect to URL
| |||||||||
Changed: | |||||||||
< < | Return: none, never returns | ||||||||
> > |
$passthru parameter allows you to pass the parameters that were passed
to the current query on to the target URL, as long as it is another URL on the
same TWiki installation. If $passthru is set to a true value, then TWiki
will save the current URL parameters, and then try to restore them on the
other side of the redirect. Parameters are stored on the server in a cache
file (see {PassthroughDir} in =configure ).
Note that if $passthru is set, then any parameters in $url will be lost
when the old parameters are restored. if you want to change any parameter
values, you will need to do that in the current CGI query before redirecting
e.g.
my $query = TWiki::Func::getCgiQuery(); $query->param(-name => 'text', -value => 'Different text'); TWiki::Func::redirectCgiQuery( undef, TWiki::Func::getScriptUrl($web, $topic, 'edit'), 1); $passthru does nothing if $url does not point to a script in the current
TWiki installation. | ||||||||
Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002) | |||||||||
Line: 984 to 1042 | |||||||||
would let you do this:
%EXEC{"ps -Af" silent="on"}% | |||||||||
Added: | |||||||||
> > | Registered tags differ from tags implemented using the old TWiki approach (text substitution in commonTagsHandler ) in the following ways:
| ||||||||
registerRESTHandler( $alias, \&fn, ) | |||||||||
Added: | |||||||||
> > | |||||||||
Should only be called from initPlugin. Adds a function to the dispatch table of the REST interface | |||||||||
Line: 1147 to 1213 | |||||||||
Parse a web and topic name, supplying defaults as appropriate.
| |||||||||
Changed: | |||||||||
< < | Return: the parsed Web/Topic pai | ||||||||
> > | Return: the parsed Web/Topic pair | ||||||||
Since: TWiki::Plugins::VERSION 1.1 | |||||||||
Line: 1156 to 1222 | |||||||||
| |||||||||
Added: | |||||||||
> > |
| ||||||||
| |||||||||
Added: | |||||||||
> > |
| ||||||||
| |||||||||
Changed: | |||||||||
< < |
Main and TWiki are the web names set in $cfg{UsersWebName} and $cfg{SystemWebName} respectively. | ||||||||
> > |
Note that hierarchical web names (SubWeb ) are only available if hierarchical webs are enabled in configure .
The symbols %USERSWEB%, %SYSTEMWEB%, %DOCWEB%, %MAINWEB% and %TWIKIWEB% can be used in the input to represent the web names set in $cfg{UsersWebName} and $cfg{SystemWebName}. For example:
| ||||||||
writeWarning( $text ) | |||||||||
Line: 1296 to 1369 | |||||||||
getDataDir( ) -> $dir | |||||||||
Changed: | |||||||||
< < | DEPRECATED since 1.1 - use the content handling functions to manipulate topics instead | ||||||||
> > | DEPRECATED since 1.1 - use the "Webs, Topics and Attachments" functions to manipulate topics instead | ||||||||
Get data directory (topic file root) | |||||||||
Line: 1309 to 1382 | |||||||||
getPubDir( ) -> $dir | |||||||||
Changed: | |||||||||
< < | DEPRECATED since 1.1 - use the content handling functions to manipulateattachments instead | ||||||||
> > | DEPRECATED since 1.1 - use the "Webs, Topics and Attachments" functions to manipulateattachments instead | ||||||||
Get pub directory (file attachment root). Attachments are in $dir/Web/TopicName |