Bug: Description of org agenda columns format in manual not correct/misleading

Bug: Description of org agenda columns format in manual not correct/misleading

[Andrew Francis Swann]

I am trying to work out how to specify the column view from the standard org-agenda-list command.  The manual is confusing me, and I can see some of the variables have changed in commit cc020dbe4d .  The documentation only seems to partially address this and does not fit with the documentation of the variables themselves.  Please see below for more details.

This manual is for Org version 9.2.
Emacs  : GNU Emacs 26.2 (build 1, x86_64-apple-darwin18.5.0, Carbon Version 158 AppKit 1671.4)
 of 2019-04-14
Package: Org mode version 9.2.5 (9.2.5-1-gff6508-elpaplus @ /Users/au5316/.emacs.d/elpa/org-plus-contrib-20190812/)

In the info pages under Agenda Views > Agenda Column View point 1. says

  1. Org needs to make a decision which columns format to use.  Since
     the entries in the agenda are collected from different files, and
     different files may have different columns formats, this is a
     non-trivial problem.  Org first checks if the variable
     ‘org-overriding-columns-format’ is currently set, and if so, takes
     the format from there.  Otherwise it takes the format associated
     with the first item in the agenda, or, if that item does not have a
     specific format (defined in a property, or in its file), it uses
     ‘org-columns-default-format’.

However, it does not say how to set org-overriding-columns-format.    The documentation for this variable gives

When set, overrides any other format definition for the agenda.
Don’t set this, this is meant for dynamic scoping.  Set
‘org-local-columns-format’ instead.

and the documentation for org-local-columns-format says

When set, overrides any other format definition for the agenda.
This can be set as a buffer local value to avoid interfering with
dynamic scoping for ‘org-overriding-columns-format’.

-- 
Andrew Swann | Associate Professor | Tel +45 871 55767 | swann@math.au.dk | http://home.math.au.dk/swann/ | Department of Mathematics, Aarhus University, Ny Munkegade 118, Bldg 1530, DK-8000 Aarhus C, Denmark | Dept +45 871 50000 | Fax +45 8613 1769
 

Re: Bug: Description of org agenda columns format in manual not correct/misleading

[Fraga, Eric]

I have this setting in my Emacs initialization:

(setq org-agenda-overriding-columns-format "%5TODO %TIMESTAMP %40ITEM %LOCATION %TAGS")

HTH,
eric

-- 
Eric S Fraga via Emacs 27.0.50, Org release_9.2.4-401-gfabd6d

FW: Bug: Description of org agenda columns format in manual not correct/misleading

[Andrew Francis Swann]

-- 
Andrew Swann | Associate Professor | Tel +45 871 55767 | swann@math.au.dk | http://home.math.au.dk/swann/ | Department of Mathematics, Aarhus University, Ny Munkegade 118, Bldg 1530, DK-8000 Aarhus C, Denmark | Dept +45 871 50000 | Fax +45 8613 1769
 

-----Original Message-----
From: Andrew Francis Swann <swann@math.au.dk>
Date: Wednesday, 14 August 2019 at 12:37
To: "Fraga, Eric" <e.fraga@ucl.ac.uk>
Subject: Re: [O] Bug: Description of org agenda columns format in manual not correct/misleading

    Thank you,  but that variable is now obseleted and points to org-overriding-columns-format whose documatiton says it should not be used.  From the documentation of the variable
    
    org-agenda-overriding-columns-format is a variable defined in ‘org-compat.el’.
    Its value is nil
    
      This variable is an alias for ‘org-overriding-columns-format’.
      This variable is obsolete since Org 9.2.2;
      use ‘org-overriding-columns-format’ instead.
    
    Documentation:
    When set, overrides any other format definition for the agenda.
    Don’t set this, this is meant for dynamic scoping.  Set
    ‘org-local-columns-format’ instead.
    
    -- 
    Andrew Swann | Associate Professor | Tel +45 871 55767 | swann@math.au.dk | http://home.math.au.dk/swann/ | Department of Mathematics, Aarhus University, Ny Munkegade 118, Bldg 1530, DK-8000 Aarhus C, Denmark | Dept +45 871 50000 | Fax +45 8613 1769
     
    
    -----Original Message-----
    From: "Fraga, Eric" <e.fraga@ucl.ac.uk>
    Date: Wednesday, 14 August 2019 at 12:33
    To: Andrew Francis Swann <swann@math.au.dk>
    Cc: Org mode <emacs-orgmode@gnu.org>
    Subject: Re: [O] Bug: Description of org agenda columns format in manual not correct/misleading
    
        I have this setting in my Emacs initialization:
        
        (setq org-agenda-overriding-columns-format "%5TODO %TIMESTAMP %40ITEM %LOCATION %TAGS")
        
        HTH,
        eric
        
        -- 
        Eric S Fraga via Emacs 27.0.50, Org release_9.2.4-401-gfabd6d
        
    
    

Re: FW: Bug: Description of org agenda columns format in manual not correct/misleading

[Fraga, Eric]

I'll copy my response to the list as well!  Didn't notice the list was
not copied.


