Re: Agenda clocktable & archive issue

emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Andrew Hyatt <ahyatt@gmail.com>
To: Ihor Radchenko <yantar92@posteo.net>
Cc: emacs-orgmode@gnu.org
Subject: Re: Agenda clocktable & archive issue
Date: Mon, 29 Jan 2024 12:46:40 -0400	[thread overview]
Message-ID: <m2sf2g140f.fsf@gmail.com> (raw)
In-Reply-To: <87le88mghg.fsf@localhost> (Ihor Radchenko's message of "Mon, 29 Jan 2024 13:11:39 +0000")

[-- Attachment #1: Type: text/plain, Size: 1286 bytes --]

Ihor Radchenko <yantar92@posteo.net> writes:

> Andrew Hyatt <ahyatt@gmail.com> writes:
>
>>> Still, I do not mind adding customization to enable it during startup,
>>> similar to the existing customizations:
>>> `org-agenda-start-with-log-mode',
>>> `org-agenda-start-with-entry-text-mode',
>>> `org-agenda-start-with-follow-mode', etc.
>>
>> Thank you, that makes sense.  I've attached the patch.
>
> Thank you!
>
>> From 4eee33856af687564a522ab40ebed4ba5d848cf4 Mon Sep 17 00:00:00 2001
>> From: Andrew Hyatt <ahyatt@gmail.com>
>> Date: Sun, 28 Jan 2024 21:33:20 -0400
>> Subject: [PATCH] Add org-agenda-start-with-archives-mode
>
> May you please also add a proper commit message? See
> https://orgmode.org/worg/org-contribute.html#commit-messages
>
>> +(defcustom org-agenda-start-with-archives-mode nil
>> +  "Initial value of archive-mode in a newly created agenda window."
>> +  :group 'org-agenda-startup
>> +  :type 'boolean)
>
> Please add :package-version '(Org . "9.7") keyword to indicate when the
> new option is added.
>
> Also, please add an entry in etc/ORG_NEWS file and document the new
> option in the manual (11.5 Commands in the Agenda Buffer display section)

Thanks for the pointers; it's been years since my last contribution.
I've attached the latest patch.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: path for addition of org-agenda-start-with-archives-mode --]
[-- Type: text/x-patch, Size: 3567 bytes --]

From 4798f9b7fadc078a914cd399e797084c166fd1b0 Mon Sep 17 00:00:00 2001
From: Andrew Hyatt <ahyatt@gmail.com>
Date: Sun, 28 Jan 2024 21:33:20 -0400
Subject: [PATCH] lisp/org-agenda.el Add org-agenda-start-with-archives-mode

* lisp/org-agenda.el: Add org-agenda-start-with-archives-mode.
(org-agenda-mode): Set value of org-agenda-archive-mode according to
value of new variable org-agenda-start-with-archives-mode.

* doc/org-manual.org: Note new variable in documentation of
org-agenda-archives.mode.

* etc/ORG-NEWS: Note change to add org-agenda-start-with-archives-mode.
---
 doc/org-manual.org |  6 +++++-
 etc/ORG-NEWS       |  5 +++++
 lisp/org-agenda.el | 11 ++++++++++-
 3 files changed, 20 insertions(+), 2 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index ffb025c93..86008164e 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -10077,9 +10077,13 @@ the other commands, point needs to be in the desired line.
 
   #+kindex: v a
   #+findex: org-agenda-archives-mode
+  #+vindex: org-agenda-start-with-clockreport-mode
   Toggle Archives mode.  In Archives mode, trees that are archived
   (see [[*Internal archiving]]) are also scanned when producing the
-  agenda.  To exit archives mode, press {{{kbd(v a)}}} again.
+  agenda.  To exit archives mode, press {{{kbd(v a)}}} again.  The
+  initial setting for this mode in new agenda buffers can set with the
+  variable ~org-agenda-start-with-archives-mode~, which can be set
+  with the same values as ~org-agenda-archives-mode~.
 
 - {{{kbd(v A)}}} ::
 
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index f4e98d78b..82090df32 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -686,6 +686,11 @@ manner with ~run-python~.
 
 This allows to run functions after ~org-indent~ intializes a buffer to
 enrich its properties.
+*** New option ~org-agenda-start-with-archives-mode~
+
+This option starts the agenda to automatically include archives,
+propagating the value for this variable to ~org-agenda-archives-mode~.
+For acceptable values and their meaning, see the value of that variable.
 
 ** New features
 *** =ob-plantuml.el=: Support tikz file format output
diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 20da364b5..7fe482f30 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -1102,6 +1102,14 @@ removed from entry text before it is shown in the agenda."
   :group 'org-agenda
   :type 'string)
 
+(defcustom org-agenda-start-with-archives-mode nil
+  "Initial value of archive-mode in a newly created agenda window.
+See `org-agenda-archives-mode' for acceptable values and their
+meaning."
+  :group 'org-agenda-startup
+  :package-version '(Org . "9.7")
+  :type 'boolean)
+
 (defvar org-agenda-entry-text-cleanup-hook nil
   "Hook that is run after basic cleanup of entry text to be shown in agenda.
 This cleanup is done in a temporary buffer, so the function may inspect and
@@ -2372,7 +2380,8 @@ The following commands are available:
     (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
 	  org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
 	  org-agenda-show-log org-agenda-start-with-log-mode
-	  org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode))
+	  org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
+          org-agenda-archives-mode org-agenda-start-with-archives-mode))
   (add-to-invisibility-spec '(org-filtered))
   (org-fold-core-initialize `(,org-link--description-folding-spec
                               ,org-link--link-folding-spec))
-- 
2.39.3 (Apple Git-145)

next prev parent reply	other threads:[~2024-01-29 16:50 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-28 18:59 Agenda clocktable & archive issue Andrew Hyatt
2024-01-28 20:40 ` Ihor Radchenko
2024-01-28 22:18   ` Andrew Hyatt
2024-01-28 22:34     ` Ihor Radchenko
2024-01-29  1:36       ` Andrew Hyatt
2024-01-29 13:11         ` Ihor Radchenko
2024-01-29 16:46           ` Andrew Hyatt [this message]
2024-01-29 17:00             ` Ihor Radchenko

find likely ancestor, descendant, or conflicting patches for this message:
dfblob:ffb025c9 dfblob:f4e98d78 dfblob:20da364b dfblob:86008164
dfblob:82090df3 dfblob:7fe482f3
	(help)

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=m2sf2g140f.fsf@gmail.com \
    --to=ahyatt@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=yantar92@posteo.net \
    /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).