summaryrefslogtreecommitdiff
path: root/etc
authoralwin <alwin>2005-03-21 14:44:12 (UTC)
committer alwin <alwin>2005-03-21 14:44:12 (UTC)
commit54544753b85aed7e6406c728d47640c389b7d755 (patch) (unidiff)
tree12969359ca3a26de232520eddcd038af2ad4cd69 /etc
parentf196df5163669bae8bdc9e70c1500b278fc49e6d (diff)
downloadopie-54544753b85aed7e6406c728d47640c389b7d755.zip
opie-54544753b85aed7e6406c728d47640c389b7d755.tar.gz
opie-54544753b85aed7e6406c728d47640c389b7d755.tar.bz2
more doc
Diffstat (limited to 'etc') (more/less context) (ignore whitespace changes)
-rw-r--r--etc/nationaldays/README31
1 files changed, 28 insertions, 3 deletions
diff --git a/etc/nationaldays/README b/etc/nationaldays/README
index a65236f..71af75b 100644
--- a/etc/nationaldays/README
+++ b/etc/nationaldays/README
@@ -1,23 +1,48 @@
1Config files for the nationalholiday plugin 1Config files for the nationalholiday plugin
2 2
3Format is simple: 3Format is simple:
4Standard-xml file. 4Standard-xml file.
5It must always enclosed by 5It must always enclosed by
6<nationaldays> 6<nationaldays>
7... 7...
8</nationaldays> 8</nationaldays>
9 9
10then a short description tag. 10then a short description tag.
11<description value="german holidays"/> 11<description value="german holidays"/>
12 12
13for example. It should be used later on. 13for example. It should be used later on.
14 14
15then a list of non-floating holidays follows, encapsulated with 15then a list of holidays follows, encapsulated with
16<entries> 16<entries>
17... 17...
18</entries> 18</entries>
19 19
20Each entry has the form 20A non-floating holiday entry has the form
21<entry date="M-D" name="description of holiday"/> 21<entry date="M-D" name="description of holiday"/>
22 22
23floating holidays are not supported this moment. 23floating holidays:
24<entry name="<name>" type="floating">
25<calculation>
26 ... calc entries ..
27</calculation>
28</entry>
29
30The calcentries may following tags:
31
32date - a short date (without Year!) in form M-D or the string "easter"
33offset - integer. these days will added (or substracted) after all other calcs are made.
34weekday - the day of week as monday, tuesday and so on.
35dayofmoth - in combination with weekday you can say "first <weekday> of ..." or "second <weekday> of ..."
36month - monthname(!) eg. january, february and so on.
37datedep - dependy to "date", may "before" or "after".
38
39example:
40<calculation>
41 <weekday value="sunday"/>
42 <datedep value="before"/>
43 <date value="12-24"/>
44</calculation>
45
46these will calculate sunday before christmaseve or christmas eve itself if it is a sunday.
47
48see german.xml for futher examples.