>
> |
| META TOPICPARENT |
name="TWikiVariablesSearch" |
Variables in this category:
CALENDAR -- show a monthly calendar with highlighted events
- Events are defined by bullets, see CalendarPlugin#Event_Syntax for details. The
%CALENDAR{}% variable is handled by the CalendarPlugin.
- Syntax:
%CALENDAR{ parameters }%
- Parameters:
| Parameter | Description | Default | year="yyyy" | The year | Current year | year="+yy" or "-yy" | Relative year | Current year | month="mm" | The month | Current month | month="+mm" or "-mm" | relative month | Current month | gmtoffset="+/-hh" | Timezone expressed as number of hours offset from GMT | Server timezone | topic="TopicName" | Topic containing events | The topic containing the tag | topic="Web.TopicName1, Web.TopicName2" | Topics containing events | The topics containing the tags | web="Webname" | Web containing the event topic | The current web | lang="language" | Language: First few characters of "English", "Francais", "Deutsch", "Espagnol", "Portugues", "Nederlands", "Italiano", "Norsk", "Svenska", "Dansk", "Suomi", "Magyar", "Polski | "English" | daynames="Mon|Tue|..." | Custom day names | "Monday|Tuesday|
Wednesday|Thursday|
Friday|Saturday|
Sunday" | header="..." | Text at the top of the calendar; use $m for current month, $y for year | Current month and year | weekstartsonmonday="1" or "0" | Flag to start week on Monday | "0" (Sunday) | showdatenumbers="0" | Show day numbers 1...31 in date cells. Note that showdatenumbers=1 means that HTML::CalendarMonthSimple will add the date numbers to the cells. If showdatenumbers=0, then the plugin adds the date numbers. The result of this is that a calendar will always show the date numbers. | "0" (except with aslist="1", see below) | showweekdayheaders="1" | Show the weekday headers | "0" | weekdayheadersbig="0" | If enabled, show weekday headers in bold cell headings | "1" | cellalignment="left" | Horizontal cell alignment of day cells: "left", "center", "right", "justify", "char" | "center" | vcellalignment="middle" | Vertical cell alignment of day cells: "top", "middle", "bottom", "baseline" | "top" | cellheight="n" | Height in pixels of each cell in the calendar | Minimum height needed | format="..." | How to highlight a date | See Event Formatting below | width="n" or "n%" | Width of calendar table in pixels or percent | Minimum width needed | sharpborders="n" | If set to 1, this gives very crisp edges between the table cells. If set to 0 standard HTML cells are used. | "1" | border="n" | Border width of calendar table. (sharpborders="0" required) | "1" | cellspacing="n" | Spacing of calendar cells. (sharpborders="0" required) | "0" | cellpadding="n" | Padding of calendar cells. (sharpborders="0" required) | "3" | nowrap="1" or "0" | Prevent cell content from wrapping | "0" | bgcolor="#nnnn" | Default background color of all cells unless redefined by other color settings below (use an HTML color-code like "#000000" as defined in StandardColors) | "white" | contentcolor="#nnnn" | Default content color of all cells unless redefined | "black" | headercolor="#nnnn" | Background color of the Month+Year header | The web bgcolor | headercontentcolor="#nnnn" | Content color of the Month+Year header | contentcolor setting | weekdayheadercolor="#nnnn" | Background color of weekdays' headers | bgcolor setting | weekdayheadercontentcolor=
"#nnnn" | Content color of weekdays' headers | contentcolor setting | weekendheadercolor="#nnnn" | Background color of weekends' headers | bgcolor setting | weekendheadercontentcolor=
"#nnnn" | Content color of weekends' headers | contentcolor setting | weekdaycolor="#nnnn" | Background color of weekday cells | bgcolor setting | weekdaycontentcolor="#nnnn" | Content color of weekday cells | contentcolor setting | weekendcolor="#nnnn" | Background of weekend cells | light gray | weekendcontentcolor="#nnnn" | Content color of weekend cells | contentcolor setting | todaycolor="#nnnn" | Background of today's cell | The web bgcolor | todaycontentcolor="#nnnn" | Content color of today's cell | contentcolor setting | | and other attributes of HTML::CalendarMonthSimple | aslist | Controls whether events displayed in calendar style (aslist=0) or list style (aslist=1). Note that specifying aslist=1 forces showdatenumbers=1. This is done to ensure that the date number is formatted according to datenumberformat and that only the days that have an event are listed. | "0" | days | Specifies how many days of calendar data to list. Only valid if aslist="1". | "1" | months | Specifies how many months of calendars to display. Only valid if aslist="0". | "1" | datenumberformat | Specifies formatting for the date number in each cell. The formatting codes accepted are the same as those for the %GMTIME% variable. | $day (if aslist="0")
* $day $mon $year (if aslist="1") | todaydatenumberformat | Specifies formatting for the date number for the current day (today) in the calendar. The formatting codes accepted are the same as those for the %GMTIME% variable. | datenumberformat | multidayformat | Specifies formatting of the description for multi-day events. See Multi-Day Event Formatting for details. | $description |
- Example:
%CALENDAR{ month="2" year="2025" bgcolor="cyan" }% shows a February 2025 calendar
- Category: DateAndTimeVariables, FormattingAndRenderingVariables
- Related: DATE, DISPLAYTIME, GMTIME{"format"}, SERVERTIME, CalendarPlugin (this topic)
DATE -- signature format date
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)
DISPLAYTIME -- display date and time
DISPLAYTIME{"format"} -- formatted display time
- Formatted time - either GMT or Local server time, depending on {DisplayTimeValues} setting in configure, default
$year-$mo-$day. Same format qualifiers as %GMTIME%
- Syntax:
%DISPLAYTIME{"format"}%
- Supported variables:
$seconds, $minutes, $hours, $day, $wday, $dow, $month, $mo, $year, $ye, $tz, $iso, $rcs, $http, $epoch
- Example:
%DISPLAYTIME{"$hou:$min"}% expands to 01:49
- Category: DateAndTimeVariables, SystemInformationVariables
- Related: DISPLAYTIME, GMTIME, SERVERTIME (this topic)
GMTIME -- GM time
GMTIME{"format"} -- formatted GM time
- Syntax:
%GMTIME{"format"}%
- Supported variables:
| Variable: | Unit: | Example | $seconds | seconds | 59 | $minutes | minutes | 59 | $hours | hours | 23 | $day | day of month | 31 | $wday | day of the Week (Sun, Mon, Tue, Wed, Thu, Fri, Sat) | Thu | $dow | day of the week (Sun = 0) | 2 | $week | number of week in year (ISO 8601) | 34 | $month | short name of month | Dec | $mo | 2 digit month | 12 | $year | 4 digit year | 1999 | $ye | 2 digit year | 99 | $tz | either "GMT" (if set to gmtime),
or offset such as "-0700" (if set to servertime) | GMT | $iso | ISO format timestamp | 2025-04-07T01:49:35Z | $rcs | RCS format timestamp | 2025/04/07 01:49:35 | $http | E-mail & http format timestamp | Mon, 07 Apr 2025 01:49:35 GMT | $epoch | Number of seconds since 00:00 on 1st January, 1970 | 1743990575 |
- Variables can be shortened to 3 characters
- Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% expands to 07 Apr, 2025 - 01:49:35
- Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
- Category: DateAndTimeVariables
- Related: DISPLAYTIME, GMTIME, REVINFO, SERVERTIME (this topic)
SERVERTIME -- server time
SERVERTIME{"format"} -- formatted server time
- Same format qualifiers as
%GMTIME%
- Syntax:
%SERVERTIME{"format"}%
- Supported variables:
$seconds, $minutes, $hours, $day, $wday, $dow, $month, $mo, $year, $ye, $tz, $iso, $rcs, $http, $epoch
- Example:
%SERVERTIME{"$hou:$min"}% expands to 01:49
- Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
- Category: DateAndTimeVariables, SystemInformationVariables
- Related: DISPLAYTIME, GMTIME, SERVERTIME (this topic)
Total: 9 variables
Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart |
Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.