This is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see customization. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your WebPreferences.

Set to "on" to disable the automatic form that encloses your comment block - remember to insert <form> tags yourself! See CommentPluginExamples#noform for an example.

"off"

nopost

Set to "on" to disable insertion of the posted text into the topic.

"off"

remove

Set to "on" to remove the comment prompt after the first time it is clicked.

"off"

button

Button label text

"Add comment"

emailto

Send comment by email. Use comma "," to seperate multiple email addresses. This feature is disabled by default. To enable this feature, please set up "$TWiki::cfg{Plugins}{CommentPlugin}{EmailEnabled} = 1;".

EDITFORM{} -- render a TWiki form for edit

Name of topic containing the TWiki form, such as "Bug1234". Specify topic name or Web.TopicName

Either "...", topic="" or formtemplate="" is required

formtemplate="..."

Name of form template topic, such as "BugForm". Specify topic name or Web.TopicName

elements="..."

Elements of edit form: formstart is the HTML form tag, header the form header, formfields the form fields, submit the submit button, hiddenfields are hidden input fields, formend is the HTML form end tag.

"formstart, header, formfields, submit, hiddenfields, formend"

header="..."

Form header, typically containing the form name. If "on", the default format is used:"| *[[$formweb.$formtopic][$formtopic]]* ||" Supported variables: • $formweb - name of web containing the form definition. • $formtopic - name of topic containing the form definition.

"on"

formfields="..., ..."

Specify names of TWiki form fields to use, in sequence. The all token shows all remaining fields.

"all"

format="..."

Format of one form field. Supported variables: • $inputfield - rendered form input field. • $title - raw field name (includes space and other special characters). • $name - field name (sanitized title). • $size - size of field or selector. • $value - initial value, or select options. • $tooltip - tooltip message. • $attributes - type attributes, such as H for hidden, M for mandatory. • $extra - extra information, such as * for mandatory field. • $formweb - name of web containing the form definition. • $formtopic - name of topic containing the form definition. See details in TWikiForms#FormFieldTypes.

"| $title: $extra | $inputfield |"

hiddenfields="..., ..."

List of form field names to use as hidden fields. For each name listed in hiddenfields="", add a name="value" parameter to specify the value of the hidden input field. If you omit the name="value" parameter for a hidden input field, it will be excluded as a form field, even with a formfields="all".

""

submit="..."

Format of submit button row. Line separator. Variable $submit expands to submit input field with label "Save", $submit(Save) to a submit input field with specific label.

"| | $submit |"

onsubmit="..."

Execute JavaScript when the form is submitted, optional.

""

action="..."

Specify a TWiki script (view, edit, save, ...), or the full URL of an action to take on form submit.

"save"

method="..."

HTML form action method.

"post" for save action, else "get"

separator="..."

Line separator. Variable $br expands to <br /> tag, and $n to a newline.

"$n"

default="..."

Text shown when no form or form fields are found

""

Example: %EDITFORM{ topic="%INCLUDINGTOPIC%" }% - show HTML form to update form data of the including topic (typically used in an included header)

Example: Custom form in an included header to update some form field values of the base topic, including one hidden field: %EDITFORM{ topic="%BASEWEB%.%BASETOPIC%" formfields="Priority, Status" hiddenfields="Updated" Updated="%SERVERTIME{$year-$mo-$day}%" submit=" | | $submit(Update) |"}%

EDITFORMFIELD{"fieldname" form=""} -- render an input field specified in a form template topic

Use this to create HTML forms that update TWikiForms, such as a custom "create new topic" form, or a topic header that allows users to change some form values at the top of the page. A valid form is composed of a start form type, various form fields, a submit type, and an end form type.

Syntax:

%EDITFORMFIELD{"fieldname" form="...Form"}% - create form field defined in a TWiki Form template

%EDITFORMFIELD{"fieldname" topic="..."}% - create form field based on a topic that has a TWiki Form & initialize its value

Rows can be added and removed if "on" Rows can be added but not removed if "add" Rows cannot be added or removed if "off"

CHANGEROWS plugin setting

quietsave

Quiet Save button is shown if "on", hidden if "off"

QUIETSAVE plugin setting

include

Other topic defining the EDITTABLE parameters. The first %EDITTABLE% in the topic is used. This is useful if you have many topics with the same table format and you want to update the format in one place.

(none)

helptopic

Topic name containing help text shown below the table when editing a table. The %STARTINCLUDE% and %STOPINCLUDE% variables can be used in the topic to specify what is shown.

(no help text)

headerislabel

Table header cells are read-only (labels) if "on"; header cells can be edited if "off" or "0"

"on"

editbutton

Set edit button text, e.g. "Edit this table"; set button image with alt text, e.g. "Edit table, %PUBURL%/%SYSTEMWEB%/TWikiDocGraphics/edittopic.gif"; hide edit button at the end of the table with "hide" (Note: Button is automatically hidden if an edit button is present in a cell)

