Skip to content

Latest commit

 

History

History
138 lines (94 loc) · 5.93 KB

readme-base.md

File metadata and controls

138 lines (94 loc) · 5.93 KB
Raw

Table of contents

What it looks like

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 3 distinct 'modes'. That is, it can display tasks from different sources:

  1. Daily notes
  2. Obsidian-tasks
  3. Online calendars

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

Note

When you copy the link to your iCloud calendar, make sure to change the webcal:// protocol to https://

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.

What else you can do

  • Observe your progress in the status bar
  • Use the week view for multi-day planning
  • Color tasks based on time
  • Click on the timeline to create tasks
  • Drag tasks to re-schedule
  • Copy tasks
  • Move multiple tasks at once

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 James Lynch for the original plugin
  • Thanks to replete, whose fork I initially forked
  • Thanks to Michael Brenan for Dataview
  • Thanks to Joshua Tazman Reinier for his plugin, which gave me an idea of how to integrate with Dataview
  • Thanks to @liamcain for creating daily note utilities and a helpful calendar plugin