Changes

Jump to: navigation, search

Calendar tools holidays

1,824 bytes added, 13:07, 21 September 2021
m
no edit summary
Explanation of how to add or change the [[File:Calendar-GraphicalReports-Content-tab-Country for holidays appearing on the output of the calendars in Gramps-default-list-51. This includes the Textpng|thumb|450px|right|Content tab showing "Country for holidays:''Birthday and Anniversary Report'', the Graphical:''Calendar'' Report, and the ''Web Calendar''." option showing "Country for holidays" default list]]
==Details on how to add custom holiday set or change the built-in holiday set appearing on the output of the [[#Calendar Holidays==-based_reports|Calendar-based reports]] in Gramps.
==Custom holiday set==Gramps comes installed with three Calendar-based reports:# Calendar (menu {{man menu|Reports-a default <code>Graphical Reports-holidays.xml</code>Calendar...}} )# Birthday file and Anniversary Report (menu {{man menu|Reports->Text Reports-you can either add more holiday sets to it or create your own custom <code>Birthday and Anniversary Report..holidays.}} )# And an output for the Web (menu {{man menu|Reports->Web Pages-xml</code>Web Calendar...}} )
===Custom holidays.xml===You can create a separate custom <code>holidays.xml</code> file in your personal [[Gramps_{{Version manual}}_Wiki_Manual_-_User_Directory|User directory]] <code>.gramps/plugins/</code> folder. ====Adding your countries holidays====Are your countries holidays missing or incomplete and you would like Gramps to have them by default? If you would like to add your [http://en.wikipedia.org/wiki/Holiday countries holidays] to the calendar, then you can add them to the file <code>holidays.xml.in</code> located:* Gramps 5 or newer: [https://github.com/gramps-project/gramps/blob/master/gramps/plugins/libdata/holidays.xml.in data/holidays.xml.in]  and then raise a feature request and submit your updated file or create a pull request on Github. ====format of holidays. Herexml====In the file <code>holidays.xml.in</code>, you can add recurring annual events in a variety of ways. The format is generally:
<pre>
</pre>
where each of the capitalized words would be filled in with appropriate values, as follows[https://github.com/gramps-project/gramps/blob/master/gramps/plugins/lib/libholiday.py]. All but NAME and VALUE are optionalshown in list of keywords.
====Keywords====The following is a list of keywords to be used when creating or expanding the holidays.xml file see:*[https://github.com/gramps-project/gramps/blob/master/gramps/plugins/lib/libholiday.py /gramps/plugins/lib/libholiday.py]. All but NAME and VALUE are optional. *'''COUNTRYNAME ''' => "United States", "China", etc. You don't have to make these countries, however. You can make these just a "holiday set" which could be "Christian", "Muslim", "Eastern European", etc. These names can be selected from a the {{man label|Country for holidays:}} list option when running calendar-related reports. You can use your own language for this name.*'''NAME ''' => the text to appear on the calendar*'''TYPE ''' => "secular", "religious", "personal", "informational" (This isn't currently used in the calendar, but could be. Use these keywords, untranslated.)*'''EXPRESSION ''' => a python expression that must be true for this to appear on the calendar. You can use y, m, and d variables (for year, month, and day, all integers). See VALUE for examples. *'''VALUE ''' =>
** "YEAR/MONTH/DAY"
*** "2012/12/25"
*** "> dst(y, "eu")[1]" (Daylight Saving Time, "eu", end)
*** "> dow(y, m, d) == 1" (dow returns the iso weekday number, where Monday is 1 and Sunday is 7)
*'''YEAR ''' => "*" or an actual year. "*" means any year.*'''MONTH ''' => "*" or actual month number. "*" means any month.*'''DAY ''' => "*" or actual day number in month. "*" means any day.*'''NUMBER ''' => number of weekday in month. For example, "every 3rd Tuesday in April" would be "*/3/tue/apr". NUMBER can also be negative, which means it is counted from the end of the month. "last Tuesday in April 2007" could be "2007/-1/tue/4"*'''DAYCODE ''' => "mon", "tue", "wed", "thu", "fri", "sat", or "sun". Do not translate these words; use all lowercase.*'''MONCODE ''' =>
** MONTH
** 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug', 'sep', 'oct', 'nov', or 'dec'. (not be translated; use all lowercase)
*'''OFFSET ''' =>
** number (may be negative) that offsets the day determined by VALUE
** DAYCODE (may be negative), the next DAYCODE that is either the same as this day, or the next(+)/prev(-) one.
** "workday" or "weekend" (may be negative) - the next workday/weekend that is on this day, or the next/prev
=== Translations ===
Holiday entries are generally written for a specific country, and thus typically don't need to be written for more than one language. However, it might be appropriate to have your entries country name and holiday text be translated into the language that Gramps is running in. To make a country name or holiday name get translated, simply precede the name of the XML item with an underscore. For example:
In this example, "Jewish Holidays", "Purim", and "Passover" will be looked up in the Gramps gettext system for translations. If you would like to help add those translations, please see [[Translating Gramps]].
==Examples=Example=== The last set ( <country name="Finland"> ) will only load if your country is Finland. It says that Card Night is the last Thursday of every month, every year. Let's play! Filename: holidays.xml
<pre>
</pre>
The last set will only load if your country is Finland==Calendar-based reports==[[File:Calendar-GraphicalReports-Content-tab-50. It says that Card Night is png|thumb|450px|right|Content tab showing "Country for holidays:" option]] Gramps comes with the last Thursday following Calendar-based reports:* [[Gramps_{{Version manual}}_Wiki_Manual_-_Reports_-_part_4#Calendar|Calendar Report]]: (menu {{man menu|Reports->Graphical Reports->Calendar...}} )* [[Gramps_{{Version manual}}_Wiki_Manual_-_Reports_-_part_6#Birthday_and_Anniversary_Report|Birthday and Anniversary Report]]: (menu {{man menu|Reports->Text Reports->Birthday and Anniversary Report...}} )* And an output for the Web with [[Gramps_{{Version manual}}_Wiki_Manual_-_Reports_-_part_7#Web_Calendar|Web Calendar Report]]:(menu {{man menu|Reports->Web Pages->Web Calendar...}} ) {{-}}You can select which holidays to show by setting the {{man label|Country for holidays:}} option in either the {{man label|Content}} tab of every month, every yearthe reports. [[File:Calendar-GraphicalReports-Content-tab-Country for holidays-default-list-51. Let's play!png|thumb|450px|right|Content tab showing "Country for holidays:" option showing "Country for holidays" default list]]{{-}}
==Separate holidays.xml=Available Calendars===Note that you can have two separate holidays.xml files:# Where Gramps is installed, # The other in your personal [[Gramps_4.2_Wiki_Manual_-_User_Directory|User directory]] <code>.gramps/plugins/</code> folder.
==Available Calendars==
===Gramps 4.2===
Countries:
* Bulgaria / Canada / Chile / China / Croatia / Czech Republic / England / Finland / France / Germany / Japan / New Zealand / Russia / Serbia / Serbia (Latin) / Slovakia / Sweden / Ukraine / United States of America
Holidays
* Jewish Holidays
[[Category:Developers/General]]
[[Category:Reports]]
[[Category:How do I...]]
3,044
edits

Navigation menu