summaryrefslogtreecommitdiff
path: root/etc/nationaldays/README
Unidiff
Diffstat (limited to 'etc/nationaldays/README') (more/less context) (ignore whitespace changes)
-rw-r--r--etc/nationaldays/README58
1 files changed, 32 insertions, 26 deletions
diff --git a/etc/nationaldays/README b/etc/nationaldays/README
index 71af75b..6a1cbb5 100644
--- a/etc/nationaldays/README
+++ b/etc/nationaldays/README
@@ -1,48 +1,54 @@
1Config files for the nationalholiday plugin 1Entry files for the nationalholiday plugin
2 2
3Format is simple: 3The format is simple. It is a standard xml file. So all tags must closed. A
4Standard-xml file. 4handy tool for checking closed tags is the xmllint utility provided by
5It must always enclosed by 5libxml2.
6
7Each xml file is enclosed by:
6<nationaldays> 8<nationaldays>
7... 9...
8</nationaldays> 10</nationaldays>
9 11
10then a short description tag. 12Each <nationaldays> tag should be follwed by a short description tag:
11<description value="german holidays"/> 13<description value="german holidays"/>
12 14
13for example. It should be used later on. 15The description will probably be used later on. Follow the description with
14 16the <entries> enclosure:
15then a list of holidays follows, encapsulated with
16<entries> 17<entries>
17... 18...
18</entries> 19</entries>
19 20
20A non-floating holiday entry has the form 21Insert your holidays in either fixed or floating format. A fixed holiday entry
21<entry date="M-D" name="description of holiday"/> 22has the form:
23<entry name="description of holiday" date="M-D" />
22 24
23floating holidays: 25A floating holiday entry has the form:
24<entry name="<name>" type="floating"> 26<entry name="<name>" type="floating">
25<calculation> 27 <calculation>
26 ... calc entries .. 28 ... calc entries ..
27</calculation> 29 </calculation>
28</entry> 30</entry>
29 31
30The calcentries may following tags: 32The calc entries may have the following tags:
31 33date - A short date (without Year!) in the form M-D or the special string
32date - a short date (without Year!) in form M-D or the string "easter" 34 "easter"
33offset - integer. these days will added (or substracted) after all other calcs are made. 35offset - A signed integer. This will added (or substracted) after all other
34weekday - the day of week as monday, tuesday and so on. 36 calculations are made.
35dayofmoth - in combination with weekday you can say "first <weekday> of ..." or "second <weekday> of ..." 37weekday - The day of week as in "monday', "tuesday", "wednesday", "thursday",
36month - monthname(!) eg. january, february and so on. 38 "friday", "saturday" or "sunday".
37datedep - dependy to "date", may "before" or "after". 39dayofmonth - Used in combination with weekday tag. You can use "first",
38 40 "second", "third", "fourth" or "last".
39example: 41month - Used in combination with weekday and/or dayofmonth eg. "january",
42 "february" and so on.
43datedep - Used in combination with date and/or weekday, may "before" or "after".
44
45example calculation entry:
40<calculation> 46<calculation>
41 <weekday value="sunday"/> 47 <weekday value="sunday"/>
42 <datedep value="before"/> 48 <datedep value="before"/>
43 <date value="12-24"/> 49 <date value="12-24"/>
44</calculation> 50</calculation>
45 51
46these will calculate sunday before christmaseve or christmas eve itself if it is a sunday. 52this will calculate sunday before christmas eve or christmas eve itself if it is a sunday.
47 53
48see german.xml for futher examples. 54see german.xml or any of the .xml files in this directory for futher examples.