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