Source blocks with captions

Source blocks with captions

[Alexander Baier]

Hello org-moders!

I just tried to put a caption under/on/above (or anywhere for that
matter) my source code block.  When exporting to latex, I didn't see any
caption belonging to my code block.  Other backends have not been
tried.  How can I achieve this?

For reference, I run Org-mode version 8.2.6 (release_8.2.6 @
/home/delexi/.emacs.d/ext/org-mode/lisp/) and this is the org file:

* Test
#+CAPTION: Test
#BEGIN_SRC java
  // some code
#END_SRC

Thanks in advance,
-- 
Alexander Baier

Re: Source blocks with captions

[Thorsten Jolitz]

Alexander Baier <alexander.baier@mailbox.org> writes:

> Hello org-moders!
>
> I just tried to put a caption under/on/above (or anywhere for that
> matter) my source code block.  When exporting to latex, I didn't see any
> caption belonging to my code block.  Other backends have not been
> tried.  How can I achieve this?
>
> For reference, I run Org-mode version 8.2.6 (release_8.2.6 @
> /home/delexi/.emacs.d/ext/org-mode/lisp/) and this is the org file:
>
> * Test
> #+CAPTION: Test
> #BEGIN_SRC java
>   // some code
> #END_SRC

shouldn't that be 

,----
| #+NAME: Test
`----

instead of 

,----
| #+CAPTION: Test
`----

?

-- 
cheers,
Thorsten

Re: Source blocks with captions

[Alexander Baier]

On 2014-06-23 17:43 Thorsten Jolitz wrote:
> Alexander Baier <alexander.baier@mailbox.org> writes:
>
>> Hello org-moders!
>>
>> I just tried to put a caption under/on/above (or anywhere for that
>> matter) my source code block.  When exporting to latex, I didn't see any
>> caption belonging to my code block.  Other backends have not been
>> tried.  How can I achieve this?
>>
>> For reference, I run Org-mode version 8.2.6 (release_8.2.6 @
>> /home/delexi/.emacs.d/ext/org-mode/lisp/) and this is the org file:
>>
>> * Test
>> #+CAPTION: Test
>> #BEGIN_SRC java
>>   // some code
>> #END_SRC
>
> shouldn't that be 
>
> ,----
> | #+NAME: Test
> `----
>
> instead of 
>
> ,----
> | #+CAPTION: Test
> `----
>
> ?

This does not work for me - I still see no caption or a similar thing in
the vicinity of my code block.  Does "#+NAME" work for you?

Regards,
-- 
Alexander Baier

Re: Source blocks with captions

[Thomas S. Dye]

Aloha Alexander,

Alexander Baier <alexander.baier@mailbox.org> writes:

> On 2014-06-23 17:43 Thorsten Jolitz wrote:
>> Alexander Baier <alexander.baier@mailbox.org> writes:
>>
>>> Hello org-moders!
>>>
>>> I just tried to put a caption under/on/above (or anywhere for that
>>> matter) my source code block.  When exporting to latex, I didn't see any
>>> caption belonging to my code block.  Other backends have not been
>>> tried.  How can I achieve this?
>>>
>>> For reference, I run Org-mode version 8.2.6 (release_8.2.6 @
>>> /home/delexi/.emacs.d/ext/org-mode/lisp/) and this is the org file:
>>>
>>> * Test
>>> #+CAPTION: Test
>>> #BEGIN_SRC java
>>>   // some code
>>> #END_SRC
>>
>> shouldn't that be 
>>
>> ,----
>> | #+NAME: Test
>> `----
>>
>> instead of 
>>
>> ,----
>> | #+CAPTION: Test
>> `----
>>
>> ?
>
> This does not work for me - I still see no caption or a similar thing in
> the vicinity of my code block.  Does "#+NAME" work for you?
>
> Regards,

There are two errors in your Org mode file on the BEGIN_SRC and END_SRC
lines.

With this code:

 * Test

 #+CAPTION: Test
 #+BEGIN_SRC java
    // some code
 #+END_SRC

I get a figure with a caption when exporting to LaTeX:

 \section{Test}
 \label{sec-1}

 \begin{figure}[H]
 \begin{verbatim}
 // some code
 \end{verbatim}\caption{Test}

 \end{figure}

You don't need to name the source code block, although it is typically a
good idea to do so.

hth,
Tom

-- 
Thomas S. Dye
http://www.tsdye.com

Re: Source blocks with captions

[Alexander Baier]

