From: Ihor Radchenko <yantar92@posteo.net>
To: Matt <matt@excalamus.com>
Cc: emacs-orgmode <emacs-orgmode@gnu.org>, Bastien <bzg@gnu.org>
Subject: Comments on Summary section of Org manual (was: [PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-readable)
Date: Wed, 03 Jan 2024 13:44:00 +0000 [thread overview]
Message-ID: <87o7e2a5wf.fsf@localhost> (raw)
In-Reply-To: <18ccc5c24ab.11c0534ea910085.7925872212667260908@excalamus.com>
Matt <matt@excalamus.com> writes:
> Several things in the first paragraph unrelated to your changes stick
> out to me. I can't help but make some other remarks.
>
> "TODO" should probably be "to-do". Every dictionary I looked in has
> an entry for "to-do". I think that's the common spelling.
Yet, we consistently use TODO keyword and TODO list across the whole
manual. Stackexchange tells that both variants are valid:
https://english.stackexchange.com/questions/46217/todo-list-or-to-do-list
although "todo" is much less widely used.
I do not see much benefit changing "todo list" to "to-do list". Both are
clear and both are grammatically correct.
> Regarding "markup language," that reads to me like programmer jargon.
> What does it mean and why should someone care? Again, who are we
> writing to? A markup language is a notation for formatting,
> structure, and relationships. I think it would be best to directly
> say that.
What about "plain text file format"?
> I would also soften that Org "relies" on its markup. It doesn't. I
> used Org only for lists for a long time. I believe lists to be a
> fundamental feature of Org (and hence a great item for the first
> sentence). Lists are as simple as dashes. It's hard to say that
> dashes before list items is a markup language.
Yet, it is. You cannot, for example, use "." as bullets in Org mode.
Also, indentation matters in Org lists, while it does not matter in more
free-style writing.
> Finally, I don't think the file extension is relevant for the first
> paragraph. Technically, an extension isn't necessary. A person can
> call M-x org-mode or use a file local variable. Worse, I think the
> extension contradicts the point that any text editor can view an Org
> file. Ever try to open a .org file in Windows? It asks for the
> program. Yes, *technically* Windows could open a .org file *if* the
> person opening it knew which program to use (or to change the
> extension to something like .txt). Again, who are we writing to? If
> it's someone who believes file extensions matter, then this would
> introduce unnecessary friction. It seems best to avoid it. Better to
> do as you've done and say Org is readable (which it is) rather than
> specify the extension (which doesn't really matter).
I am mostly neutral here, but I can see an argument why mentioning .org
extension may be useful - unlike Windows, GitHub does expect .org file
extension specifically to render Org mode files. The same goes for
non-Emacs editors that support Org markup. For example, Vim/Neovim.
--
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>
next prev parent reply other threads:[~2024-01-03 13:41 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-31 15:24 [PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-readable Ihor Radchenko
2024-01-02 5:24 ` Thomas S. Dye
2024-01-03 7:52 ` Jean Louis
2024-01-03 12:36 ` Bastien Guerry
2024-01-03 13:00 ` Ihor Radchenko
2024-01-02 22:47 ` Matt
2024-01-03 13:44 ` Ihor Radchenko [this message]
2024-01-03 20:43 ` Comments on Summary section of Org manual (was: [PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-readable) Matt
2024-01-05 13:17 ` Ihor Radchenko
2024-01-05 13:06 ` [PATCH v2] doc/org-manual.org (Summary): Clarify the Org markup is human-readable Ihor Radchenko
2024-01-06 10:31 ` Matt
2024-01-06 12:55 ` Ihor Radchenko
2024-01-06 12:56 ` Matt
2024-02-01 12:16 ` 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=87o7e2a5wf.fsf@localhost \
--to=yantar92@posteo.net \
--cc=bzg@gnu.org \
--cc=emacs-orgmode@gnu.org \
--cc=matt@excalamus.com \
/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).