emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@posteo.net>
To: "André A. Gomes" <andremegafone@gmail.com>, Bastien <bzg@gnu.org>,
	Timothy <orgmode@tec.tecosaur.net>
Cc: emacs-orgmode@gnu.org
Subject: [RFC] Re: Headings and Headlines
Date: Sun, 13 Nov 2022 06:59:56 +0000	[thread overview]
Message-ID: <87wn7z730z.fsf@localhost> (raw)
In-Reply-To: <878s1xupey.fsf@gmail.com>

André A. Gomes <andremegafone@gmail.com> writes:

> The project's documentation refers to headings and headlines as
> synonyms.  Relying on a single definition would be beneficial.  If I had
> to choose between the two, I'd go with heading.

I've been looking into changing all the instances of "headline" to
"heading" and I ran into a serious issue: We use `headline' _symbol_ in
multiple places in the code.

Most importantly, org-element.el uses element type `headline' to parse
headings. We cannot easily change this symbol for backwards
compatibility reasons.

I'm afraid that a complete switch to use "heading" everywhere consistently
is not possible without backwards-incompatible change. I know for sure
that changing `headline' element to `heading' element type will break
important packages like org-roam. And there is no good way to work
around this. We cannot make symbol aliases in Elisp in scenarios like
(memq (org-element-type ...) '(headline inlinetask)).

I came to the conclusion that it will, in fact, be easier to change all
things to use "headline" -- all the instances of "heading" in Org code
are in function names, variable names, and docstrings. All can be
changed using obsolete aliases.

On the other hand, overwhelming feedback in this thread is the
opposite -- change "headline" to "heading".

Maybe others have better ideas how to deal with `headline' symbol issue?

-- 
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>


  parent reply	other threads:[~2022-11-13  7:00 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-23 13:32 Headings and Headlines André A. Gomes
2021-07-23 13:56 ` Eric S Fraga
2021-07-23 15:43   ` Christopher Dimech
2021-07-23 15:47     ` Timothy
2021-07-23 15:55       ` Eric S Fraga
2021-07-23 14:04 ` Marco Wahl
2021-07-23 15:03   ` Kaushal Modi
2021-07-23 14:34 ` Timothy
2021-07-23 14:56   ` André A. Gomes
2021-07-23 15:39     ` Timothy
2021-07-24  2:06 ` Tim Cross
2021-07-24  4:04   ` Tom Gillespie
2021-07-24 11:49     ` Matt Price
2021-07-24 18:56   ` Charles Millar
2021-07-24 19:23 ` Timothy
2022-11-13  6:59 ` Ihor Radchenko [this message]
2022-11-13 21:10   ` [RFC] " Rudolf Adamkovič
2022-11-14  4:36     ` Ihor Radchenko
2022-11-16 22:16   ` Tim Cross
2022-11-19 13:46   ` Bastien Guerry
2022-11-19 14:34     ` Vikas Rawal
2022-11-19 15:03       ` Timothy
2022-11-19 15:54         ` Bastien Guerry
2022-11-19 15:54   ` Bastien
2022-11-19 16:01     ` Ihor Radchenko
2022-11-19 23:04       ` Tim Cross
2022-11-20  0:56         ` Vikas Rawal
2022-11-20  5:45         ` Ihor Radchenko
2022-11-20  5:46       ` Bastien
2022-11-20  5:53         ` Ihor Radchenko
2022-11-27  3:33           ` Ihor Radchenko
2022-11-27 10:32             ` Bastien

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=87wn7z730z.fsf@localhost \
    --to=yantar92@posteo.net \
    --cc=andremegafone@gmail.com \
    --cc=bzg@gnu.org \
    --cc=emacs-orgmode@gnu.org \
    --cc=orgmode@tec.tecosaur.net \
    /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).