Source blocks for tiny snippets

Source blocks for tiny snippets

[suvayu ali]

Hi everyone,

I was wondering what people do when they need to put a few (1 or 2)
lines of code snippets in org files? I like the syntax highlighting one
gets in an org buffer and in HTML export with code blocks. Is there some
work around other than have code blocks for every line I want to
include?

As an example consider this paragraph:

Edit job options for number of events and other configurations
: $ $EDITOR $GAUSSOPTS/<options_files>.py
The number of events in a job can be customised with the option
: LHCbApp().EvtMax = nEvts
To run the generator only, set the property below.
: Gauss().Phases = ["Generator"]
To turn on full monitoring and dump an ntuple to a root file, include
the opts files as below. It can be customised further to suit the needs.
: importOptions('$GAUSSOPTS/<some>.opts')

In the above example you have a mix of bash and python snippets.

Any thought?

-- 
Suvayu

Open source is the future. It sets us free.

Re: Source blocks for tiny snippets

[Eric Schulte]

suvayu ali <fatkasuvayu+linux@gmail.com> writes:

> Hi everyone,
>
> I was wondering what people do when they need to put a few (1 or 2)
> lines of code snippets in org files? I like the syntax highlighting one
> gets in an org buffer and in HTML export with code blocks. Is there some
> work around other than have code blocks for every line I want to
> include?
>
> As an example consider this paragraph:
>
> Edit job options for number of events and other configurations
> : $ $EDITOR $GAUSSOPTS/<options_files>.py
> The number of events in a job can be customised with the option
> : LHCbApp().EvtMax = nEvts
> To run the generator only, set the property below.
> : Gauss().Phases = ["Generator"]
> To turn on full monitoring and dump an ntuple to a root file, include
> the opts files as below. It can be customised further to suit the needs.
> : importOptions('$GAUSSOPTS/<some>.opts')
>
> In the above example you have a mix of bash and python snippets.
>

Currently there is no more concise way to specify code blocks other than
the normal code block format.  Although it doesn't currently exist maybe
an option could be added to hide the #+BEGIN/END_SRC lines so that they
don't appear in the buffer.  That combined with a helper for specifying
code blocks (I use yasnippets for this) should serve.

Best -- Eric

-- 
Eric Schulte
http://cs.unm.edu/~eschulte/

Re: Source blocks for tiny snippets

[suvayu ali]

Hi Eric,

On Sat, Oct 22, 2011 at 18:08, Eric Schulte <schulte.eric@gmail.com> wrote:
> suvayu ali <fatkasuvayu+linux@gmail.com> writes:
>
>> Hi everyone,
>>
>> I was wondering what people do when they need to put a few (1 or 2)
>> lines of code snippets in org files? I like the syntax highlighting one
>> gets in an org buffer and in HTML export with code blocks. Is there some
>> work around other than have code blocks for every line I want to
>> include?
>>
>> As an example consider this paragraph:
>>
>> Edit job options for number of events and other configurations
>> : $ $EDITOR $GAUSSOPTS/<options_files>.py
>> The number of events in a job can be customised with the option
>> : LHCbApp().EvtMax = nEvts
>> To run the generator only, set the property below.
>> : Gauss().Phases = ["Generator"]
>> To turn on full monitoring and dump an ntuple to a root file, include
>> the opts files as below. It can be customised further to suit the needs.
>> : importOptions('$GAUSSOPTS/<some>.opts')
>>
>> In the above example you have a mix of bash and python snippets.
>>
>
> Currently there is no more concise way to specify code blocks other than
> the normal code block format.  Although it doesn't currently exist maybe
> an option could be added to hide the #+BEGIN/END_SRC lines so that they
> don't appear in the buffer.  That combined with a helper for specifying
> code blocks (I use yasnippets for this) should serve.
>

Thanks for the confirmation. I can live with example lines for now. :)

-- 
Suvayu

Open source is the future. It sets us free.

Re: Source blocks for tiny snippets

[Thorsten]

Hi Eric,

Eric Schulte <schulte.eric@gmail.com> writes:

> That combined with a helper for specifying
> code blocks (I use yasnippets for this) should serve.

I would like to suggest adding the keybindings and shortcuts for
specifying code blocks to chapter 14.11 "Key bindings and useful
functions" in the manual. I'm still looking for a comfortabel way to
specify a code-block without typing much. A summary of keybindings,
shortcuts and completion methods available for this task in chapter 14
would be helpfull, even if there is some duplication of information
given in other chapters.

There is, e.g., the shortcut

,-------
| <s TAB
`-------

to insert a code-block, but its somehow underdocumented - I don't
remember, where I read about it, and don't find it in the manual
anymore. 


cheers
-- 
Thorsten

Re: Source blocks for tiny snippets

[Nick Dokos]

Thorsten <quintfall@googlemail.com> wrote:

> ... 
> There is, e.g., the shortcut
> 
> ,-------
> | <s TAB
> `-------
> 
> to insert a code-block, but its somehow underdocumented - I don't
> remember, where I read about it, and don't find it in the manual
> anymore. 
> 

It is documented in sec. 15.2, "Easy Templates", of
the org manual (along with how to add your own):

(info "(org) Easy Templates")

Nick

Re: Source blocks for tiny snippets

[Thorsten]

Nick Dokos <nicholas.dokos@hp.com> writes:

> It is documented in sec. 15.2, "Easy Templates", of
> the org manual (along with how to add your own):
>
> (info "(org) Easy Templates")

Thanks, I think I should take the dynamics of org-mode more into account
- my not so old hard-copy of the manual is already out of date,
apparently, it lacks that section. 

cheers
-- 
Thorsten

Re: Source blocks for tiny snippets

[Eric Schulte]

Nick Dokos <nicholas.dokos@hp.com> writes:

> Thorsten <quintfall@googlemail.com> wrote:
>
>> ... 
>> There is, e.g., the shortcut
>> 
>> ,-------
>> | <s TAB
>> `-------
>> 
>> to insert a code-block, but its somehow underdocumented - I don't
>> remember, where I read about it, and don't find it in the manual
>> anymore. 
>> 
>
> It is documented in sec. 15.2, "Easy Templates", of
> the org manual (along with how to add your own):
>
> (info "(org) Easy Templates")
>

I was not aware this existed.  I've just updated the manual to point to
this feature when the code block syntax is introduced.

Thanks -- Eric

>
> Nick
>
>

-- 
Eric Schulte
http://cs.unm.edu/~eschulte/