Org list source block

Org list source block

[Jarmo Hurri]

Greetings.

Once again I fail when I try to do something very _simple_ with Org.

I am trying to define a checklist and then use the same list in my
exported document in multiple locations. I don't think macros would work
here, since my org code has multiple lines. So I am trying to use
Babel.

The idea would be the following (please ignore code block header
arguments):

# -----------------------------------------------------------------
* Test list
  #+NAME: my-list
  #+BEGIN_SRC org :exports code :results value org
  - [ ] foo
  - [ ] bar
  #+END_SRC

  #+BEGIN_SRC org :noweb yes
  <<my-list>>
  #+END_SRC
# -----------------------------------------------------------------

I have tried to do this in many different ways, but in my exported file
the checklist always appears as an unformatted code block; that is,
checklist appear as '[ ]', not as nicely formatted LaTeX boxes. I have
tried to vary ':exports' and ':results' to no avail.

What is the correct solution to this?

BTW, if there is a solution to this, I think future generations might
benefit if something about it were mentioned in the manual in section
11.6 "Macro replacement".

Thanks in advance!

Jarmo

Re: Org list source block

[Richard Lawrence]

Hi Jarmo,

Jarmo Hurri <jarmo.hurri@iki.fi> writes:

> I am trying to define a checklist and then use the same list in my
> exported document in multiple locations. ...
> What is the correct solution to this?

Would an #+INCLUDE file work here?  See

http://orgmode.org/manual/Include-files.html#Include-files

Best,
Richard

Re: Org list source block

[Jarmo Hurri]

Richard Lawrence <richard.lawrence@berkeley.edu> writes:

> Hi Jarmo,
>
> Jarmo Hurri <jarmo.hurri@iki.fi> writes:
>
>> I am trying to define a checklist and then use the same list in my
>> exported document in multiple locations. ...
>> What is the correct solution to this?
>
> Would an #+INCLUDE file work here?

Yes, thank you! Adopted this solution for the time being.

Because this requires a (basically) unnecessary second file, I am still
hoping for other solutions to emerge.

Thanks!

Jarmo

Re: Org list source block

[Charles C. Berry]

On Sun, 3 Jan 2016, Jarmo Hurri wrote:

>
> Greetings.
>
> Once again I fail when I try to do something very _simple_ with Org.
>
> I am trying to define a checklist and then use the same list in my
> exported document in multiple locations. I don't think macros would work
> here, since my org code has multiple lines. So I am trying to use
> Babel.
>
> The idea would be the following (please ignore code block header
> arguments):
>
> # -----------------------------------------------------------------
> * Test list
>  #+NAME: my-list
>  #+BEGIN_SRC org :exports code :results value org
>  - [ ] foo
>  - [ ] bar
>  #+END_SRC
>
>  #+BEGIN_SRC org :noweb yes
>  <<my-list>>
>  #+END_SRC
> # -----------------------------------------------------------------
>
> I have tried to do this in many different ways, but in my exported file
> the checklist always appears as an unformatted code block; that is,
> checklist appear as '[ ]', not as nicely formatted LaTeX boxes. I have
> tried to vary ':exports' and ':results' to no avail.
>
> What is the correct solution to this?
>

Is this what you want?

--8<---------------cut here---------------start------------->8---
\section{Test list}
\label{sec:orgheadline1}
\begin{org}
\begin{itemize}
\item $\square$ foo
\item $\square$ bar
\end{itemize}
\end{org}
--8<---------------cut here---------------end--------------->8---

If so, you can get it with

--8<---------------cut here---------------start------------->8---
* Test list
#+NAME: my-list
#+BEGIN_SRC org :exports none :results value org
     - [ ] foo
     - [ ] bar
#+END_SRC

#+BEGIN_SRC org :noweb yes :results replace :wrap org :exports results
   <<my-list>>
#+END_SRC
--8<---------------cut here---------------end--------------->8---


