emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Tommy Kelly <tommy.kelly@verilab.com>
To: emacs-orgmode@gnu.org
Subject: Suggested manual changes - section 7.2 Special Properties
Date: Sat, 27 Jan 2024 22:59:34 -0800	[thread overview]
Message-ID: <CAMg28OtQTFsk8SRSvN6B83M_Rf1AaTskgtYGcND_XnaazDnRww@mail.gmail.com> (raw)

After figuring out, with help on Reddit (ht: Adam), some nuances
affecting timestamps, column
mode, and the Special Properties TIMESTAMP, and TIMESTAMP_IA, I think
the following
modifications to section 7.2 (Special Properties) of the manual would
be worthwhile.

As it stands, the relevant part reads as follows:
'TIMESTAMP'     The first keyword-less timestamp in the entry.
'TIMESTAMP_IA'  The first inactive timestamp in the entry.

Both are slightly incorrect and that can be fixed by changing to the following:
'TIMESTAMP'     The first inactive keyword-less timestamp in the entry.
'TIMESTAMP_IA'  The first inactive keyword-less timestamp in the entry.

In addition, the following three clarifying details would be useful
(the last of them is required)
perhaps as a footnote:

For both TIMESTAMP and TIMESTAMP_IA: the word "first" refers to the
first occurrence in the entry, not the earliest in time; the prefix
'CLOCK:' at the beginning of a clock entry is considered a keyword in
this context; and timestamps inside property drawers are ignored.

regards.

P.S. I'm not familiar enough with the various moving parts to provide
the above as a proper
git patch. However, FWIW, I did the following. I modified a local copy
of org-manual.org and then I ensured that at least a PDF export
(produced using 'C-c C-e l p', but only the section
in question) looked sensible. Then I produced a diff-based patch file.
Here it is, in case its
of any use:

#### START OF PATCHFILE ####
--- work/git/org-mode/doc/org-manual.org        2022-10-06 11:49:32
+++ org-manual-changed.org      2024-01-27 22:44:36
@@ -5353,8 +5353,8 @@
 | =PRIORITY=     | The priority of the entry, a string with a single
letter.      |
 | =SCHEDULED=    | The scheduling timestamp.
            |
 | =TAGS=         | The tags defined directly in the headline.
            |
-| =TIMESTAMP=    | The first keyword-less timestamp in the entry.
            |
-| =TIMESTAMP_IA= | The first inactive timestamp in the entry.
            |
+| =TIMESTAMP=    | The first active keyword-less timestamp in the
entry.[fn::For both TIMESTAMP and TIMESTAMP_IA: the word "first"
refers to the first occurrence in the entry, not the earliest in time;
the prefix 'CLOCK:' at the beginning of a clock entry is considered a
keyword in this context; and timestamps inside property drawers are
ignored.]          |
+| =TIMESTAMP_IA= | The first inactive keyword-less timestamp in the
entry.        |
 | =TODO=         | The TODO keyword of the entry.
            |

  ** Property Searches
#### END OF PATCHFILE ####


             reply	other threads:[~2024-01-28  7:01 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-28  6:59 Tommy Kelly [this message]
2024-01-28  7:44 ` Suggested manual changes - section 7.2 Special Properties Tommy Kelly
2024-01-28 10:39   ` Matt
2024-01-29  3:37     ` Tommy Kelly
2024-01-29 18:30       ` Matt
2024-02-01 15:44       ` Ihor Radchenko
2024-02-01 15:37 ` 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=CAMg28OtQTFsk8SRSvN6B83M_Rf1AaTskgtYGcND_XnaazDnRww@mail.gmail.com \
    --to=tommy.kelly@verilab.com \
    --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).