On Wednesday, 14 Aug 2019 at 10:37, Andrew Francis Swann wrote:
> Thank you, but that variable is now obseleted and points to
> org-overriding-columns-format whose documatiton says it should not be
> used.  From the documentation of the variable

Interesting.  My org-overriding-columns-format has the same value so I
guess the string I gave you should work for that variable?

-- 
Eric S Fraga via Emacs 27.0.50, Org release_9.2.4-401-gfabd6d

Re: Bug: Description of org agenda columns format in manual not correct/misleading

[Andrew Francis Swann]

Yes, but the documentation says to use that variable, but the variable's own documentation says it should not be used.  What I am reporting is a documentation bug.

-- 
Andrew Swann | Associate Professor | Tel +45 871 55767 | swann@math.au.dk | http://home.math.au.dk/swann/ | Department of Mathematics, Aarhus University, Ny Munkegade 118, Bldg 1530, DK-8000 Aarhus C, Denmark | Dept +45 871 50000 | Fax +45 8613 1769
 

-----Original Message-----
From: "Fraga, Eric" <e.fraga@ucl.ac.uk>
Date: Wednesday, 14 August 2019 at 12:44
To: Andrew Francis Swann <swann@math.au.dk>
Subject: Re: [O] Bug: Description of org agenda columns format in manual not correct/misleading

    On Wednesday, 14 Aug 2019 at 10:37, Andrew Francis Swann wrote:
    > Thank you, but that variable is now obseleted and points to
    > org-overriding-columns-format whose documatiton says it should not be
    > used.  From the documentation of the variable
    
    Interesting.  My org-overriding-columns-format has the same value so I
    guess the string I gave you should work for that variable?
    
    -- 
    Eric S Fraga via Emacs 27.0.50, Org release_9.2.4-401-gfabd6d
    

Re: Bug: Description of org agenda columns format in manual not correct/misleading

[Nick Dokos]

"Fraga, Eric" <e.fraga@ucl.ac.uk> writes:

> I have this setting in my Emacs initialization:
>
> (setq org-agenda-overriding-columns-format "%5TODO %TIMESTAMP %40ITEM %LOCATION %TAGS")
>
> HTH,
> eric

Shouldn't you be using org-columns-default-format instead?

-- 
Nick

"There are only two hard problems in computer science: cache
invalidation, naming things, and off-by-one errors." -Martin Fowler

Re: Bug: Description of org agenda columns format in manual not correct/misleading

[Fraga, Eric]

On Wednesday, 14 Aug 2019 at 15:57, Nick Dokos wrote:
> "Fraga, Eric" <e.fraga@ucl.ac.uk> writes:
>
>> I have this setting in my Emacs initialization:
>>
>> (setq org-agenda-overriding-columns-format "%5TODO %TIMESTAMP %40ITEM %LOCATION %TAGS")
>>
>> HTH,
>> eric
>
> Shouldn't you be using org-columns-default-format instead?

No because it's about setting the columns format for the agenda view
alone, not the format for normal org buffers.  My error was in using a
deprecated variable; the actual variable is
org-overriding-columns-format.

The OP's post was actually about the documentation (which I
misunderstood).

-- 
Eric S Fraga via Emacs 27.0.50, Org release_9.2.4-401-gfabd6d

Re: Bug: Description of org agenda columns format in manual not correct/misleading

[Carsten Dominik]

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

Hi,

On Thu, Aug 15, 2019 at 9:50 AM Fraga, Eric <e.fraga@ucl.ac.uk> wrote:

> On Wednesday, 14 Aug 2019 at 15:57, Nick Dokos wrote:
> > "Fraga, Eric" <e.fraga@ucl.ac.uk> writes:
> >
> >> I have this setting in my Emacs initialization:
> >>
> >> (setq org-agenda-overriding-columns-format "%5TODO %TIMESTAMP %40ITEM
> %LOCATION %TAGS")
> >>
> >> HTH,
> >> eric
> >
> > Shouldn't you be using org-columns-default-format instead?
>
> No because it's about setting the columns format for the agenda view
> alone, not the format for normal org buffers.  My error was in using a
> deprecated variable; the actual variable is
> org-overriding-columns-format.
>
> The OP's post was actually about the documentation (which I
> misunderstood).
>

I have discussed this problem with Allen Li, who fixed a bug in the agenda
column setting a while ago.

I think what is missing to make this more transparent is a variable
`org-default-columns-format-for-agenda' which is a proper user option.
This option can be set in your init.el or through customize, and it will
provide a default format for the agenda.  `org-overriding-columns-format
should ONLY EVER be used in the local setting section of a custom agenda
view.

This new variable is not available in master.

- Carsten

