[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-re
From: |
Ihor Radchenko |
Subject: |
[PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-readable |
Date: |
Sun, 31 Dec 2023 15:24:31 +0000 |
I'd like to amend the Org manual introduction as in the attached patch.
The idea is to highlight that Org markup is designed to be
human-readable first and foremost rather than just computer-readable.
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.
>From f97e3d9b7e346506f0a87b98f4809e612d7e78b6 Mon Sep 17 00:00:00 2001
Message-ID:
<f97e3d9b7e346506f0a87b98f4809e612d7e78b6.1704036076.git.yantar92@posteo.net>
From: Ihor Radchenko <yantar92@posteo.net>
Date: Sun, 31 Dec 2023 16:20:24 +0100
Subject: [PATCH] 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 | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index ff1b9cffb..3ddce7d41 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -22,6 +22,10 @@ ** Summary
It relies on a lightweight plain-text markup language used in files
with the =.org= extension.
+Org files can be viewed using any text editor. You can read and
+understand raw Org markup with a naked eye. Although authoring Org
+files is best-supported inside Emacs.
+
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
--
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>
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-readable,
Ihor Radchenko <=