emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Carlos Pita <carlosjosepita2@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Inconsistent usage of "overview"
Date: Wed, 3 Nov 2021 00:31:14 -0300	[thread overview]
Message-ID: <CAEOO5TcBr2Yz9gEhkvHWGcnCBozkrLA4pd4+htjQr3ahKJ5sgA@mail.gmail.com> (raw)

Hi all,

Here is something I find very confusing. In [1]:

    #+STARTUP: overview
    #+STARTUP: content
    #+STARTUP: showall
    #+STARTUP: show<n>levels
    #+STARTUP: showeverything

In org-startup-folded docstring it is said that it takes values equivalent to:

   #+STARTUP: fold              (or ‘overview’, this is equivalent)
   #+STARTUP: nofold            (or ‘showall’, this is equivalent)
   #+STARTUP: content
   #+STARTUP: show<n>levels (<n> = 2..5)
   #+STARTUP: showeverything

The fact that "overview" is also called "fold" doesn't make what
follows simpler, but so far so good.

Then there is the function org-overview, which:

    Switch to overview mode, showing only top-level headlines.

But org-overview shows drawers unfolded while "overview" mode folds
drawers at startup. That is, if you start in "fold" or "overview" mode
(as in #+STARTUP or org-startup-folder) and then cycle visibility all
the way back to "overview" (now as in org-overview) you're not at the
beginning again.

I would say that this is not intentional but an inconsistency in what
"overview" means that should be resolved some way or another. For me
it makes sense that drawers begin folded in an overview and the
docstring of org-overview seems to suggest that. Moreover, while
cycling the rest of the "more expanded" visibility states fold
drawers.

And sometimes properties represent a disproportionate part of the
document when compared to folded top-level headlines. For example, I'm
thinking of brief org-roam notes showing an awful UUID at the top
which is IMO not relevant to an overview.

Best regards,
Carlos

---

[1] https://orgmode.org/manual/Initial-visibility.html


             reply	other threads:[~2021-11-03  3:32 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-03  3:31 Carlos Pita [this message]
2021-11-03 20:14 ` Inconsistent usage of "overview" Carlos Pita
2024-02-11 12:43   ` Ihor Radchenko

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=CAEOO5TcBr2Yz9gEhkvHWGcnCBozkrLA4pd4+htjQr3ahKJ5sgA@mail.gmail.com \
    --to=carlosjosepita2@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /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).