emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Matt Lundin <mdl@imapmail.org>
To: Brett Viren <bv@bnl.gov>
Cc: Nick Dokos <ndokos@gmail.com>, emacs-orgmode@gnu.org
Subject: Re: Possible to use src block to generate org headlines for export?
Date: Wed, 23 Jul 2014 10:17:36 -0500	[thread overview]
Message-ID: <8761io2jnz.fsf@fastmail.fm> (raw)
In-Reply-To: <ir4d2cwtcme.fsf@lycastus.phy.bnl.gov> (Brett Viren's message of "Wed, 23 Jul 2014 09:42:49 -0400")

Hi Brett,

Brett Viren <bv@bnl.gov> writes:

> Matt Lundin <mdl@imapmail.org> writes:
>
>> Let's hope the real blog (when I get around to publishing it) is more
>> interesting than the example above. ;)
>
> Maybe it would be more convenient to add the "meta-ness" you want as
> part of a new exporter process?  

To change the "meta" wrappers for code block results, we would have to
modify org babel (ob-core.el). Right now, the only wrapper that org
babel uses to contain the results of *raw* org output is a :RESULTS:
drawer. However, headlines wrapped in a drawer is something that
org-element, by definition, cannot recognize. For the same reason, no
custom export backend is going to be able to recognize this element.

But I've discovered to my delight all this is moot.

The *best and simplest solution* for automatically generating org
headlines for export is...

...never to execute the source block by hand in org source file. That
way, the results will appear only in the *temporary* copy of the buffer
is parsed for export and one does need to worry about demarcating the
output with a :RESULTS: drawer...

--8<---------------cut here---------------start------------->8---
#+BEGIN_SRC perl :exports results :results output org raw
[code to generate org source]
#+END_SRC
--8<---------------cut here---------------end--------------->8---

The above works perfectly so long I as resist the temptation to hit C-c
C-c.[fn:1]

And that can be solved easily by adding the following line to the top of
the file:

--8<---------------cut here---------------start------------->8---
# -*- org-babel-no-eval-on-ctrl-c-ctrl-c: t; -*-
--8<---------------cut here---------------end--------------->8---

Isn't emacs wonderful?

In short, it is much easier than I assumed to use babel blocks (and any
language one wants) to generate org headlines destined for publishing.

This is amazing! The applications are endless. E.g., I will use this to
generate a blog summary when publishing my website. I'll post a tutorial
sometime soon. Suffice it to say, one can easily use babel blocks to
generate content on a web page, thus implementing the functionality of a
static site generator like Jekyll, docpad, octopress, etc. (but with
infinitely more flexibility).

Best,
Matt

Footnotes:

[fn:1] If one really needs to see the headlines in the original org
buffer, a hook can be used to remove the :RESULTS: drawer.

--8<---------------cut here---------------start------------->8---
(defun my-remove-stray-results-drawer (backend)
  (when (eq backend 'html)
    (while (re-search-forward "^\\s-*:RESULTS:\\s-*\n" nil t)
      (replace-match ""))))

(add-hook 'org-export-before-parsing-hook 'my-remove-results-drawer)
--8<---------------cut here---------------end--------------->8---

  reply	other threads:[~2014-07-23 15:17 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-07-22 23:52 Possible to use src block to generate org headlines for export? Matt Lundin
2014-07-23  1:27 ` Nick Dokos
2014-07-23  2:35   ` Matt Lundin
2014-07-23  2:46     ` Matt Lundin
2014-07-23 13:42     ` Brett Viren
2014-07-23 15:17       ` Matt Lundin [this message]
2014-07-23 16:06         ` Charles Berry
2014-07-23 17:07           ` Matt Lundin
2014-07-24  1:51           ` Nick Dokos
2014-07-24 10:21             ` Andreas Leha
2014-07-25  8:31               ` Nicolas Goaziou
2014-07-25 13:05                 ` Andreas Leha
2014-07-25 13:23                   ` Nicolas Goaziou
2014-07-25 13:39                     ` Andreas Leha
2014-07-25 14:26                       ` Thorsten Jolitz
2014-07-25 16:08                       ` Nicolas Goaziou
2014-07-26  0:26                         ` Andreas Leha
2014-07-26  8:07                           ` Nicolas Goaziou
2014-07-26 19:47                             ` Andreas Leha
2014-07-24 18:40             ` Charles Berry
2014-07-24 19:41               ` Nick Dokos
2014-07-23 19:53         ` Brett Viren
2014-07-23 20:42           ` Matt Lundin
2014-07-24 22:05             ` Brett Viren
2014-07-23 16:09     ` Rick Frankel

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=8761io2jnz.fsf@fastmail.fm \
    --to=mdl@imapmail.org \
    --cc=bv@bnl.gov \
    --cc=emacs-orgmode@gnu.org \
    --cc=ndokos@gmail.com \
    /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).