TWiki Variables » Search » Category: Editing & Content Update

Variables in this category:

BUBBLESIG -- show bubble box and user signature with profile picture icon

  • Syntax: %BUBBLESIG{WikiName}% or %BUBBLESIG{WikiName - YYYY-MM-DD}%
  • The parameter can be either just the WikiName of a user, or by convention the WikiName followed by a dash and the date
  • Example:
    -- %BUBBLESIG{TWikiGuest - 2024-11-21}%
  • Expands to:
    -- TWiki Guest - 2024-11-21
  • Category: EditingAndContentUpdateVariables, FormattingAndRenderingVariables, UsersAndAuthenticationVariables
  • Related: USERREPORT, USERSIG, UserList, UserReports (this topic)

COLORPICKER{} -- color picker for use in HTML forms for TWiki applications

  • The %COLORPICKER{}% variable is handled by the ColorPickerPlugin.
  • Syntax: %COLORPICKER{ name="..." value="..." }%
  • Parameters:
Parameter Description Default Example
name Name of input field (required) name="text_color"
value Initial color value, in hexadecimal notation for the combination of Red, Green, and Blue color values (RGB). (none) value="#0000ff"
size Size of input field (browser default) size="12"
class CSS class of input field (none) class="twikiInputField"
Additional parameters can be supplied; they will be added to the HTML input field.

COMMENT{ attributes } -- insert an edit box into the topic to easily add comments.

  • A %COMMENT% without parameters shows a simple text box.
  • A %COMMENT{}% can handle the following parameters:
Parameter Description Default
type 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. "below"
default Default text to put into the textarea of the prompt.  
target Name of the topic to add the comment to the current topic
location Regular expression specifying the comment location in the target topic. Read carefully the CommentPlugin documentation!  
mode For compatibility with older versions only, synonymous with type  
nonotify Set to "on" to disable change notification for target topics "off"
noform 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;".  

DATEPICKER{} -- pop-up calendar to select a date for use in HTML forms

  • The %DATEPICKER{}% variable is handled by the DatePickerPlugin.
  • Syntax: %DATEPICKER{ name="..." value="..." }%
  • Parameters:
Parameter Description Default Example
name Name of input field.
φ: No output is shown if the name parameter is missing, but the CSS and Javascript are loaded. 		(requiredφ) name="Start"
value Initial date value. "" (today) value="2012-12-31"
format Format of resulting date value.
• %a - abbreviated weekday name
• %A - full weekday name
• %b - abbreviated month name
• %B - full month name
• %C - century number
• %d - the day of the month (00 ... 31)
• %e - the day of the month (0 ... 31)
• %H - hour (00 ... 23)
• %I - hour (01 ... 12)
• %j - day of the year ( 000 ... 366)
• %k - hour (0 ... 23)
• %l - hour (1 ... 12)
• %m - month (01 ... 12)
• %M - minute (00 ... 59)
• %n - a newline character
• %p - "PM" or "AM"
• %P - "pm" or "am"
• %S - second (00 ... 59)
• %s - number of seconds since Epoch (since Jan 01 1970 00:00:00 UTC)
• %t - a tab character
• %U, %W, %V - the week number. The week 01 is the week that has the Thursday in the current year, which is equivalent to the week that contains the fourth day of January. Weeks start on Monday.
• %u - the day of the week (1 ... 7, 1 = MON)
• %w - the day of the week (0 ... 6, 0 = SUN)
• %y - year without the century (00 ... 99)
• %Y - year including the century (ex. 2012)
• %% - a literal % character 		"%Y-%m-%d" format="%e %b %Y"
id ID of input field, optional. "id_" + name id="idStart"
size Size of input field, in number of characters. (calculated as needed) size="12"
class CSS class of input field. "twikiInputField" class="dateField"
Additional HTML input field attributes, such as alt, disabled, maxlength, onblur, onchange, onfocus, readonly, style, tabindex, title    

