data/TWiki/TWikiScripts.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
child 1 e2915a7cbdfa
permissions -rw-r--r--
RELEASE 4.2.0 freetown
     1 %META:TOPICINFO{author="TWikiContributor" date="1168672578" format="1.1" version="5"}%
     2 %STARTINCLUDE%
     3 ---+ TWiki CGI and Command Line Scripts
     4 
     5 _Programs on the TWiki server performing actions such as rendering, saving and renaming topics._
     6 
     7 The TWiki scripts are located in the =twiki/bin= and =twiki/tools= directories. This topic describes the interfaces to some of those scripts. All scripts in the =twiki/bin= directory can be called from the CGI ([[http://en.wikipedia.org/wiki/Common_Gateway_Interface][Common Gateway Interface]]) environment or from the command line. The scripts in the =twiki/tools= directory can only be called from the command line.
     8 
     9 %TOC%
    10 
    11 ---++ CGI Scripts
    12 Details on CGI scripts located in the =twiki/bin= directory.
    13 
    14 ---+++ General Information
    15 ---++++ CGI environment
    16 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 =guest=).
    17 ---++++ Command-line
    18 You *must* be have the =twiki/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=.
    19 
    20 Parameters are passed on the command line using '-name' - for example,
    21 <verbatim>
    22 $ cd /usr/local/twiki/bin
    23 $ save -topic MyWeb.MyTopic -user admin -action save -text "New text of the topic"
    24 </verbatim>
    25 All parameters require a value, even if that is the empty string.
    26 
    27 ---++++ Common parameters
    28 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:
    29 
    30 | *Parameter* | *Description* | *Default* |
    31 | =topic= | 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.<nop>TopicName) | |
    32 | =user= | 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 authorised users should be allowed to execute scripts from the command line. | |
    33 | =skin= | Overrides the default skin path (see TWikiSkins) | |
    34 | =cover= | Specifies temporary skin path to prepend to the skin path for this script only (see TWikiSkins) | |
    35 
    36 ---+++ =attach=
    37 Despite the name, this script doesn't actually attach a file to a topic - for that, use =upload=. 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.
    38 
    39 | *Parameter* | *Description* | *Default* |
    40 | =filename= | Name of existing attachment (if provided, this is a "manage attachment" action) | none (in which case this is a "new attachment" action) |
    41 
    42 ---+++ =changes=
    43 Shows all the changes in the given web. 
    44 
    45 The =changes= script can receive one parameter:
    46 
    47 | *Parameter* | *Description* | *Default* |
    48 | =minor= | If 0, show only major changes. If 1, show all the changes (both minor and major) | 0 |
    49 
    50 The main difference between invoking this script and using WebChanges is that WebChanges is based on a =%<nop>SEARCH%=, while this script reads the =changes= file in each web, making it much faster.
    51 
    52 *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.
    53 
    54 ---+++ =configure=
    55 =configure= 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 =configure=. See [[%SCRIPTURLPATH{"configure"}%][configure]].
    56 
    57 ---+++ =edit=
    58 The =edit= scipt understands the following parameters, typically supplied by HTML input fields:
    59 
    60 | *Parameter* | *Description* | *Default* |
    61 | =action= | Optional. Use the editaction template instead of the standard edit. If action=text, then hide the form. If action=form hide the normal text area and only edit the form. | |
    62 | =onlynewtopic= | If set, error if topic already exists | |
    63 | =onlywikiname= | If set, error if topic name is not a WikiWord | |
    64 | =templatetopic= | The name of the template topic, copied to get the initial content | |
    65 | =text= | Initial text for the topic | |
    66 | =topicparent= | The parent topic | |
    67 | =formtemplate= | Name of the form to instantiate in the topic. Overrides the form set in the =templatetopic= if defined. | |
    68 | =contenttype= | Optional parameter that defines the application type to write into the CGI header. Defaults to =text/html=. May be used to invoke alternative client applications | |
    69 | =anyname= | Any parameter can passed to the new topic; if the template topic contains =%<nop>URLPARAM{"anyname"}%=, it will be replaced by its value | |
    70 | =breaklock= | If set, any lease conflicts will be ignored, and the edit will proceed even if someone is already editing the topic. | |
    71 | =redirectto= | 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 =TopicName=, a =Web.TopicName=, or a URL.%BR% __Note:__ Redirect to a URL only works if it is enabled in =configure= (Miscellaneous ={AllowRedirectUrl}=). | |
    72 
    73 Form field values are passed in parameters named 'field' - for example, if I have a field =Status= the parameter name is =Status=.
    74    1 The first sequence of ten or more =X= 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.
    75 
    76 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.
    77 
    78 ---+++ =login=
    79 Used for logging in when TWiki login is being used (e.g !TemplateLoginManager).
    80 | *Parameter* | *Description* | *Default* |
    81 | =origurl= | URL that was being accessed when an access violation occurred. the login process will redirect to this URL if it is successful | none |
    82 | =username= | username of user logging in | none |
    83 | =password= | password of user logging in | none |
    84 
    85 ---+++ =logon=
    86 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.
    87  
    88 ---+++ =manage=
    89 Performs a range of management functions.
    90 | *Parameter* | *Description* | *Default* |
    91 | =action= | One of =createweb=, =deleteUserAccount=, =editSettings= or =saveSettings= | none |
    92 
    93 ---++++ =action=createweb=
    94 | *Parameter* | *Description* | *Default* |
    95 | =newweb= | Name of the new web | '' |
    96 | =baseweb= | Name of the web to copy to create the new web | '' |
    97 | =webbgcolor= | value for WEBBGCOLOR | '' |
    98 | =sitemapwhat= | Value for SITEMAPWHAT | '' |
    99 | =sitemapuseto= | Value for SITEMAPUSETO | '' |
   100 | =nosearchall= | Value for NOSEARCHALL | '' |
   101 
   102 ---++++ =action=editSettings=
   103 No parameters
   104 
   105 ---++++ =action=saveSettings=
   106 | *Parameter* | *Description* | *Default* |
   107 | =text= | Text of the topic | '' |
   108 | =originalrev= | Revision that the edit started on | Most recent revision |
   109 | =redirectto= | If the savesettings process is successful, save will redirect to this topic or URL. The parameter value can be a =TopicName=, a =Web.TopicName=, or a URL.%BR% __Note:__ Redirect to a URL only works if it is enabled in =configure= (Miscellaneous ={AllowRedirectUrl}=). | 
   110 All other parameters may be interpreted as form fields, depending on the current form definition in the topic.
   111 
   112 ---++++ =action=bulkRegister=
   113 See BulkRegistration.
   114 | *Parameter* | *Description* | *Default* |
   115 | =OverwriteHomeTopics= | Whether to overwrite existing home topics or not | false |
   116 | =EmailUsersWithDetails= | Whether to mail registered users or not | false |
   117 | =LogTopic= | Topic to save the log in | Same as topic name, with 'Result' appended. |
   118 
   119 ---++++ =action=changePassword=
   120 Change password, email address, or both, of a user.
   121 | *Parameter* | *Description* | *Default* |
   122 | =username= | god alone knows | _none_ |
   123 | =oldpassword= | current password | _none_ |
   124 | =password= | new password | _none_ |
   125 | =passwordA= | new password confirmation | _none_ |
   126 | =email= | new email address | _none_ |
   127 =password, =passwordA= and =email= are optional. If neither or =password= and =passwordA= is set, then the user password is left unchanged. If =email= is unset, their email is left unchanged.
   128 
   129 ---++++ =action=resetPassword=
   130 Reset the password for a single or multiple users
   131 | *Parameter* | *Description* | *Default* |
   132 | =LoginName= | *list* of usernames to reset | none - error if not set |
   133 | =Introduction= | message to be sent alongside the reset, most often used to announce to the user that they have been given an account.  | '' |
   134 
   135 This is used by BulkResetPassword and ResetPassword. Only administrators can provide a list of LoginNames, non-admins can only provide a single LoginName. 
   136 
   137 BulkRegistration provides the means to create multiple accounts but it does not announce those accounts to the users who own them. BulkResetPassword is used to assign the passwords, the Introduction is used to explain why they are receiving the mail.
   138 
   139 ---++++ =action=deleteUserAccount=
   140 Unregisters (removes) the currently logged-in user.
   141 | *Parameter* | *Description* | *Default* |
   142 | =password= | Users' password | none |
   143 
   144 ---+++ =oops=
   145 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).
   146 
   147 =oops= templates are used with the =oops= script to generate system messages. This is done to make internationalisation or other local customisations simple. 
   148 
   149 The =oops= script supports the following parameters:
   150 
   151 | *Parameter* | *Description* | *Default* |
   152 | =template= | Name of the template file to display | |
   153 | =def= | Optional, can be set to the name of a single definition within =template=. This definition will be instantiated in the =template= wherever =%<nop>INSTANTIATE%= is seen. This lets you use a single template file for many messages. For an example, see =oopsmanagebad.tmpl=. | |
   154 | =paramN= | Where N is an integer from 1 upwards. These values will be substituted into =template= for =%<nop>PARAM1%= etc. | |
   155 
   156 ---+++ =preview=
   157 This script is _deprecated_. Its functions are covered by the =save= script.
   158 
   159 ---+++ =rdiff=
   160 Renders the differences between version of a TWiki topic
   161 
   162 | *Parameter* | *Description* | *Default* |
   163 | rev1 | the higher revision | |
   164 | rev2 | the lower revision | |
   165 | render | the rendering style {sequential, sidebyside, raw, debug} | DIFFRENDERSTYLE, =sequential= |
   166 | type | {history, diff, last} history diff, version to version, last version to previous | =diff= |
   167 | context | number of lines of context | |
   168 TODO:
   169    * add a {word} render style
   170 
   171 ---+++ =register=
   172 
   173 | *Parameter* | *Description* | *Default* |
   174 | =action= | =register= or =verify= or =resetPassword= or =approve= | |
   175 
   176 ---+++ =rename=
   177 Used for renaming topics.
   178 
   179 | *Parameter* | *Description* | *Default* |
   180 | =skin= | skin(s) to use | |
   181 | =newweb= | new web name | |
   182 | =newtopic= | new topic name | |
   183 | =breaklock= | | |
   184 | =attachment= | | |
   185 | =confirm= | if defined, requires a second level of confirmation | |
   186 | =currentwebonly= | if defined, searches current web only for links to this topic | |
   187 | =nonwikiword= | if defined, a non-wikiword is acceptable for the new topic name | |
   188 | =redirectto= | If the rename process is successful, rename will redirect to this topic or URL. The parameter value can be a =TopicName=, a =Web.TopicName=, or a URL.%BR% __Note:__ Redirect to a URL only works if it is enabled in =configure= (Miscellaneous ={AllowRedirectUrl}=). | |
   189 
   190 ---+++ =rest=
   191 This REST ([[http://en.wikipedia.org/wiki/REST][Representational State Transfer]]) script can be invoked via http in the same way as the other TWiki scripts (see *Invocation Examples*, 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 =TWiki::Func::registerRESTHandler= method. The =rest= script will print the result directly to the browser unless the =endPoint= parameter is specified, in which case it will output a redirect to the given topic.
   192 
   193 The =rest= script supports the following parameters:
   194 | =username= | If =TemplateLogin=, 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 =username= and =password= parameters are used for this purpose. |
   195 | =password= | See =username= |
   196 | =topic= | 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 %USERWEB%.%HOMETOPIC% will be passed to plugins. |
   197 | =endPoint= | Where to redirect the response once the request is served, in the form "Web.Topic" |
   198 
   199 The function is free to use any other query parameters for its own purposes.
   200 
   201 %X% The =rest= script should *always* 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 =ApacheLogin=.
   202 
   203 ---++++ Invocation Examples
   204 
   205 The =rest= script assumes that it will be called with URL in the form:
   206 
   207 =http://my.host/bin/rest/&lt;subject&gt;/&lt;verb&gt;=
   208 
   209 where =&lt;subject&gt;= must be the WikiWord name of one of the installed TWikiPlugins, and the =&lt;verb&gt;= is the alias for the function registered using the =TWiki::Func::registerRESTHandler= method. The =&lt;subject&gt;= and =&lt;verb&gt;= are then used to lookup and call the registered function.
   210 
   211 =&lt;subject&gt;= and =&lt;verb&gt;= are checked for illegal characters exactly in the same way as the web and topic names.
   212 
   213 As an example, the EmptyPlugin has registered a function to be used with the =rest= script under the subject *EmptyPlugin* and the verb *example*. Click below to see the =rest= script in action (run as Main.TWikiGuest).
   214 
   215 [[%SCRIPTURL{rest}%/EmptyPlugin/example?debugenableplugin=EmptyPlugin][Call the Plugin]]
   216 
   217 Note that for Plugins to register REST handlers, they must be enabled in =configure=.
   218 
   219 ---+++ =save=
   220 The =save= script performs a range of save-related functions, as selected by the =action= parameter.
   221 
   222 | *Parameter* | *Description* | *Default* |
   223 | =action_save=1= | *default*; save, return to view, dontnotify is =off= | |
   224 | =action_quietsave=1= | save, and return to view, =dontnotify= is =on= | |
   225 | =action_checkpoint= | save and redirect to the edit script, =dontnotify= is =on= | |
   226 | =action_cancel= | exit without save, return to view | |
   227 | =action_preview= | preview edited text | |
   228 | =action_addform= | Redirect to the "change form" page. | |
   229 | =action_replaceform...= | Redirect to the "change form" page. | |
   230 | =action_delRev= | *Administrators only* 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. | |
   231 | =action_repRev= | *Administrators only* replace the text of the most recent revision of the topic with the text in the =text= parameter. =text= must included embedded meta-data tags. All other parameters are ignored. You have to be an administrator to use this, and not all store implementations will support it. | |
   232 | =onlynewtopic= | If set, error if topic already exists | |
   233 | =onlywikiname= | If set, error if topic name is not a WikiWord | |
   234 | =dontnotify= | if defined, suppress change notification | |
   235 | =templatetopic= | Name of a topic to use as a template for the text and form | |
   236 | =text= | New text of the topic | |
   237 | =forcenewrevision= | if set, forces a revision even if TWiki thinks one isn't needed | |
   238 | =topicparent= | If 'none' remove any current topic parent. If the name of a topic, set the topic parent to this. | |
   239 | =formtemplate= | if defined, use the named template for the form | |
   240 | =editaction= | When action is =checkpoint=, =add form= or =replace form...=, this is used as the =action= parameter to the =edit= script that is redirected to after the save is complete. | |
   241 | =originalrev= | Revision on which the edit started. | |
   242 | =edit= | The script to use to edit the topic when action is =checkpoint= | =edit= |
   243 | =editparams= | The parameter string to use to edit the topic |  |
   244 | =redirectto= | 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 =TopicName=, a =Web.TopicName=, or a URL.%BR% __Note:__ Redirect to a URL only works if it is enabled in =configure= (Miscellaneous ={AllowRedirectUrl}=). | view topic being edited |
   245 
   246 Any errors will cause a redirect to an =oops= page.
   247 
   248 The parameters are interpreted in according to the following rules.
   249 
   250    1 The first sequence of ten or more =X= characters in the topic name will be converted to a number such that the resulting topic name is unique in the target web.
   251    1 When the action is =save=, =checkpoint=, =quietsave=, or =preview=:
   252       1 The new text is taken from the =text= parameter, if it is defined,
   253          * otherwise it is taken from the =templatetopic=, if it is defined,
   254          * otherwise it is taken from the previous version of the topic, if any,
   255       1 The name of the new form is taken from the =formtemplate=, if defined
   256          * otherwise it is taken from the =templatetopic=, if defined,
   257          * otherwise it is taken from the previous version of the topic, if any,
   258          * otherwise no form is attached.
   259       1 The value for each field in the form is taken from the query, if it is defined
   260          * otherwise it is taken from the =templatetopic=, if defined,
   261          * otherwise it is taken from the previous version of the topic, if any,
   262          * otherwise it defaults to the empty string.
   263 
   264 Merging is only enabled if the topic text comes from =text= and =originalrev= is &gt; 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.
   265 
   266 Form field values are passed in parameters named 'field' - for example, if I have a field =Status= the parameter name is =Status=.
   267 
   268 ---+++ =search=
   269 CGI gateway to the =%<nop>SEARCH%= functionality driven by the following CGI parameters:
   270 
   271 | *Parameter:* | *Description:* | *Default:* |
   272 | ="text"= | Search term. Is a keyword search, literal search or regular expression search, depending on the =type= parameter. SearchHelp has more | required |
   273 | =search="text"= | (Alternative to above) | N/A |
   274 | =web="Name"= <br /> =web="%USERSWEB%, Know"= <br /> =web="all"= | Comma-separated list of webs to search. See TWikiVariables#VarSEARCH for more details. | Current web |
   275 | =topic="%WEBPREFSTOPIC%"= <br /> =topic="*Bug"= | Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. | All topics in a web |
   276 | =excludetopic="Web*"= <br /> =excludetopic="%HOMETOPIC%, <nop>WebChanges"= | Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. | None |
   277 | =type="keyword"= <br /> =type="literal"= <br /> =type="regex"= | Do a keyword search like =soap "web service" -shampoo=; a literal search like =web service=; or RegularExpression search like =soap;web service;!shampoo= | =%<nop>SEARCHVAR- DEFAULTTYPE%= [[TWikiPreferences][preferences]] setting (%SEARCHVARDEFAULTTYPE%) |
   278 | =scope="topic"= <br /> =scope="text"= <br /> =scope="all"= | Search topic name (title); the text (body) of topic; or all (both) | ="text"= |
   279 | =order="topic"= <br /> =order="created"= <br />  =order="modified"= <br /> =order="editby"= <br /> =order=<br />&nbsp;"formfield(name)"= | Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of TWikiForms. The sorting is done web by web; in case you want to sort across webs, create a [[FormattedSearch][formatted]] table and sort it with TablePlugin's initsort | Sort by topic name |
   280 | =limit="all"= <br /> =limit="16"= | Limit the number of results returned. This is done after sorting if =order= is specified | All results |
   281 | =date="..."= | limits the results to those pages with latest edit time in the given [[TimeSpecifications#TimeIntervals][time interval]].  | All results |
   282 | =reverse="on"= | Reverse the direction of the search | Ascending search |
   283 | =casesensitive="on"= | Case sensitive search | Ignore case |
   284 | =bookview="on"= | BookView search, e.g. show complete topic text | Show topic summary |
   285 | =nonoise="on"= | Shorthand for =nosummary="on" nosearch="on" nototal="on" zeroresults="off" noheader="on" noempty="on"= | Off |
   286 | =nosummary="on"= | Show topic title only | Show topic summary |
   287 | =nosearch="on"= | Suppress search string | Show search string |
   288 | =noheader="on"= | Suppress search header <br /> <span style='background: #FFB0B0;'> *Topics: Changed: By:* </span> | Show search header |
   289 | =nototal="on"= | Do not show number of topics found | Show number |
   290 | =zeroresults="off"= | Suppress all output if there are no hits | =zeroresults="on"=, displays: "Number of topics: 0" |
   291 | =noempty="on"= | Suppress results for webs that have no hits. | Show webs with no hits |
   292 | =header="..."= <br /> =format="..."= | Custom format results: see *[[FormattedSearch]]* for usage, variables &amp; examples | Results in table |
   293 | =expandvariables="on"= | Expand variables before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin =%<nop>CALC{}%= instead of the formula | Raw text |
   294 | =multiple="on"= | Multiple hits per topic. Each hit can be [[FormattedSearch][formatted]]. The last token is used in case of a regular expression ";" _and_ search | Only one hit per topic |
   295 | =nofinalnewline="on"= | If =on=, the search variable does not end in a line by itself. Any text continuing immediately after the search tag on the same line will be rendered as part of the table generated by the search, if appropriate. | =off= |
   296 | =separator=", "= | Line separator between hits | Newline ="$n"= |
   297 
   298 ---+++ =statistics=
   299 Refresh the WebStatistics topics in range of webs.
   300 | *Parameter* | *Description* | *Default* |
   301 | =webs= | comma-separated list of webs to run stats on | all accessible webs |
   302 | =logdate= | YYYYMM to generate statistics for | current month |
   303 
   304 for example:
   305    1 from browser %SCRIPTURL{"statistics"}% updates _all user webs_
   306    2 from browser %SCRIPTURL{"statistics"}%?webs=TWiki,Main,Sandbox updates _TWiki,Main,Sandbox_
   307    3 from browser %SCRIPTURL{"statistics"}%/%WEB% updates %WEB%
   308    4 from command line twiki/bin/statistics updates _all user webs_
   309    5 from command line twiki/bin/statistics -webs=TWiki,Main,Sandbox updates _TWiki,Main,Sandbox_
   310    6 from command line twiki/bin/statistics %WEB%.<nop>WebHome updates %WEB%
   311 
   312 see TWikiSiteTools#WebStatistics_site_statistics for updating statistics using cron.
   313 
   314 ---+++ =upload=
   315 Uploads an attachment to a topic. The HTTP request is expected to be in =multipart/form-data= format.
   316 | *Parameter* | *Description* | *Default* |
   317 | =hidefile= | if defined, will not show file in attachment table | |
   318 | =filepath= | local (client) path name of the file being uploaded. This is used to look up the data for the file in the HTTP query. | |
   319 | =filename= | deprecated, do not use | |
   320 | =filecomment= | Comment to associate with file in attachment table | |
   321 | =createlink= | if defined, will create a link to file at end of topic | |
   322 | =changeproperties= | if defined, this is a property change operation *only* - no file will be uploaded. | null |
   323 
   324 You can use a tool like =curl= to upload files from the command line using this script.
   325 
   326 ---+++ =view=
   327 Used for viewing topics.
   328 
   329 | *Parameter* | *Description* | *Default* |
   330 | =raw=on= | Shows the text of the topic in a scrollable textarea | |
   331 | =raw=debug= | As =raw=on=, but also shows the metadata (forms etc) associated with the topic. | |
   332 | =raw=text= | Shows only the source of the topic, as plain text (Content-type: text/plain). Only shows the body text, *not* the form or other meta-data. |
   333 | =raw=all= | Shows only the source of the topic, as plain text (Content-type: text/plain), *with embedded meta-data*. This may be useful if you want to extract the source of a topic to a local file on disc. | |
   334 | =section= | Allows to view only a part of the topic delimited by a named section (see %SYSTEMWEB%.VarSTARTSECTION). If the given section is not present, no topic content is displayed. | |
   335 | =contenttype= | Allows you to specify a different *Content-Type:* (e.g. =contenttype=text/plain=) | |
   336 | =rev= | Revision to view (e.g. =rev=45=) | |
   337 | =template= | Allows you to specify a different skin template, overriding the 'view' template the view script would normally use. The default template is =view=. For example, you could specify [[%SCRIPTURLPATH{"view"}%/%WEB%/%TOPIC%?template=edit][%SCRIPTURLPATH{"view"}%/%WEB%/%TOPIC%?template=edit]]. This is mainly useful when you have specialised templates for a TWiki Application. | |
   338 | =topic= | redirects (at the beging of the cgi script running) to show the spcified Web.Topic, or, redirects to a URL, if allowed by {AllowRedirectUrl} and {PermittedRedirectHostUrls} | |
   339 
   340 %X% For historical reasons, the view script has a special interpretation of the =text= skin. In earlier TWiki versions the =skin=text= parameter was used like this:
   341 =http<nop>://.../view/MyWeb/MyTopic?skin=text&contenttype=text/plain&raw=on=
   342 which shows the topic as plain text; useful for those who want to download plain text for the topic.
   343 Using =skin=text= this way is *DEPRECATED*, use =raw=text= instead.
   344 
   345 ---+++ =viewfile=
   346 Used for viewing attachments. Normally, a site will publish the attachments (=pub=) directory using a URL. However if it contains sensitive information, you will want to protect attachments using TWikiAccessControls. In this case, you can use the =viewfile= script to give access to attachments while still checking access controls.
   347 
   348 | *Parameter* | *Description* | *Default* |
   349 | =filename= | name of attachment | |
   350 | =rev= | Revision to view | |
   351 
   352 Instead of using the =filename= parameter, you can append the attachment name
   353 to the end of the URL path (after the topic) e.g. =%SCRIPTURL{viewfile}%/Webname/TopicName/Attachment.gif=
   354 
   355 ---++ Command Line Scripts
   356 Details on command line scripts located in the =twiki/tools= directory.
   357 
   358 ---+++ =geturl.pl=
   359 This is a very simple script to get the content of a web site. It is marked as _deprecated_ and might be removed (or enhanced) in a future TWiki release. Its functions are covered by the standard =wget= and =curl= commands.
   360    * Usage:    =geturl.pl &lt;host&gt; &lt;path&gt; [&lt;port&gt; [&lt;header&gt;]]=
   361    * Example:  =geturl.pl some.domain /some/dir/file.html 80=
   362    * Will get: =http://some.domain:80/some/dir/file.html=
   363 
   364 ---+++ =rewriteshebang.pl=
   365 Simple script to rewrite the =#!/usr/bin/perl= 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').
   366 
   367 ---+++ =tick_twiki.pl=
   368 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.
   369 
   370 It is intended to be run as a cron job or a scheduled task once a week. Example crontab entry:%BR%
   371 =0 0 * * 0 cd /usr/twiki/bin && perl ../tools/tick_twiki.pl=
   372 
   373 __Note:__ The script has to be run by a user who can write files created by the webserver user.
   374 
   375 
   376 
   377 __Related Topics:__ AdminDocumentationCategory, DeveloperDocumentationCategory