Event Notes

by scott-chen
5
4
3
2
1
Score: 51/100

Description

Obsidian calendar plugin that keeps events as Markdown notes, linked to Daily and Weekly Notes, with sidebars and read-only iCal subscriptions.

Reviews

No reviews yet.

Stats

1
stars
105
downloads
0
forks
13
days
3
days
3
days
55
total PRs
0
open PRs
1
closed PRs
54
merged PRs
1
total issues
0
open issues
1
closed issues
164
commits

Latest Version

4 days ago

Changelog

Event Notes 0.3.8

Event Notes that lose their calendar event, because a calendar was removed and added again or its feed renamed its events, are now reconnected by start time and title, and the notes that cannot be reconnected are reported as one problem instead of one per note.

  • Reconnected by start time and title. An Event Note is tied to its event by the calendar it came from and the event's iCal UID. Removing a calendar and adding it again, changing its URL to a feed with other UIDs, or a feed that gives its events new UIDs used to leave every such note without an event. A scan now gives such a note to the event in a current calendar that has the same start, the same all-day setting, and the same title. The note's text and other properties are not changed; its event_id, source, ical_uid, and recurrence_id are rewritten, its Daily Note entry stays, and its times follow the new event unless you had changed them yourself. No message is shown.
  • Only when there is no doubt. A note is reconnected only if exactly one event without a note matches it and no other lost note matches that event. Titles are compared exactly, apart from leading, trailing, and repeated spaces; the end time is not compared. Two events with the same start and title, two notes for one event, or an event that already has a note are left for you to decide.
  • A note whose event left the feed. A note whose event the feed stopped listing is reconnected in the same way when the feed lists the same start and title under a new UID. With no such event, the note stays as it was.
  • One problem instead of many. Notes that cannot be reconnected are grouped: one problem for the notes a removed calendar left, and one for each calendar that no longer lists its notes' events. Review Event Note problems lists the notes of a group with their events, and Keep all as ordinary notes or Move all to trash applies to the whole group; open a note from the list to handle it by itself. A single such note is reported as before. The problem count in settings and in the toolbar counts problems, so a group counts once.

A note that matches an event by UID behaves as before. There is no fuzzy matching and no new setting.

Install

Download the Event Notes 0.3.8 ZIP, extract it, and copy the event-notes folder into <Vault>/.obsidian/plugins/, or install through BRAT. Moving from Calendar Pro is covered in the installation guide.

Compatibility and verification

Requires Obsidian 1.14.5 or later on desktop. npm run typecheck, npm test, and npm run package pass. Matching notes to events, reconnecting a note with its link, path claim and own times, the cases that are left alone, and the grouped problems have automated coverage. Reconnecting after a calendar is set up again in a real Vault, and the grouped problem card with its two buttons, have not had native QA in Obsidian.

README file from

Github

Event Notes

A calendar and Gantt chart for Obsidian that keep your events and project tasks as Markdown notes in your Vault, linked from your Daily Notes.

Event Notes week view with local events, the mini calendar, and the toolbar

Highlights

  • Events are notes. Each local event is an Event Note with start and end in its properties, linked from the Daily Note for its date. Subscribed events get an Event Note when you open them. Drag an event to another day and its Daily Note entry moves with it.
  • Six views. Week, Day, Month, Year, Custom days, and List, plus a mini calendar for jumping between dates. Click a date header for its Daily Note or a week number for its Weekly Note.
  • Your schedule beside your notes. An events sidebar shows a phone-style day timeline or a two-week list, and a month calendar sidebar marks event days and existing Daily Notes.
  • Calendar subscriptions. Add read-only HTTPS or webcal:// feeds next to your local events. Holiday calendars shade their days.
  • Finds and fixes note problems. When a copied note duplicates an event_id, Review Event Note problems shows the copies side by side, highlights the differences, recommends which to keep, and applies the fix you choose. Notes with broken properties can be restored to their last valid version.
  • Projects as Gantt charts. Open a note's outline as a WBS table or a Gantt chart. Dates, progress, and assignees live in brackets at the end of each line, such as (30%, 11/1-11/6, @小王) or @[[小王]] / [[@小王]] for a linked person, and dated tasks appear in the calendar. See Projects and Gantt.
  • Local and private. No account or telemetry. The only network requests fetch the feeds you add. See privacy and compatibility.
Event details Event Note problems
Event details dialog with start and end times and an Event Note preview Review Event Note problems showing two notes with the same event_id side by side

Install

Event Notes needs desktop Obsidian 1.14.5 or later. It is not in the Community Plugins directory yet.

Open the calendar from the ribbon icon or the command palette, then see the user guide for clicking, sidebars, subscriptions, holiday calendars, and where Event Notes are saved.

Contributing

Bug reports and pull requests are welcome. You need Node.js 22 or newer, npm, and zip.

git clone https://github.com/rightson/obsidian-event-notes.git
cd obsidian-event-notes
npm ci
npm run dev -- /absolute/path/to/test-vault

npm run dev rebuilds into the Vault's plugin folder on every save. The path must be absolute and point to a Vault Obsidian has already opened, so it has a .obsidian folder. With the Hot Reload plugin installed there, Obsidian reloads Event Notes after each build. Use a test Vault, not your real one.

Before opening a pull request:

npm run typecheck
npm test
npm run package

Where things live:

Area Files
Plugin entry, commands, settings src/main.ts, src/settings.ts, src/settings-tab.ts
Main calendar and mini calendar src/calendar-*.ts
Events sidebar and month calendar sidebar src/agenda-*.ts, src/months-*.ts
Event Notes and Daily/Weekly Notes src/events.ts, src/notes.ts, src/paths.ts
Event details dialog, event actions, change history src/modals.ts, src/event-actions.ts, src/history.ts
Subscriptions and holiday calendars src/ical*.ts, src/subscription*.ts, src/sync.ts, src/holidays.ts
Event Note problems src/note-problems.ts, src/problems-modal.ts
Gantt view and Project Notes src/gantt-view.ts, src/annotation.ts, src/tasks.ts, src/task-hints.ts, src/project-*.ts
Saved state and crash recovery src/store.ts, src/state.ts, src/vault-adapter.ts
Shared types and date/week helpers src/types.ts, src/date.ts
Tests (Node test runner) tests/*.test.ts

Ways to help:

  • Native QA. Several features have automated coverage only. The native test checklist lists what to check in a real Obsidian Vault.
  • Mobile. The plugin is desktop-only because mobile has not been tested.

See development and QA for the full build, install, and test notes, and releasing for packaging a release.

License

MIT. Third-party licenses are embedded in the release main.js and included as THIRD_PARTY_LICENSES.txt in the ZIP. See the 0.2.1 release notes for this version's verified scope and known limits, and all release notes for earlier versions.