emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Jambunathan K <kjambunathan@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: example or source blocks with captions
Date: Sat, 30 Apr 2011 10:30:08 +0530	[thread overview]
Message-ID: <81tydg8gmu.fsf@gmail.com> (raw)


(Forwarding it - Looks like the original mail didn't make it's way to
the list)

> Hi Neilen,
>
> Neilen Marais wrote:
>> Is it possible to caption a #+begin_src or #+begin_example block? Doing
>>
>> #+CAPTION: dipole_analytical_balanis.mac
>> #+begin_example
>> ....
>> #+end_example
>>
>> doesn't seem to do the trick. I would find this useful to include
>> suggested filenames when quoting source on a web page.
>
> Would such block be better for you?
>
> #+srcname: dipole_analytical_balanis.mac
> #+begin_src mac
> ....
> #+end_src
>
> The source name should be exported in HTML. If not, this is a feature.[1]
>

A cursory look suggests that

org-export-format-source-code-or-example takes caption as an arg. This
is used only if htmlize or org-export-latex-listings is configured by
the user - Both of these are not part of factory settings and wouldn't
work out of the box. (Seems like the situation could be improved)

ASCII export always exports a caption without fail.

So if I export

* Source Block
** Emacs Lisp Block

--8<---------------cut here---------------start------------->8---
#+CAPTION: HelloWorldCaption
#+srcname: HelloWorldSrcName
#+begin_src emacs-lisp
  (defun helloworld () 
    ""
    (message "hello world"))
#+end_src  
--8<---------------cut here---------------end--------------->8---

I get something like 

--8<---------------cut here---------------start------------->8---
1 Source Block 
---------------

1.1 Emacs Lisp Block 
=====================


  (defun helloworld () 
    ""
    (message "hello world"))
--8<---------------cut here---------------end--------------->8---

meaning that captions are not possibly passed into
org-export-format-source-code-or-example.

A cursory look at org-export-attach-captions-and-attributes where
('org-caption text property is added) suggests that captions are not
getting associated with the src blocks.

In summary, there seems to be a clear intent to attach a caption to
example or source blocks but somehow things are turning out otherwise.

Jambunathan K.

> Best regards,
>   Seb
>
> Footnotes:
>
> [1] I know for sure it does when the block has "grounded" parameters (ie, with
> a given value).

-- 

             reply	other threads:[~2011-04-30  5:15 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-04-30  5:00 Jambunathan K [this message]
  -- strict thread matches above, loose matches on Subject: below --
2011-04-27 15:57 example or source blocks with captions Neilen Marais
2011-04-27 19:36 ` Sébastien Vauban
2011-04-30  5:00   ` Jambunathan K
2011-04-27 21:21 ` Thomas S. Dye
2011-04-28  7:46   ` Sébastien Vauban

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=81tydg8gmu.fsf@gmail.com \
    --to=kjambunathan@gmail.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).