| Chapter 6 File Format |
The parameter file is an .INI file that contains some parameters for the calendar template file. These parameters instruct XLCalendar how to output the calendar. The calendar parameter file is located in the same directory as the template file, and has a same base name as the template file.
The [Monthly Calendar] section contains the settings how to output monthly calendar.
Output=Y/N
This setting specifies whether to output the monthly calendar. If the value is Y, the monthly calendar will be used. If the value is N, the monthly calendar will not be used.
SheetName=< sheetname >
This setting specifies the name of the worksheet for the monthly calendar. < sheetname > value is the name of the worksheet.
FirstDayOfWeek=< firstdayofweek >
This setting specifies the first day of the week. If the value is "Sunday" or "0", the week starts at Sunday. If the value is "Monday" or "1", the week starts at Monday.
FirstCellOfDay=< firstcellofday >
This setting specifies the position where the day of the month will be inserted. < firstcellofday > value is the first cell of day. XLCalendar will compute the positions for each day.
ColIntervalOfDay=< colintervalofday >
This setting specifies the number of columns between two days.
RowIntervalOfDay=< rowintervalofday >
This setting specifies the number of rows between two days or two weeks.
OutWeekday=Y/N
This setting specifies whether to output the name of weekday. If the value is Y, the name of weekday will be outputted. If the value is N, the name of weekday will not be used.
FirstCellOfWeekday=< firstcellofweekday >
This setting specifies the position where the name of weekday will be inserted. < firstcellofweekday > value is the first cell for the weekdays. XLCalendar will compute the positions for each weekday.
WeekdayName=< weekdayname >
This setting specifies the weekday name. < weekdayname > value is the list of the weekday name. For example, "Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday".
OutMonth=Y/N
This setting specifies whether to output the month. If the value is Y, the month will be used. If the value is N, the month will not be used.
FirstCellOfMonth=< firstcellofmonth >
This setting specifies the position where the month will be inserted. < firstcellofmonth > value is the cell for January. XLCalendar will compute the positions for each month.
MonthName=< monthname >
This setting specifies the month name. < monthname > value is the list of the month name. For example, "Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec".
OutYear=Y/N
This setting specifies whether to output the year. If the value is Y, the year will be used. If the value is N, the year will not be used.
FirstCellOfYear=< firstcellofyear >
This setting specifies the position where the year will be inserted.
OutHoliday=Y/N
This setting specifies whether to output the holidays. If the value is Y, the holidays will be used. If the value is N, the holidays will not be used.
FirstCellOfHoliday=< firstcellofholiday >
This setting specifies the position where the name of holiday will be inserted.
MultiHolidays=< multiholidays >
This setting specifies how to process holidays when there are multiple holidays on the same day. If the value is 0, the holiday will be overwritten with the last one. You only get the last one. If the value is 1, you will get all holidays on the same day. The others on the same day will be put into the next rows. If the value is 2, the others on the same day will be put into the next columns.
Holiday1=< date1 >,< type1 >,< name1 >
Holiday2=< date2 >,< type2 >,< name2 >
Holiday3=< date3 >,< type3 >,< name3 >
......
These settings specify the holidays you want to use in the calendar. Each entry specifies a holiday. < type1 > is the type of the holiday. If < type1 > value is "day" or "", < date1 > is the month and the day. For example, "0101" means January 1. If < type1 > value is "sunday", "monday", "tuesday"..., < date1 > represents the month and the weekday of the month. If the weekday of the month is greater than or equal to 5, XLCalendar will count backwards. If the weekday of month is 5, 6, 7, 8, it represents the first, second, third, fourth weekday of month from the end of month. For example, "1004,thursday" means the fourth occurrence of Thursday in October, "0506,monday" means the second Monday from the end of month in May. If < type1 > value is "Easter", it means a holiday that relates to Easter. < date1 > means the days of the interval. It can be positive (the days after Easter) or negative (the days before Easter). For example, "-2,easter" means 2 days before Easter. < name1 > is the name of the holiday.
The [Yearly Calendar] section contains the settings how to ouput yearly calendar.
Output=Y/N
This setting specifies whether or not to output the yearly calendar. If the value is Y, the Yearly calendar will be used. If the value is N, the yearly calendar will not be used.
SheetName=< sheetname >
This setting specifies the name of the worksheet for the yearly calendar. < sheetname > value is the name of the worksheet.
FirstDayOfWeek=< firstdayofweek >
This setting specifies the first day of the week. If the value is "Sunday" or "0", the week starts at Sunday. If the value is "Monday" or "1", the week starts at Monday.
MonthLayout=< monthlayout >
This setting specifies the layout of months. For example, 2x6 months, 3x4 months or 4x3 months. < monthlayout > value is the number between 1 and 12 representing the layout of months. 1 represents 1x12 months layout, 2 represents 2x6 months layout, 3 represents 3x4 months layout, 4 represents 4x3 months layout, 6 represents 6x2 months layout, and 12 represents 12x1 months layout.
ColIntervalOfMonth=< colintervalofmonth >
This setting specifies the number of columns between two months.
RowIntervalOfMonth=< rowintervalofmonth >
This setting specifies the number of rows between two months.
FirstCellOfDay=< firstcellofday >
This setting specifies the position where the day of the month will be inserted. < firstcellofday > value is the first cell of day. XLCalendar will compute the positions for each day.
ColIntervalOfDay=< colintervalofday >
This setting specifies the number of columns between two days.
RowIntervalOfDay=< rowintervalofday >
This setting specifies the number of rows between two days or two weeks.
OutWeekday=Y/N
This setting specifies whether to output the name of weekday. If the value is Y, the name of weekday will be used. If the value is N, the name of weekday will not be used.
FirstCellOfWeekday=< firstcellofweekday >
This setting specifies the position where the name of weekday will be inserted. < firstcellofweekday > value is the first cell for the weekdays. XLCalendar will compute the positions for each weekday.
WeekdayName=< weekdayname >
This setting specifies the weekday name. < weekdayname > value is the list of the weekday name. For example, "Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday".
OutMonth=Y/N
This setting specifies whether to output the month. If the value is Y, the month will be used. If the value is N, the month will not be used.
FirstCellOfMonth=< firstcellofmonth >
This setting specifies the position where the month will be inserted. < firstcellofmonth > value is the cell for January. XLCalendar will compute the positions for each month.
MonthName=< monthname >
This setting specifies the month name. < monthname > value is the list of the name of the month. For example, "Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec".
OutYear=Y/N
This setting specifies whether to output the year. If the value is Y, the year will be used. If the value is N, the year will not be used.
FirstCellOfYear=< firstcellofyear >
This setting specifies the position where the year will be inserted.
OutHoliday=Y/N
This setting specifies whether to output the holidays. If the value is Y, the holidays will be used. If the value is N, the holidays will not be used.
FirstCellOfHoliday=< firstcellofholiday >
This setting specifies the position where the name of holiday will be inserted.
MultiHolidays=< multiholidays >
This setting specifies how to process holidays when there are multiple holidays on the same day. If the value is 0, the holiday will be overwritten with the last one. You only get the last one. If the value is 1, you will get all holidays on the same day. The others on the same day will be put into the next rows. If the value is 2, the others on the same day will be put into the next columns.
Holiday1=< date1 >,< type1 >,< name1 >
Holiday2=< date2 >,< type2 >,< name2 >
Holiday3=< date3 >,< type3 >,< name3 >
......
These settings specify the holidays you want to use in the calendar. Each entry specifies a holiday. < type1 > is the type of the holiday. If < type1 > value is "day" or "", < date1 > is the month and the day. For example, "0101" means January 1. If < type1 > value is "sunday", "monday", "tuesday"..., < date1 > represents the month and the weekday of the month. If the weekday of the month is greater than or equal to 5, XLCalendar will count backwards. If the weekday of month is 5, 6, 7, 8, it represents the first, second, third, fourth weekday of month from the end of month. For example, "1004,thursday" means the fourth occurrence of Thursday in October, "0506,monday" means the second Monday from the end of month in May. If < type1 > value is "Easter", it means a holiday that relates to Easter. < date1 > means the days of the interval. It can be positive (the days after Easter) or negative (the days before Easter). For example, "-2,easter" means 2 days before Easter. < name1 > is the name of the holiday.
The holiday files are text files that contain the information of holidays. The folder of the holiday files is the holiday under the data folder. For more detail information about the data folder, refer to "Directories and Files" in this document.
The layout of a holiday file is as the following:
< date1 >,< type1 >,< name1 >
< date2 >,< type2 >,< name2 >
< date3 >,< type3 >,< name3 >
......
Each line specifies a holiday. < type1 > is the type of the holiday. If < type1 > value is "day" or "", < date1 > is the month and the day. For example, "0101" means January 1. If < type1 > value is "sunday", "monday", "tuesday"..., < date1 > represents the month and the weekday of the month. If the weekday of the month is greater than or equal to 5, XLCalendar will count backwards. If the weekday of month is 5, 6, 7, 8, it represents the first, second, third, fourth weekday of month from the end of month. For example, "1004,thursday" means the fourth occurrence of Thursday in October, "0506,monday" means the second Monday from the end of month in May. If < type1 > value is "Easter", it means a holiday that relates to Easter. < date1 > means the days of the interval. It can be positive (the days after Easter) or negative (the days before Easter). For example, "-2,easter" means 2 days before Easter. < name1 > is the name of the holiday.
XLCalendar.ini contains the settings and defaults of XLCalendar according to your preferences. XLCalendar.ini is under XLCalendar's working directory.
The [Environment] section contains the settings about the environment.
TemplatePath=< templatepath >
This setting specifies the path of the template files. < templatepath > value is the path of the template files.
OutputPath=< outputpath >
This setting specifies the path of the calendar files generated by XLCalendar. < outputpath > value is the path of the calendar files.
HolidayFilePath=< holidayfilepath >
This setting specifies the path of the holiday files. < holidayfilepath > value is the path of the holiday files.
ShowTips=Y/N
This setting specifies whether to show Tips on startup. If the value is Y, it will show the Tips on startup. If the value is N, it will not show the Tips.
The [Monthly Calendar] section contains the settings related to monthly calendar.
Output=Y/N
This setting specifies the default value whether XLCalendar will use the monthly calendar.
SheetName=< sheetname >
This setting specifies the default name of the worksheet for the monthly calendar.
FirstDayOfWeek=< firstdayofweek >
This setting specifies the default first day of the week.
FirstCellOfDay=< firstcellofday >
This setting specifies the default cell for the first cell of day.
ColIntervalOfDay=< colintervalofday >
This setting specifies the default value for the column interval of day.
RowIntervalOfDay=< rowintervalofday >
This setting specifies the default value for the row interval of day.
OutWeekday=Y/N
This setting specifies the default value whether XLCalendar will use the name of the weekday.
FirstCellOfWeekday=< firstcellofweekday >
This setting specifies the default cell for the first cell of the weekday.
WeekdayName=< weekdayname >
This setting specifies the default weekday name.
OutMonth=Y/N
This setting specifies the default value whether XLCalendar will use the month.
FirstCellOfMonth=< firstcellofmonth >
This setting specifies the default value for the first cell of the month.
MonthName=< monthname >
This setting specifies the default month name.
OutYear=Y/N
This setting specifies the default value whether XLCalendar will use the year.
FirstCellOfYear=< firstcellofyear >
This setting specifies the default cell for the first cell of the year.
OutHoliday=Y/N
This setting specifies the default value whether XLCalendar will use the holidays.
FirstCellOfHoliday=< firstcellofholiday >
This setting specifies the default cell for the first cell of the holiday.
MultiHolidays=< multiholidays >
This setting specifies the default value how to process holidays when there are multiple holidays on the same day.
HolidayFile=< holidayfile >
This setting specifies the default holiday file. < holidayfile > value is the name and path of the holiday file.
The [Yearly Calendar] section contains the settings related to the yearly calendar.
Output=Y/N
This setting specifies the default value whether XLCalendar will use the yearly calendar.
SheetName=< sheetname >
This setting specifies the default name of the worksheet for the yearly calendar.
FirstDayOfWeek=< firstdayofweek >
This setting specifies the default first day of the week.
MonthLayout=< monthlayout >
This setting specifies the default layout of months.
ColIntervalOfMonth=< colintervalofmonth >
This setting specifies the default value for the column interval of the month.
RowIntervalOfMonth=< rowintervalofmonth >
This setting specifies the default value for the row interval of the month.
FirstCellOfDay=< firstcellofday >
This setting specifies the default cell for the first cell of the day.
ColIntervalOfDay=< colintervalofday >
This setting specifies the default value for the column interval of the day.
RowIntervalOfDay=< rowintervalofday >
This setting specifies the default value for the row interval of the day.
OutWeekday=Y/N
This setting specifies the default value whether XLCalendar will use the name of weekday.
FirstCellOfWeekday=< firstcellofweekday >
This setting specifies the default cell for the first cell of the weekday.
WeekdayName=< weekdayname >
This setting specifies the default weekday name.
OutMonth=Y/N
This setting specifies the default value whether XLCalendar will use the month.
FirstCellOfMonth=< firstcellofmonth >
This setting specifies the default value for the first cell of the month.
MonthName=< monthname >
This setting specifies the default month name.
OutYear=Y/N
This setting specifies the default value whether XLCalendar will use the year.
FirstCellOfYear=< firstcellofyear >
This setting specifies the default cell for the first cell of the year.
OutHoliday=Y/N
This setting specifies the default value whether XLCalendar will output the holidays.
FirstCellOfHoliday=< firstcellofholiday >
This setting specifies the default cell for the first cell of the holiday.
MultiHolidays=< multiholidays >
This setting specifies the default value how to process holidays when there are multiple holidays on the same day.
HolidayFile=< holidayfile >
This setting specifies the default holiday file. < holidayfile > value is the name and path of the holiday file.
The [MonthName] section contains the settings about the name of the month.
Count=< count >
This setting specifies how many name lists of months defined in XLCalendar.ini. < count > value is a number.
Name1=< name1 >
Name2=< name2 >
Name3=< name3 >
......
These settings specify the month name. < name1> value is the first name list of the month name. < name2> value is the second name list of the month name......For example, "Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec".
The [WeekdayName] section contains the settings about the names of weekdays.
Count=< count >
This setting specifies how many name lists of weekdays defined in XLCalendar.ini. < count > value is a number.
Name1=< name1 >
Name2=< name2 >
Name3=< name3 >
......
These settings specify the weekday name. < name1> value is the first name list of the weekday name. < name2> value is the second name list of the weekday name......For example, "Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday".