branch: externals/tmr
commit 7f074024de46f4d471943057403f900a6321e299
Author: Protesilaos Stavrou <[email protected]>
Commit: Protesilaos Stavrou <[email protected]>
Update tmr to version 1.3.0
---
CHANGELOG.org | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
README.org | 14 ++++--------
tmr.el | 2 +-
3 files changed, 75 insertions(+), 11 deletions(-)
diff --git a/CHANGELOG.org b/CHANGELOG.org
index 7ca191e1e4..cbb2eece6f 100644
--- a/CHANGELOG.org
+++ b/CHANGELOG.org
@@ -12,6 +12,76 @@ the manual: <https://protesilaos.com/emacs/tmr>.
#+toc: headlines 1 insert TOC here, with one headline level
+* Version 1.3.0 on 2026-01-25
+:PROPERTIES:
+:CUSTOM_ID: h:705987e4-60e9-4d06-bdc0-4f08347348a0
+:END:
+
+This version adds some user options and new features to an already
+stable package.
+
+** Timers can be paused
+:PROPERTIES:
+:CUSTOM_ID: h:4e740a08-0e29-4d5e-84ec-e5507df3845c
+:END:
+
+The command ~tmr-toggle-pause~ will prompt for a running timer and
+pause it.
+
+Users who have something like the following in their configuration,
+have access to ~tmr-toggle-pause~ under the =P= key:
+
+#+begin_src emacs-lisp
+;; All TMR commands are behind this prefix key. So `tmr-toggle-pause' is C-c
t P.
+(define-key global-map (kbd "C-c t") #'tmr-prefix-map)
+#+end_src
+
+In the buffer produced by the command ~tmr-tabulated-view~ the pause
+functionality applies to the timer at point. The ~tmr-toggle-pause~ is
+invoked with the =P= key.
+
+An extra column in the tabulated view shows whether a timer is paused
+or not. Here is an example:
+
+#+begin_example
+Start End Duration Remaining Paused? Acknowledge? Description
+
+08:49:41 09:19:46 30m 29m 17s Yes Work on
TMR for 30 minutes
+08:49:31 08:54:31 5m 3m 53s Prepare tea
+08:49:21 08:59:21 10m 8m 42s Yes Edit the
description with this one instead
+#+end_example
+
+** Configure the confirmation text for acknowledgements
+:PROPERTIES:
+:CUSTOM_ID: h:b08bda30-2991-4d36-83d8-39d619abb20f
+:END:
+
+When a timer is set to be acknowledged (i.e. the user must confirm
+that they saw it elapse) it prompts for confirmation. The default
+input text that confirms the acknowledgement is =ack=. This is now
+subject to configuration via the user option ~tmr-acknowledge-timer-text~.
+
+** Change how frequently the tabulated list is refreshed
+:PROPERTIES:
+:CUSTOM_ID: h:758d2691-14c5-4f3e-9044-a394101f9cff
+:END:
+
+The buffer produced by ~tmr-tabulated-view~ is set to automatically
+refresh every 5 seconds by default. In previous versions this was every
+1 second. The new user option ~tmr-tabulated-refresh-interval~ can be
+set to a number of seconds or ~nil~. In the latter case, the automatic
+refresh is disabled.
+
+** Removed the long-obsolete =tmr-tabulated.el=
+:PROPERTIES:
+:CUSTOM_ID: h:5bd873e9-15fa-4660-947f-b4f104d4e577
+:END:
+
+Its code was merged into =tmr.el= on 2024-10-30 and all it was doing
+thenceforth is issue a warning to those who would ~require~ the
+~tmr-tabulated~ feature. Now ~(require 'tmr-tabulated)~ produces an
+error.
+
* Version 1.2.0 on 2025-10-06
:PROPERTIES:
:CUSTOM_ID: h:87d321d7-e88e-4303-a7fc-fa4264e62a92
diff --git a/README.org b/README.org
index b18183b50a..3c205b47d1 100644
--- a/README.org
+++ b/README.org
@@ -104,22 +104,20 @@ The command ~tmr-edit-description~ can change the
description a given
timer object.
#+findex: tmr-toggle-acknowledge
-#+vindex: tmr-acknoledge-timer-text
+#+vindex: tmr-acknowledge-timer-text
The command ~tmr-toggle-acknowledge~ toggles the acknowledge flag of a
given timer object. A timer that needs to be acknowledged prompts for
confirmation after it elapses. The user can either confirm and thus
dismiss the timer, or set a new duration for the next reminder, using
the familiar TMR input. The confirmation text to be provided at the
minibuffer prompt (=ack= by default) can be configured via the user
-option ~tmr-acknoledge-timer-text~ [ The confirmation text is
-configurable as part of {{{development-version}}}. ]
+option ~tmr-acknowledge-timer-text~.
#+findex: tmr-toggle-pause
The command ~tmr-toggle-pause~ pauses the given timer. The tabulated
view has a column to show when a timer is paused
([[#h:51fe78e0-d614-492b-b7a3-fb6d5bd52a9a][Grid or tabulated view]]).
Similarly, the mode line indicator adapts the text of the timer to
-tell that it is paused ([[#h:a1938fd5-64ef-4f4f-ade1-c7058d4062fc][Display
timers on the mode line]]). [ The
-~tmr-toggle-pause~ and related functionality is part of
{{{development-version}}}. ]
+tell that it is paused ([[#h:a1938fd5-64ef-4f4f-ade1-c7058d4062fc][Display
timers on the mode line]]).
#+vindex: tmr-descriptions-list
The user option ~tmr-descriptions-list~ defines the completion
@@ -195,8 +193,6 @@ Timers can be viewed in a grid with ~tmr-tabulated-view~
(alias
~tmr-list-timers~). The data is placed in the =*tmr-tabulated-view*=
buffer and looks like this:
-[ The pause functionality is part of {{{development-version}}}. ]
-
#+begin_example
Start End Duration Remaining Paused? Acknowledge? Description
@@ -230,9 +226,7 @@ every 5 seconds. Users can change the number of seconds by
modifying
the user option ~tmr-tabulated-refresh-interval~. A ~nil~ value means
to never refresh that buffer automatically: users can update it
manually by invoking the command ~revert-buffer~, which is bound to
-=g= by default. [ This is part of {{{development-version}}}, instead
-of the old arrangement of updating the buffer every second without an
-option to change it. ]
+=g= by default.
#+vindex: tmr-list-timers-action-alist
The user option ~tmr-list-timers-action-alist~ controls how the
diff --git a/tmr.el b/tmr.el
index e5d887d51b..eb5708cf9f 100644
--- a/tmr.el
+++ b/tmr.el
@@ -8,7 +8,7 @@
;; Steven Allen <[email protected]>
;; Maintainer: Protesilaos Stavrou <[email protected]>
;; URL: https://github.com/protesilaos/tmr
-;; Version: 1.2.1
+;; Version: 1.3.0
;; Package-Requires: ((emacs "29.1"))
;; Keywords: convenience, timer
