(in work),
(absent for some time),
(not at work; used if you type a location). You can also use other smilies (like :skull:).
Example (image):
* 01 Jul 2005 - JohnExample2: To list that Mary will be away from 3-Sep - 9-Sep 2005
* 03 Sep 2005 - 09 Sep 2005 - MaryExample3: To list that Jill will be in Paris from 10-Sep - 11-Sep 2005 and in Tokyo on 15 Sep 2005
* 10 Sep 2005 - 11 Sep 2005 - Jill - Paris * 15 Sep 2005 - Jill - TokyoExample4: To list that Eve will be ill from 12-Sep - 20-Sep 2005 with her own 'smily'
* 12 Sep 2005 - 20 Sep 2005 - Eve - is ill - :skull:Example5: To list that Lisa will by not at work from April to June and the complete December 2005:
* Apr 2005 - Jun 2005 - Lisa * Dec 2005 - LisaExample6: To list in all time table entries that anybody will be not at work on Christmas Day:
* 25 Dec 2005 - Christmas Day @allExample7: There are several attributes (see Attributes) like
days (defaults to 30days) and tablecaption (defaults to null).
%HOLIDAYLIST{days="90" tablecaption="Planned Holidays"}%
| Entry type | Syntax | Example |
|---|---|---|
| Single entry | * dd MMM yyyy - name |
* 01 Jul 2005 - Jane |
* dd MMM yyyy - name - location |
* 01 Jul 2005 - Sarah - in Paris |
|
* dd MMM yyyy - name - location - icon |
* 01 Jul 2005 - Eve - ill - :skull: |
|
| Interval entry | * dd MMM yyyy - dd MMM yyyy - name |
* 01 Aug 2005 - 22 Aug 2005 - EvaMaria |
* dd MMM yyyy - dd MMM yyyy - name - location |
* 02 Sep 2005 - 10 Sep 2005 - JohnDo - in London |
|
* dd MMM yyyy - dd MMM yyyy - name - location - icon |
* 02 Oct 2005 - 22 Oct 2005 - Fred - is ill - :skull: |
|
* MMM yyyy - name |
* May 2005 - Carl |
|
* MMM yyyy - name - location |
* Jun 2005 - Sam - in Sidney |
|
* MMM yyyy - name - location - icon |
* Nov 2005 - Lisa - is ill for a complete month - :skull: |
|
* MMM yyyy - MMM yyyy - name |
* Jun 2005 - Jul 2005 - Lily |
|
* MMM yyyy - MMM yyyy - name - location |
* Feb 2005 - Apr 2005 - Lisa - is not at work |
|
* MMM yyyy - MMM yyyy - name - location - icon |
* Nov 2005 - Dec 2005 - Lola - is 2 month not at work - :yes: |
|
| Exception | insert the following before the name field and after a date (range): X { dd MMM yyyy, dd MMM yyy - dd MMM yyyy } |
* Dec 2005 X { 5 Dec 2005 - 7 Dec 2005, 12 Dec 2005 } - Sarah - will be away for the complete December except between 5 Dec and 7 Dec and on 12 Dec 2005 |
| Public Holidays | just type '@all' in the name field | * 25 Dec 2005 - Christmas Day @all |
color(<MYCOLOR>), e.g. * 5 Mar 2009 - Green Entry - anywhere - color(green). It is also possible to combine icon and background color, e.g. * 6 Mar 2009 - Red Entry - somewhere - color(red) :skull:.
%HOLIDAYLIST%
<!--
* 24 Dec 2005 - Sam - @home
-->
%HOLIDAYLIST{topic="TimeTableDataTopic" tablecaption="Planned Holidays (see TimeTableDataTopic)"}%
* 25 Dec 2005 - Christmas Day <!--@all-->
| 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 |
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 |
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 |
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 ( |
||
| 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}" |
hlp_<attribute> e.g. https://sprace.org.br/twiki/bin/view/TWiki.HolidaylistPlugin?hlp_startdate=+10#HolidaylistPluginExample
statcolformat=" <column1 format> | <column2 format> | ..."
statcoltitle=" <column1 format> | <column2 format> | ..."
statrowformat=" <row1 format> | <row2 format> | ..."
statrowtitle=" <row1 format> | <row2 format> | ..."
statformat=" <column1/row1 format> | <column2/row2 format> | ..."
stattitle=" <column1/row1 format> | <column2/row2 format> | ..." statcolformat/statrowformat and statcoltitle/statrowtitle, simple use '|' as separator
<column/row? format> definitions (see table below), e.g. statcolformat="%{l}"
statcolheader/statrowheader should have the same number of columns/rows (count of '|' should be equal)
%{l*2:sick} in stat(col|row)(format|title) to count 'sick' entries double; or %{d*0.5} let every day counts as a half day
%HOLIDAYLIST{startdate="21 Jul 2008" showstatcol="on" showstatrow="on" statformat="%{ll:sick} | %{ll:holidays} | %{ww} " statheader="sick | holidays | @work " stattitle="%{lldd:sick}|%{lldd:holidays}|%{wwdd}"}%
* 21 Jul 2008 - Sam - sick
* 23 Jul 2008 - 25 Jul 2008 - Sam - holidays
| 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') |
color(red)
:mad: ):
8-))
%RED% Sorry, some parameters are unknown: %UNKNOWNPARAMSLIST% %ENDCOLOR% <br/> Allowed parameters are (see TWiki.HolidaylistPlugin topic for more details): %KNOWNPARAMSLIST%) :-))
perl -MCPAN -e "install Date::Calc" )
HolidaylistPlugin.zip in your twiki installation directory. Content:
| File: | Description: |
|---|---|
data/TWiki/HolidaylistPlugin.txt |
Plugin topic |
data/TWiki/VarHOLIDAYLIST.txt |
Documentation |
lib/TWiki/Plugins/HolidaylistPlugin.pm |
Plugin Perl module |
pub/TWiki/HolidaylistPlugin/example.gif |
Example image |
| Plugin Author: | TWiki:Main.PeterJones |
| Plugin Version: | v1.032 (23 Aug 2010) |
| Change History: | |
| v1.032 (23 Aug 2010) | TWiki:Main.DanielRohde |
| v1.031 (19 Aug 2010) | TWiki:Main.DanielRohde |
| v1.030 (24 Nov 2009) | TWiki:Main.DanielRohde |
| v1.029 (6 Mar 2009) | TWiki:Main.DanielRohde |
| v1.026 (28 Oct 2008) | TWiki:Main.DanielRohde |
| v1.025 (17 Oct 2008) | TWiki:Main.DanielRohde |
| v1.024 (29 Jul 2008) | TWiki:Main.DanielRohde |
| v1.023 (19 Jan 2008) | TWiki:Main.KennethLavrsen |
| v1.022 (18 Jun 2007) | TWiki:Main.DanielRohde |
| v1.021 (20 Apr 2007) | TWiki:Main.DanielRohde |
| v1.020 (21 Sep 2006) | TWiki:Main.DanielRohde |
| v1.019 (7 Aug 2006) | TWiki:Main.DanielRohde |
| v1.018 (25 Jul 2006) | TWiki:Main.DanielRohde |
| v1.017 (31 May 2006) | TWiki:Main.DanielRohde |
| v1.016 (27 Apr 2006) | TWiki:Main.DanielRohde |
| v1.015 (9 Feb 2006) | TWiki:Main.DanielRohde |
| v1.014 (23 Jan 2006) | TWiki:Main.DanielRohde |
| v1.013 (8 Nov 2005) | TWiki:Main.DanielRohde |
| v1.012 (5 Sep 2005): | TWiki:Main.DanielRohde |
| v1.011 (11 Jul 2005): | TWiki:Main.DanielRohde |
| v1.010 (5 Jul 2005): | TWiki:Main.DanielRohde |
| v1.009 (29 Jun 2005): | TWiki:Main.DanielRohde |
| v1.008 (23 Jun 2005): | TWiki:Main.DanielRohde |
| v1.007 (17 Jun 2005): | TWiki:Main.DanielRohde |
| v1.006 (16 Jun 2005): | TWiki:Main.DanielRohde |
| v1.005 (16 Jun 2005): | TWiki:Main.DanielRohde |
| v1.004 (14 Jun 2005): | TWiki:Main.DanielRohde |
| v1.003 (13 Jun 2005): | TWiki:Main.DanielRohde |
| v1.002 (13 Jun 2005): | TWiki:Main.DanielRohde |
| v1.001 (10 Jun 2005): | TWiki:Main.DanielRohde |
| v1.021 (01 Jun 2005): | TWiki:Main.PeterJones |
| 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 |