7e400abdc0
Due to emacs-straight/org-mode@e22b4eb, a replacement major mode (for org-mode) can no longer be specified from .dir-locals.el, as it spirals into infinite recursion. Therefore, a mode: line is needed in all Doom docs. Ref: emacs-straight/org-mode@e22b4eb7aa
79 lines
2.5 KiB
Org Mode
79 lines
2.5 KiB
Org Mode
# -*- mode: doom-docs-org -*-
|
|
#+title: :app calendar
|
|
#+subtitle: Watch your missed deadlines in real time
|
|
#+created: January 13, 2018
|
|
#+since: 21.12.0 (#355)
|
|
|
|
* Description :unfold:
|
|
This module adds a calendar view for Emacs, with org and google calendar sync
|
|
support.
|
|
|
|
** Maintainers
|
|
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
|
|
|
** Module flags
|
|
/This module has no flags./
|
|
|
|
** Packages
|
|
- [[doom-package:][calfw]]
|
|
- [[doom-package:][calfw-org]]
|
|
- [[doom-package:][org-gcal]]
|
|
|
|
** Hacks
|
|
/No hacks documented for this module./
|
|
|
|
** TODO Changelog
|
|
# This section will be machine generated. Don't edit it by hand.
|
|
/This module does not have a changelog yet./
|
|
|
|
* Installation
|
|
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
|
|
|
This module requires:
|
|
- A Google Calendar account.
|
|
- [[https://github.com/kidd/org-gcal.el#installation][An OAuth client ID]], for syncing said account with [[doom-package:][org-gcal]].
|
|
|
|
* TODO Usage
|
|
#+begin_quote
|
|
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
|
#+end_quote
|
|
|
|
* TODO Configuration
|
|
#+begin_quote
|
|
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
|
#+end_quote
|
|
|
|
** Changing calendar sources
|
|
By defining your own calendar commands, you can control what sources to pull
|
|
calendar data from:
|
|
#+begin_src emacs-lisp
|
|
(defun my-open-calendar ()
|
|
(interactive)
|
|
(cfw:open-calendar-buffer
|
|
:contents-sources
|
|
(list
|
|
(cfw:org-create-source "Green") ; org-agenda source
|
|
(cfw:org-create-file-source "cal" "/path/to/cal.org" "Cyan") ; other org source
|
|
(cfw:howm-create-source "Blue") ; howm source
|
|
(cfw:cal-create-source "Orange") ; diary source
|
|
(cfw:ical-create-source "Moon" "~/moon.ics" "Gray") ; ICS source1
|
|
(cfw:ical-create-source "gcal" "https://..../basic.ics" "IndianRed") ; google calendar ICS
|
|
)))
|
|
#+end_src
|
|
|
|
The [[https://github.com/kiwanami/emacs-calfw][kiwanami/emacs-calfw]] project readme contains more examples.
|
|
|
|
** Synchronizing Org and Google Calendar
|
|
The [[https://github.com/kidd/org-gcal.el][kidd/org-gcal.el]] project README contains more detailed instructions on how
|
|
to link your calendar with Google calendars.
|
|
|
|
* Troubleshooting
|
|
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
|
|
|
* Frequently asked questions
|
|
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
|
|
|
* TODO Appendix
|
|
#+begin_quote
|
|
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
|
#+end_quote
|