emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: "Gustav Wikström" <gustav@whil.se>
To: Eric S Fraga <e.fraga@ucl.ac.uk>, Bastien <bzg@gnu.org>,
	TEC <tecosaur@gmail.com>
Cc: "emacs-orgmode@gnu.org" <emacs-orgmode@gnu.org>
Subject: Sv: New startup options, show<n>levels
Date: Sun, 13 Dec 2020 15:36:33 +0000	[thread overview]
Message-ID: <HE1PR0202MB2857A98F44B759AE6A9A2826DAC80@HE1PR0202MB2857.eurprd02.prod.outlook.com> (raw)
In-Reply-To: <878sa2xci7.fsf@ucl.ac.uk>

Hi,

I believe we still can change the name if that’s preferred. I'm not overly attached to the name I committed, although I fail to see the ugliness in it. And it's only in master since a few days. No biggie to change.

In my opinion it's important to see the names in their context. One context is the other available startup options.

Principles I tried to follow when choosing the names (Alt 0 below):
1) Keep the name as close to the intent as possible. It should be possible to understand it based on name alone, if possible. (I.e. avoid ambiguity)
2) Let the pattern for the name match with the pattern already existing for names in its surrounding context.
3) Keep it short, but prefer principle 1 and 2 to short.

The following options have been presented, where the first one is already in master:

Already in master (Alt 0): 
 `overview'        Top-level headlines only.  
 `content'         All headlines.             
 `show2levels'     Headline levels 1-2.       
 `show3levels'     Headline levels 1-3.       
 `show4levels'     Headline levels 1-4.       
 `show5levels'     Headline levels 1-5.       
 `showall'         No folding on any entry.   
 `showeverything'  Show even drawer contents. 

Alt 1:
 `overview'        Top-level headlines only.  
 `content'         All headlines.             
 `show:2'          Headline levels 1-2.       
 `show:3'          Headline levels 1-3.       
 `show:4'          Headline levels 1-4.       
 `show:5'          Headline levels 1-5.       
 `showall'         No folding on any entry.   
 `showeverything'  Show even drawer contents. 

Alt 2:
 `overview'        Top-level headlines only.  
 `content'         All headlines.             
 `levels:2'        Headline levels 1-2.       
 `levels:3'        Headline levels 1-3.       
 `levels:4'        Headline levels 1-4.       
 `levels:5'        Headline levels 1-5.       
 `showall'         No folding on any entry.   
 `showeverything'  Show even drawer contents. 

Alt 3:
 `overview'        Top-level headlines only.  
 `content'         All headlines.             
 `content:2'       Headline levels 1-2.       
 `content:3'       Headline levels 1-3.       
 `content:4'       Headline levels 1-4.       
 `content:5'       Headline levels 1-5.       
 `showall'         No folding on any entry.   
 `showeverything'  Show even drawer contents.

To me no option is perfect. There are incongruencies for all. Maybe a fourth option?

Alt 4:
`overview'        Top-level headlines only.  
 `content'         All headlines.             
 `2levels'         Headline levels 1-2.       
 `3levels'         Headline levels 1-3.       
 `4levels'         Headline levels 1-4.       
 `5levels'         Headline levels 1-5.       
 `showall'         No folding on any entry.   
 `showeverything'  Show even drawer contents.

Since show in showall and showeverything seems to symbolize the unfolding of things.

That would be an improvement based on all three principles above, in that it removes the ambiguity of "show" (and how it relates to unfolding), makes the names shorter, and stays in line with the naming convention (i.e. no ':'). Not sure what the syntax says about names starting with numerals though.

Your call. Personally I'd prefer Alt 4 or the existing one.

/Gustav

> -----Ursprungligt meddelande-----
> Från: Eric S Fraga <e.fraga@ucl.ac.uk>
> Skickat: den 13 december 2020 10:49
> Till: Bastien <bzg@gnu.org>
> Kopia: Gustav Wikström <gustav@whil.se>; emacs-orgmode@gnu.org
> Ämne: Re: New startup options, show<n>levels
> 
> On Saturday, 12 Dec 2020 at 18:54, Bastien wrote:
> > In this case, I think we could come up with better option names than
> > "show2levels", even if I don't have a better suggestion right now.
> 
> I agree.  I had started responding to Gustav when the original post
> appeared but then aborted my response.  I wonder whether something like
> levels:N or show:N or content:N is possible in a startup setting, akin
> to H:N in options?
> 
> I do have (org-content N) often in my file local variables in any case.
> --
> : Eric S Fraga via Emacs 28.0.50, Org release_9.4-160-g7c8dce

  parent reply	other threads:[~2020-12-13 15:44 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-10  9:46 Gustav Wikström
2020-12-12 17:54 ` Bastien
2020-12-12 18:56   ` Gustav Wikström
2020-12-13  9:48   ` Eric S Fraga
2020-12-13 10:19     ` TEC
2020-12-13 10:19     ` TEC
2020-12-13 15:36     ` Gustav Wikström [this message]
2020-12-13 15:42       ` Sv: " TEC

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=HE1PR0202MB2857A98F44B759AE6A9A2826DAC80@HE1PR0202MB2857.eurprd02.prod.outlook.com \
    --to=gustav@whil.se \
    --cc=bzg@gnu.org \
    --cc=e.fraga@ucl.ac.uk \
    --cc=emacs-orgmode@gnu.org \
    --cc=tecosaur@gmail.com \
    --subject='Re: Sv: New startup options, show<n>levels' \
    /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

Code repositories for project(s) associated with this 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).