Re: #+PROPERTY documentation

[Daimrod <daimrod@gmail.com>]

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

Daimrod <daimrod@gmail.com> writes:

> John Hendy <jw.hendy@gmail.com> writes:
>
>> On Mon, Jan 21, 2013 at 12:41 PM, Daimrod <daimrod@gmail.com> wrote:
>>> Hi,
>>>
>>> It would be nice if the documentation mentioned the need to reparse the
>>> org buffer with `C-c C-c' when a property is set with #+PROPERTY.
>>> (info "(org) Property syntax")
>>
>> As in adding to the header arguments? Yeah, probably wouldn't hurt,
>> though it is, as stated below, documented that *any* change to the
>> header arguments requires C-c C-c.
>>
>> On a side note, is there the possibility for "normal" users to submit
>> git based changes to the manual? I know how to do this for Worg, but
>> I'd be happy to update stuff in the manual, too, when I catch them.
>> These sorts of things could be tweaked by the finder and it would save
>> the maintenance team a bit -- just scan the commit and notes for
>> rationale and accept.
>
> Sure, one can modify the file doc/org.texi. And you're right, I should
> have submit a patch.
>
>> John
>>
>>>
>>> And, IMO, it should also be mentioned here:
>>> (info "(org) Buffer-wide header arguments").
>>>
>>> A simple footnote like the one present here:
>>> (info "(org) Tag inheritance") should be sufficient.
>>>
>>>> (1) As with all these in-buffer settings, pressing `C-c C-c'
>>>> activates any changes in the line.
>>>

So, here is a patch for this:

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: 0001-add-footnote-to-recall-the-user-to-refresh-the-org-b.patch --]
[-- Type: text/x-diff, Size: 1413 bytes --]

From 09e569a651e77e8f2c1c2d1f0a285c69688fbd05 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gr=C3=A9goire=20Jadi?= <gregoire.jadi@gmail.com>
Date: Mon, 21 Jan 2013 23:45:47 +0100
Subject: [PATCH] add footnote to recall the user to refresh the org buffer
 when settings are changed.

---
 doc/org.texi |    8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 61f1ee5..c2bdd58 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -4954,7 +4954,9 @@ publishers and the number of disks in a box like this:
 @end example
 
 If you want to set properties that can be inherited by any entry in a
-file, use a line like
+file, use a line like@footnote{As
+with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
+changes in the line.}
 @cindex property, _ALL
 @cindex #+PROPERTY
 @example
@@ -13252,7 +13254,9 @@ of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
 For example the following would set @code{session} to @code{*R*}, and
 @code{results} to @code{silent} for every code block in the buffer, ensuring
 that all execution took place in the same session, and no results would be
-inserted into the buffer.
+inserted into the buffer.@footnote{As
+with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
+changes in the line.}
 
 @example
 #+PROPERTY: session *R*
-- 
1.7.10.4


[-- Attachment #1.3: Type: text/plain, Size: 21 bytes --]


-- 
Daimrod/Greg

[-- Attachment #2: Type: application/pgp-signature, Size: 835 bytes --]