From mboxrd@z Thu Jan 1 00:00:00 1970 From: Nicolas Goaziou Subject: [RFC] Change property drawer syntax Date: Tue, 14 Oct 2014 16:42:46 +0200 Message-ID: <87oatek909.fsf@nicolasgoaziou.fr> Mime-Version: 1.0 Content-Type: text/plain Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:55064) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Xe3In-0006Y1-D6 for emacs-orgmode@gnu.org; Tue, 14 Oct 2014 10:42:27 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Xe3Ic-0007f6-D1 for emacs-orgmode@gnu.org; Tue, 14 Oct 2014 10:42:17 -0400 Received: from relay4-d.mail.gandi.net ([2001:4b98:c:538::196]:38958) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Xe3Ic-0007d0-3f for emacs-orgmode@gnu.org; Tue, 14 Oct 2014 10:42:06 -0400 Received: from mfilter20-d.gandi.net (mfilter20-d.gandi.net [217.70.178.148]) by relay4-d.mail.gandi.net (Postfix) with ESMTP id 74B0B1720EB for ; Tue, 14 Oct 2014 16:42:00 +0200 (CEST) Received: from relay4-d.mail.gandi.net ([217.70.183.196]) by mfilter20-d.gandi.net (mfilter20-d.gandi.net [10.0.15.180]) (amavisd-new, port 10024) with ESMTP id luvIC8++rgk4 for ; Tue, 14 Oct 2014 16:41:59 +0200 (CEST) Received: from selenimh (unknown [91.224.148.150]) (Authenticated sender: mail@nicolasgoaziou.fr) by relay4-d.mail.gandi.net (Postfix) with ESMTPSA id D0F131720E9 for ; Tue, 14 Oct 2014 16:41:58 +0200 (CEST) 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: Org Mode List Hello, As discussed previously, I would like to modify property drawers syntax. The change is simple: they must be located right after a headline and its planning line, if any. Therefore the following cases are valid * Headline :PROPERTIES: :KEY: value :END: * Headline SCHEDULED: <2014-10-14 mar.> :PROPERTIES: :KEY: value :END: but, in the following case, the scheduled keyword will not be recognized * Headline :PROPERTIES: :KEY: value :END: SCHEDULED: <2014-10-14 mar.> When not empty, they also have to contain only node properties. Moreover, node properties' keys can only contain non-whitespace characters and cannot end with a plus sign (which is used for accumulation). Value can contain anything but a newline character. Thus, the following property drawer is invalid * Headline :PROPERTIES: :KEY: value Some text. :END: Any invalid property drawer becomes de facto a regular drawer, with "PROPERTIES" as its name. Besides defining exactly the syntax of property drawers, it should also make the property API faster in some cases. Indeed, there's no need to search through entire (possibly huge) sections in order to find properties attached to a headline. However, it will break some Org documents. In particular, TODO-states changes are usually logged before any drawer, including properties drawers. The following function repairs them. (defun org-repair-property-drawers () "Fix properties drawers in current buffer. Ignore non Org buffers." (when (eq major-mode 'org-mode) (org-with-wide-buffer (goto-char (point-min)) (let ((case-fold-search t) (inline-re (and (featurep 'org-inlinetask) (concat (org-inlinetask-outline-regexp) "END[ \t]*$")))) (org-map-entries (lambda () (unless (and inline-re (org-looking-at-p inline-re)) (save-excursion (let ((end (save-excursion (outline-next-heading) (point)))) (forward-line) (when (org-looking-at-p org-planning-line-re) (forward-line)) (when (and (< (point) end) (not (org-looking-at-p org-property-drawer-re)) (save-excursion (re-search-forward org-property-drawer-re end t))) (insert (delete-and-extract-region (match-beginning 0) (min (1+ (match-end 0)) end))) (unless (bolp) (insert "\n")))))))))))) Internally, changes are somewhat invasive, as they include a rewrite of almost all the property API. They also alter clocking, tags, todo keywords, logging, initialization, hopefully in an invisible manner. I pushed a new branch, "top-properties" in the repository for code review and testing. It includes unit tests, documentation and an ORG-NEWS entry. Feedback welcome. Regards, -- Nicolas Goaziou 0x80A93738