org-agenda-clock-report-header

org-agenda-clock-report-header

[Colin Baxter]

Hello,

Could more information perhaps be added to the doc string of
"org-agenda-clock-report-header"? And an example would be very
useful. As it stands at present, I haven't a clue as to what the
variable does and why it might be useful.

Thank you.

Colin Baxter.

[PATCH] Re: org-agenda-clock-report-header

[Ihor Radchenko]

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

Colin Baxter <m43cap@yandex.com> writes:

> Could more information perhaps be added to the doc string of
> "org-agenda-clock-report-header"? And an example would be very
> useful. As it stands at present, I haven't a clue as to what the
> variable does and why it might be useful.

It's literally a string inserted right before the table. There is
nothing much to show there. See
https://orgmode.org/list/CAJAdVc06_tj58Je=tn42JqfUtkjamQBQdcvobQXeegARS_M0hQ@mail.gmail.com

Is version in the attached patch more clear?

Best,
Ihor


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-agenda-clock-report-header-Update-docstring.patch --]
[-- Type: text/x-patch, Size: 1082 bytes --]

From 9b5f5844aedfab9f36ba89ed8beca36651370c0a Mon Sep 17 00:00:00 2001
Message-Id: <9b5f5844aedfab9f36ba89ed8beca36651370c0a.1652099870.git.yantar92@gmail.com>
From: Ihor Radchenko <yantar92@gmail.com>
Date: Mon, 9 May 2022 20:34:38 +0800
Subject: [PATCH] org-agenda-clock-report-header: Update docstring

See https://orgmode.org/list/87o808j6si.fsf@yandex.com
---
 lisp/org-agenda.el | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 0479a0e1f..9d38b889d 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -1221,11 +1221,11 @@ (defcustom org-agenda-timegrid-use-ampm nil
   :type 'boolean)
 
 (defcustom org-agenda-clock-report-header nil
-  "Header for org agenda clock report mode"
+  "Header inserted before the table in Org agenda clock report mode."
   :group 'org-agenda
   :type '(choice
-    (string :tag "Header")
-    (const :tag "No header" nil))
+          (string :tag "Header")
+          (const :tag "No header" nil))
   :safe #'stringp
   :package-version '(Org . "9.6"))
 
-- 
2.35.1

Re: [PATCH] Re: org-agenda-clock-report-header

[Colin Baxter]

Hello Ihor,

>>>>> Ihor Radchenko <yantar92@gmail.com> writes:

    > Colin Baxter <m43cap@yandex.com> writes:
    >> Could more information perhaps be added to the doc string of
    >> "org-agenda-clock-report-header"? And an example would be very
    >> useful. As it stands at present, I haven't a clue as to what the
    >> variable does and why it might be useful.

    > It's literally a string inserted right before the table. There is
    > nothing much to show there. See
    > https://orgmode.org/list/CAJAdVc06_tj58Je=tn42JqfUtkjamQBQdcvobQXeegARS_M0hQ@mail.gmail.com

    > Is version in the attached patch more clear?

    > Best, Ihor

    > From 9b5f5844aedfab9f36ba89ed8beca36651370c0a Mon Sep 17 00:00:00
    > 2001 Message-Id:
    > <9b5f5844aedfab9f36ba89ed8beca36651370c0a.1652099870.git.yantar92@gmail.com>
    > From: Ihor Radchenko <yantar92@gmail.com> Date: Mon, 9 May 2022
    > 20:34:38 +0800 Subject: [PATCH] org-agenda-clock-report-header:
    > Update docstring

    > See https://orgmode.org/list/87o808j6si.fsf@yandex.com ---
    > lisp/org-agenda.el | 6 +++--- 1 file changed, 3 insertions(+), 3
    > deletions(-)

    > diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el index
    > 0479a0e1f..9d38b889d 100644 --- a/lisp/org-agenda.el +++
    > b/lisp/org-agenda.el @@ -1221,11 +1221,11 @@ (defcustom
    > org-agenda-timegrid-use-ampm nil :type 'boolean)
 
    >  (defcustom org-agenda-clock-report-header nil - "Header for org
    > agenda clock report mode" + "Header inserted before the table in
    > Org agenda clock report mode."  :group 'org-agenda :type '(choice
    > - (string :tag "Header") - (const :tag "No header" nil)) + (string
    > :tag "Header") + (const :tag "No header" nil)) :safe #'stringp
    > :package-version '(Org . "9.6"))
 
    > -- 2.35.1