Assuming that (require 'ob-org) has been taken care of!

HTH,

Chuck

Re: Org list source block

[Nicolas Goaziou]

Hello,

Jarmo Hurri <jarmo.hurri@iki.fi> writes:

> Once again I fail when I try to do something very _simple_ with Org.

You're building programmatically your document. I don't believe it
belongs to "very simple" tasks.

> I am trying to define a checklist and then use the same list in my
> exported document in multiple locations. I don't think macros would work
> here, since my org code has multiple lines. So I am trying to use
> Babel.
>
> The idea would be the following (please ignore code block header
> arguments):
>
> # -----------------------------------------------------------------
> * Test list
>   #+NAME: my-list
>   #+BEGIN_SRC org :exports code :results value org
>   - [ ] foo - [ ] bar #+END_SRC
>
>   #+BEGIN_SRC org :noweb yes
>   <<my-list>>
>   #+END_SRC
> # -----------------------------------------------------------------
>
> I have tried to do this in many different ways, but in my exported file
> the checklist always appears as an unformatted code block; that is,
> checklist appear as '[ ]', not as nicely formatted LaTeX boxes. I have
> tried to vary ':exports' and ':results' to no avail.
>
> What is the correct solution to this?

I think something along the following lines should work.

  #+NAME: mylist
  #+BEGIN_SRC org :results raw :exports none
  - [ ] foo 
  - [ ] bar 
  #+END_SRC

  #+CALL: mylist() :results raw
  #+RESULTS:

  #+CALL: mylist() :results raw
  #+RESULTS:

> BTW, if there is a solution to this, I think future generations might
> benefit if something about it were mentioned in the manual in section
> 11.6 "Macro replacement".

As you noticed already, you are not using a macro. Why would it be in
macro replacement?

Regards,

-- 
Nicolas Goaziou

Re: Org list source block

[Jarmo Hurri]

Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

>> Once again I fail when I try to do something very _simple_ with Org.
>
> You're building programmatically your document. I don't believe it
> belongs to "very simple" tasks.

Coming from a LaTeX background, Org is a real miracle tool, but it is
difficult to figure out how to do some things that used to be so
simple. Like in LaTeX you have a single \newcommand (or
\newenvironment), and then you use it wherever you want to. And if you
need similar document structure in multiple places, that is how a
programmer always does it.

>> BTW, if there is a solution to this, I think future generations might
>> benefit if something about it were mentioned in the manual in section
>> 11.6 "Macro replacement".
>
> As you noticed already, you are not using a macro. Why would it be in
> macro replacement?

To help the confused reader. Because people like me (common or rare
case?) just think: ok, I am going to define a macro for this. Then we go
to the org document and look up macros. Then we start doing online
searches for macros with linebreaks. Then we find discussions on
stackoverflow that say: "No you should do it with babel." Then we try to
figure out how to do it with babel. Then we post here. And so on.

My two absolute favorite tools from recent years are Org and Asymptote,
but neither have very beginner-friendly documentation. Partially because
both systems are so complex.

Yeah, I know I shouldn't whine: I could write the sections myself. But
others can do it better... :-)

> I think something along the following lines should work.
>
>   #+NAME: mylist
>   #+BEGIN_SRC org :results raw :exports none
>   - [ ] foo 
>   - [ ] bar 
>   #+END_SRC
>
>   #+CALL: mylist() :results raw
>   #+RESULTS:
>   #+CALL: mylist() :results raw
>   #+RESULTS:

This worked after adding org to org-babel-do-load-languges. Thanks!

Jarmo

Re: Org list source block

[Jarmo Hurri]

"Charles C. Berry" <ccberry@ucsd.edu> writes:

> If so, you can get it with
>
> * Test list
> #+NAME: my-list
> #+BEGIN_SRC org :exports none :results value org
>      - [ ] foo
>      - [ ] bar
> #+END_SRC
>
> #+BEGIN_SRC org :noweb yes :results replace :wrap org :exports results
>    <<my-list>>
> #+END_SRC

Thanks, that worked!

All the best,

Jarmo