On 2014-06-23 21:23 Thomas S. Dye wrote:
> Aloha Alexander,
>
> Alexander Baier <alexander.baier@mailbox.org> writes:
>
>> On 2014-06-23 17:43 Thorsten Jolitz wrote:
>>> Alexander Baier <alexander.baier@mailbox.org> writes:
>>>
>>>> Hello org-moders!
>>>>
>>>> I just tried to put a caption under/on/above (or anywhere for that
>>>> matter) my source code block.  When exporting to latex, I didn't see any
>>>> caption belonging to my code block.  Other backends have not been
>>>> tried.  How can I achieve this?
>>>>
>>>> For reference, I run Org-mode version 8.2.6 (release_8.2.6 @
>>>> /home/delexi/.emacs.d/ext/org-mode/lisp/) and this is the org file:
>>>>
>>>> * Test
>>>> #+CAPTION: Test
>>>> #BEGIN_SRC java
>>>>   // some code
>>>> #END_SRC
>>>
>>> shouldn't that be 
>>>
>>> ,----
>>> | #+NAME: Test
>>> `----
>>>
>>> instead of 
>>>
>>> ,----
>>> | #+CAPTION: Test
>>> `----
>>>
>>> ?
>>
>> This does not work for me - I still see no caption or a similar thing in
>> the vicinity of my code block.  Does "#+NAME" work for you?
>>
>> Regards,
>
> There are two errors in your Org mode file on the BEGIN_SRC and END_SRC
> lines.

You are of course right! This was just a mistake I made whilst putting
together this short example.  In my "normal" setup the source code
blocks have the right form.

> With this code:
>
>  * Test
>
>  #+CAPTION: Test
>  #+BEGIN_SRC java
>     // some code
>  #+END_SRC
>
> I get a figure with a caption when exporting to LaTeX:
>
>  \section{Test}
>  \label{sec-1}
>
>  \begin{figure}[H]
>  \begin{verbatim}
>  // some code
>  \end{verbatim}\caption{Test}
>
>  \end{figure}
>
> You don't need to name the source code block, although it is typically a
> good idea to do so.

I always only looked at the generated PDF to see if there was a caption
added.  When opening the generated .tex file I found the same code you
are seeing.  It seems the document class I am using just drops the
caption.

The class in question is LLNCS, does anyone know why this could happen?

Regards,
-- 
Alexander Baier

[Latex] Don't push code blocks to end of document (was: Source blocks with captions)

[Alexander Baier]

On 2014-06-24 14:31 Alexander Baier wrote:

[...]

>> With this code:
>>
>>  * Test
>>
>>  #+CAPTION: Test
>>  #+BEGIN_SRC java
>>     // some code
>>  #+END_SRC
>>
>> I get a figure with a caption when exporting to LaTeX:
>>
>>  \section{Test}
>>  \label{sec-1}
>>
>>  \begin{figure}[H]
>>  \begin{verbatim}
>>  // some code
>>  \end{verbatim}\caption{Test}
>>
>>  \end{figure}
>>
>> You don't need to name the source code block, although it is typically a
>> good idea to do so.
>
> I always only looked at the generated PDF to see if there was a caption
> added.  When opening the generated .tex file I found the same code you
> are seeing.  It seems the document class I am using just drops the
> caption.
>
> The class in question is LLNCS, does anyone know why this could happen?

In fact, the document class does not drop those captions, it just moves
the listings to the end of the document, where I did not see them.

How do I prevent this from happening? It is not much use to me if _all_
my listings are pushed to the very end of my document. I would like
latex to place them in the vicinity of where I defined my code block in
org.

This is the test file showing the behaviour described above:

----------------------------------------------------------------
#+LANGUAGE: de
#+OPTIONS: tasks:nil num:3 toc:nil ':t ":t
#+LATEX_CLASS: llncs
#+TITLE: Test

* A headline
Some words before the source code block.
For good measure, here is a link to listing [[src:foo]].

#+NAME: src:foo
#+CAPTION: test caption.
#+BEGIN_SRC java
  interface Foo {
      void bar();
  }
#+END_SRC

And some words after the block.
----------------------------------------------------------------


Thanks,
-- 
Alexander Baier

Re: [Latex] Don't push code blocks to end of document

[Alexander Baier]

Hello again,

this is another follow up, I am sorry for so much noise.

On 2014-06-25 13:20 Alexander Baier wrote:
> On 2014-06-24 14:31 Alexander Baier wrote:
>
> [...]
>
>>> With this code:
>>>
>>>  * Test
>>>
>>>  #+CAPTION: Test
>>>  #+BEGIN_SRC java
>>>     // some code
>>>  #+END_SRC
>>>
>>> I get a figure with a caption when exporting to LaTeX:
>>>
>>>  \section{Test}
>>>  \label{sec-1}
>>>
>>>  \begin{figure}[H]
>>>  \begin{verbatim}
>>>  // some code
>>>  \end{verbatim}\caption{Test}
>>>
>>>  \end{figure}
>>>
>>> You don't need to name the source code block, although it is typically a
>>> good idea to do so.
>>
>> I always only looked at the generated PDF to see if there was a caption
>> added.  When opening the generated .tex file I found the same code you
>> are seeing.  It seems the document class I am using just drops the
>> caption.
>>
>> The class in question is LLNCS, does anyone know why this could happen?
>
> In fact, the document class does not drop those captions, it just moves
> the listings to the end of the document, where I did not see them.
>
> How do I prevent this from happening? It is not much use to me if _all_
> my listings are pushed to the very end of my document. I would like
> latex to place them in the vicinity of where I defined my code block in
> org.

I fixed this by using the listings package. I set "org-latex-listings"
to true and followed the instructions in the doc string of said
variable. Now, my code blocks are placed where I want them and are even
syntax highlighted!

[...]

Regards,
-- 
Alexander Baier