EDITBUTTON plugin setting

buttonrow

Set to top to put the edit buttons above the table.

bottom

javascriptinterface

Use javascript to directly move and delete row without page refresh. Enable with "on", disable with "off".

JAVASCRIPTINTERFACE plugin setting

redirectto

Set up a return page after saving changes. e.g By setting redirectto="%BASEPAGE%", you can return to base page if your editable table is included by another page.

FORM{} -- render a TWiki form for view

Name of topic containing the TWiki form, such as "Bug1234". Specify topic name or Web.TopicName

Current topic

rev="..."

Get the form from the specified topic revision, range "1" to top revision of topic. "0" is equivalent to the top revision

The rev URL parameter value if present, else the top revision

formfields="..., ..."

Specify names of TWiki form fields to show, in sequence. The all token shows all remaining fields.

"all"

header="..."

Form header, typically containing the form name. If "on", the default format "| *[[$formweb.$formtopic][$formtopic]]* ||" is used. If "none", the header is suppressed. Supported variables: • $formweb - name of web containing the form definition. • $formtopic - name of topic containing the form definition.

"on"

format="..."

Format of one form field. Supported variables: • $title - raw field name (includes space and other special characters). • $name - field name (sanitized title). • $type - form field type. • $size - size of field or selector. • $value - form field value. • $value(20, -<br />) - value hyphenated every 20 characters using separator -<br />. • $value(30, ...) - value shortened to 30 characters. • $length - length of form field value. • $tooltip - tooltip message. • $attributes - type attributes, such as H for hidden, M for mandatory. • $formweb - name of web containing the form definition. • $formtopic - name of topic containing the form definition. See details in TWikiForms#FormFieldTypes.

"| $title: | $value |"

separator="..."

Line separator. Variable $br expands to <br /> tag, and $n to a newline.

"$n"

default="..."

Text shown when no form or form fields are found

""

newline="$br"

Convert newlines in textarea to other delimiters. Variable $br expands to <br /> tag, and $n to a newline. Other text is encoded based on encode parameter.

"$br" if format is a TWiki table, else "\n"

encode="html"

Encode special characters in form field value into HTML entities. Additional encodings available: encode="quote", encode="moderate", encode="safe", encode="entity" and encode="url". See ENCODE for details.

"" (no encoding)

showhidden="..."

Set to "on" to show also hidden form fields.

""

Examples:

%FORM{topic="%INCLUDINGTOPIC%"}% - show form data of the including topic (typically used in an included header)

%FORM{topic="Projects.SushiProject" formfields="Title, Status, Deadline" header="none"}% - show a subset of form fields

%FORM{format="$name" header="none" separator=", "}% - get all visible form field names as a list

Encode special characters into HTML entities. If a FORMFIELD is passed into an HTML form field it should be encoded as "html". Additional encodings available: encode="quote", encode="moderate", encode="safe", encode="entity", encode="url" and encode="csv". See ENCODE for details.

SEARCH{"text"} -- search content

Search term. Is a keyword search, literal search, regular expression search, or query, depending on the type parameter. SearchHelp has more

required

search="text"

(Alternative to above)

N/A

web="Name"web="Main, Know"web="all"

Comma-separated list of webs to search. You can specifically \*exclude\* webs from an all search using a minus sign - for example, web="all,-Secretweb". The special word all means all webs that do not have the NOSEARCHALL variable set to on in their WebPreferences. Note that TWikiAccessControls are respected when searching webs; it is much better to use them than NOSEARCHALL.

Current web

topic="WebPreferences"topic="*Bug"

Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. Note this is a list of topic names and must not include web names.

All topics in a web

excludetopic="Web*"excludetopic="WebHome, WebChanges"

Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. Note this is a list of topic names and must not include web names.

None

scope="topic"scope="text"scope="all"

Search topic name (title); the text (body) of topic; or all (title and body)

"text"

type="keyword"type="word"type="literal"type="regex"type="query"

Control how the search is performed when scope="text" or scope="all"keyword: use Google-like controls as in soap "web service" -shampoo; searches word parts: using the example, topics with "soapsuds" will be found as well, but topics with "shampoos" will be excluded word: identical to keyword but searches whole words: topics with "soapsuds" will not be found, and topics with "shampoos" will not be excluded literal: search for the exact string, like web serviceregex: use a RegularExpression search like soap;web service;!shampoo; to search on whole words use \bsoap\bquery: query search of form fields and other meta-data, like (Firstname='Emma' OR Firstname='John') AND Lastname='Peel'

