[PATCH] only display a scheduled item if it is due today or in the past

[PATCH] only display a scheduled item if it is due today or in the past

[Nathaniel Flath]

[-- Attachment #1.1: Type: text/plain, Size: 392 bytes --]

Hello,
One thing I've wanted from org-mode is the ability to have certain items
'hidden' from the agenda until the day they are scheduled - this patch
implements this for all properties who have a STYLE property of 'hidden'.
I ended up implementing this(the patch is attached), and thought I'd
contribute it to org-mode. If you have any comments, please let me know.

Thanks,
Nathaniel Flath

[-- Attachment #1.2: Type: text/html, Size: 437 bytes --]

[-- Attachment #2: org-agenda.patch --]
[-- Type: text/x-patch, Size: 568 bytes --]

diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 2b56cb6..c7a07c4 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -4697,6 +4697,9 @@ FRACTION is what fraction of the head-warning time has passed."
 			    (and (not todayp)
 				 org-habit-show-habits-only-for-today))
 			(throw :skip nil))
+		  (if (and (string= "hidden" (org-entry-get (point) "STYLE"))
+			   (< today d2))
+		      (throw :skip nil))
 		  (if (and
 		       (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
 			   (and org-agenda-skip-scheduled-if-deadline-is-shown

[-- Attachment #3: Type: text/plain, Size: 201 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: [PATCH] only display a scheduled item if it is due today or in the past

[Nathan Neff]

On Sun, May 2, 2010 at 12:37 PM, Nathaniel Flath <flat0103@gmail.com> wrote:
> Hello,
> One thing I've wanted from org-mode is the ability to have certain items
> 'hidden' from the agenda until the day they are scheduled - this patch
> implements this for all properties who have a STYLE property of 'hidden'.
> I ended up implementing this(the patch is attached), and thought I'd
> contribute it to org-mode. If you have any comments, please let me know.
>
> Thanks,
> Nathaniel Flath
>

+1 for this functionailty

This is great for "repeating" things that I don't want to have
littering up my agenda, such as "Check Org-Mode Mailing List".

Org-habit uses similar functionality, except that I don't want to see
the habit-grid.

--Nate
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
>

Re: [PATCH] only display a scheduled item if it is due today or in the past

[Carsten Dominik]

Hi Nathaniel,

I am not yet sure about the purpose of this functionality.
Items that are scheduled only show up in the agenda on the day when  
they are scheduled.  What is the added value?  Please explain, with an  
example.

Thanks.

- Carsten

On May 2, 2010, at 7:37 PM, Nathaniel Flath wrote:

> Hello,
> One thing I've wanted from org-mode is the ability to have certain  
> items 'hidden' from the agenda until the day they are scheduled -  
> this patch implements this for all properties who have a STYLE  
> property of 'hidden'.   I ended up implementing this(the patch is  
> attached), and thought I'd contribute it to org-mode. If you have  
> any comments, please let me know.
>
> Thanks,
> Nathaniel Flath
> <org-agenda.patch>_______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

- Carsten

Re: [PATCH] only display a scheduled item if it is due today or in the past

[Nathaniel Flath]

[-- Attachment #1.1: Type: text/plain, Size: 1855 bytes --]

Sorry for the late reply - this thread was filtered incorrectly.

The primary use I have for it is essentially what Nathan said - it controls
display or recurring items to be the same as habits, with the exception of
not displaying the habit graph.

I also use it when scheduling items that can't be started before a certain
date.  For example, I recently got a note that my tax return was being
inverstigated and that I should contact the IRS in 30 days.  Now, I schedule
this item for 30 days from now, but in 23 days it starts showing up in my
weekly agenda, even though there's nothing that can be done about it at that
point.  I'd much rather have it only display when it can actually be worked
on.

Let me know if you have any more questions.

Thanks,
Nathaniel Flath

On Thu, May 13, 2010 at 1:36 AM, Carsten Dominik
<carsten.dominik@gmail.com>wrote:

> Hi Nathaniel,
>
> I am not yet sure about the purpose of this functionality.
> Items that are scheduled only show up in the agenda on the day when they
> are scheduled.  What is the added value?  Please explain, with an example.
>
> Thanks.
>
> - Carsten
>
>
> On May 2, 2010, at 7:37 PM, Nathaniel Flath wrote:
>
>  Hello,
>> One thing I've wanted from org-mode is the ability to have certain items
>> 'hidden' from the agenda until the day they are scheduled - this patch
>> implements this for all properties who have a STYLE property of 'hidden'.
>> I ended up implementing this(the patch is attached), and thought I'd
>> contribute it to org-mode. If you have any comments, please let me know.
>>
>> Thanks,
>> Nathaniel Flath
>> <org-agenda.patch>_______________________________________________
>>
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>
> - Carsten
>
>
>
>

[-- Attachment #1.2: Type: text/html, Size: 2682 bytes --]

[-- Attachment #2: Type: text/plain, Size: 201 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: [PATCH] only display a scheduled item if it is due today or in the past

[Matt Lundin]

Nathaniel Flath <flat0103@gmail.com> writes:

>     On May 2, 2010, at 7:37 PM, Nathaniel Flath wrote:
>
>         One thing I've wanted from org-mode is the ability to have
>         certain items 'hidden' from the agenda until the day they are
>         scheduled - this patch implements this for all properties who
>         have a STYLE property of 'hidden'.   I ended up implementing
>         this(the patch is attached), and thought I'd contribute it to
>         org-mode. If you have any comments, please let me know.

> The primary use I have for it is essentially what Nathan said - it
> controls display or recurring items to be the same as habits, with the
> exception of not displaying the habit graph.

To avoid seeing future instances of recurring tasks, you can set the
variable org-agenda-repeating-timestamp-show-all to nil. 

> I also use it when scheduling items that can't be started before a
> certain date.  For example, I recently got a note that my tax return
> was being inverstigated and that I should contact the IRS in 30 days. 
> Now, I schedule this item for 30 days from now, but in 23 days it
> starts showing up in my weekly agenda, even though there's nothing that
> can be done about it at that point.  I'd much rather have it only
> display when it can actually be worked on.

I'm still a bit confused about this patch. By definition, scheduled
items do not appear on the agenda until the day on which they are
scheduled. As I understand it, this patch is primarily for weekly
agendas---i.e., to prevent items scheduled on Friday from appearing
under the Friday slot until it is indeed Friday. In that case, why not
use the daily agenda instead of the weekly agenda?

Would it perhaps be better to write a personal skip function that
handles this instead of hard-coding another test in org-agenda.el?

Best,
Matt

Re: [PATCH] only display a scheduled item if it is due today or in the past

[Nathaniel Flath]

[-- Attachment #1.1: Type: text/plain, Size: 2641 bytes --]

Yes, this patch is primarily for weekly agendas - it changes when items are
displayed to be the same as having a style of 'habit, while also allowing to
do it for non-recurring items.

org-agenda-repeating-timestamp-show-all doesn't do quite what I want - I
want the item to not show on my weekly agenda if it isn't scheduled for
today, where that will make it show a maximum of once.

I'd be wiling to write a personal skip function - I mainly did it this way
because I was emulating org-habit, and then I thought it may be useful to
other people.  This is what I'll fall back to if you decide not to install
this patch.

Thanks,
Nahtaniel Flath

On Sat, May 22, 2010 at 12:50 AM, Matt Lundin <mdl@imapmail.org> wrote:

> Nathaniel Flath <flat0103@gmail.com> writes:
>
> >     On May 2, 2010, at 7:37 PM, Nathaniel Flath wrote:
> >
> >         One thing I've wanted from org-mode is the ability to have
> >         certain items 'hidden' from the agenda until the day they are
> >         scheduled - this patch implements this for all properties who
> >         have a STYLE property of 'hidden'.   I ended up implementing
> >         this(the patch is attached), and thought I'd contribute it to
> >         org-mode. If you have any comments, please let me know.
>
> > The primary use I have for it is essentially what Nathan said - it
> > controls display or recurring items to be the same as habits, with the
> > exception of not displaying the habit graph.
>
> To avoid seeing future instances of recurring tasks, you can set the
> variable org-agenda-repeating-timestamp-show-all to nil.
>
> > I also use it when scheduling items that can't be started before a
> > certain date.  For example, I recently got a note that my tax return
> > was being inverstigated and that I should contact the IRS in 30 days.
> > Now, I schedule this item for 30 days from now, but in 23 days it
> > starts showing up in my weekly agenda, even though there's nothing that
> > can be done about it at that point.  I'd much rather have it only
> > display when it can actually be worked on.
>
> I'm still a bit confused about this patch. By definition, scheduled
> items do not appear on the agenda until the day on which they are
> scheduled. As I understand it, this patch is primarily for weekly
> agendas---i.e., to prevent items scheduled on Friday from appearing
> under the Friday slot until it is indeed Friday. In that case, why not
> use the daily agenda instead of the weekly agenda?
>
> Would it perhaps be better to write a personal skip function that
> handles this instead of hard-coding another test in org-agenda.el?
>
> Best,
> Matt
>

[-- Attachment #1.2: Type: text/html, Size: 3311 bytes --]

[-- Attachment #2: Type: text/plain, Size: 201 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: [PATCH] only display a scheduled item if it is due today or in the past

[Matthew Lundin]

Nathaniel Flath <flat0103@gmail.com> writes:

> Yes, this patch is primarily for weekly agendas - it changes when items
> are displayed to be the same as having a style of 'habit, while also
> allowing to do it for non-recurring items.

Do you mean that it is the same as when
org-habit-show-habits-only-for-today is set to t?

> org-agenda-repeating-timestamp-show-all doesn't do quite what I want -
> I want the item to not show on my weekly agenda if it isn't scheduled
> for today, where that will make it show a maximum of once.
>
> I'd be wiling to write a personal skip function - I mainly did it this
> way because I was emulating org-habit, and then I thought it may be
> useful to other people.  This is what I'll fall back to if you decide
> not to install this patch.

My main concern about the patch is that, unlike org-habit, the test is
not optional, so it adds an extra expense (however small) for everyone
who uses the agenda regardless of whether they want the test or not.

I believe this good scenario for using an org-agenda-skip-function. Does
the following skip function/custom command accomplish what you are
looking for?

--8<---------------cut here---------------start------------->8---
(defun my-org-skip-hidden-if-future ()
  (let ((end-entry (save-excursion 
		     (or (outline-next-heading) (org-end-of-subtree))))
	 (scheduled (org-entry-get nil "SCHEDULED"))
	 (hidden (when (string= (org-entry-get nil "STYLE") "hidden")
		   t)))
    (when (and hidden scheduled)
      (if (<= (- (org-time-string-to-absolute scheduled)
		 (calendar-absolute-from-gregorian (calendar-current-date)))
	      0)
	  nil
	end-entry))))

(setq org-agenda-custom-commands
      '(("x" "Weekly agenda with hidden future" agenda ""
	 ((org-agenda-ndays 7)
	  (org-agenda-skip-function 'my-org-skip-hidden-if-future)
	  (org-agenda-start-day nil)))))
--8<---------------cut here---------------end--------------->8---

When I call it on the following subtree...

--8<---------------cut here---------------start------------->8---
* Test
** TODO Hidden and future
   SCHEDULED: <2010-05-23 Sun>
   :PROPERTIES:
   :STYLE:    hidden
   :END:
** TODO Hidden and past
   SCHEDULED: <2010-05-20 Thu>
   :PROPERTIES:
   :STYLE:    hidden
   :END:
** TODO Hidden and today
   SCHEDULED: <2010-05-22 Sat>
   :PROPERTIES:
   :STYLE:    hidden
   :END:
--8<---------------cut here---------------end--------------->8---

...I get this agenda output...

--8<---------------cut here---------------start------------->8---
Week-agenda (W20-W21):
Saturday   22 May 2010
  inbox:      Sched. 3x:  TODO Hidden and past
  inbox:      Scheduled:  TODO Hidden and today
Sunday     23 May 2010
Monday     24 May 2010 W21
Tuesday    25 May 2010
Wednesday  26 May 2010
Thursday   27 May 2010
Friday     28 May 2010
--8<---------------cut here---------------end--------------->8---

HTH,
Matt

Re: Re: [PATCH] only display a scheduled item if it is due today or in the past

[Nathan Neff]

On Sat, May 22, 2010 at 11:27 AM, Matthew Lundin <mdl@imapmail.org> wrote:
> Nathaniel Flath <flat0103@gmail.com> writes:
>
>> Yes, this patch is primarily for weekly agendas - it changes when items
>> are displayed to be the same as having a style of 'habit, while also
>> allowing to do it for non-recurring items.
>
> Do you mean that it is the same as when
> org-habit-show-habits-only-for-today is set to t?

From what I gather, it is almost the same except that the agenda entry
does NOT show the habit-grid.

>> org-agenda-repeating-timestamp-show-all doesn't do quite what I want -
>> I want the item to not show on my weekly agenda if it isn't scheduled
>> for today, where that will make it show a maximum of once.
>>
>> I'd be wiling to write a personal skip function - I mainly did it this
>> way because I was emulating org-habit, and then I thought it may be
>> useful to other people.  This is what I'll fall back to if you decide
>> not to install this patch.

Nathaniel, can you forward me your personal skip function if you write one?

Thanks,
--Nate

Re: [PATCH] only display a scheduled item if it is due today or in the past

[Carsten Dominik]

Hi,

can someone please summarize what the status of this discussion is?

I have lost track....

Thanks!

- Carsten

On May 22, 2010, at 4:09 PM, Nathaniel Flath wrote:

> Yes, this patch is primarily for weekly agendas - it changes when  
> items are displayed to be the same as having a style of 'habit,  
> while also allowing to do it for non-recurring items.
>
> org-agenda-repeating-timestamp-show-all doesn't do quite what I want  
> - I want the item to not show on my weekly agenda if it isn't  
> scheduled for today, where that will make it show a maximum of once.
>
> I'd be wiling to write a personal skip function - I mainly did it  
> this way because I was emulating org-habit, and then I thought it  
> may be useful to other people.  This is what I'll fall back to if  
> you decide not to install this patch.
>
> Thanks,
> Nahtaniel Flath
>
> On Sat, May 22, 2010 at 12:50 AM, Matt Lundin <mdl@imapmail.org>  
> wrote:
> Nathaniel Flath <flat0103@gmail.com> writes:
>
> >     On May 2, 2010, at 7:37 PM, Nathaniel Flath wrote:
> >
> >         One thing I've wanted from org-mode is the ability to have
> >         certain items 'hidden' from the agenda until the day they  
> are
> >         scheduled - this patch implements this for all properties  
> who
> >         have a STYLE property of 'hidden'.   I ended up implementing
> >         this(the patch is attached), and thought I'd contribute it  
> to
> >         org-mode. If you have any comments, please let me know.
>
> > The primary use I have for it is essentially what Nathan said - it
> > controls display or recurring items to be the same as habits, with  
> the
> > exception of not displaying the habit graph.
>
> To avoid seeing future instances of recurring tasks, you can set the
> variable org-agenda-repeating-timestamp-show-all to nil.
>
> > I also use it when scheduling items that can't be started before a
> > certain date.  For example, I recently got a note that my tax return
> > was being inverstigated and that I should contact the IRS in 30  
> days.
> > Now, I schedule this item for 30 days from now, but in 23 days it
> > starts showing up in my weekly agenda, even though there's nothing  
> that
> > can be done about it at that point.  I'd much rather have it only
> > display when it can actually be worked on.
>
> I'm still a bit confused about this patch. By definition, scheduled
> items do not appear on the agenda until the day on which they are
> scheduled. As I understand it, this patch is primarily for weekly
> agendas---i.e., to prevent items scheduled on Friday from appearing
> under the Friday slot until it is indeed Friday. In that case, why not
> use the daily agenda instead of the weekly agenda?
>
> Would it perhaps be better to write a personal skip function that
> handles this instead of hard-coding another test in org-agenda.el?
>
> Best,
> Matt
>

- Carsten

Re: [PATCH] only display a scheduled item if it is due today or in the past

[Matthew Lundin]

Hi Carsten,

Carsten Dominik <carsten.dominik@gmail.com> writes:

> can someone please summarize what the status of this discussion is?
>
> I have lost track....

As I understand it, the proposed patch hides items scheduled in the
future in the weekly agenda. E.g., if it is Monday, tasks scheduled for
Friday with a "STYLE=hidden" property would not appear under the Friday
slot in the weekly agenda.

I believe this is a perfect scenario for a skip-function. I offered an
example in this post:

http://thread.gmane.org/gmane.emacs.orgmode/24856/focus=25595

If you do decide to apply the patch, I would request that an option be
added to turn off the check for a STYLE=hidden property, so as to
minimize any undesired expenses in constructing the agenda. 

My argument is that if a test can be accommodated by current
configuration options (e.g., the skip-function) and is unlikely to be
invoked by a significant number of users, it should not be
hard-coded.

Best,
Matt

Re: [PATCH] only display a scheduled item if it is due today or in the past

[Carsten Dominik]

On Jun 4, 2010, at 2:51 PM, Matthew Lundin wrote:

> Hi Carsten,
>
> Carsten Dominik <carsten.dominik@gmail.com> writes:
>
>> can someone please summarize what the status of this discussion is?
>>
>> I have lost track....
>
> As I understand it, the proposed patch hides items scheduled in the
> future in the weekly agenda. E.g., if it is Monday, tasks scheduled  
> for
> Friday with a "STYLE=hidden" property would not appear under the  
> Friday
> slot in the weekly agenda.
>
> I believe this is a perfect scenario for a skip-function. I offered an
> example in this post:
>
> http://thread.gmane.org/gmane.emacs.orgmode/24856/focus=25595
>
> If you do decide to apply the patch, I would request that an option be
> added to turn off the check for a STYLE=hidden property, so as to
> minimize any undesired expenses in constructing the agenda.
>
> My argument is that if a test can be accommodated by current
> configuration options (e.g., the skip-function) and is unlikely to be
> invoked by a significant number of users, it should not be
> hard-coded.

Thanks Matt.  I follow your argument.  This certainly should
be configurable, but in fact I think this can indeed easily
be done with a skip function like you showed.

And I do not understand the point of the weekly agenda.  The
whole point of the weekly agenda is to show what will be
coming up during he next dasy, so in a way hiding items that
are scheduled on those days is defeating the purpose of the
weekly agenda.

Greetings

- Carsten

>
> Best,
> Matt
>

- Carsten

Re: Re: [PATCH] only display a scheduled item if it is due today or in the past

[Nathan Neff]

On Sat, Jun 5, 2010 at 11:38 PM, Carsten Dominik
<carsten.dominik@gmail.com> wrote:
>
> On Jun 4, 2010, at 2:51 PM, Matthew Lundin wrote:
>
>> Hi Carsten,
>>
>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>
>>> can someone please summarize what the status of this discussion is?
>>>
>>> I have lost track....

I apologize for commenting on this issue again, but I wanted to share
my solution.

First, maybe my use-case is slightly different than everyone else's,
but here it is:

I'm looking for jobs currently, and I want a reminder to Check
Monster.com every two days.

But, I do not want this item to show up in my weekly agenda 3 separate
times.  I tried org-habit, but I do not want the red/green habit graph
showing up in my agenda.  It's just a personal preference.

So, I set up an item like this:

*** TODO Check Monster.com
    SCHEDULED: <2010-06-16 Wed .+2d>
    :PROPERTIES:
    :STYLE:    habit
    :END:

I tried the skip-function mentioned here, and couldn't get it to work,
so I tried org-habit again, and I found that if I set

org-habit-show-habits-only-for-today to not-nil
and if I set
org-habit-graph-column to -1 then it successfully hides the graph.

So, that's my solution, and it's great for only seeing these "habits"
once, and not littering up my agenda with future TODOs with these
habits.
I'm using Org 6.35

Hope this helps,

--Nate
>>
>> As I understand it, the proposed patch hides items scheduled in the
>> future in the weekly agenda. E.g., if it is Monday, tasks scheduled for
>> Friday with a "STYLE=hidden" property would not appear under the Friday
>> slot in the weekly agenda.
>>
>> I believe this is a perfect scenario for a skip-function. I offered an
>> example in this post:
>>
>> http://thread.gmane.org/gmane.emacs.orgmode/24856/focus=25595
>>
>> If you do decide to apply the patch, I would request that an option be
>> added to turn off the check for a STYLE=hidden property, so as to
>> minimize any undesired expenses in constructing the agenda.
>>
>> My argument is that if a test can be accommodated by current
>> configuration options (e.g., the skip-function) and is unlikely to be
>> invoked by a significant number of users, it should not be
>> hard-coded.
>
> Thanks Matt.  I follow your argument.  This certainly should
> be configurable, but in fact I think this can indeed easily
> be done with a skip function like you showed.
>
> And I do not understand the point of the weekly agenda.  The
> whole point of the weekly agenda is to show what will be
> coming up during he next dasy, so in a way hiding items that
> are scheduled on those days is defeating the purpose of the
> weekly agenda.
>
> Greetings
>
> - Carsten
>
>>
>> Best,
>> Matt
>>
>
> - Carsten
>
>
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>

Re: Re: [PATCH] only display a scheduled item if it is due today or in the past

[Livin Stephen Sharma]

 To to 'hide' the graph, I set both org-habit-<preceding,following>-days to 0 .



On Jun 24, 2010, at 05:25:07 , Nathan Neff wrote:

> org-habit-graph-column to -1 then it successfully hides the graph.

Re: Re: [PATCH] only display a scheduled item if it is due today or in the past

[Nathan Neff]

On Sat, Jun 26, 2010 at 2:00 AM, Livin Stephen Sharma
<livin.stephen@gmail.com> wrote:
>
>  To to 'hide' the graph, I set both org-habit-<preceding,following>-days to 0 .
>
>

Very cool -- that will get rid of the error that shows up at the bottom of
my agenda.  The error says something about the datatype of
org-habit-graph-column :-)


>
> On Jun 24, 2010, at 05:25:07 , Nathan Neff wrote:
>
>> org-habit-graph-column to -1 then it successfully hides the graph.
>
>