From: Rasmus <rasmus@gmx.us>
To: emacs-orgmode@gnu.org
Subject: Re: Usage of org-element api
Date: Fri, 16 Jan 2015 20:35:49 +0100 [thread overview]
Message-ID: <87r3uu34dm.fsf@gmx.us> (raw)
In-Reply-To: CAC2TPPg_v_0Jb9mZY90mK=8YWF1GgL8ins7r2O8eZY4vn4HOoQ@mail.gmail.com
Hi Dieter,
Nicolas will probably reply at some point and he has much greater (∞ more)
insight in this topics. None the less, I hope the below message will
help a bit.
Dieter Van Eessen <dieter.van.eessen@gmail.com> writes:
> 1) How to use org-element-content? Returns nil when used on elements parsed
> by org-element-<element>-parser (because they operate locally) When used
> globally, it only seems to remove the car of the list (org-data ....)
Don't use org-element-<element>-parser directly.
Use org-element-at-point or org-element-contents. The former is for
elements, the latter is for contents, such as scripts, bold, etc. See the
head of org-element.el.
> 2) What is actually a normal workflow if you wish to interactive manipulate
> only some of the elements? Is it something like:
> a) Define the region in which you wish to manipulate things (using :begin
> and :extract from org-element-at-point)
Org-element is a parser and manipulation might not be super efficient with
org-element, but it can be done.
OTOH Org-syntax is great for manipulation. E.g. to insert a heading you
can do (insert (format "* %s" "my-heading")).
> b) Parse the region: Get TREE and CONTENT
> (Are they always separated for manipulation?)
See org-element-map for operating on a subset of the consents. You could
also use narrowing to operate only on a subset of the buffer.
> c) Manipulate tree AND/OR manipulate content
Manipulate whatever you have as you want. Org-elements are plists. Check
org-element-type, org-element-property, org-element-contents,
org-element-put-property, org-element-set-contents. See also
";;; Accessors and Setters" in org-element.el.
org-element-interpret-data is the way to go from an element to
org-syntax. Here's an example:
http://emacs.stackexchange.com/questions/2869/turn-a-list-or-data-structure-into-an-org-document/
> d) Interpret (the org-element-<element>interpreters seem to require
> <element> and content whilst the org-element-interpret-data only requires a
> single 'data'. Why?)
Don't use org-element-<element>interpreters. Use
org-element-interpret-data for transforming org-element→org-syntax.
> e) See the manipulated stuff appear in the buffer.
There's insert for that.
> 3) How can the output of (org-element-parse-secondary-string ...) be used.
> When I give a heading and bit of text as input (output of
> buffer-substring), it looks like it returns the 'content' of the region.
> Though I can't seem to use it anyway as 'CONTENT' for the functions
> requiring this.
I don't get this.
> 4) How to use org-element--parse-elements? Whilst it is running i notice
> that it uses (org-element--current-element) and some of the
> (org-element-<element>-parser) functions. Thought it could be nice to use
> this one, but no matter how use it, all I get is nil. For example:
In Emacs-lisp typically "--" indicates that it's a private function.
Don't use it.
> 5) What is org-element--current-element for? It also seems to be called by
> org-element--parse-element.The properties :begin, :end and :title seem
> different than when parsing with org-element-at-point. Org-element-contents
> also nill when applied on the output. Why can't I use
> this function (org-element--current-element) on plainlists/items
> (returns error with point within a plain-list/item)?
See above.
> I know the basic answer to most of these question is: Why don't you use
> (org-element-parse-buffer). Well simply because I don't need everything. in
> first implementation I only need:
> OR HEADLINE under point and it's subtree
> (HEADLINE (plainlist (item,item,item)),(subheadline),...)
> OR the headline of an ITEM under point and subtree
> (headline (plainlist (item, ITEM,item)),(subheadline),...).
So use org-element-map and org-element-parse-buffer.
Hope it helps,
Rasmus
--
The second rule of Fight Club is: You do not talk about Fight Club
next prev parent reply other threads:[~2015-01-16 19:36 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-01-16 18:35 Usage of org-element api Dieter Van Eessen
2015-01-16 19:35 ` Rasmus [this message]
2015-01-16 21:45 ` Dieter Van Eessen
2015-01-16 22:04 ` Nicolas Goaziou
2015-01-17 0:33 ` Rasmus
2015-01-17 17:02 ` Dieter Van Eessen
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=87r3uu34dm.fsf@gmx.us \
--to=rasmus@gmx.us \
--cc=emacs-orgmode@gnu.org \
/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).