From: Ihor Radchenko <yantar92@posteo.net>
To: David Masterson <dsmasterson@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Is this proper time format?
Date: Sat, 17 Jun 2023 12:33:49 +0000 [thread overview]
Message-ID: <87zg4yjmj6.fsf@localhost> (raw)
In-Reply-To: <SJ0PR03MB5455693CA8266256D46BA594A259A@SJ0PR03MB5455.namprd03.prod.outlook.com>
[-- Attachment #1: Type: text/plain, Size: 1475 bytes --]
David Masterson <dsmasterson@gmail.com> writes:
> Ihor Radchenko <yantar92@posteo.net> writes:
>
>> May you please re-create the patch for the current main?
>
> Ok. See below.
Thanks!
See the attached final draft.
I amended removals of cindex entries in the manual - redundancy will not
hurt here (for better searchability).
I also slightly adjusted the wording and fixed list indentation in
one of description list items.
Finally, I detailed all the changes in the commit message and added
TINYCHANGE cookie.
Let me know if you are ok with this version.
Please note that with this patch your total contribution is approaching
non-trivial 15LOC. Further patches will require FSF copyright assignment.
> Minor question -- I've used Ediff in the past, but I now see diff-mode
> in Emacs. I get the idea of it (I think I used an early version of it
> in the deep past), but wonder if I am seeing a bug in it. In the diff
> file below, there is a few mentions of "=--=" in separating timestamps
> in a date/time range. When I view the diff file in Diff mode, a couple
> on those strings show up and a couple do not. I had to check the file
> with 'less' to make sure the diff file was intact. Switching from
> unified to context view didn't change this.
>
> Am I missing an option in diff mode or is this a bug around handling
> this particular string?
I suspect that it is greedy fontification. =--= is a part of diff
syntax, AFAIK. May report is as a bug to Emacs.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-manual-org-guide-Improve-timestamp-documentation.patch --]
[-- Type: text/x-patch, Size: 7207 bytes --]
From 17e8902e8d6f3c23a9226d697e51169c24b5414a Mon Sep 17 00:00:00 2001
Message-ID: <17e8902e8d6f3c23a9226d697e51169c24b5414a.1687004884.git.yantar92@posteo.net>
From: David Masterson <dsmasterson@gmail.com>
Date: Sat, 17 Jun 2023 15:26:55 +0300
Subject: [PATCH] org-manual, org-guide: Improve timestamp documentation
* doc/org-manual.org (Dates and Times): Explain the purpose of
timestamps in the opening paragraphs.
(Timestamps): Mention that time range. Clarify that an entry may
contain multiple timestamps, providing an example. Explain formal
time range meaning, with example. Add cindex entry "time range". Add
date range example.
* doc/org-guide.org: Syncronoize changes with org-manual, adding some
missing pieces.
(Timestamps): Remove useless cindex entries (org-guide does not
produce index).
Co-authored-by: Ihor Radchenko <yantar92@posteo.net>
Link: https://orgmode.org/list/SJ0PR03MB5455693CA8266256D46BA594A259A@SJ0PR03MB5455.namprd03.prod.outlook.com
TINYCHANGE
---
doc/org-guide.org | 33 +++++++++++++++++++++++++++----
doc/org-manual.org | 49 +++++++++++++++++++++++++++++++---------------
2 files changed, 62 insertions(+), 20 deletions(-)
diff --git a/doc/org-guide.org b/doc/org-guide.org
index 828bdd872..a6d4e7c3d 100644
--- a/doc/org-guide.org
+++ b/doc/org-guide.org
@@ -1081,7 +1081,15 @@ * Dates and Times
To assist project planning, TODO items can be labeled with a date
and/or a time. The specially formatted string carrying the date and
-time information is called a /timestamp/ in Org mode.
+time information is called a /timestamp/ in Org mode. This may be
+a little confusing because timestamp is often used as indicating when
+something was created or last changed. However, in Org mode this term
+is used in a much wider sense.
+
+Timestamps can be used to plan appointments, schedule tasks, set
+deadlines, track time, and more. The following sections describe
+the timestamp format and tooling that Org mode provides for common
+use cases dealing with time and time intervals.
** Timestamps
:PROPERTIES:
@@ -1099,12 +1107,16 @@ ** Timestamps
A simple timestamp just assigns a date/time to an item. This is
just like writing down an appointment or event in a paper agenda.
+ There can be multiple timestamps in an item.
#+begin_example
,* Meet Peter at the movies
<2006-11-01 Wed 19:15>
,* Discussion on climate change
<2006-11-02 Thu 20:00-22:00>
+ ,* My days off
+ <2006-11-03 Fri>
+ <2006-11-06 Mon>
#+end_example
- Timestamp with repeater interval ::
@@ -1121,8 +1133,6 @@ ** Timestamps
- Diary-style expression entries ::
- #+cindex: diary style timestamps
- #+cindex: sexp timestamps
For more complex date specifications, Org mode supports using the
special expression diary entries implemented in the Emacs Calendar
package. For example, with optional time:
@@ -1132,13 +1142,28 @@ ** Timestamps
<%%(diary-float t 4 2)>
#+end_example
+- Time range
+
+ Time range is a timestamp having two time units connected by =-=
+
+ #+begin_example
+ ,* Discussion on climate change
+ <2006-11-02 Thu 10:00-12:00>
+ #+end_example
+
- Time/Date range ::
- Two timestamps connected by =--= denote a range.
+ Two timestamps connected by =--= denote a range. In the agenda, the
+ headline is shown on the first and last day of the range, and on any
+ dates that are displayed and fall in the range. The first example
+ specifies just the dates of the range while the second example
+ specifies a time range for each date.
#+begin_example
,** Meeting in Amsterdam
<2004-08-23 Mon>--<2004-08-26 Thu>
+ ,** This weeks committee meetings
+ <2004-08-23 Mon 10:00-11:00>--<2004-08-26 Thu 10:00-11:00>
#+end_example
- Inactive timestamp ::
diff --git a/doc/org-manual.org b/doc/org-manual.org
index c11694849..4b00d1e6f 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -5987,6 +5987,11 @@ * Dates and Times
something was created or last changed. However, in Org mode this term
is used in a much wider sense.
+Timestamps can be used to plan appointments, schedule tasks, set
+deadlines, track time, and more. The following sections describe
+the timestamp format and tooling that Org mode provides for common
+use cases dealing with time and time intervals.
+
** Timestamps
:PROPERTIES:
:DESCRIPTION: Assigning a time to a tree entry.
@@ -5997,12 +6002,12 @@ ** Timestamps
#+cindex: deadlines
#+cindex: scheduling
-A timestamp is a specification of a date (possibly with a time) in a
-special format, either =<2003-09-16 Tue>= or
-=<2003-09-16 Tue 09:39>=[fn:19]. A timestamp can appear anywhere in
-the headline or body of an Org tree entry. Its presence causes
-entries to be shown on specific dates in the agenda (see [[*Weekly/daily
-agenda]]). We distinguish:
+A timestamp is a specification of a date---possibly with a time or
+time range---in a special format, either =<2003-09-16 Tue>= or
+=<2003-09-16 Tue 09:39>= or =<2003-09-16 Tue 12:00-12:30>=[fn:19].
+A timestamp can appear anywhere in the headline or body of an Org tree
+entry. Its presence causes entries to be shown on specific dates in
+the agenda (see [[*Weekly/daily agenda]]). We distinguish:
- Plain timestamp; Event; Appointment ::
@@ -6011,13 +6016,17 @@ ** Timestamps
A simple timestamp just assigns a date/time to an item. This is
just like writing down an appointment or event in a paper agenda.
In the agenda display, the headline of an entry associated with
- a plain timestamp is shown exactly on that date.
+ a plain timestamp is shown exactly on that date. There can be
+ multiple timestamps in an item.
#+begin_example
,* Meet Peter at the movies
<2006-11-01 Wed 19:15>
,* Discussion on climate change
- <2006-11-02 Thu>
+ <2006-11-02 Thu 10:00-12:00>
+ ,* My days off
+ <2006-11-03 Fri>
+ <2006-11-06 Mon>
#+end_example
- Timestamp with repeater interval ::
@@ -6053,24 +6062,32 @@ ** Timestamps
<%%(diary-float t 4 2)>
#+end_example
+- Time range ::
+ #+cindex: time range
+
+ Time range is a timestamp having two time units connected by =-=
+
+ #+begin_example
+,* Discussion on climate change
+ <2006-11-02 Thu 10:00-12:00>
+ #+end_example
+
- Time/Date range ::
+ #+cindex: time range
#+cindex: timerange
#+cindex: date range
Two timestamps connected by =--= denote a range. In the agenda, the
headline is shown on the first and last day of the range, and on any
- dates that are displayed and fall in the range. Here is an example:
+ dates that are displayed and fall in the range. The first example
+ specifies just the dates of the range while the second example
+ specifies a time range for each date.
#+begin_example
,** Meeting in Amsterdam
<2004-08-23 Mon>--<2004-08-26 Thu>
- #+end_example
-
- Timerange is a timestamp consisting of two time units connected by =-=
-
- #+begin_example
- ,* Discussion on climate change
- <2006-11-02 Thu 10:00-12:00>
+ ,** This weeks committee meetings
+ <2004-08-23 Mon 10:00-11:00>--<2004-08-26 Thu 10:00-11:00>
#+end_example
- Inactive timestamp ::
--
2.41.0
[-- Attachment #3: Type: text/plain, Size: 224 bytes --]
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
next prev parent reply other threads:[~2023-06-17 12:30 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-05 16:58 Is this proper time format? David Masterson
2023-06-05 19:52 ` Ihor Radchenko
2023-06-05 21:03 ` David Masterson
2023-06-06 6:08 ` Ihor Radchenko
2023-06-06 18:01 ` David Masterson
2023-06-06 23:52 ` Samuel Wales
2023-06-07 5:40 ` David Masterson
2023-06-08 10:33 ` Ihor Radchenko
2023-06-08 23:09 ` David Masterson
2023-06-09 7:36 ` Ihor Radchenko
2023-06-10 2:34 ` David Masterson
2023-06-10 10:02 ` Ihor Radchenko
2023-06-11 0:01 ` David Masterson
2023-06-11 9:31 ` Ihor Radchenko
2023-06-12 0:19 ` David Masterson
2023-06-12 10:44 ` Ihor Radchenko
2023-06-11 6:20 ` David Masterson
2023-06-11 9:45 ` Ihor Radchenko
2023-06-12 0:16 ` David Masterson
2023-06-12 11:00 ` Ihor Radchenko
2023-06-12 18:02 ` David Masterson
2023-06-13 9:41 ` Ihor Radchenko
2023-06-14 6:16 ` David Masterson
2023-06-14 11:01 ` Ihor Radchenko
2023-06-15 3:35 ` David Masterson
2023-06-15 11:07 ` Ihor Radchenko
2023-06-15 16:04 ` David Masterson
2023-06-16 9:38 ` Ihor Radchenko
2023-06-17 0:54 ` David Masterson
2023-06-17 12:33 ` Ihor Radchenko [this message]
2023-06-18 3:57 ` David Masterson
2023-06-18 10:42 ` Ihor Radchenko
2023-06-18 19:05 ` David Masterson
2023-06-18 20:53 ` Ihor Radchenko
2023-06-19 18:13 ` David Masterson
2023-06-10 2:40 ` David Masterson
2023-06-23 12:18 ` 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=87zg4yjmj6.fsf@localhost \
--to=yantar92@posteo.net \
--cc=dsmasterson@gmail.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).