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 WMYEBUnHlWW1BwAAkFu2QA (envelope-from ) for ; Wed, 03 Jan 2024 21:44:57 +0100 Received: from aspmx1.migadu.com ([2001:41d0:403:4876::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0.migadu.com with LMTPS id kLwwAEnHlWXieAAAqHPOHw (envelope-from ) for ; Wed, 03 Jan 2024 21:44:57 +0100 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=excalamus.com header.s=zmail header.b=OFuf153j; 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=none; arc=pass ("zohomail.com:s=zohoarc:i=1") ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1704314696; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=iOJrrlh0CyNXVsuvMc3I9t4jsqr0/SYFaV0BEkaNODQ=; b=OAKlUY/ANNC+UH0sdFT6Z84T4bNhyBZ6DvwyeFZYXV/aNflmUsWxRlb81ussmH8HdaKfJB QQBCimuRRz1Cto7BxQIdpHemrb7MIibcDjIGZHOjekSa4xxTSyzdPUZR3JXGESh3z78AWD yj2tG/UXYGYyGfoxlQPpBFvxvudbLSi7RqFoZheHd0xZnew96GU+A3WOHfTVTaU2W7auOY NTjmbAx216Tx2zIvJ5TJ3BiNDgKqsUYSgIW21mae0bX6+WkKBskFqy6JT5l1eMxRanU7K5 Erj6XRzwebBbe9+inu864E0jHkQhnY4z0V08i/vFoUPFmTpxJjGKvEP1EULh3w== ARC-Authentication-Results: i=2; aspmx1.migadu.com; dkim=pass header.d=excalamus.com header.s=zmail header.b=OFuf153j; 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=none; arc=pass ("zohomail.com:s=zohoarc:i=1") ARC-Seal: i=2; s=key1; d=yhetil.org; t=1704314696; a=rsa-sha256; cv=pass; b=WdMUItrVxyJ5gJZGRfoih0fatJRsnAaPY6ycW+5RtPgvo42bSgz3ftCp0csV7aqcdiARqY PTCjVwJyyqcOkziRSC/9ODujUpQ6jgh6nuF70JzXsp6LuyM7BgbL+pdlndg1cjsXv4DgvV uygs7ZqXi6PjXXTVmtrxCEP4CJwLEjthabxljK9OxuBUjm1It3teI/awgB3llZRR11xIer CYN4+BCQsTR1L87VMolOwabQ/m3hUHybQt0Tswwt3E1DyLNEldugB0VMq0YjtbfGle6g56 Xh0ZhGYIt0xUELt9UHQYgXeefz+Dle874JiQI4qz/mcbuDMW4MfhSwuQPYdshQ== 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 997B95A2B3 for ; Wed, 3 Jan 2024 21:44:56 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rL85s-0008Id-4Y; Wed, 03 Jan 2024 15:44:04 -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 1rL85p-0008I7-S3 for emacs-orgmode@gnu.org; Wed, 03 Jan 2024 15:44:01 -0500 Received: from sender4-op-o15.zoho.com ([136.143.188.15]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rL85n-0005Bf-1m for emacs-orgmode@gnu.org; Wed, 03 Jan 2024 15:44:01 -0500 ARC-Seal: i=1; a=rsa-sha256; t=1704314634; cv=none; d=zohomail.com; s=zohoarc; b=BX8H7/W58KKhJJUI7E8o2xgf0QagG0JvR8A/lvUU9b+im0JfmkStQCvoy35VGZd51hHDFMUo18nKQWQJ2gfhwAPk8a1WOwFrJ9giJdcn20NPROZNzAKAAUIa3j8VNTNEh+cM3vkQ3JB7nR97jw1g+XT6In/IFf8QDJxQ7fLWQ2g= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1704314634; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:MIME-Version:Message-ID:References:Subject:Subject:To:To:Message-Id:Reply-To; bh=iOJrrlh0CyNXVsuvMc3I9t4jsqr0/SYFaV0BEkaNODQ=; b=S5JQRNpVDkBc5TCzmZ32jbwJspBaEZn2nO6C26fWZw8fIot0uujSUtcdRGWxnxcxctnExzjkO5q77MTMIaOlSpAYwOQF8XGg4PzL9gDuCct6o5bu6YPwMrUDX4Cq47Tq/jwOerHbdqV9xIFQ+o4Oi8HJz8hu9YXhyzoQUCnUHf0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass header.i=excalamus.com; spf=pass smtp.mailfrom=matt@excalamus.com; dmarc=pass header.from= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1704314634; s=zmail; d=excalamus.com; i=matt@excalamus.com; h=Date:Date:From:From:To:To:Cc:Cc:Message-ID:In-Reply-To:References:Subject:Subject:MIME-Version:Content-Type:Content-Transfer-Encoding:Message-Id:Reply-To; bh=iOJrrlh0CyNXVsuvMc3I9t4jsqr0/SYFaV0BEkaNODQ=; b=OFuf153jNGnVir4tgRrx9tBylPnKdufI5t18qoc+MFRbJ7tz7cB7NpV6D5ihmDHp 3rXbIe4Tw7u5berHyqWN6vXO5mSOUdiacTsPiFFpBTphAVXeSSuldoeORon2eLkImTG f5f2lEyvUep9wNlKmobrDUgKC4fEaUn6dpUwkyDE= Received: from mail.zoho.com by mx.zohomail.com with SMTP id 1704314632102937.6484926260885; Wed, 3 Jan 2024 12:43:52 -0800 (PST) Date: Wed, 03 Jan 2024 21:43:52 +0100 From: Matt To: "Ihor Radchenko" Cc: "emacs-orgmode" Message-ID: <18cd111777e.efad32b9285772.6378361649896083029@excalamus.com> In-Reply-To: <87o7e2a5wf.fsf@localhost> References: <87il4e75u8.fsf@localhost> <18ccc5c24ab.11c0534ea910085.7925872212667260908@excalamus.com> <87o7e2a5wf.fsf@localhost> Subject: Re: Comments on Summary section of Org manual (was: [PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-readable) MIME-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Importance: Medium User-Agent: Zoho Mail X-Mailer: Zoho Mail Received-SPF: pass client-ip=136.143.188.15; envelope-from=matt@excalamus.com; helo=sender4-op-o15.zoho.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham 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-Spam-Score: -10.31 X-Spam-Score: -10.31 X-Migadu-Queue-Id: 997B95A2B3 X-Migadu-Scanner: mx10.migadu.com X-TUID: cXiavXB7lHt7 ---- On Wed, 03 Jan 2024 14:41:29 +0100 Ihor Radchenko wrote ---=20 > I do not see much benefit changing "todo list" to "to-do list". Both are > clear and both are grammatically correct. I said "TODO" to "to-do". I was reacting to it being all caps. I'm sorry = I didn't say that. When it's all caps, TODO is a keyword. Otherwise, it's prose. The follo= wing are different (AFAIK): * TODO Finish this headline * todo Finish this headline * to-do Finish this headline Agreed, it's a minor detail. > > 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. >=20 > What about "plain text file format"? I like that it's less technical. I worry that it's less precise. =20 I still think a word like "notation," that doesn't derive from computer cul= ture, has a greater chance of being meaningful to people from other domains= , like authors, scientists, or engineers. Of course, these same people can= easily understand the idea when they see it. It's more important to expla= in why it matters and that's something we're already doing. "Markup language" is fine. It's correct. Org syntax is a markup language. I'm happy to leave it rather than risk bike-shedding it more than I have. = If we learn that it caused friction for a newcomer, we can change it easily= enough. > > 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. >=20 > 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. Fair points. I concede. :) > > 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). >=20 > 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. =20 That's a good point. Knowing about the .org extension is useful. I don't think it hurts anythin= g other than taking up valuable space. If we need to bump something from t= he first paragraph, this gets my vote. -- Matt Trzcinski Emacs Org contributor (ob-shell) Learn more about Org mode at https://orgmode.org Support Org development at=C2=A0https://liberapay.com/org-mode