diff options
| author | Craig Jennings <c@cjennings.net> | 2026-05-11 05:51:29 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2026-05-11 05:51:29 -0500 |
| commit | 783c2abe7ca6e88e372dfbf86aae2cbaa321fed8 (patch) | |
| tree | ac4c6113825db52ba71ba9f0fa30b3c991f76daa /docs/CONFIGURATION.org | |
| parent | ee90de269e4f65a9b57b4fc9e260d3aa6948b6ca (diff) | |
| download | chime-783c2abe7ca6e88e372dfbf86aae2cbaa321fed8.tar.gz chime-783c2abe7ca6e88e372dfbf86aae2cbaa321fed8.zip | |
docs: document the per-event :CHIME_NOTIFY_BEFORE: property
The README's migration note said the per-event reminder property had been removed. That's stale now that the property is back. I rewrote the line to point at :CHIME_NOTIFY_BEFORE: and the deprecated :WILD_NOTIFIER_NOTIFY_BEFORE: alias. I also added a "Per-Event Override" section to docs/CONFIGURATION.org covering the syntax, the no-inheritance behavior, malformed-value handling, and the alias's deprecation path.
Diffstat (limited to 'docs/CONFIGURATION.org')
| -rw-r--r-- | docs/CONFIGURATION.org | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/CONFIGURATION.org b/docs/CONFIGURATION.org index ae73071..87ff0cf 100644 --- a/docs/CONFIGURATION.org +++ b/docs/CONFIGURATION.org @@ -41,6 +41,28 @@ Set when to receive notifications and their urgency levels using =(minutes . sev Severity levels are =high=, =medium=, and =low=. They are passed to [[https://github.com/jwiegley/alert][alert.el]], which maps them to your notification style or daemon. +* Per-Event Override + +A single heading can override =chime-alert-intervals= with a property in its drawer: + +#+BEGIN_SRC org +* Important meeting +:PROPERTIES: +:CHIME_NOTIFY_BEFORE: 30 +:END: +SCHEDULED: <2026-05-10 Sun 14:00> +#+END_SRC + +=:CHIME_NOTIFY_BEFORE:= takes a non-negative integer number of minutes. The example fires one notification 30 minutes before the event with =medium= severity, ignoring the global =chime-alert-intervals= for this heading. =0= means notify at event time. + +The property does not inherit — it applies to the heading it is set on, not to subheadings. + +A malformed value (non-integer, negative, fractional) is ignored: chime logs a message naming the heading and falls back to =chime-alert-intervals=. + +** Migrating from org-wild-notifier + +org-wild-notifier's =:WILD_NOTIFIER_NOTIFY_BEFORE:= property is honored as a deprecated alias. When a heading uses it, chime emits one warning per Emacs session pointing at the new name. Rename it to =:CHIME_NOTIFY_BEFORE:= when convenient; the alias will be removed in a future release. + * Chime Sound #+BEGIN_SRC elisp |