From: David Masterson <dsmasterson@gmail.com>
To: Ihor Radchenko <yantar92@posteo.net>
Cc: emacs-orgmode@gnu.org
Subject: Re: oeg-add-note and double backslash ?
Date: Sun, 10 Dec 2023 13:00:00 -0800 [thread overview]
Message-ID: <LV8P223MB0920EB98752321D066FB5BEBA288A@LV8P223MB0920.NAMP223.PROD.OUTLOOK.COM> (raw)
In-Reply-To: <877clm9kbo.fsf@localhost> (Ihor Radchenko's message of "Sun, 10 Dec 2023 14:57:31 +0000")
Ihor Radchenko <yantar92@posteo.net> writes:
> David Masterson <dsmasterson@gmail.com> 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'.
Hmm. The docstring on that should discuss what it's looking for to say
"this is the end of the state notes". Does a plain note (org-add-note)
count as a state note?
>> 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'.
Oh! That's an interesting point. That variable is not mentioned in the
Manual (AFAICS), but perhaps it should be -- particularly around the
talk of "rescheduling" (and "delschedule" which I don't see in the
manual). Mentioned only in the sense of, if you want to change the note
header, look here.
> However, it is probably worth describing the notes in 5.3 Progress
> Logging section of the manual.
I'd agree. In particular, what depends on the format of the note
(header) -- like Agenda. To warn people what they can or cannot touch.
--
David Masterson
next prev parent reply other threads:[~2023-12-10 21:06 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-03 22:37 oeg-add-note and double backslash ? David Masterson
2023-12-04 15:10 ` Ihor Radchenko
2023-12-04 22:03 ` David Masterson
2023-12-05 1:31 ` Samuel Wales
2023-12-05 6:36 ` David Masterson
2023-12-05 13:50 ` Ihor Radchenko
2023-12-07 7:52 ` David Masterson
2023-12-07 10:44 ` Ihor Radchenko
2023-12-09 2:27 ` David Masterson
2023-12-09 11:03 ` Ihor Radchenko
2023-12-10 0:23 ` David Masterson
2023-12-10 14:57 ` Ihor Radchenko
2023-12-10 21:00 ` David Masterson [this message]
2023-12-11 13:48 ` Ihor Radchenko
2023-12-12 18:29 ` David Masterson
2023-12-13 10:34 ` Ihor Radchenko
2023-12-14 5:53 ` David Masterson
2023-12-14 13:05 ` 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=LV8P223MB0920EB98752321D066FB5BEBA288A@LV8P223MB0920.NAMP223.PROD.OUTLOOK.COM \
--to=dsmasterson@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=yantar92@posteo.net \
/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).