emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: "Christopher J. White" <chris@grierwhite.com>
To: emacs-orgmode@gnu.org
Subject: Extract item body with drawers/properties
Date: Sun, 06 May 2012 18:28:57 -0400	[thread overview]
Message-ID: <4FA6FB29.2060204@grierwhite.com> (raw)

Hi Folks,

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

* Item
   This is the text I want.
   And here is the second line.
   SCHEDULED: <2012-05-12>
   DEADLINE: <2012-05-13>
   :PROPERTIES:
   :foo: bar
   :END:
   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..."

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?  If not, does it make sense to make my version below 
workable for org-mode developers in general?

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

Thanks
...cj

(defun org-toodledo-entry-note ()
   "Extract the note for this task."
   (save-excursion
     (org-back-to-heading t)
     (when (looking-at org-complex-heading-regexp)
       (goto-char (match-end 0))
       (let ((text (buffer-substring-no-properties
                    (point)
                    (if (re-search-forward org-complex-heading-regexp nil t)
                        (match-beginning 0)
                      (org-end-of-subtree t t)))))
         (with-temp-buffer
           (insert text)

           ;; Pull out DEADLINE / SCHEDULED / CLOSED fields
           (dolist (str (list (regexp-quote org-deadline-string)
                              (regexp-quote org-scheduled-string)
                              (regexp-quote org-closed-string)))
             (goto-char (point-min))
             (when (re-search-forward
                    (concat "\\<" str " +[<\[][^]>\n]+[]>][ \t]*") nil t)
               (replace-match "XXXX ")))

           ;; Drop any empty lines with only XXXX
           (goto-char (point-min))
           (while (re-search-forward "^ *\\(XXXX \\)+\n" nil t)
             (replace-match ""))

           ;; Drop any remaining XXXX
           (goto-char (point-min))
           (while (re-search-forward "XXXX " nil t)
             (replace-match ""))

           ;; org-export-remove-or-extract-drawers removed an argument 
sometime around version 7
           (if (>= (string-to-number org-version) 7)
               (org-export-remove-or-extract-drawers org-drawers nil)
             (org-export-remove-or-extract-drawers org-drawers nil nil))

           ;; Trim leading/trailing empty lines, but preserve whitepace 
at the beginning of the line
           (goto-char (point-min))
           (if (re-search-forward "\\=\\( *\n\\)+" nil t)
               (replace-match ""))

           (goto-char (point-min))
           (if (re-search-forward "\\( *\n\\)+\\'" nil t)
               (replace-match ""))

           (goto-char (point-max))
           (insert "\n")

           ;; Finally, if this was indented and indenting notes, remove 
indentation
           (when org-toodledo-indent-task-note
             (goto-char (point-min))
             (when (re-search-forward "^ +" nil t)
               (let ((str (match-string 0)))
                 (goto-char (point-min))
                 (while (re-search-forward (format "^%s" str) nil t)
                   (replace-match "")))))

           (let ((s (buffer-substring-no-properties (point-min)
                                                    (point-max))))
             (if (string-match "\\(\\`[ \t]*[\n\r]+\\)+" s)  (setq s 
(replace-match "" t t s)))
             (if (string-match "\\([\n\r]+[ \t]*\\)+\\'" s) (setq s 
(replace-match "" t t s)))
             s)
           )
         )
       )
     )
   )

next             reply	other threads:[~2012-05-06 22:29 UTC|newest]

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

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=4FA6FB29.2060204@grierwhite.com \
    --to=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

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).