Thank you for your reply and patch.

Unfortunately, I see no difference in my clock tables whether I have
org-agenda-clock-report-header set to t, nil or something like
"My-Heading", or if I put :Header: as a tag in the file headline that
contains the clock table, or if I write :Header t in the #+BEGIN:
clocktable line. You can see I'm ringing the changes in ignorant
desperation. I'm pretty stupid so I'm obviously missing something
fundamental here - but what?
 
Best wishes,

Colin Baxter.

Re: [PATCH] Re: org-agenda-clock-report-header

[Ihor Radchenko]

Colin Baxter <m43cap@yandex.com> writes:

> Unfortunately, I see no difference in my clock tables whether I have
> org-agenda-clock-report-header set to t, nil or something like
> "My-Heading", or if I put :Header: as a tag in the file headline that
> contains the clock table, or if I write :Header t in the #+BEGIN:
> clocktable line. You can see I'm ringing the changes in ignorant
> desperation. I'm pretty stupid so I'm obviously missing something
> fundamental here - but what?

Because your clock tables in Org _files_ have nothing to do with agenda.
There is no "Agenda clock report mode" when you create an ordinary clock
report in Org buffers.

Best,
Ihor

Re: [PATCH] Re: org-agenda-clock-report-header

[Colin Baxter]

>>>>> Ihor Radchenko <yantar92@gmail.com> writes:

    > Colin Baxter <m43cap@yandex.com> writes:
    >> Unfortunately, I see no difference in my clock tables whether I
    >> have org-agenda-clock-report-header set to t, nil or something
    >> like "My-Heading", or if I put :Header: as a tag in the file
    >> headline that contains the clock table, or if I write :Header t
    >> in the #+BEGIN: clocktable line. You can see I'm ringing the
    >> changes in ignorant desperation. I'm pretty stupid so I'm
    >> obviously missing something fundamental here - but what?

    > Because your clock tables in Org _files_ have nothing to do with
    > agenda.  There is no "Agenda clock report mode" when you create an
    > ordinary clock report in Org buffers.

Well now you've really confused me because I wasn't in an agenda buffer,
I had constructed a clock table from a non-agenda org file.

Could give me a concrete example of where the variable
org-agenda-clock-report-header might be used?

Best wishes,

Re: [PATCH] Re: org-agenda-clock-report-header

[Ihor Radchenko]

Colin Baxter <m43cap@yandex.com> writes:

>     > Because your clock tables in Org _files_ have nothing to do with
>     > agenda.  There is no "Agenda clock report mode" when you create an
>     > ordinary clock report in Org buffers.
>
> Well now you've really confused me because I wasn't in an agenda buffer,
> I had constructed a clock table from a non-agenda org file.
>
> Could give me a concrete example of where the variable
> org-agenda-clock-report-header might be used?

When you are in agenda, you can press v R to toggle
org-agenda-clockreport-mode:

(11.5 Commands in the Agenda Buffer)

>>     Toggle Clockreport mode.  In Clockreport mode, the daily/weekly
>>     agenda always shows a table with the clocked times for the time
>>     span and file scope covered by the current agenda view.  The
>>     initial setting for this mode in new agenda buffers can be set with
>>     the variable ‘org-agenda-start-with-clockreport-mode’.  By using a
>>     prefix argument when toggling this mode (i.e., ‘C-u R’), the clock
>>     table does not show contributions from entries that are hidden by
>>     agenda filtering(1).  See also the variable
>>     ‘org-clock-report-include-clocking-task’.

Best,
Ihor

Re: [PATCH] Re: org-agenda-clock-report-header

[Ihor Radchenko]

Ihor Radchenko <yantar92@gmail.com> writes:

> From 9b5f5844aedfab9f36ba89ed8beca36651370c0a Mon Sep 17 00:00:00 2001
> Message-Id: <9b5f5844aedfab9f36ba89ed8beca36651370c0a.1652099870.git.yantar92@gmail.com>
> From: Ihor Radchenko <yantar92@gmail.com>
> Date: Mon, 9 May 2022 20:34:38 +0800
> Subject: [PATCH] org-agenda-clock-report-header: Update docstring

Applied onto main via 702b0a81e after adding reference to relevant
manual page.

Best,
Ihor