emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@posteo.net>
To: emacs-orgmode@gnu.org, Bastien <bzg@gnu.org>
Subject: [PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-readable
Date: Sun, 31 Dec 2023 15:24:31 +0000	[thread overview]
Message-ID: <87il4e75u8.fsf@localhost> (raw)

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


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.


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

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


[-- Attachment #3: Type: text/plain, Size: 224 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>

             reply	other threads:[~2023-12-31 15:22 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-31 15:24 Ihor Radchenko [this message]
2024-01-02  5:24 ` [PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-readable 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   ` Comments on Summary section of Org manual (was: [PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-readable) Ihor Radchenko
2024-01-03 20:43     ` 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=87il4e75u8.fsf@localhost \
    --to=yantar92@posteo.net \
    --cc=bzg@gnu.org \
    --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).