From mboxrd@z Thu Jan 1 00:00:00 1970 From: Ilya Shlyakhter Subject: [PATCH] documentation patch clarifying ITEM special property Date: Fri, 16 Mar 2012 17:34:47 -0400 Message-ID: Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="------------070509080004000906060303" Return-path: Received: from eggs.gnu.org ([208.118.235.92]:42900) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1S8enz-0007PL-68 for emacs-orgmode@gnu.org; Fri, 16 Mar 2012 17:35:26 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1S8enx-0004c4-1d for emacs-orgmode@gnu.org; Fri, 16 Mar 2012 17:35:22 -0400 Received: from plane.gmane.org ([80.91.229.3]:41588) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1S8enw-0004be-ND for emacs-orgmode@gnu.org; Fri, 16 Mar 2012 17:35:20 -0400 Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1S8enu-0005QU-IS for emacs-orgmode@gnu.org; Fri, 16 Mar 2012 22:35:18 +0100 Received: from dhcp-140-247-108-225.fas.harvard.edu ([140.247.108.225]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Fri, 16 Mar 2012 22:35:18 +0100 Received: from ilya_shl by dhcp-140-247-108-225.fas.harvard.edu with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Fri, 16 Mar 2012 22:35:18 +0100 List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: emacs-orgmode@gnu.org This is a multi-part message in MIME format. --------------070509080004000906060303 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Documentation patch clarifying that ITEM refers to the headline not the contents of an entry, and that it currently isn't supported for tags/property searchers. Added a footnote pointing to a partial workaround using org-agenda-skip-entry-if. --------------070509080004000906060303 Content-Type: text/plain; charset=UTF-8; x-mac-type="0"; x-mac-creator="0"; name="0002-Documentation-Clarified-current-role-of-ITEM-special.patch" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename*0="0002-Documentation-Clarified-current-role-of-ITEM-special.pa"; filename*1="tch" >From 33ccb4f2d3dc352e54c18b7bb88b1be90f6067cf Mon Sep 17 00:00:00 2001 From: Ilya Shlyakhter Date: Fri, 16 Mar 2012 17:33:36 -0400 Subject: [PATCH 2/2] Documentation: Clarified current role of ITEM special property doc/org.texi (section on Special Properties) Clarified that ITEM refers to the headline of the entry not the whole entry text. (section on Matching Tags and Properties) Clarified that matching on the value of ITEM special property is not currently supported, and added a footnote about a partial workaround. Also added missing -if suffix to references to org-agenda-skip-entry-if. TINYCHANGE --- doc/org.texi | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 181ccd9..2c6168a 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -4953,7 +4953,7 @@ TIMESTAMP_IA @r{The first inactive timestamp in the entry.} CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}} @r{must be run first to compute the values in the current buffer.} BLOCKED @r{"t" if task is currently blocked by children or siblings} -ITEM @r{The content of the entry.} +ITEM @r{The headline of the entry.} FILE @r{The filename the entry is located in.} @end example @@ -7536,6 +7536,9 @@ So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc. +The ITEM special property cannot currently be used in tags/property +searches@footnote{But @pxref{x-agenda-skip-entry-regexp, +,skipping entries based on regexp}.}. Here are more examples: @table @samp @@ -15876,9 +15879,10 @@ Skip current entry if the TODO keyword is TODO or WAITING. Skip current entry if the TODO keyword marks a DONE state. @item (org-agenda-skip-entry-if 'timestamp) Skip current entry if it has any timestamp, may also be deadline or scheduled. -@item (org-agenda-skip-entry 'regexp "regular expression") +@anchor{x-agenda-skip-entry-regexp} +@item (org-agenda-skip-entry-if 'regexp "regular expression") Skip current entry if the regular expression matches in the entry. -@item (org-agenda-skip-entry 'notregexp "regular expression") +@item (org-agenda-skip-entry-if 'notregexp "regular expression") Skip current entry unless the regular expression matches. @item (org-agenda-skip-subtree-if 'regexp "regular expression") Same as above, but check and skip the entire subtree. -- 1.7.9.3 --------------070509080004000906060303--