Skip to content

Latest commit

 

History

History
177 lines (113 loc) · 7.37 KB

readme-base.md

File metadata and controls

177 lines (113 loc) · 7.37 KB
Raw

Day Planner is a community plugin for Obsidian. It adds editable calendar views and basic time-tracking. Day Planner is integrated with

Table of contents

How to use it

Warning

Dataview (community plugin, see in Obsidian) should be installed and enabled for the plugin to work.

To open the timeline in the sidebar:

  • Either run the command: Show Timeline
  • Or click the timeline icon in the left ribbon

To open multi-day planner:

  • Either run the command: Show multi-day planner
  • Or click on the icon in the left ribbon:

The plugin has 4 distinct 'modes'. That is, it can display records from different sources:

  1. Daily notes
  2. Obsidian-tasks
  3. Online calendars
  4. Dataview clock properties

Let's go over each one of them.

1. Showing events from your daily notes

Warning

Either the core 'Daily Notes' (core plugin) or the 'Periodic Notes' (community plugin, see in Obsidian) should be enabled. This is what allows day-planner to 'see' and interact with your daily notes.

This works out of the box: you write your tasks in a daily note, and they show up on the timeline:

# Day planner

- [ ] 10:00 - 10:30 Wake up
- [ ] 11:00 - 12:30 Grab a brush and put a little make-up

2. tasks community plugin integration, showing events from other files in your vault

This mode allows you to see tasks anywhere in the vault with dates added by the tasks community plugin.

To make this work,

  1. Add a tag like #task or a folder to the Dataview source field:
  2. Add the tag (#task in this example) to the file with some tasks
  3. Add the scheduled property to a task in one of the formats:
    • Shorthand, added by tasks community plugin: ⏳ 2021-08-29
      • Note that this plugin has a handy modal for adding these properties
    • Full Dataview-like property: [scheduled:: 2021-08-29]
    • Another Dataview format: (scheduled:: 2021-08-29).

Full examples:

- [ ] #task 08:00 - 10:00 This task uses the shorthand format ⏳ 2021-08-29
- [ ] #task 11:00 - 13:00 This task uses the Dataview property format [scheduled:: 2021-08-29]

Note

For now, the tags work at the level of files. So if #task is found anywhere in the file, all the tasks are going to be pulled into the calendar.

3. Showing internet calendars

To show events from internet calendars like Google Calendar, iCloud Calendar and Outlook you only need to add an ICS link in the plugin settings.

Where to get a Google Calendar link

Warning

Make sure you copy the right link! It should end with .ics, otherwise, you won't see your events!

Google Calendar instructions

Where to get an iCloud link

iCloud Calendar instructions

Where to get an Outlook link

Outlook Calendar instructions

Here's the relevant part:

Under the settings in Outlook on the web, go to Calendar > Shared calendars. Choose the calendar you wish to publish and the level of details that you want others to see.

Here's how the settings look on the web version:

Alternative

If your organization doesn't let you share your calendar this way, you might try a different way described in this issue.

4. Time tracking

Warning

This feature is experimental and can break or change at any time in the near future. You can help to shape this feature by providing your feedback.

You can record time spent on tasks in the form of Dataview properties and then view the records as time blocks, much like planner entries.

Recording clocks

Start a clock by right-clicking on a task in the editor:

Stop the clock to record the time spent on a task or cancel it to discard the record:

There is a command for each of the menu items, available in the command palette or as a hotkey:

Clocks in timelines

You can enable an additional timeline column to see the recorded clocks next to your planner:

Active clocks

You can see the currently active clocks in the timeline sidebar:

A right click on an active clock will bring the control menu:

Limitations

  • For now clock time blocks are read-only. This is going to be addressed in the future.

Note on the old plugin version

0.7.0 significantly changes what the plugin looks like and what it does. If you like to have some of the old behaviors back, consider creating an issue.

If for some reason you still want to use the old version, there are community forks, which you can use via BRAT. Here is one such fork.

Acknowledgements

  • Thanks to Michael Brenan for Dataview
  • Thanks to James Lynch for the original plugin
  • Thanks to Joshua Tazman Reinier for his plugin that served as an inspiration
  • Thanks to @liamcain for creating daily note utilities and a helpful calendar plugin
  • Thanks to Emacs Org Mode for an idea of text-based time-tracking
  • Thanks to Toggl Track for an idea of a great time-tracking UI