Sort the search results by: • topic: topic name, • created: topic creation time, • modified: last modified time, • editby: last editor, • parent: parent topic name, • parent(N): parent breadcrumb up to indicated level, • formfield(NAME): named TWikiForms field, • or a combination to sort by more than one field using a comma list. The sorting is done web by web; if you want to sort across webs, create a formatted table and sort it with TablePlugin's initsort. Note that dates are sorted most recent date last (i.e at the bottom of the table). Legacy order parameter is used in case sort is not specified.

"topic"

reverse="on"reverse="off, on"

Reverse the direction of the search. Specify a comma list of on, off tokens to toggle direction by sort field. If sort has more fields than reverse tokens, the state of the last reverse token is taken for the remaining fields.

"off"

start="0"start="20"

Specify the number of results to skip. This is done after sorting if sort parameter is specified. This is intended for pagination of results. If this parameter is specified, %NTOPICS% in the search template is replaced with the number of topics matched. Without this parameter, %NTOPICS% doesn't exceed the limit value.

"0"

limit="all"limit="16"

Limit the number of results returned. This is done after sorting if sort parameter is specified. This parameter specifing the number of results remains the same in the presense of the start parameter. Assuming there are more than 20 results matched, start="10" limit="10" results in 11th to 20th results are returned

"all"

date="..."

limits the results to those pages with latest edit time in the given time interval.

All results

createdate="..."

similar to date but it's about create time instead of last edit. You can specify both date and createdate, in which case topics matching both conditions are shown.

Show default search header, unless search is inline and a format is specified (Cairo compatibility)

nototal="on"

Do not show number of topics found

Show number

zeroresults="off"

Suppress all output if there are no hits

zeroresults="on", displays: "Number of topics: 0"

noempty="on"

Suppress results for webs that have no hits.

Show webs with no hits

headingoffset="2"

Adjust the level of headings in text of topics found, taking effect in $text and $pattern() of a FormattedSearch. A "2" or "+2" increases the level by two, e.g. a ---+ H1 turns into a ---+++ H3. Positive and negative values are supported. Adjusted min and max levels are H1 and H6, respectively.

Default message if there are no hits in a web. See FormattedSearch for usage, variables & examples

No output

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%CALC{}% instead of the formula

Raw text

multiple="on"

Multiple hits per topic. Each hit can be formatted. The last token is used in case of a regular expression ";" and search

Only one hit per topic

nofinalnewline="on"

If on, the search variable does not end in a line by itself. Any text continuing immediately after the search variable on the same line will be rendered as part of the table generated by the search, if appropriate.

off

recurse="on"

Recurse into subwebs, if subwebs are enabled.

off

separator=", "

Line separator between search hits. Specify format="$topic" separator=", " to get a comma separated list of topic names. The following variables can be used in the separator value: $n expands to a newline, $br expands to a <br /> line break tag.

"$n" (Newline)

newline="$br"

Line separator within a search hit. Useful if you want to put multi-line content into a table cell, for example if the format="" parameter contains a $pattern() that captures more than one line, or contains a $formfield() that returns a multi-line textfield. The following variables can be used in the newline value: $n expands to a newline, $br expands to a <br /> line break tag.

"$n" (Newline)

encode="html"

Encode special characters into HTML entities. If a FORMFIELD is passed into an HTML form field it should be encoded as "html". Additional encodings available: encode="quote", encode="moderate", encode="safe", encode="entity" and encode="url". See ENCODE for details.

Concurrent editing. If enabled, multiple people can edit TWiki Sheet and see each other's changes. This includes editing cells, pasting a range of cells, drag-filling cells, adding/removing rows, adding/removing columns, and undo. • concurrent="0" - disable concurrent editing; changes by others will be shown after a page reload. • concurrent="1" - enable concurrent editing; changes by others will show up while editing TWiki Sheet.

Defines the right-click context menu; set to "false" to disable; set to array of available strings, such as:contextMenu="['row_above', 'row_below', 'col_left', 'col_right', 'remove_row', 'remove_col', '---------', 'undo', 'redo']"

contextMenu="false"

contextMenu="true"

fixedRowsTop

Fixed number of rows shown on top; takes effect if height parameter is used

fixedRowsTop="1"

(none)

fixedColumnsLeft

Fixed number of columns shown on the left; takes effect if width parameter is used

fixedColumnsLeft="2"

(none)

formulas

Formula support; set to "false" to disable spreadsheet calculations in table cells, such as: =SUM(A1:A8)

formulas="false"

formulas="true"

maxCols

Maximum number of columns

maxCols="10"

(unlimited)

maxRows

Maximum number of rows

maxRows="1000"

(unlimited)

minSpareCols

When set to 1 (or more), automatically add a new column at the right if there are no more empty columns

minSpareCols="1"

minSpareCols="0"

minSpareRows

When set to 1 (or more), automatically add a new row at the bottom if there are no more empty rows

minSpareRows="1"

minSpareRows="0"

wordWrap

Word wrap; set to "false" to disable cell content wrapping if it does not fit in the fixed column width