emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Doc suggestion: Clarify subtree export properties
@ 2015-07-09 13:10 James Harkins
  2015-07-22  8:27 ` Nicolas Goaziou
  0 siblings, 1 reply; 2+ messages in thread
From: James Harkins @ 2015-07-09 13:10 UTC (permalink / raw)
  To: orgmode

I think the manual could be a bit clearer on one point of the use of :EXPORT_*: properties.

http://orgmode.org/manual/Export-settings.html#Export-settings

~~
When exporting only a subtree, each of the previous keywords3 can be overridden locally by special node properties. These begin with ‘EXPORT_’, followed by the name of the keyword they supplant. For example, ‘DATE’ and ‘OPTIONS’ keywords become, respectively, ‘EXPORT_DATE’ and ‘EXPORT_OPTIONS’ properties.
~~

And...

~~
[2] If you want to configure many options this way, you can use several #+OPTIONS lines.
~~

*If* you already know what you're doing, then you know that you can't have multiple properties of the same name in the same PROPERTIES drawer.

If you are reading the manual because you don't already know what you're doing, then you might simply convert the default block of options (inserted by C-c C-e # default RET) into multiple lines of properties, and then get annoyed when many of them are ignored.

Perhaps add this?

~~
... become, respectively, ‘EXPORT_DATE’ and ‘EXPORT_OPTIONS’ properties. Note that multiple EXPORT_OPTIONS lines are not supported, because node properties must have unique identifiers.
~~

hjh

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: Doc suggestion: Clarify subtree export properties
  2015-07-09 13:10 Doc suggestion: Clarify subtree export properties James Harkins
@ 2015-07-22  8:27 ` Nicolas Goaziou
  0 siblings, 0 replies; 2+ messages in thread
From: Nicolas Goaziou @ 2015-07-22  8:27 UTC (permalink / raw)
  To: James Harkins; +Cc: orgmode

Hello,

James Harkins <jamshark70@qq.com> writes:

> *If* you already know what you're doing, then you know that you can't
> have multiple properties of the same name in the same PROPERTIES
> drawer.
>
> If you are reading the manual because you don't already know what
> you're doing, then you might simply convert the default block of
> options (inserted by C-c C-e # default RET) into multiple lines of
> properties, and then get annoyed when many of them are ignored.
>
> Perhaps add this?
>
> ~~
> ... become, respectively, ‘EXPORT_DATE’ and ‘EXPORT_OPTIONS’ properties. Note that multiple EXPORT_OPTIONS lines are not supported, because node properties must have unique identifiers.
> ~~

I don't mind improving the wording. However, this is inaccurate because
you can add augmented properties:

  :PROPERTIES:
  :EXPORT_OPTIONS: ...
  :EXPORT_OPTIONS+: ...
  :END:

Also, C-c C-e C-s # default RET already inserts the default options as
a set of node properties.


Regards,

-- 
Nicolas Goaziou

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2015-07-22  8:25 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2015-07-09 13:10 Doc suggestion: Clarify subtree export properties James Harkins
2015-07-22  8:27 ` Nicolas Goaziou

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).