[-- Attachment #2: Type: text/html, Size: 1860 bytes --]

Re: Bug: Description of org agenda columns format in manual not correct/misleading

[Andrew Francis Swann]

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

Dear Carsten,

This sounds like a very good solution.  I look forward to it being implemented.

Andrew

--
Andrew Swann | Associate Professor | Tel +45 871 55767 | swann@math.au.dk<mailto:swann@math.au.dk> | http://home.math.au.dk/swann/ | Department of Mathematics, Aarhus University, Ny Munkegade 118, Bldg 1530, DK-8000 Aarhus C, Denmark | Dept +45 871 50000 | Fax +45 8613 1769


From: Emacs-orgmode <emacs-orgmode-bounces+swann=math.au.dk@gnu.org> on behalf of Carsten Dominik <dominik@uva.nl>
Date: Friday, 16 August 2019 at 10:19
To: "Fraga, Eric" <e.fraga@ucl.ac.uk>
Cc: Nick Dokos <ndokos@gmail.com>, Org mode <emacs-orgmode@gnu.org>
Subject: Re: [O] Bug: Description of org agenda columns format in manual not correct/misleading

Hi,

On Thu, Aug 15, 2019 at 9:50 AM Fraga, Eric <e.fraga@ucl.ac.uk<mailto:e.fraga@ucl.ac.uk>> wrote:
On Wednesday, 14 Aug 2019 at 15:57, Nick Dokos wrote:
> "Fraga, Eric" <e.fraga@ucl.ac.uk<mailto:e.fraga@ucl.ac.uk>> writes:
>
>> I have this setting in my Emacs initialization:
>>
>> (setq org-agenda-overriding-columns-format "%5TODO %TIMESTAMP %40ITEM %LOCATION %TAGS")
>>
>> HTH,
>> eric
>
> Shouldn't you be using org-columns-default-format instead?

No because it's about setting the columns format for the agenda view
alone, not the format for normal org buffers.  My error was in using a
deprecated variable; the actual variable is
org-overriding-columns-format.

The OP's post was actually about the documentation (which I
misunderstood).

I have discussed this problem with Allen Li, who fixed a bug in the agenda column setting a while ago.

I think what is missing to make this more transparent is a variable `org-default-columns-format-for-agenda' which is a proper user option.  This option can be set in your init.el or through customize, and it will provide a default format for the agenda.  `org-overriding-columns-format should ONLY EVER be used in the local setting section of a custom agenda view.

This new variable is not available in master.

- Carsten

[-- Attachment #2: Type: text/html, Size: 6096 bytes --]

Re: Bug: Description of org agenda columns format in manual not correct/misleading

[Carsten Dominik]

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

It is already in the git master branch.

Carsten

On Fri, Aug 16, 2019 at 1:46 PM Andrew Francis Swann <swann@math.au.dk>
wrote:

> Dear Carsten,
>
>
>
> This sounds like a very good solution.  I look forward to it being
> implemented.
>
>
>
> Andrew
>
>
>
> --
>
> Andrew Swann | Associate Professor | Tel +45 871 55767 | swann@math.au.dk |
> http://home.math.au.dk/swann/ | Department of Mathematics, Aarhus
> University, Ny Munkegade 118, Bldg 1530, DK-8000 Aarhus C, Denmark | Dept
> +45 871 50000 | Fax +45 8613 1769
>
>
>
>
>
> *From: *Emacs-orgmode <emacs-orgmode-bounces+swann=math.au.dk@gnu.org> on
> behalf of Carsten Dominik <dominik@uva.nl>
> *Date: *Friday, 16 August 2019 at 10:19
> *To: *"Fraga, Eric" <e.fraga@ucl.ac.uk>
> *Cc: *Nick Dokos <ndokos@gmail.com>, Org mode <emacs-orgmode@gnu.org>
> *Subject: *Re: [O] Bug: Description of org agenda columns format in
> manual not correct/misleading
>
>
>
> Hi,
>
>
>
> On Thu, Aug 15, 2019 at 9:50 AM Fraga, Eric <e.fraga@ucl.ac.uk> wrote:
>
> On Wednesday, 14 Aug 2019 at 15:57, Nick Dokos wrote:
> > "Fraga, Eric" <e.fraga@ucl.ac.uk> writes:
> >
> >> I have this setting in my Emacs initialization:
> >>
> >> (setq org-agenda-overriding-columns-format "%5TODO %TIMESTAMP %40ITEM
> %LOCATION %TAGS")
> >>
> >> HTH,
> >> eric
> >
> > Shouldn't you be using org-columns-default-format instead?
>
> No because it's about setting the columns format for the agenda view
> alone, not the format for normal org buffers.  My error was in using a
> deprecated variable; the actual variable is
> org-overriding-columns-format.
>
> The OP's post was actually about the documentation (which I
> misunderstood).
>
>
>
> I have discussed this problem with Allen Li, who fixed a bug in the agenda
> column setting a while ago.
>
>
>
> I think what is missing to make this more transparent is a variable
> `org-default-columns-format-for-agenda' which is a proper user option.
> This option can be set in your init.el or through customize, and it will
> provide a default format for the agenda.  `org-overriding-columns-format
> should ONLY EVER be used in the local setting section of a custom agenda
> view.
>
>
>
> This new variable is not available in master.
>
>
>
> - Carsten
>

[-- Attachment #2: Type: text/html, Size: 5174 bytes --]