[PATCH v2] doc/org-manual.org (Summary): Clarify the Org markup is human-readable

[Ihor Radchenko <yantar92@posteo.net>]

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

Ihor Radchenko <yantar92@posteo.net> writes:

> This is the first section of the manual. Most of the new users will see
> it. So, I'd like to hear any objections before installing the patch.

Thanks for the comments!
I am attaching the next iteration of the patch.

"Thomas S. Dye" <tsd@tsdye.online> writes:

> How about this, assuming lightweight is equivalent to readable and 
> easy to understand?
>
> It relies on a readable and easy to understand plain-text markup 
> language saved to files with the =.org= extension. Authoring Org 
> files is best supported by Emacs, but you can view and change them 
> with any text editor. As an authoring tool ...

I used a shorter and modified version of your wording with more emphasis
that one can *understand* Org markup.

Matt <matt@excalamus.com> writes:

> +Org Mode is an authoring tool and a to-do lists manager for GNU Emacs.
> +It uses a legible plain-text notation to show formatting, structure,
> +relationships.  Anyone able to edit text can write using Org.  Anyone
> +able to read text can view it.

As a non-native speaker, I have some difficulties understanding
"legible" meaning in this context. Also, "anyone able to read text can
view it" would be a bit of a bold claim, I think. So, I went with more
moderate wording.

(I will limit this patch to the specific additions I had in mind.
Changes to the existing text you proposed can be discussed separately,
which is why I created a new branch in this thread.)


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: v2-0001-doc-org-manual.org-Summary-Clarify-the-Org-markup.patch --]
[-- Type: text/x-patch, Size: 1156 bytes --]

From 9754dea7cca1bc525d0b39cc31e7b0596c5a2bf8 Mon Sep 17 00:00:00 2001
Message-ID: <9754dea7cca1bc525d0b39cc31e7b0596c5a2bf8.1704459551.git.yantar92@posteo.net>
From: Ihor Radchenko <yantar92@posteo.net>
Date: Sun, 31 Dec 2023 16:20:24 +0100
Subject: [PATCH v2] doc/org-manual.org (Summary): Clarify the Org markup is
 human-readable

Readability of raw Org text is one of the core principles we maintain
when designing Org markup language.  Let's state it explicitly in the
manual.
---
 doc/org-manual.org | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 65aa5dd30..c6c37441f 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -22,6 +22,9 @@ ** Summary
 It relies on a lightweight plain-text markup language used in files
 with the =.org= extension.
 
+Authoring Org files is best supported by Emacs, but you can view,
+understand, and change them with any text editor.
+
 As an authoring tool, Org helps you write structured documents and
 provides exporting facilities. Org files can also be used for literate
 programming and reproducible research.  As a TODO lists manager, Org
-- 
2.42.0


[-- Attachment #3: Type: text/plain, Size: 225 bytes --]



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