[BUG] results from org-prepare-dblock make clocktable unusable

[BUG] results from org-prepare-dblock make clocktable unusable

[Mark A. Hershberger]

Buffer contains:

> #+BEGIN: clocktable :match tag
> #+END:

Hiting C-c C-c with point on #+BEGIN results in “Invalid match tag: tag”.

This is from the first line of code in org-tags-expand:
    (unless (org-string-nw-p match) (error "Invalid match tag: %S" match))

Tracking this down, the problem seems too be that org-prepare-dblock
produces a list of params that is the following:

    (:name "clocktable" :match tag)

Emacs  : GNU Emacs 31.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.38, cairo version 1.16.0)
 of 2024-09-04
Package: Org mode version 9.7.10 (release_9.7.10 @ /home/mah/work/code/emacs-master/lisp/org/)

and running “/usr/bin/emacs -Q” on

Emacs  : GNU Emacs 29.4 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.38, cairo version 1.16.0)
 of 2024-07-22, modified by Debian
Package: Org mode version 9.6.15 (release_9.6.15 @ /usr/share/emacs/29.4/lisp/org/)

-- 
http://hexmode.com/

Don't ask me who's influenced me. A lion is made up of the
lambs he's digested, and I've been reading all my life.
    -- Giorgos Seferis

Re: [BUG] results from org-prepare-dblock make clocktable unusable

[Mark A. Hershberger]

This should be re-titled results from org-prepare-dblock make :match
with clocktable unusable".

-- 
http://hexmode.com/

Don't ask me who's influenced me. A lion is made up of the
lambs he's digested, and I've been reading all my life.
    -- Giorgos Seferis

Re: [BUG] results from org-prepare-dblock make clocktable unusable

[Ihor Radchenko]

"Mark A. Hershberger" <mah@everybody.org> writes:

>> #+BEGIN: clocktable :match tag
>> #+END:
>
> Hiting C-c C-c with point on #+BEGIN results in “Invalid match tag: tag”.
>
> This is from the first line of code in org-tags-expand:
>     (unless (org-string-nw-p match) (error "Invalid match tag: %S" match))
>
> Tracking this down, the problem seems too be that org-prepare-dblock
> produces a list of params that is the following:
>
>     (:name "clocktable" :match tag)

You need to put tag into quotes.
I guess we may document this, but I am not sure where.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: [BUG] results from org-prepare-dblock make clocktable unusable

[Mark A. Hershberger]

Ihor Radchenko <yantar92@posteo.net> writes:

> You need to put tag into quotes.
> I guess we may document this, but I am not sure where.

I did figure this out and meant to follow up.

As far as documentation, in the infodoc under "7.5.3 Capturing column
view", we have this:

    ‘:match’
         When set to a string, use this as a tags/property match filter to
         select only a subset of the headlines in the scope set by the ‘:id’
         parameter.

And, under "8.4.2 The clock table":

    ‘:match’
         A tags match to select entries that should contribute.  See *note
         Matching tags and properties:: for the match syntax.

I'm looking through "11.3.3 Matching tags and properties" and the only
reference there to double-quotes is this:

   • If the comparison value is enclosed in double-quotes, a string
     comparison is done, and the same operators are allowed.

and

   • If the comparison value is enclosed in double-quotes _and_ angular
     brackets (like ‘DEADLINE<​="<2008-12-24 18:30>"’), both values are
     assumed to be date/time specifications in the standard Org way, and
     the comparison is done accordingly.  Valid values also include
     ‘"<now>"’ for now (including time), ‘"<today>"’, and ‘"<tomorrow>"’
     for these days at 0:00 hours, i.e., without a time specification.
     You can also use strings like ‘"<+5d>"’ or ‘"<-2m>"’ with units
     ‘d’, ‘w’, ‘m’, and ‘y’ for day, week, month, and year,
     respectively.

So, I think there is a lack of clarity in the documentation.

-- 
http://hexmode.com/

Don't ask me who's influenced me. A lion is made up of the
lambs he's digested, and I've been reading all my life.
    -- Giorgos Seferis

Re: [BUG] results from org-prepare-dblock make clocktable unusable

[Ihor Radchenko]

"Mark A. Hershberger" <mah@everybody.org> writes:

> Ihor Radchenko <yantar92@posteo.net> writes:
>
>> You need to put tag into quotes.
>> I guess we may document this, but I am not sure where.
>
> I did figure this out and meant to follow up.
>
> As far as documentation, in the infodoc under "7.5.3 Capturing column
> view", we have this:
>
>     ‘:match’
>          When set to a string, use this as a tags/property match filter to
>          select only a subset of the headlines in the scope set by the ‘:id’
>          parameter.

So, we clearly say that :match should be set to a string here.
Is it confusing for you?

> And, under "8.4.2 The clock table":
>
>     ‘:match’
>          A tags match to select entries that should contribute.  See *note
>          Matching tags and properties:: for the match syntax.

I guess we may specify that the value must be a string here.
Would you be interested to write a small patch that improves the description?

> I'm looking through "11.3.3 Matching tags and properties" and the only
> reference there to double-quotes is this:
>
>    • If the comparison value is enclosed in double-quotes, a string
>      comparison is done, and the same operators are allowed.
>
> and
>
>    • If the comparison value is enclosed in double-quotes _and_ angular
>      brackets (like ‘DEADLINE<​="<2008-12-24 18:30>"’), both values are
>      assumed to be date/time specifications in the standard Org way, and
>      the comparison is done accordingly.  Valid values also include
>      ‘"<now>"’ for now (including time), ‘"<today>"’, and ‘"<tomorrow>"’
>      for these days at 0:00 hours, i.e., without a time specification.
>      You can also use strings like ‘"<+5d>"’ or ‘"<-2m>"’ with units
>      ‘d’, ‘w’, ‘m’, and ‘y’ for day, week, month, and year,
>      respectively.

This is not related. This part is talking about quoting value _inside_
the match syntax. Like :match "DEADLINE>=\"+1d\"".

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: [BUG] results from org-prepare-dblock make clocktable unusable

[Mark A. Hershberger]

On Sun, 2024-09-15 at 10:25 +0000, Ihor Radchenko wrote:
> "Mark A. Hershberger" <mah@everybody.org> writes:
> > 
> > As far as documentation, in the infodoc under "7.5.3 Capturing
> > column view", we have this:
> > 
> >     ‘:match’
> >          When set to a string, use this as a tags/property match  
> > filter to
> >          select only a subset of the headlines in the scope set by
> > the ‘:id' parameter.
> 
> So, we clearly say that :match should be set to a string here.
> Is it confusing for you?

It does not specifically say "Strings must be wrapped in quotes".  When
I'm dealing with org-files (and my mental model may be wrong), I think
everything is a string, even if it is not wrapped in quotes.