Changeset 1221 for trunk/core/data/System/CommandAndCGIScripts.txt

Timestamp:

12/09/08 18:16:48 (3 years ago)

Author:

CrawfordCurrie

Message:

Item253: remove TWikiDrawPlugin hack; analyse, rationalise and document usage of redirectto; Item5926: added encodings that were proposed to make chinese work (they don't break anything AFAICT). Deprecate Foswiki::Func::getRegularExpression (the regex array is published)

File:

• trunk/core/data/System/CommandAndCGIScripts.txt (modified) (1 diff)

trunk/core/data/System/CommandAndCGIScripts.txt

@@ -322 +322 @@
 | =createlink= | if defined, will create a link to file at end of topic | |
 | =changeproperties= | if defined, this is a property change operation *only* - no file will be uploaded. | null |
-
-You can use a tool like =curl= to upload files from the command line using this script.
+| =redirectto= | URL to redirect to after upload. ={AllowRedirectUrl}= \
+     must be enabled in =configure=. The parameter value can be a \
+     =TopicName=, a =Web.TopicName=, or a URL. Redirect to a URL only works \
+     if it is enabled in =configure=, and is ignored if =noredirect= is \
+     specified.%BR% __Note:__ Redirect to a URL only works if it is enabled \
+     in =configure= (Miscellaneous ={AllowRedirectUrl}=). |
+| =noredirect= | Normally it will redirect to 'view' when the upload is \
+     complete, but also designed to be useable for REST-style calling using \
+     the 'noredirect' parameter. If this parameter is set it will return an \
+     appropriate HTTP status code and print a message to STDOUT, starting \
+     with 'OK' on success and 'ERROR' on failure. |
+
+__Tips__
+   * You can use a tool like =curl= to upload files from the command line using this script.
+   * You can call upload easily from !XmlHttpRequest in Javascript.
 
 ---+++ =view=