From: "Samuel W. Flint" <swflint+orgmode@flintfam.org>
To: "Org-Mode" <emacs-orgmode@gnu.org>
Subject: [PATCH v2 2/2] doc/org-manual.org: Document org-clock-{in,out}-switch-to-state
Date: Wed, 26 Oct 2022 09:54:42 -0500 [thread overview]
Message-ID: <87czaed499.fsf@flintfam.org> (raw)
* doc/org-manual.org (Clocking commands): Document operation of
org-clock-{in,out}-switch-to-state.
---
doc/org-manual.org | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index ad584d7a5..95acf9170 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -6583,6 +6583,27 @@ about what to do with it.
C-u C-u)}}} prefixes, force continuous clocking by starting the
clock when the last clock stopped.
+ #+vindex: org-clock-in-switch-to-state
+ The variable ~org-clock-in-switch-to-state~ controls how a current
+ task's TODO state is changed on clock-in. No change (a ~nil~) is
+ the default. A specific state may be forced with a string value.
+ Additionally, a function which takes a current state and returns
+ either a new state or ~nil~ for no change may be used. Finally, an
+ alist may be used to provide a mapping from state to state.
+ Consider the following example, where ~TODO~ becomes ~WORKING~, and
+ ~WAITING~ becomes ~WORKING~ on clock-in.
+
+ #+begin_src emacs-lisp
+ (setf org-clock-in-switch-to-state '(("TODO" . "WORKING")
+ ("WAITING" . "WORKING")))
+ #+end_src
+
+ The
+ ~org-clock-in-next-state~ alist may be utilized by setting it to
+ ~org-clock-in-next-state-function~, or a custom function may be
+ used. This custom function should take the current state, and
+ return either a new state or ~nil~ to keep the current state.
+
#+cindex: @samp{CLOCK_MODELINE_TOTAL}, property
#+cindex: @samp{LAST_REPEAT}, property
#+vindex: org-clock-mode-line-total
@@ -6618,6 +6639,10 @@ about what to do with it.
timestamp[fn:: The corresponding in-buffer setting is: =#+STARTUP:
lognoteclock-out=.].
+ #+vindex: org-clock-out-switch-to-state
+ The variable ~org-clock-out-switch-to-state~ may be configured
+ similarly to ~org-clock-in-switch-to-state~.
+
- {{{kbd(C-c C-x C-x)}}} (~org-clock-in-last~) ::
#+kindex: C-c C-x C-x
--
2.37.0
--
Samuel W. Flint
4096R/FA13D704
(F50D 862B 4F65 5943 A8C2 EF0E 86C9 3E7A FA13 D704)
λs.(s s) λs.(s s)
O< ascii ribbon campaign - stop html mail - www.asciiribbon.org
next reply other threads:[~2022-10-26 14:58 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-10-26 14:54 Samuel W. Flint [this message]
2023-07-16 8:23 ` [PATCH v2 2/2] doc/org-manual.org: Document org-clock-{in,out}-switch-to-state Ihor Radchenko
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87czaed499.fsf@flintfam.org \
--to=swflint+orgmode@flintfam.org \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).