Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for syncing TODOs #218

Merged
merged 17 commits into from
Dec 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,11 @@ synced and which not:
`org-caldav-skip-conditions`. The syntax of the conditions is
described in the doc-string of `org-agenda-skip-if`.

* In case you just want to keep your remote calendar clean, set
`org-caldav-days-in-past` to the number of days you want to keep in
the past on the remote calendar. This does not affect your org files,
it works just as a filter for entries older than N days.

Note however that the normal `org-agenda-skip-function(-global)` will
**not** have any effect on the icalendar exporter (this used to be the
case, but changed with the new exporters).
Expand Down Expand Up @@ -398,6 +403,38 @@ the events into the debug buffer. If you send such a buffer in a bug
report, please make very sure you have removed personal information
from those events.

#### Syncing TODO

This section is experimental. So please make sure you have backups before you
use this. Create issues if it doesn't work for you. This was developed with a
nextcloud 12 server, and it is not sure if it works somewhere else. Please
report if you have another setup, so we can fix that.

To enable this, just use

(setq org-icalendar-include-todo 'all
org-caldav-sync-todo t)

The first will include your todos to the exporter (org->cal) the second controls
the use of downloaded vtodo events to import it to the `inbox`.

It is also a good idea to set

(setq org-icalendar-categories '(local-tags))

so the tags on the nextcloud will not include the local category. If you need
that, leave a message. On cal->org this would add it to the tags.

See the variables `org-caldav-todo-priority` and
`org-caldav-todo-percent-states` for some customization.

There is also `org-caldav-todo-deadline-schedule-warning-days` which can be set
to `t` if you want to include a scheduled date. Some apps like OpenTasks will
move tasks out of the widget if there is a scheduled, until it actually starts.

I would recommend you to test this and report issues, because I also want to
have a stable todo handling.

#### Known Bugs

* Recurring events created or changed on the calendar side cannot be
Expand All @@ -410,6 +447,11 @@ from those events.
* Pretty much everything besides SUMMARY, DESCRIPTION, LOCATION and
time is ignored in iCalendar.

* When trying to sync todo entries org-mode's export to ical can create empty
entries. org-caldav tries to sync this, which results in errors.
In this case you can set `org-icalender-sync-todo` to `t` instead of `'all`,
until it is fixed.

#### How syncing happens (a.k.a. my little CalDAV rant)

(This is probably not interesting, so you can just stop reading.)
Expand Down
Loading