EDITACTION -- select an edit template

  • EDITACTION defined in a topic or preference setting will define the use of an editaction template instead of the standard edit. If EDITACTION is defined as text, then hide the form. If EDITACTION is defined as form hide the normal text area and only edit the form.
  • Syntax: %EDITACTION% (returning either text or form)
  • Expands to: %EDITACTION%
  • Note: When EDITACTION is defined as text or form the Edit and Edit Raw buttons simply add ;action=text or ;action=form to the URL for the edit script. If you have defined EDITACTION in a topic setting or preference setting you can still edit the topic content or the form by removing the ;action=form or ;action=text from the edit URL in the browser and reload.
  • Category: AdministrationVariables, EditingAndContentUpdateVariables, SkinsAndTemplatesVariables
  • Related: TWikiScripts#edit (this topic)

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
    • %EDITFORMFIELD{"fieldname" type="..."}% - create an HTML input field
  • Supported parameters:
Parameter: Description: Default:
"fieldname" The name of a TWiki form field or HTML form field. Required
form="..." Name of form template topic, such as "BugForm". Specify topic name or Web.TopicName Either form or topic
is required unless
type is specified
topic="..." Name of topic containing form, such as "Bug1234". Specify topic name or Web.TopicName
format="..." Format string. 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.
See details in TWikiForms#FormFieldTypes. This parameter is ignored if type="..." is specified. 		"$inputfield"
value="..." Initial value of input field. If omitted and if topic="..." is specified, the value is taken from the named form field. ""
type="start" Special case: Start an HTML form. Parameters:
"form" type="start" action="save" topic="..." method=""
• action: Specify a TWiki script (view, edit, save, ...), or a full action URL, default "view".
• topic: Specify topic name or Web.TopicName, default current topic; ignored if full action URL is provided.
• method: HTML form action method, default "post" for save action, else "get". 		""
type="end" Special case: End an HTML form. Parameters:
"form" type="end" 		""
type="..." Special case: Create an input field regardless of the type defined in the TWikiForm. Used mainly for hidden fields and submit button. The nameless parameter is the field name. Supported types:
• "fieldname" type="hidden" value="..." - hidden input field.
• "fieldname" type="submit" value="..." - submit button, value is button label.
• "fieldname" type="button" value="..." onclick="..." - regular button, value is button label.
• "fieldname" type="text" value="..." size="80" - text input field.
• "fieldname" type="checkbox" value="..." text="..." - checkbox, text is display text.
• "fieldname" type="radio" value="..." text="..." - radio button, text is display text.
• In addition, any valid XHML and HTML5 input type is supported, such as type="date", type="file", type="image".
Additional type-specific parameters can be supplied, such as alt="", checked="checked", class="", max="", min="", src="", style="", width="". Consult HTML documentation. 		""

EDITTABLE{ attributes } -- edit TWiki tables using edit fields and other input fields

  • The %EDITTABLE{}% variable is handled by the EditTablePlugin
  • Syntax: %EDITTABLE{ attributes }%

  • Supported attributes:
Attribute Comment Default
header Specify the header format of a new table like "|*Food*|*Drink*|". Useful to start a table with only a button (no header)
format The format of one column when editing the table. A cell can be a text input field, or any of these edit field types:
• Text input field (1 line):
  | text, <size>, <initial value> |
• Textarea input field:
  | textarea, <rows>x<columns>, <initial value> |
• Drop down box:
  | select, <size>, <option 1>, <option 2>, etc* |
  * only one item can be selected
• Radio buttons:
  | radio, <size*>, <option 1>, <option 2>, etc |
  * size indicates the number of buttons per line in edit mode
• Checkboxes:
  | checkbox, <size*>, <option 1>, <option 2>, etc |
  * size indicates the number of checkboxes per line in edit mode
• Fixed label:
  | label, 0, <label text> |
• Row number:
  | row, <offset> |
• Date:
  | date, <size>, <initial value>, <DHTML date format*> |
  * see Date Field Type 		"text, 16"
for all cells
changerows 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. (none)

USERSIG -- show user signature with profile picture icon

Total: 8 variables

Categories: Administration, Applications & Components, Attachments & Files, Charting & Drawing, Database & Forms, Date & Time, Development, Editing & Content Update, Email & Notification, Export & Publishing, Formatting & Rendering, Import, Linking & Navigation, Searching & Listing, Security & Access Control, Skins & Templates, System Information, Tables & Spreadsheets, UI& Visualization, Users & Authentication, Workflow & Automation

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart