From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0.migadu.com ([2001:41d0:303:5f26::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms8.migadu.com with LMTPS id GD3mBVj+l2Us/wAAkFu2QA (envelope-from ) for ; Fri, 05 Jan 2024 14:04:24 +0100 Received: from aspmx1.migadu.com ([2001:41d0:303:e16b::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0.migadu.com with LMTPS id kKpUOVf+l2WXfAEAqHPOHw (envelope-from ) for ; Fri, 05 Jan 2024 14:04:24 +0100 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=nWXXhW75; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=posteo.net ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1704459863; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=Mxzm1p2SWIdhvBuJm7Zc3u9PWaLquadgKX3HNSw5Y0o=; b=UPub7KsitfUc31levlaBVMcK5LXBv6/bOI0AiHZ5kmc7Jb5F4zvv1PqRlKKCxQBT0hDkPL 50e1g89MZ0wio1uYAR6dBTQtEmgJSiHl3QIXD0jFfAcL0pNQqrctwWzU8h4XyJJl8dmLL/ u3Xs5j+D5523u8kwjgdXH2rtKAcuwh4mcFidLRYcDkXoBcoVwm5pLtEDBfYPsnykYUfB/P PMk4uHLWEwh2sIgR1dVZkShx8PQoeBUbtoCEXKYyY0XQR+HK9nUeL+K4HheoZxTj+UUawz k5S/iPqyF91dBEVnc4cpHLMqeWv10/zEyiU17KwQBN2qHeLpGa0xerUjL25rlw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=nWXXhW75; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=posteo.net ARC-Seal: i=1; s=key1; d=yhetil.org; t=1704459863; a=rsa-sha256; cv=none; b=fbYPuFdPqguBMwKosq2uppXDt4vJXm16QR0+o3ZzTIhnQ+VLp89fFDQRW6NWGtu5b+t0oy AbAbpMxJakBxBz/WLEVjPy7xbIRf+nX06zNEFV32jSfdOn/X8DQdCBlWEwj0dLV7UX/j2A xDlen+KSZ1cqAu95gWH2JK1JEGGug40XvtkzduJA96Yj8DR02+g53T/vEt9Ye1nXzOJn76 gWTmYzaAnwwvCc440FkqlS2dX8st21aTRFrUZoFrBeSdLce+KQcQ0YKjuBg7B/E4NfVXm6 xjingcLEF+qI67edrZp8S/Sn35JWQhmQFQ1GwvUNoGlvOyhRBSW3OCfxuazuUg== Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id B0D255557A for ; Fri, 5 Jan 2024 14:04:23 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rLjrR-00051q-7b; Fri, 05 Jan 2024 08:03:41 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rLjrN-00050f-6S for emacs-orgmode@gnu.org; Fri, 05 Jan 2024 08:03:39 -0500 Received: from mout01.posteo.de ([185.67.36.65]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rLjrH-0003KN-TT for emacs-orgmode@gnu.org; Fri, 05 Jan 2024 08:03:36 -0500 Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id C0619240028 for ; Fri, 5 Jan 2024 14:03:29 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1704459809; bh=pgOo6ow9lgy++svlKAdV9IO2u1tSDlJUWjO6wbdseDg=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:From; b=nWXXhW75WMi6qJfk3JuMNLPs2e2mFrh2vzuFIlMdx0q6lN1aBFxDCLnuft39Ro9vb HCsJcyhFCeYd8w+K5xmd4tpjHng88q07uyKTZg1ElfMOYRDQYhfnkpJNcV8dtKUmUW MibdTaJVHGHmHVx8XQByH7RrV+t6uydJvh7zbroasaLKw4qenY4XqXFEIa29XJYQ/N jQ9Dxnf5GeK6GdLXapHiV83uq2YHZlh2jJgNXJCfco0CbTkKooDFRZv9RSQcir7k11 +PTmlC0cO8FJicjW/yd0bzqPfhzKLPgm/iiBz9wpE0KT4+jgv5cZcL52tBJfXQCwKi p7/fomUT0gOHQ== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4T63YD6pNGz6txN; Fri, 5 Jan 2024 14:03:28 +0100 (CET) From: Ihor Radchenko To: emacs-orgmode@gnu.org Cc: Bastien Subject: [PATCH v2] doc/org-manual.org (Summary): Clarify the Org markup is human-readable In-Reply-To: <87il4e75u8.fsf@localhost> References: <87il4e75u8.fsf@localhost> Date: Fri, 05 Jan 2024 13:06:41 +0000 Message-ID: <8734vc6iam.fsf@localhost> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Received-SPF: pass client-ip=185.67.36.65; envelope-from=yantar92@posteo.net; helo=mout01.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=unavailable autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: emacs-orgmode-bounces+larch=yhetil.org@gnu.org X-Migadu-Country: US X-Migadu-Flow: FLOW_IN X-Migadu-Scanner: mx13.migadu.com X-Migadu-Spam-Score: -7.17 X-Spam-Score: -7.17 X-Migadu-Queue-Id: B0D255557A X-TUID: AA+5/z76m7vG --=-=-= Content-Type: text/plain Ihor Radchenko 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" 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 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.) --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=v2-0001-doc-org-manual.org-Summary-Clarify-the-Org-markup.patch >From 9754dea7cca1bc525d0b39cc31e7b0596c5a2bf8 Mon Sep 17 00:00:00 2001 Message-ID: <9754dea7cca1bc525d0b39cc31e7b0596c5a2bf8.1704459551.git.yantar92@posteo.net> From: Ihor Radchenko 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 --=-=-= Content-Type: text/plain -- Ihor Radchenko // yantar92, Org mode contributor, Learn more about Org mode at . Support Org development at , or support my work at --=-=-=--