emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Rasmus <rasmus@gmx.us>
Cc: emacs-orgmode@gnu.org
Subject: Re: [ox] possible to modify org-export-document-properties OTG
Date: Tue, 17 Mar 2015 09:25:10 +0100	[thread overview]
Message-ID: <87k2yg115l.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <87vbi030eb.fsf@gmx.us> (rasmus@gmx.us's message of "Tue, 17 Mar 2015 01:58:36 +0100")

Hello,

Rasmus <rasmus@gmx.us> writes:

> Is it possible to modify or extend org-export-document-properties on the
> go?  And would it be OK?

`org-export-document-properties' is a defconst, which is computed from
`org-element-document-properties', also a defconst. So, no, it
isn't meant for that.

Document properties are keywords where `org-element-context' is allowed
to return an object. It doesn't make sense to add random keywords
specific to some export back-ends to the list.

> Or should org-element-parse-secondary-string be used with appropriate
> limitations?

For now, I suggest to use `org-element-parse-secondary-string'.

> It would be useful 'cause it's an easy way to have a property parsed.  In
> ox-koma-letter.el it would make sense to make #+SUBJECT a document
> property (ATM org-syntax isn't interpreted).  In some backends it would
> probably also make sense to make #+KEYWORDS parsed.  I'm also working on a
> patch to add #+SUBTITLE, which would also benefit from being easily added
> as a document-property.

You can always use `org-element-parse-secondary-string' on the keyword
value and `org-export-data' or `org-export-data-with-backend' on it.

At some point, I thought about adding a `parsed' behaviour to
`org-export-options-alist' as a shortcut. Sadly, I cannot remember why
I didn't implement the idea eventually. It may be related to
`org-element-map', which couldn't map over data in such keywords, or the
fact that it would be confusing wrt `org-element-context'. E.g., if we
consider the two keywords

  #+TITLE: *boXld*
  #+PARSED_KÊYWORD_IN_SOME_BACKEND_IGNORED_IN_OTHERS: *boXld*

in the former, `org-element-context' at "X" returns a `bold' object, in
the latter, a `keyword' element. Note that I'm not arguing it should
return a `bold' object in both cases, it really shouldn't, but it can be
confusing and potentially trigger false bug reports.


Regards,

-- 
Nicolas Goaziou

  reply	other threads:[~2015-03-17 15:22 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-03-17  0:58 [ox] possible to modify org-export-document-properties OTG Rasmus
2015-03-17  8:25 ` Nicolas Goaziou [this message]
2015-03-18 16:42   ` Rasmus
2015-03-21 23:10     ` Nicolas Goaziou
2015-03-22  0:06       ` Rasmus
2015-03-22  1:06         ` Nicolas Goaziou
2015-03-22  1:34           ` Rasmus
2015-03-22 14:12             ` Nicolas Goaziou

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87k2yg115l.fsf@nicolasgoaziou.fr \
    --to=mail@nicolasgoaziou.fr \
    --cc=emacs-orgmode@gnu.org \
    --cc=rasmus@gmx.us \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).