NeatoCal

A neato calendar with the full year on a single page.

This is a JavaScript port of the very awesome Neatnik's Calendar project, with added parameters (see below) and designed to be "dependency free" with all files local.

Printing probelms? See printing issues.

Screenshots

Parameters

| URL Parameter | Description | Example | |---|---|---| | year | Change year (default to current year) | ...?year=2030 | | start_month | Start at month other than January. 0 indexed (0=Jan, 1=Feb, ...). | ...?start_month=7 | | n_month | Change number of months to something other than 12 (default 12). | ...?n_month=6 | | layout | Changes the layout of the calendar. default, aligned-weekdays, hallon-almanackan, or weekly-grid. | ...?layout=aligned-weekdays ...?layout=hallon-almanackan ...?layout=weekly-grid | | start_day | Start at day other than Monday. 0 indexed (0=Sun, 1=Mon, ...). Only valid with aligned-weekdays layout | ...?layout=aligned-weekdays&start_day=0 | | highlight_color | Change the weekend highlight color (default eee) | ...?highlight_color=fee | | today_highlight_color | Change the current day's highlight color | ...?today_highlight_color=f66 | | language | Change the language for month and day codes. Values will be overridden if month_code or weekday_code is specified. | ...?language=ko-KR | | weekday_code | Comma separated list of weekday codes to use (default Su,M,T,W,R,F,Sa). Elements can be blank if no weekday code is wanted. | ...?weekday_code=S,M,T,W,T,F,S | | weekday_format | Change the representation of weekdays (language must be specified). long, short or narrow | ...?language=en&weekday_format=narrow | | month_code | Comma separated list of month codes to use (default Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec). Elements can be blank if no month code is wanted. | ...?month_code=J,F,M,A,M,J,J,A,S,O,N,D | | month_format | Change the representation of months (language must be specified). numeric, 2-digit, long, short or narrow | ...?language=en&month_format=narrow | | weekend_days | Comma separated list of days weekend falls on (0=Sun, 1=Mon, ..., 6=Sat). Default to 0,6. | ...?weekend_days=5,6 | | cell_height | CSS parameter to alter cell height. | ...?cell_height=1.5em | | show_moon_phase | Display moon phases on calendar (default false). | ...?show_moon_phase=true | | moon_phase_style | Moon phase display style: css (default), symbol, or name. | ...?show_moon_phase=true&moon_phase_style=symbol | | moon_phase_position | Position of moon phase: below (default) or inline. | ...?show_moon_phase=true&moon_phase_position=inline | | moon_phase_display | When to show moon phases: changes (default, only on phase transitions) or all (every day). | ...?show_moon_phase=true&moon_phase_display=all | | show_week_numbers | Displays the week number. (default false) | ...?show_week_numbers=true | | font_family | Changes the font. (default Oswald) | ...?font_family=sans-serif | | data | Location of JSON data file. | ...?data=example/data.json | | ics | Show the ICS drag-and-drop prompt overlay on load. | ...?ics | | help | Show help screen | ...?help |

Detailed Styling

In addition, parameters for weekday text, weekend text, month text, week number, day in month and weekend day in month can be styled with font size, font weight, foreground and background color.

These are given as URL parameters with the [VARIABLE]_[CSSTYPE]. The following prefix and suffixes are available:

| Variable | |---| | year | | month | | weekday | | weekend | | week | | date | | weekend_date |

| CSS Type Parameter | CSS Variable | |---|---| | font_size | fontSize | | font_weight | fontWeight | | foreground_color | color | | background_color | background |

For example, ...?weekend_font_size=1.4vmin.

Presets

The above parameter list is versatile enough to provide many options for display. Below is an abbreviated list of presets that might be useful to people.

| Preset | Description | |---|---| | Color and aligned | Calendar with aligned days and red highlighted weekends | | Academic calendar | An "academic calendar" that starts on Sept and runs through to August of the following year | | Half Page left and right calendars | Two half page (6 months) calendars | | Non-highlighted calendar | Calendar without the weekend highlighting | | Chinese month and day | Calendar with (simplified) Chinese month and day abbreviations (thanks to myway42) | | German month and day (using language code) | Calendar with German month and day abbreviations | | Turkish month and day | Calendar with Turkish month and day abbreviations | | Two year calendar | Two year single page calendar | | Moon phase calendar | Calendar with SVG moon phases (shows only phase changes) | | Moon phase symbols | Calendar with Unicode moon phase symbols | | Moon phase every day | Calendar showing moon phase on every day |

Data File

There is a data file option that can be used to provide parameters or text in the day cells. The data value can be an absolute URL like ?data=https://example.com/data.json. The only caveats are browser rules: the remote host must allow CORS (e.g. Access-Control-Allow-Origin), and mixed-content rules apply (HTTPS page can’t load HTTP JSON).

The format is:

{
  "param": {
    ...
    "color_cell" : [
      { "date":"YYYY-MM-DD", "color":"#rgb" },
      ...
      { "date":"YYYY-MM-DD", "color":"#rgb" }
    ]
  },
  "YYYY-MM-DD" : "text",
  ...
  "YYYY-MM-DD" : "text"
}

The file example/data.json provides an example:

{
  "param": {
    "year":2030,
    "layout":"aligned-weekdays",
    "cell_height": "2em"
  },
  "2030-03-21" : "The quick brown fox jumps over the lazy yellow dog",
  "2030-01-30" : "Sphynx of black quartz, judge my vow",
  "2030-06-01" : "Thule Worm-God of the Lords",
  "2030-08-11" : "Swarms Matriarch",
  "2030-10-20" : "Higher Dimension Being"
}

The admissible parameters in the "param" : {} section have the same name as the URL parameters. If a parameter is specified in the data file, they will override any parameters provided in the URL.

color_cell allows for individual cell highlighting (example). See example/sched.json for the example data file with the color_cell array.

Moon phase parameters (`s

Neatocal

Install / Use

README