From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp12.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms8.migadu.com with LMTPS id AEvdIk/RdWX0DgEAauVa8A:P1 (envelope-from ) for ; Sun, 10 Dec 2023 15:55:11 +0100 Received: from aspmx1.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp12.migadu.com with LMTPS id AEvdIk/RdWX0DgEAauVa8A (envelope-from ) for ; Sun, 10 Dec 2023 15:55:11 +0100 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=QgGgUZNL; 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=1702220111; 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=yCWCFrDYYw6JX5q/IW1qeXNPmSq32+08w9OR9n9dee0=; b=CNHYr9xTZCtuzZJJXIqhCiX/nnA2lScgYyCaT0Sl8RVAyxtmO/scH2I+Kw0my5VCYNtOSf 4aYkXM3aaPA+5pQhKNxUTgZQdsfsbjmX157mQjeYkHGI650P8DRfzUuCJ1lL5KsR0FSNo6 Uhhx0G4iGcLrS8n/1AXglbBNLGmG8WqKfXq21y9EED+RO9w5DQPKyRFvPLpsE0Gsl+SqYQ rCOHcYdI3gb+DoZMzmg7aaq2BOxg/1yt1wSuCZ7LqmOw5bbtAIhaRMchT/byB7y4ma7KvI Yx0IShNCDSTQEclUab1rwRIRXb+Nzu4Irgbt2Ry4gquLaLDQJM1t5nCr2t94QA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1702220111; a=rsa-sha256; cv=none; b=uHNAbKWUKYoiL9ftUVfp7gDrxKm4MmQQ3vw1k4d3NgOQ2ViKmQp220ZfTkXDeaxeQsiIkl 0uAvtbx16fAOXQLU56r/mtxLKi0dfolBjBI28/seSEEzByJQ27Uw17eoJYnOweOgX2CCPp KnArfMXHuzWOdAgQdqpOz89pGvt51qwZL4AJcl164LkZPnLpz3jLlfF1lsB+GMXk3Gsafz RT5X8yXs30Jzguf66mZ6Wsz1QG8OvI/R1peHmW+/mJ9/3tqd9fZ9icxcPMx2Za0LuR18Rw lAOFdVuXYP61Y6VSbXLC52Vm0TnjsDyc1SAxkNp0TjkzmO8EIG4jkMwWncCUMg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=QgGgUZNL; 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 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 049816076B for ; Sun, 10 Dec 2023 15:55:11 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rCLCg-0007ZL-Qt; Sun, 10 Dec 2023 09:54:46 -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 1rCLCd-0007Yl-QQ for emacs-orgmode@gnu.org; Sun, 10 Dec 2023 09:54:43 -0500 Received: from mout02.posteo.de ([185.67.36.66]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rCLCX-0005L9-IH for emacs-orgmode@gnu.org; Sun, 10 Dec 2023 09:54:43 -0500 Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id D784C240101 for ; Sun, 10 Dec 2023 15:54:32 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1702220072; bh=Ux3K70aoQ9XVOm+faPvSL9jE9NBnUrwfALh+XWY5Amc=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:From; b=QgGgUZNLIBGQKRzbEQ2VWbHzzMPT5tsNuK9IOCQl3nzYJ0Dh8B+F6gG2jQExdvN5H bnNMNslkQdpALvQqmbys1ylWoMqY+zoaSmZoOZkN0qZodShGYQYY7VLB3LFjQuhez8 jzziSKpwtig/VXsFquMmDV+NVkua3xEE2hxwzsRadKL4l8tDWo7BNPGHf5kuwEOvxc d1Hy6lIAKwS2DuJPIqCocV6EjRXZrtlMgX6hGTSNmwVv7hhrzFWeVbh368ZNkGzkPn 5FzSwH66I3qY9pg9J9EkLn6D/fs7QUcYjj3im+pus1+f1iX/GmVk0ylLXZQBF8Qsh7 ct7VRCrhls2Pw== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4Sp7FN0tZcz9rxP; Sun, 10 Dec 2023 15:54:32 +0100 (CET) From: Ihor Radchenko To: David Masterson Cc: emacs-orgmode@gnu.org Subject: Re: oeg-add-note and double backslash ? In-Reply-To: References: <87jzpuatr1.fsf@localhost> <87il5cvjvw.fsf@localhost> <8734we47i4.fsf@localhost> <87jzpnskmy.fsf@localhost> Date: Sun, 10 Dec 2023 14:57:31 +0000 Message-ID: <877clm9kbo.fsf@localhost> MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=185.67.36.66; envelope-from=yantar92@posteo.net; helo=mout02.posteo.de X-Spam_score_int: -53 X-Spam_score: -5.4 X-Spam_bar: ----- X-Spam_report: (-5.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=-1, RCVD_IN_MSPIKE_WL=-0.01, 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-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Spam-Score: -8.38 X-Spam-Score: -8.38 X-Migadu-Queue-Id: 049816076B X-Migadu-Scanner: mx12.migadu.com X-TUID: kYM8jXvChRNO David Masterson writes: >> The detailed reason why we use this particular markup is that >> otherwise some internal code assumptions inside Org mode may break when >> users run `fill-region' on the notes. This is an internal implementation >> detail which should not be explained in the manual. > > Hmm. Fill-region will also compress the blanks in the generate note > header -- does that run up against the code assumptions? No. See `org-skip-over-state-notes'. > I'm all for keeping internal implementation details out of the user's > manual, unless... > >> What we might explain better is what is a line break, although I am not >> very sure what to explain here - I may be too familiar with the concept >> from my LaTeX-foo. > > The manual should set expectations on what an Org file should look like > -- at least the key components. It already defines Header, Paragraph > and Timestamp. What I think is missing here is the definition of a Note > along with some structure info about it (header line + 2 space indented > paragraphs[s]) to prepare the user. Unlike headings, paragraphs, and timestamps, notes are not a part of Org syntax. Their format is customizeable via `org-log-note-headings'. However, it is probably worth describing the notes in 5.3 Progress Logging section of the manual. > ... In this, I probably come from a > more Reference Manual viewpoint (ie. "this is what all the pieces could > look like -- now lets discuss why you want each piece"). You could say > that the '\\' is needed to keep "other things" from combining the header > and paragraph of the note. You could leave the details of "other > things" to variable or function docstrings as well as internal code. I am not sure if I understand what you mean here. > p.s. would requiring a blank line after the Note header eliminate the > need for '\\' ? Yes. -- Ihor Radchenko // yantar92, Org mode contributor, Learn more about Org mode at . Support Org development at , or support my work at