Manual twiki

Topic summary, just the plain text, all TWiki variables, formatting and line breaks removed; up to characters. Topic summary, up to 50 characters shown. Summary of changes between latest rev and previous rev. Summary of changes between latest rev and rev n. The name of the form attached to the topic; empty if none. This applies only to topics that have a TWikiForm.

Form field value, encoded in the specified type. The encode: type parameter can be combined with other parameters described below, but it needs to be the last parameter. Form field value, rendered for display.

For example, a form field of type color will render as a colored box. If not specified, the raw value is returned, such as a color value The render:display parameter can be combined with other parameters, but must be used after the parameters described below. Form field value, " - " hyphenated each 10 characters. Form field value, shortened to 30 characters with " Strings in QuerySearch result are quoted with the specified quote. QuerySearch result is encoded in the specified type.

A text extracted by reg-exp is encoded in the specified type. Count of number of times a regular expression pattern appears in the text of a topic does not search meta data. Number of topics found in current web. This is the current topic count, not the total number of topics. The total number of topics matched. Cumulative across all topics in current web. Just a sample. Smiley face. Public Supported. Public FAQ. Columns x rows, such as 80x6 ; default is 40x5.

One or more checkboxes that can be toggled individually. Like checkbox , adding [Set] and [Clear] buttons. Radio buttons, mutually exclusive; only one can be selected. Select box, rendered as a picklist or a multi-row selector box depending on the size value. Like select , allowing definition of values that are different to the displayed text. An option is defined as value: title , where the value is the value passed on form submit, and title is the option text shown to the user.

Single-line text box and a color picker to pick a color. The color can also be typed into the text box, such as Text input field and a button next to it to pick a date from a pop-up calendar. The date can also be typed into the text box.

Percent complete indicator and pick list. The percentage can be set by clicking on the percent complete indicator bar, or by picking a value from the pick list.

Initial default percentage value. Standard header ex: view, index, search. Simple header with reduced links ex: edit, attach, oops. Footer, excluding revision and copyright parts. Alert page shown when you try to view a nonexistent topic. This page is usually used as a prompt to help you create a new topic. Alert page shown when you try to view a nonexistent topic with a non-WikiName.

Again, this page is used as a prompt to help you create the new topic. Default text used in a new topic. Whenever you create a topic ending in the word "Template", it is automatically added to the list of available templates in the "Use Template" drop down field on the WebCreateNewTopic page. Signature format date.

A no-operation variable that gets removed. Text that gets removed when a new topic based on the template is created. See notes below. Login name of user who is instantiating the new topic, e.

Value of a named URL parameter. WikiName of user who is instantiating the new topic, e. User name of user who is instantiating the new tpoic, e. Renders as:. Web-specific background color, defined in the WebPreferences.

The script suffix, ex:. The name of the current web. The name of the current topic. Common links of current web, defined in the WebPreferences.

It includes a Jump box. The topic text, e. TWikiForm , if any. FileAttachment table. The revision title, if any, ex: r1.

Revision info, ex: r1. Copyright notice, defined in the WebPreferences. Broadcast message at the beginning of your view template, can be used to alert users of scheduled downtimes; can be set in TWikiPreferences. Title bar for upload screens, with attributes column. Footer for all screens. Header for versions table on upload screen. Row format for versions table on upload screen. Footer for versions table on upload screen.

A file icon suitable for representing the attachment content. The name of the file. The date the file was uploaded. The comment they put in when uploading it. The attributes of the file as seen on the upload screen e. Format of this topic, will be used for automatic format conversion.

The topic from which this was created, typically when clicking on a red-link, or by filling out a form. Normally just TopicName , but it can be a full Web.

TopicName format if the parent is in a different Web. Name of file, no path. Must be unique within topic. Full path file was loaded from.

As supplied when file uploaded. A topic name - the topic represents one of the TWikiForms. Can optionally include the web name i. Ties to entry in TWikiForms template, is title with all bar alphanumerics and.

Full text from TWikiForms template. Value user has supplied via form. Show form data, see TWikiForms. Show form field value.

Show attachments, except for hidden ones. Show topic parent. BlackListPlugin This handler is deprecated - please check for updated versions of the plugins that use it! RenderListPlugin This handler is deprecated - please check for updated versions of the plugins that use it! A password input is hidden. A perl structure, consisting of arrays and hashes. Pick one of a range of choices.

Select a perl package class. A relative URL path. True if this is a minor change, and is not to be notified. Wiki name of the author not login name. Name of a file to use for the attachment data.

Local file on the server. Standard variable names e. Otherwise it overrides the URL and is taken as the topic name you can pass Web. 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. Overrides the default skin path see TWikiSkins.

Specifies temporary skin path to prepend to the skin path for this script only see TWikiSkins. Name of existing attachment if provided, this is a "manage attachment" action.

If 0, show only major changes. If 1, show all the changes both minor and major. Use the editaction template instead of the standard edit. If set, error if topic name is not a WikiWord. The name of the template topic, copied to get the initial content new topic only. Name of the form to instantiate in the topic. Overrides the form set in the templatetopic if defined. 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. Optional parameter that defines the application type to write into the CGI header. May be used to invoke alternative client applications. If set, any lease conflicts will be ignored, and the edit will proceed even if someone is already editing the topic.

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. 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. URL that was being accessed when an access violation occurred.

One of createweb , renameweb , deleteUserAccount , editSettings or saveSettings. Name of the web to copy to create the new web. If defined, requires a second level of confirmation. Supported values are "getlock", "continue", and "cancel". If the savesettings process is successful, save will redirect to this topic or URL.

Whether to overwrite existing home topics or not. Same as topic name, with 'Result' appended. Optional, can be set to the name of a single definition within template. This lets you use a single template file for many messages. For an example, see oopsmanagebad. Where N is an integer from 1 upwards. The parent topic of the new user profile page. If the rename process is successful, rename will redirect to this topic or URL. 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. If the copy process is successful, copy will redirect to this topic or URL. By default, copy does not happen if the destination topic already exists. If this parameter is 'on' , the destination topic is deleted if exists before copying takes place. 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. 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. 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 Main. WebHome will be passed to plugins. Where to redirect the response once the request is served, in the form "Web. 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. Administrators only replace the text of the most recent revision of the topic with the text in the text parameter. All other parameters are ignored.

Name of a topic to use as a template for the text and form new topic only. If 'none' remove any current topic parent. If the name of a topic, set the topic parent to this. When action is checkpoint , add form or replace form Send feedback. Ask community in the support forum.

All material on this collaboration platform is the property of the contributing authors. GNU diff 2. Used by the site statistics to record disk usage statistics, optional. The df command is pre-installed on Linux and OS-X. On Windows install the CoreUtils for Windows. UpgradeTWiki script. GNU fgrep , egrep. Modify command line parameters in configure if you use non-GNU grep programs. Zip archive command line utility. Used by the BackupRestorePlugin to create and restore from backups.

Apache is well supported; see TWiki:TWiki. Included in TWiki distribution. A suitable version ships with TWiki since TWiki Versions 2. This version included in Perl 5.