* Change example timestamps to not occur in headlines
@ 2012-04-20 16:01 Brian van den Broek
2012-04-20 16:16 ` John Hendy
0 siblings, 1 reply; 11+ messages in thread
From: Brian van den Broek @ 2012-04-20 16:01 UTC (permalink / raw)
To: emacs-orgmode
[-- 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
^ permalink raw reply related [flat|nested] 11+ messages in thread
* Re: Change example timestamps to not occur in headlines
2012-04-20 16:01 Change example timestamps to not occur in headlines Brian van den Broek
@ 2012-04-20 16:16 ` John Hendy
2012-04-20 16:18 ` Brian van den Broek
0 siblings, 1 reply; 11+ messages in thread
From: John Hendy @ 2012-04-20 16:16 UTC (permalink / raw)
To: Brian van den Broek; +Cc: emacs-orgmode
On Fri, Apr 20, 2012 at 11:01 AM, Brian van den Broek
<brian.van.den.broek@gmail.com> wrote:
> 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.
>
Can you point to the discouragement? I do this and would like to know
why it's discouraged but didn't see anything noting it in the manual
section on dates and timestamps.
Thanks,
John
> 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
^ permalink raw reply [flat|nested] 11+ messages in thread
* Change example timestamps to not occur in headlines
@ 2012-04-20 16:16 Brian van den Broek
0 siblings, 0 replies; 11+ messages in thread
From: Brian van den Broek @ 2012-04-20 16:16 UTC (permalink / raw)
To: emacs-orgmode
[-- Attachment #1: Type: text/plain, Size: 740 bytes --]
Hi all,
[I wondered why my first post wasn't labelled a patch, and then I saw
that it attached as octet-stream. Investigating, I was surprised to see
that gmail's web interface cannot handle patches as attachments. Sorry
for the dupe, but I thought it best to send again in a way that
patchwork can detect.]
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: text/x-diff, 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
^ permalink raw reply related [flat|nested] 11+ messages in thread
* Re: Change example timestamps to not occur in headlines
2012-04-20 16:16 ` John Hendy
@ 2012-04-20 16:18 ` Brian van den Broek
2012-04-20 16:53 ` John Hendy
0 siblings, 1 reply; 11+ messages in thread
From: Brian van den Broek @ 2012-04-20 16:18 UTC (permalink / raw)
To: John Hendy; +Cc: emacs-orgmode
On 20 April 2012 18:16, John Hendy <jw.hendy@gmail.com> wrote:
> On Fri, Apr 20, 2012 at 11:01 AM, Brian van den Broek
> <brian.van.den.broek@gmail.com> wrote:
>> 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.
>>
>
> Can you point to the discouragement? I do this and would like to know
> why it's discouraged but didn't see anything noting it in the manual
> section on dates and timestamps.
>
> Thanks,
> John
Hi John,
The first footnote on
<http://orgmode.org/manual/Handling-links.html#Handling-links>, for
instance. There may be more, but this is the one I could find,
quickly.
Best,
Brian vdB
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: Change example timestamps to not occur in headlines
2012-04-20 16:18 ` Brian van den Broek
@ 2012-04-20 16:53 ` John Hendy
2012-04-22 16:00 ` Samuel Wales
0 siblings, 1 reply; 11+ messages in thread
From: John Hendy @ 2012-04-20 16:53 UTC (permalink / raw)
To: Brian van den Broek; +Cc: emacs-orgmode
On Fri, Apr 20, 2012 at 11:18 AM, Brian van den Broek
<brian.van.den.broek@gmail.com> wrote:
> On 20 April 2012 18:16, John Hendy <jw.hendy@gmail.com> wrote:
>> On Fri, Apr 20, 2012 at 11:01 AM, Brian van den Broek
>> <brian.van.den.broek@gmail.com> wrote:
>>> 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.
>>>
>>
>> Can you point to the discouragement? I do this and would like to know
>> why it's discouraged but didn't see anything noting it in the manual
>> section on dates and timestamps.
>>
>> Thanks,
>> John
>
>
> Hi John,
>
> The first footnote on
> <http://orgmode.org/manual/Handling-links.html#Handling-links>, for
> instance. There may be more, but this is the one I could find,
> quickly.
Gotcha. Just my take -- your patch made me think it was a major
offense. The man seems to just mention that it can mess up headline
linking. Not a big deal and still is a valid point, but wasn't what I
expected. Thanks for the link!
John
>
> Best,
>
> Brian vdB
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: Change example timestamps to not occur in headlines
2012-04-20 16:53 ` John Hendy
@ 2012-04-22 16:00 ` Samuel Wales
2012-04-23 10:16 ` Bastien
0 siblings, 1 reply; 11+ messages in thread
From: Samuel Wales @ 2012-04-22 16:00 UTC (permalink / raw)
To: John Hendy; +Cc: Brian van den Broek, emacs-orgmode
On 2012-04-20, John Hendy <jw.hendy@gmail.com> wrote:
>>>> 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.
Does this advice apply any more? Perhaps it shoudl be removed.
--
The Kafka Pandemic: http://thekafkapandemic.blogspot.com
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: Change example timestamps to not occur in headlines
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 17:08 ` Samuel Wales
0 siblings, 2 replies; 11+ messages in thread
From: Bastien @ 2012-04-23 10:16 UTC (permalink / raw)
To: Samuel Wales; +Cc: Brian van den Broek, emacs-orgmode
Hi Samuel,
Samuel Wales <samologist@gmail.com> writes:
> On 2012-04-20, John Hendy <jw.hendy@gmail.com> wrote:
>>>>> 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.
>
> Does this advice apply any more?
Yes it does.
> Perhaps it shoudl be removed.
So no... let's stick to the current version of the manual.
--
Bastien
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: Change example timestamps to not occur in headlines
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
1 sibling, 1 reply; 11+ messages in thread
From: Brian van den Broek @ 2012-04-23 12:44 UTC (permalink / raw)
To: Bastien; +Cc: emacs-orgmode
[-- Attachment #1: Type: text/plain, Size: 944 bytes --]
On 23 Apr 2012 12:15, "Bastien" <bzg@gnu.org> wrote:
>
> Hi Samuel,
>
> Samuel Wales <samologist@gmail.com> writes:
>
> > On 2012-04-20, John Hendy <jw.hendy@gmail.com> wrote:
> >>>>> 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.
> >
> > Does this advice apply any more?
>
> Yes it does.
>
> > Perhaps it shoudl be removed.
>
> So no... let's stick to the current version of the manual.
Hi Bastien and all,
I agree that the discouragement of timestamps in headlines should remain in
the docs.
But I still do think the docs examples should be changed to comply with
that advice. I tried twice to send a patch, yet failed to do so in a manner
recognized by patchwork. I *think* I know how now, but elected not to send
a third attempt. Should I send it once again?
Best,
Brian vdB
[-- Attachment #2: Type: text/html, Size: 1342 bytes --]
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: Change example timestamps to not occur in headlines
2012-04-23 12:44 ` Brian van den Broek
@ 2012-04-23 12:52 ` Bastien
0 siblings, 0 replies; 11+ messages in thread
From: Bastien @ 2012-04-23 12:52 UTC (permalink / raw)
To: Brian van den Broek; +Cc: emacs-orgmode
Hi Brian,
Brian van den Broek <brian.van.den.broek@gmail.com> writes:
> I agree that the discouragement of timestamps in headlines should
> remain in the docs.
>
> But I still do think the docs examples should be changed to comply
> with that advice. I tried twice to send a patch, yet failed to do so
> in a manner recognized by patchwork.
One of your patches made it to patchword.
> I *think* I know how now, but
> elected not to send a third attempt. Should I send it once again?
No, it has already been applied:
http://orgmode.org/w/?p=org-mode.git;a=commit;h=8f3dc945
Thanks!
--
Bastien
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: Change example timestamps to not occur in headlines
2012-04-23 10:16 ` Bastien
2012-04-23 12:44 ` Brian van den Broek
@ 2012-04-23 17:08 ` Samuel Wales
2012-04-23 17:17 ` Samuel Wales
1 sibling, 1 reply; 11+ messages in thread
From: Samuel Wales @ 2012-04-23 17:08 UTC (permalink / raw)
To: Bastien; +Cc: Brian van den Broek, emacs-orgmode
Hi Bastien,
Just wanted to make sure.
Just so you know:
With my settings, I find that if I have:
********* Details [2012-04-23 Mon 09:58]
and I do M-x org-store-link, then the resulting link with ID works
when you click on it.
So it works for me, but I guess others with other settings will find
that it does not work?
As I sort headlines with timestamps by time, timestamps in headlines
are valuable for me. I don't use date trees because I find sorting to
be a much better fit for me.
If the explanation (which I don't know yet) is short, perhaps the
manual can explain, for similar use cases.
Samuel
--
The Kafka Pandemic: http://thekafkapandemic.blogspot.com
<a href="http://thekafkapandemic.blogspot.com">http://thekafkapandemic.blogspot.com</a>
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: Change example timestamps to not occur in headlines
2012-04-23 17:08 ` Samuel Wales
@ 2012-04-23 17:17 ` Samuel Wales
0 siblings, 0 replies; 11+ messages in thread
From: Samuel Wales @ 2012-04-23 17:17 UTC (permalink / raw)
To: Bastien; +Cc: Brian van den Broek, emacs-orgmode
On 2012-04-23, Samuel Wales <samologist@gmail.com> wrote:
> If the explanation (which I don't know yet) is short, perhaps the
> manual can explain, for similar use cases.
Then again maybe I am the only person who doesn't get why the footnote is there.
I'm guessing something to do with brackets interfering with link
syntax, but then I would think that would be escaped to fix it. Or
else the footnote would say don't put brackets in headlines.
Is there a different explanation?
P.S. I do it like this (and I sort by reverse chrono) which works
*fantastically* for me:
...
* CALLED [2012-04-24 Tue 11:20] Bastien explained
* CALLED [2012-04-23 Mon 10:00] discussed links with Bastien
...
:)
--
The Kafka Pandemic: http://thekafkapandemic.blogspot.com
<a href="http://thekafkapandemic.blogspot.com">http://thekafkapandemic.blogspot.com</a>
^ permalink raw reply [flat|nested] 11+ messages in thread
end of thread, other threads:[~2012-04-23 17:17 UTC | newest]
Thread overview: 11+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2012-04-20 16:01 Change example timestamps to not occur in headlines Brian van den Broek
2012-04-20 16:16 ` 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
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).