> > |
META TOPICPARENT |
name="TWikiVariablesSearch" |
Variables in this category:
BUBBLESIG -- show bubble box and user signature with profile picture icon
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 | Additional parameters can be supplied; they will be added to the HTML input field or the rectangular color block. | class | CSS class of input field or the rectangular color block | (none) | class="twikiInputField" | value | Initial color value, in hexadecimal notation for the combination of Red, Green, and Blue color values (RGB). | (none) | value="#0000ff" | name | Name of input field | (required) | name="text_color" | size | Size of input field, in number of characters | (browser default) | size="8" | style | Style of input field or the rectangular color block | (none) | style="width: 190px; height: 32px" | type | Type of color widget: • "below" - color picker is located below the input field; • "popup" - pop-up a color picker window when clicking the button next to the input field (this uses very little vertical space); • "view" - a read-only rectangular block colored in the color value (no color picker); • "view-hex" - like view , in addition shows the color value as an RGB hexadecimal code (no color picker); | type="below" | type="view-hex" |
- Example:
<form action="..."> %COLORPICKER{ name="text_color" value="#123456" class="twikiInputField" type="popup" }% <form> Renders as:
- Category: ApplicationsAndComponentsVariables, DatabaseAndFormsVariables, EditingAndContentUpdateVariables, FormattingAndRenderingVariables, UIAndVisualizationVariables
- Related: ColorPickerPlugin, TWikiForms (this topic)
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 | | |
- Example:
<form action="..."> %DATEPICKER{ name="Start_Date" }% <form>
- Expands to:
- Category: ApplicationsAndComponentsVariables, DatabaseAndFormsVariables, DateAndTimeVariables, EditingAndContentUpdateVariables, FormattingAndRenderingVariables, UIAndVisualizationVariables
- Related: DatePickerPlugin, TWikiForms (this topic)
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%
|