Attribute |
Comment |
Default / Example |
Behavior |
allowvarsininclude |
allows you to use TWiki variables within INCLUDE statement parameters of your source topics (disabled by default for a fast INCLUDE handling) |
allowvarsininclude="off" |
compatmode |
if set to "1" all TWiki:Plugins.CalendarPlugin event types are supported (related: compatmodeicon) |
compatmode="0" |
daynames |
custom daynames (a list separated by a '¦' and starting on Monday; overrides lang attribute) |
daynames="M¦T¦W¦T¦F¦S¦S" |
days |
number of days to show |
days="30" |
enablepubholidays |
enables/disables public holidays (bullet list entries with a @all in a person field; related: showpubholidays, pubholidayicon) |
enablepubholidays="1" |
lang |
language (related: daynames, monthnames); allows a comma separted list of languages and the first is the default, e.g. lang="English,Deutsch" allows entry definitions like * 17 June 2009 - Test-en and * 17. Juni 2009 - Test-de |
lang="English" |
month |
set a month (e.g. Jan, Feb ... or 01, 02, ... 12 ) or a month offset (e.g. +0, +1, -2,...) Note: If you use this month attribute the days attribute will be ignored (days will be set to the duration of the month). |
month="+1" |
monthnames |
custom month names (a list separated by '¦' and starting on January; overrides lang attribute) |
monthnames="J¦F¦M¦A¦M¦J¦J¦A¦S¦O¦N¦D" |
namepos |
allows you to change the position of the names; allowed values: left, right, both |
namepos="left" |
navdays |
defines the days to navigate to (default: value of the days attribute) |
navdays="30" |
order |
changes the sorting order of entries and contains a comma separated list of names or special tags (default: alphanumerical order); hint: order attribute can also be used as a filter: show only listed persons (e.g. order="Bob,Bill" ); specials: [:ralpha:] - sort persons reverse alphanumerical; [:nextfirst:] - next person with an entry will be shown first; [:rest:] - will be replaced by missing persons if order contains an uncomplete person list (e.g. order="Bob,Bill,[:rest:]" ); [:num:] ([:rnum]) - (reverse) numerical order |
undefined / order="Bob,Bill,Alice,Jane,[:rest:]" |
removeatwork |
set to "1" to remove persons without calendar entries from table |
removeatwork="0" |
showmonthheader |
enables/disables month header |
showmonthheader="1" |
showoptions |
shows a navigation form |
showoptions="0" |
showpubholidays |
shows public holidays as separate lines (rows) in table (related: enablepubholidays, pubholidayicon) |
showpubholidays="0" |
showstatcol |
enables/disables statistics column(s) |
showstatcol="off" |
showstatrow |
enables/disables statistics row(s) |
showstatrow="off" |
showstatsum |
enables/disables statistics summary below/behind the statistics columns/rows; works only in conjunction with showstatcol and/or showstatrow |
showstatsum="on" |
showweekends |
shows weekends if set to 1 |
showweekends="0" |
showwnheader |
enables/disables week number header (related: wnheaderformat, wnheadertitle); only ISO/European week numbers are supported (week starts with Monday) |
showwnheader="off" |
startdate |
a start date (e.g. '1 Oct 2005') or a day offset (e.g. '10', '+30' or '-30') |
startdate="+0" |
topic |
a comma separated list of source topics |
topic="%TOPIC%" |
week |
set a week (1..52) or a week offset (-1, +0, +1, +2, ...) |
week="+0" |
year |
set a year (e.g. 2005, 2006 ...) or a year offset (e.g. +0, +1, -1, ...) |
year="0" |
Icons |
adayofficon |
a day off icon |
adayofficon=":ok:" |
compatmodeicon |
icon used for TWiki:Plugins.CalendarPlugin event types (only used if compatmode is enabled) |
compatmodeicon="8-)" |
holidayicon |
holiday icon |
holidayicon="8-)" |
notatworkicon |
not at work icon (only used if you type a location) |
notatworkicon=":-I" |
pubholidayicon |
public holiday icon (related: enablepubholidays, showpubholidays) |
pubholidayicon=":-)" |
workicon |
in work icon |
workicon=" " |
Table Formatting |
border |
table border |
border="1" |
cellpadding |
table cell padding |
cellpadding="1" |
cellspacing |
tabel cell spacing |
cellspacing="0" |
daynames |
custom daynames (a list separated by a '¦' and starting on Monday; overrides lang attribute) |
daynames="M¦T¦W¦T¦F¦S¦S" |
headerformat |
table header format of a day; a subset of strftime conversion specifiers is supported (only date not time specificiers; see manual page or TWiki:Codev.ConvergeDateTimeFormattingModels ) |
headerformat="<font size=\"-2\">%a<br/>%e</font>" |
lang |
language (related: daynames, monthnames); allows a comma separted list of languages and the first is the default, e.g. lang="English,Deutsch" allows entry definitions like * 17 June 2009 - Test-en and * 17. Juni 2009 - Test-de |
lang="English" |
maxheight |
maximum table height |
undefined / maxheight="200px" |
monthheaderformat |
month header format (related: showmonthheader) |
monthheaderformat="%b" |
monthnames |
custom month names (a list separated by '¦' and starting on January; overrides lang attribute) |
monthnames="J¦F¦M¦A¦M¦J¦J¦A¦S¦O¦N¦D" |
name |
header content of the first cell header |
name="Name" |
namecolors |
a comma separated list of names with own colors, e.g. namecolors="Mary:red,Bob:lightblue" |
undefined / namecolors="Bill:yellow" |
navdays |
defines the days to navigate to (default: value of the days attribute) |
navdays="30" |
navenable |
enables/disables navigation (1 - enabled; 0 - disabled) |
navenable="1" |
navhome |
navigation button to the start date (%d will be replaced with page x days) |
navhome="%d" |
navhometitle |
title text (tooltip text) for the navigation button to the start date |
navhometitle="Go to the start date" |
navnext |
navigation button to the next navdays days |
navnext=">¦" |
navnexthalf |
navigation button to the next navdays/2 days |
navnexthalf=">" |
navnexthalftitle |
title text (tooltip text) for the navigation button to the next navdays/2 days (%n will be replaced with the half number of days to show) |
navnexttitle="Next %n day(s)" |
navnexttitle |
title text (tooltip text) for the navigation button to the next navdays days (%n will be replaced with the number of days to show) |
navnexttitle="Next %n day(s)" |
navprev |
navigation button to the previous navdays days |
navprev="<br/>¦<" |
navprevhalf |
navigation button to the previous navdays/2 days |
navprevhalf="<" |
navprevhalftitle |
title text (tooltip text) for the navigation button to the previous navdays/2 days (%n will be replaced with the half number of days to show) |
navprevtitle="Previous %n day(s)" |
navprevtitle |
title text (tooltip text) for the navigation button to the previous navdays days (%n will be replaced with the number of days to show) |
navprevtitle="Previous %n day(s)" |
nwidth |
cell width of the first column |
nwidth="120px" |
optionspos |
position of the navigation form; allowed values: top, bottom, both |
optionspos="bottom" |
optionsformat |
defines the output format of the navigation form; some variables are available: %(WEEK|MONTH|YEAR)SEL(<range>) - a week|month|year popup menu; %(STARTDATE|WEEK|MONTH|YEAR)OFFS(<range>) - a day|week|month|year offset popup menu; %(STARTDATE|WEEK|MONTH|YEAR)(<default value>) - a startdate|week|month|year input field; %BUTTON(<submit button text>) - a submit button; ranges are optional (range syntax: <start value>(:<end value>(:<steps>)?)? , e.g. %YEARSEL(2002:2010:1) |
optionsformat="Month: %MONTHSEL, Year: %YEARSEL %BUTTON(Change)" |
rowcolors |
a comma separated list of background colors used for entries; the color count is not limited |
rowcolors="#ffffff,#f0f0f0" |
tablebgcolor |
table background color |
tablebgcolor="white" |
tablecaption |
table caption |
tablecaption=" " |
tablecaptionalign |
table caption alignment (top, bottom, left, right) |
tablecaptionalign="top" |
tableheadercolor |
color of the table header |
tableheadercolor="%WEBBGCOLOR%" |
tcwidth |
width of the icon table cells |
tcwidth="33px" |
todaybgcolor |
background color for today cells (usefull if you use startdate attribute) |
todaybgcolor="white" |
todayfgcolor |
foreground color for today cells (usefull for a dark todaybgcolor) |
todayfgcolor="black" |
weekendbgcolor |
background color of weekend header and data table cells |
weekendbgcolor="%WEBBGCOLOR%" |
width |
width of table in pixels or percent |
width="100%" |
wnheaderformat |
week number header format |
wnheaderformat="<font size=\"-2\">%V</font>" |
wnheadertitle |
week number header title |
wnheadertitle="Week Number" |
Table Formatting - Statistics ( showstatcol or showstatrow should be enabled) |
statcolformat |
statistics column format (related: showstatcol, statcolheader, statcoltitle); see Statistics Column/Row Format/Title section |
statcolformat="%{hh}" -or- statcolofrmat="%{h}" (if showweekends set to "on" ) |
statcolheader |
statistics header (related: showstatcol, statcolformat, statcoltitle); use '|' to separate multiple column headers |
statcolheader="#" |
statcoltitle |
statistics tooltip (related: showstatcol, statcolformat, statcolheader); see Statistics Column/Row Format/Title section |
statcoltitle="%{ll}" -or- statcoltitle="%{l}" (if showweekends set to "on" ) |
statformat |
statistics format; overrides statcolformat and statrowformat |
undefined / statformat="%{hh}" |
statformat_0 |
defines the string for the zero value of all statistics variables; Statistics Column/Row Format/Title section |
statformat_0="0" |
statformat_i |
format for a single %{i} variable value; %ICON will be substituted by the icon; see Statistics Column/Row Format/Title section |
statformat_i="%{i:%ICON} x %ICON ;" |
statformat_ii |
format for a single %{ii} variable value; %ICON will be substituted by the icon; see Statistics Column/Row Format/Title section |
statformat_ii="%{ii:%ICON} x %ICON ;" |
statformat_l |
format for a single %{l} variable value; %LOCATION will be substituted by the location; see Statistics Column/Row Format/Title section |
statformat_l="%{l:%LOCATION} x %LOCATION;" |
statformat_ll |
format for a single %{ll} variable value; %LOCATION will be substituted by the location; see Statistics Column/Row Format/Title section |
statformat_ll="%{ll:%LOCATION} x %LOCATION;" |
statformat_perc |
percentage format |
statformat_perc="%3.1f%%" |
statformat_unknown |
will be used for unknown locations or icons if one of the statistics variables %{l}, %{ll}, %{i} or %{ii}) is replaced |
statformat_unknown="unknown" |
statheader |
statistics header; overrides statcolheader and statrowheader |
undefined / statheader="#" |
statrowformat |
statistics row format (related: showstatrow, statrowheader, statrowtitle); see Statistics Column/Row Format/Title section |
statrowformat="%{hh}" -or- statrowformat="%{h}" (if showweekends set to "on" ) |
statrowheader |
statistics header (related: showstatrow, statrowformat, statrowtitle); use '|' to separate multiple row headers |
statrowheader="#" |
statrowtitle |
statistics tooltip (related: showstatrow, statrowformat, statrowheader); see Statistics Column/Row Format/Title section |
statrowtitle="%{ll}" -or- statrowtitle="%{l}" (if showweekends set to "on" ) |
stattitle |
statistics tooltip; overrides statrowtitle and statcoltitle |
undefined / stattitle="%{ll}" |
Substituted Statistics Variables |
Variable |
Description |
Counters |
%{d} |
number of days |
%{dd} |
number of days without weekends |
%{h} |
number of days in holidays |
%{hh} |
number of days in holidays without weekends and public holidays |
%{i} |
all icons and icon counts; use statformat_i to format an entry |
%{i:ICON} |
count of ICON icons |
%{ii} |
all icons and icon counts without weekends and public holidays; use statformat_ii to format an entry |
%{ii:ICON} |
count of ICON icons without weekends and public holidays |
%{l} |
all locations and location counts; use statformat_l to format an entry |
%{l:LOCATION} |
location count of LOCATION |
%{ll} |
all locations and location counts without weekends and publich holidays; use statformat_ll to fromat an entry |
%{ll:LOCATION} |
location count of LOCATION without weekends and public holidays |
%{p} |
day count of public holidays |
%{pp} |
day count of public holidays without weekends |
%{w} |
= %{d} - %{h} (day count at work) |
%{ww} |
= %{dd} - %{hh} (day count at work without weekends and public holidays) |
Percentages (value format attribute: statformat_perc) |
%{hd}, %{hdd}, %{hhd}, %{hhdd} |
holidays-to-days percentage with ('h'/'d') or without weekends and public holidays ('hh'/'dd') |
%{id:ICON}, %{idd:ICON}, %{iid:ICON}, %{iidd:ICON} |
icon-to-days percentage with ('i'/'d') or without weekends and public holidays ('ii'/'dd') |
%{ih:ICON}, %{ihh:ICON}, %{iih:ICON}, %{iihh:ICON} |
icon-to-holidays percentage with ('i'/'h') or without weekends and public holidays ('ii'/'dd') |
%{ld:LOCATION}, %{ldd:LOCATION}, %{lld:LOCATION}, %{lldd:LOCATION} |
location-to-days percentage with ('l'/'d') or without weekends and public holidays ('ll'/'dd') |
%{lh:LOCATION}, %{lhh:LOCATION}, %{llh:LOCATION}, %{llhh:LOCATION} |
location-to-holidays percentage with ('l'/'h') or without weekends and public holidays ('ll'/'hh') |
%{pd}, %{pdd}, %{ppd}, %{ppdd} |
public holidays-to-days percentage with ('p'/'d') or without weekends ('pp'/'dd') |
%{wd}, %{wdd}, %{wwd}, %{wwdd} |
working days-to-days percentage with ('w'/'d') or without weekends ('ww'/'dd') |
Plugin Author: |
TWiki:Main.PeterJones , TWiki:Main.DanielRohde |
Plugin Version: |
v1.032 (23 Aug 2010) |
Change History: |
<-- versions below in reverse order --> |
v1.032 (23 Aug 2010) |
TWiki:Main.DanielRohde : fixed TWiki 5 problems |
v1.031 (19 Aug 2010) |
TWiki:Main.DanielRohde : added week number header feature requested by Frank Olzog; fixed week number bug (week number should not be 0); added multiplier feature for statistics rows/columns requested by Oliver Stund; fixed TWiki 5.0 problems reported by Jean-Francois Macaud and TWiki:Main.ThomasBAndersen |
v1.030 (24 Nov 2009) |
TWiki:Main.DanielRohde : improved INCLUDE support requested by Foswiki:Main.IngoKappler; added multi language support for entry definitions; fixed unknown language bug; fixed performance issue reported by Foswiki:Main.IngoKappler (thx Foswiki:Main.MichaelDaum) |
v1.029 (6 Mar 2009) |
TWiki:Main.DanielRohde : changed some defaults (showmonthheader, monthheaderformat, headerformat); fixed alignments (statistics, monthheader); added maxheight attribute; allowed color definitions in icon fields |
v1.026 (28 Oct 2008) |
TWiki:Main.DanielRohde : added missing anchor in showoptions form action; added row color feature (new attributes: namecolors, rowcolors); added order feature (new attribute: order); added namepos attribute (place names left and/or right of a row) |
v1.025 (17 Oct 2008) |
TWiki:Main.DanielRohde : added div tag with style overflow:auto requested by Matthew Thomson; added query parameters feature (hlp_<attribute> in URIs); added option form feature (new attributes: showoptions, optionspos, optionsformat) requested by Matthew Thomson; improved performance; fixed minor icon related bugs |
v1.024 (29 Jul 2008) |
TWiki:Main.DanielRohde : added statistics feature requested by TWiki:Main.GarySprague |
v1.023 (19 Jan 2008) |
TWiki:Main.KennethLavrsen : fixed Item5190 - does not like whitespace after the smiley. This makes the plugin work with TWiki 4.2.0 and Wysiwyg |
v1.022 (18 Jun 2007) |
TWiki:Main.DanielRohde : added documentation requested by TWiki:Main.PeterThoeny ; fixed type (on=off bug) |
v1.021 (20 Apr 2007) |
TWiki:Main.DanielRohde : fixed minor HTML bug reported by TWiki:Main.JfMacaud ; added month header feature (showmonthheader attribute) requested by Rikard Johansson; fixed some minor bugs (documentation, preferences handling); |
v1.020 (21 Sep 2006) |
TWiki:Main.DanielRohde : added week attribute requested by TWiki:Main.JanFilipsky ; added tooltip to day headers; |
v1.019 (7 Aug 2006) |
TWiki:Main.DanielRohde : improved navigation; fixed %ICON% tag handling bug reported by TWiki:Main.UlfJastrow ; |
v1.018 (25 Jul 2006) |
TWiki:Main.DanielRohde : fixed periodic event bug; added navigation feature |
v1.017 (31 May 2006) |
TWiki:Main.DanielRohde : fixed minor bug (periodic repeater) |
v1.016 (27 Apr 2006) |
TWiki:Main.DanielRohde : fixed some major bugs: deep recursion bug reported by TWiki:Main.ChrisHausen ; exception handling bug (concerns Dakar) |
v1.015 (9 Feb 2006) |
TWiki:Main.DanielRohde : added class attribute (holidaylistPluginTable) to table tag for stylesheet support (thanx TWiki:Main.HaraldJoerg and TWiki:Main.ArthurClemens ); fixed mod_perl preload bug (removed 'use warnings;') reported by TWiki:Main.KennethLavrsen |
v1.014 (23 Jan 2006) |
TWiki:Main.DanielRohde : incorporated documentation fixes by TWiki:Main.KennethLavrsen (Bugs:Item1440) |
v1.013 (8 Nov 2005) |
TWiki:Main.DanielRohde : added Perl strict pragma; |
v1.012 (5 Sep 2005): |
TWiki:Main.DanielRohde : added public holiday support requested by TWiki:Main.IlltudDaniel ; improved documentation; improved forced link handling in alt/title attributes of img tags; fixed documentation bug reported by TWiki:Main.FranzJosefSilli |
v1.011 (11 Jul 2005): |
TWiki:Main.DanielRohde : improved performance; fixed major periodic repeater bug; added parameter check; fixed flag parameter handling; allowed language specific month and day names for entries; fixed minor repeater bugs; added new attributes: monthnames, daynames, width, unknownparamsmsg |
v1.010 (5 Jul 2005): |
TWiki:Main.DanielRohde : added exception handling; added compatibility mode (new attributes: compatmode, compatmodeicon) with full CalendarPlugin event type support; added documentation |
v1.009 (29 Jun 2005): |
TWiki:Main.DanielRohde : fixed major bug (WikiNames and forced links in names) reported by TWiki:Main.KennethLavrsen ; fixed documentation bugs; added INCLUDE expansion (for topics in topic attribute value); added name rendering |
v1.008 (23 Jun 2005): |
TWiki:Main.DanielRohde : added new attributes (nwidth,tcwidth,removeatwork,tablecaptionalign,headerformat); performance fixes; allowed digits in month attribute |
v1.007 (17 Jun 2005): |
TWiki:Main.DanielRohde : personal icon support; new attributes (month,year); icon tooltips with dates/person/location/icon; fixed '-' bug |
v1.006 (16 Jun 2005): |
TWiki:Main.DanielRohde : added new features (location support; today(fg/bg)color) |
v1.005 (16 Jun 2005): |
TWiki:Main.DanielRohde : added new features (start date support; weekendbgcolor); fixed documentation bugs; |
v1.004 (14 Jun 2005): |
TWiki:Main.DanielRohde : some performance improvements; code cleanup; documentation |
v1.003 (13 Jun 2005): |
TWiki:Main.DanielRohde : fix plugin preference handling; rename some subroutines |
v1.002 (13 Jun 2005): |
TWiki:Main.DanielRohde : renders some options; fixes some documentation bugs and a white space bug |
v1.001 (10 Jun 2005): |
TWiki:Main.DanielRohde : A complete reimplementation with many bug fixes and some new features. |
v1.021 (01 Jun 2005): |
TWiki:Main.PeterJones : Initial version |
CPAN Dependencies: |
required: CPAN:Date::Calc |
Other Dependencies: |
SmiliesPlugin |
Perl Version: |
5.0 and up |
TWiki:Plugins/Benchmark : |
GoodStyle 94%, FormattedSearch 98%, HolidaylistPlugin 86% |
Plugin Home: |
http://TWiki.org/cgi-bin/view/Plugins/HolidaylistPlugin |
Feedback: |
http://TWiki.org/cgi-bin/view/Plugins/HolidaylistPluginDev |
Appraisal: |
http://TWiki.org/cgi-bin/view/Plugins/HolidaylistPluginAppraisal |