emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Brian van den Broek <brian.van.den.broek@gmail.com>
To: emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Change example timestamps to not occur in headlines
Date: Fri, 20 Apr 2012 18:01:48 +0200	[thread overview]
Message-ID: <CAF6DajLZZVaL+snyO_sSy+UVT9xtXKqNF9ju3wA1AD0drzxOyg@mail.gmail.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 435 bytes --]

Hi all,

I've attached a small patch to the documentation that resolves a
conflict between the manual's advice not to include timestamps in
headlines and some of its examples where it does just that.

This is the first time I've ever submitted a formal patch using git to
any project, so I hope I did things the right way.

Sadly, I am not presently in a position to sign assignment papers, but
this is a TINYCHANGE.

Best,

Brian vdB

[-- Attachment #2: 0001-Change-example-timestamps-to-not-occur-in-headlines.patch --]
[-- Type: application/octet-stream, Size: 3258 bytes --]

From 5ccad7cf377a19c8a8b89aba1e12c17fa96a1cb0 Mon Sep 17 00:00:00 2001
From: Brian van den Broek <vanden@gmail.com>
Date: Fri, 20 Apr 2012 17:43:18 +0200
Subject: [PATCH] Change example timestamps to not occur in headlines

* doc/doc/org.texi Alter several examples of headings with timestamps
  in them to include the timestamps in the body instead of the heading.

* b/doc/org.texi Alter the same examples in the same way as for
  org.texi.

The Org-mode manual explicitly discourages the inclusion of timestamps
in headlines, yet examples do just that. These changes make the manual
consistent with its own advice.

TINYCHANGE
---
 doc/org.texi      |   12 ++++++++----
 doc/orgguide.texi |   12 ++++++++----
 2 files changed, 16 insertions(+), 8 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index a981f68..412a241 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -5393,8 +5393,10 @@ timeline and agenda displays, the headline of an entry associated with a
 plain timestamp will be shown exactly on that date.
 
 @example
-* Meet Peter at the movies <2006-11-01 Wed 19:15>
-* Discussion on climate change <2006-11-02 Thu 20:00-22:00>
+* Meet Peter at the movies
+  <2006-11-01 Wed 19:15>
+* Discussion on climate change
+  <2006-11-02 Thu 20:00-22:00>
 @end example
 
 @item Timestamp with repeater interval
@@ -5405,7 +5407,8 @@ interval of N days (d), weeks (w), months (m), or years (y).  The
 following will show up in the agenda every Wednesday:
 
 @example
-* Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
+* Pick up Sam at school
+  <2007-05-16 Wed 12:30 +1w>
 @end example
 
 @item Diary-style sexp entries
@@ -5449,7 +5452,8 @@ angular ones.  These timestamps are inactive in the sense that they do
 @emph{not} trigger an entry to show up in the agenda.
 
 @example
-* Gillian comes late for the fifth time [2006-11-01 Wed]
+* Gillian comes late for the fifth time
+  [2006-11-01 Wed]
 @end example
 
 @end table
diff --git a/doc/orgguide.texi b/doc/orgguide.texi
index f92e97b..a23a532 100644
--- a/doc/orgguide.texi
+++ b/doc/orgguide.texi
@@ -1325,8 +1325,10 @@ 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.
 
 @smallexample
-* Meet Peter at the movies <2006-11-01 Wed 19:15>
-* Discussion on climate change <2006-11-02 Thu 20:00-22:00>
+* Meet Peter at the movies
+  <2006-11-01 Wed 19:15>
+* Discussion on climate change
+  <2006-11-02 Thu 20:00-22:00>
 @end smallexample
 
 @noindent @b{Timestamp with repeater interval}@*
@@ -1335,7 +1337,8 @@ applies not only on the given date, but again and again after a certain
 interval of N days (d), weeks (w), months (m), or years (y).  The
 following will show up in the agenda every Wednesday:
 @smallexample
-* Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
+* Pick up Sam at school
+  <2007-05-16 Wed 12:30 +1w>
 @end smallexample
 
 @noindent @b{Diary-style sexp entries}@*
@@ -1360,7 +1363,8 @@ angular ones.  These timestamps are inactive in the sense that they do
 @emph{not} trigger an entry to show up in the agenda.
 
 @smallexample
-* Gillian comes late for the fifth time [2006-11-01 Wed]
+* Gillian comes late for the fifth time
+  [2006-11-01 Wed]
 @end smallexample
 
 
-- 
1.7.9


             reply	other threads:[~2012-04-20 16:02 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-04-20 16:01 Brian van den Broek [this message]
2012-04-20 16:16 ` Change example timestamps to not occur in headlines John Hendy
2012-04-20 16:18   ` Brian van den Broek
2012-04-20 16:53     ` John Hendy
2012-04-22 16:00       ` Samuel Wales
2012-04-23 10:16         ` Bastien
2012-04-23 12:44           ` Brian van den Broek
2012-04-23 12:52             ` Bastien
2012-04-23 17:08           ` Samuel Wales
2012-04-23 17:17             ` Samuel Wales
  -- strict thread matches above, loose matches on Subject: below --
2012-04-20 16:16 Brian van den Broek

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=CAF6DajLZZVaL+snyO_sSy+UVT9xtXKqNF9ju3wA1AD0drzxOyg@mail.gmail.com \
    --to=brian.van.den.broek@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).