emacs-orgmode
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [O] [RFC] Change property drawer syntax


From: Rainer M Krug
Subject: Re: [O] [RFC] Change property drawer syntax
Date: Wed, 15 Oct 2014 09:38:56 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3 (darwin)

Nicolas Goaziou <address@hidden> writes:

> Hello,

Hi

I am not using org that much for schedulig, todo items, and other
similar topics, but mainly for literate programming, so I will comment
From that perspective.

>
> 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.

No problems so far from my side.

> Moreover, node properties' keys can only contain non-whitespace
> characters and cannot end with a plus sign (which is used for
> accumulation). 

This is problematic for me, as I am using it extensively in the case
of :header-args.

I set file wide header-arg and add the ones which have to change per
subtree / node:

--8<---------------cut here---------------start------------->8---
#+Property: header-args :tangle-mode (identity #o444)
#+PROPERTY: header-args+ :tangle no
#+PROPERTY: header-args+ :mkdirp yes
#+PROPERTY: header-args+ :exports both
#+PROPERTY: header-args+ :comments both
#+PROPERTY: header-args+ :padline no
#+PROPERTY: header-args+ :eval no-export

* To be tangled but *never* executed
:PROPERTIES:
:header-args+: :eval never
:END:
** some code
:PROPERTIES:
:comments: no
:header-args+: :tangle ./code.R
:header-args+: :padline no
:header-args+: :no-expand TRUE
:header-args+: :comments no
:END:
#+begin_src R 
## some code
#+end_src

* Not to be tangled but can be executed
#+begin_src R 
## some other code
#+end_src
--8<---------------cut here---------------end--------------->8---

So if I understand you correctly, this would break this approach, which
I think is very valuable in literate programming and reproducible research.

> 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.

At the moment, I do not see any way on how I can replace the + in the
properties drawer - or am I missing something very basic here?

Cheers,

Rainer

>
>   (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,

-- 
Rainer M. Krug
email: Rainer<at>krugs<dot>de
PGP: 0x0F52F982

Attachment: pgprFdms09gQz.pgp
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]