emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Bastien <bzg@gnu.org>
To: "Christopher J. White" <chris@grierwhite.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Extract item body with drawers/properties
Date: Tue, 08 May 2012 11:53:10 +0200	[thread overview]
Message-ID: <87r4uvvw1l.fsf@gnu.org> (raw)
In-Reply-To: <4FA6FB29.2060204@grierwhite.com> (Christopher J. White's message of "Sun, 06 May 2012 18:28:57 -0400")

Hi Christopher,

"Christopher J. White" <chris@grierwhite.com> writes:

> Is there a function to extract the body of an item minus all the auxiliary
> information?

Yes -- see org-element.el in contrib/lisp/ and ̀org-element-parse-buffer'
as a starting point.  Nicolas might give further directions on how to get
the body text only.

> * Item
>   This is the text I want.
>   And here is the second line.
>   SCHEDULED: <2012-05-12>
>   DEADLINE: <2012-05-13>

Please put SCHEDULED: <2012-05-12> and DEADLINE: <2012-05-13> on the
line right after the headline "Item".  It will produce unexpected
results on some commands right now.  

>   :PROPERTIES:
>   :foo: bar
>   :END:

I would also recommend putting this right below the SCHEDULED/DEADLINE
line.  

>   And it's conceivable there is more below drawers...
> ** Sub-Item 1
> ** Sub-Item 2

> Basically I want a function that does the following:
>
> (org-entry-get-text)
> "This is the text I want
> And here is the second line.
> And it's conceivable there is more below drawers..."

There is `org-agenda-get-some-entry-text' but you don't want to look at
it... because it's tuned for use in agenda only.

> Point is at "* Item" when this is called.
>
> For one project (org-toodledo), I coded a version (see below) that pulls
> out the drawers, drops properties SCHEDULED/DEADLINE/CLOSED, and pulls off
> any indentation, and it works pretty well, although it is probably not
> complete for all cases.  However, I'm now working on extensions for another
> project (org-taskjuggler) and want to again pull out the note.
>
> I tried again to find such a function in the org source files, but I just
> can't seem to find it.
>
> Does it exist?  

Not yet -- but building one from org-element.el is possible.

> If not, does it make sense to make my version below
> workable for org-mode developers in general?

Please have a look at what Aurélien is working on right now:
http://orgmode.org/w/org-sync.git

The purpose is exactly this: build a gateway between Org and
external services like toodledo.  There is no support for toodledo
service in Aurélien's code for now, but I think there will be when
he will be done.

You might also be interested in org-x:

  http://thread.gmane.org/gmane.emacs.orgmode/45570

AFAIU, org-x ignores the content of a subtree, so this will not
help you that much -- but the idea of connecting Org with external 
services is there.

> (Related, what is the right term for this block of text?  Note?  Content?
> Text?)

I'd call this the "contents" of a section.  Note the plural form, as
each section can contain paragraphs, code snippets, etc.

HTH,

-- 
 Bastien

      reply	other threads:[~2012-05-08  9:52 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-05-06 22:28 Extract item body with drawers/properties Christopher J. White
2012-05-08  9:53 ` Bastien [this message]

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=87r4uvvw1l.fsf@gnu.org \
    --to=bzg@gnu.org \
    --cc=chris@grierwhite.com \
    --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).