[PATCH] org.el: Added a new interactive function which inserts a code block

[PATCH] org.el: Added a new interactive function which inserts a code block

[Florian Adamsky]

[-- Attachment #1: Type: text/plain, Size: 656 bytes --]

Hello,

I do not always use code blocks in org-mode, but when I do, I have
forgotten the syntax :-). In order to prevent that situation I wrote a
little function which is similar to org-insert-link. I called that
function org-insert-code-block. This function reads the language per
minibuffer in and supports completion. It only allows languages which
are loaded via org-babel-load-languages.

Is this function also useful to others? I'm not a long-time Emacs lisp
hacker, so any comment is welcome. Has anyone an idea for a reasonable
keybinding for org-insert-code-block which is not already taken by
org-mode?

Thanks in advance.

Best regards,
Florian 

[-- Attachment #2: org.el.diff --]
[-- Type: text/x-patch, Size: 822 bytes --]

diff --git a/lisp/org.el b/lisp/org.el
index 66f9c3e..19e91c0 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -9145,6 +9145,21 @@ a link description or nil."
 	    "[[" (car link) "]]")))
 
 ;;;###autoload
+(defun org-insert-code-block ()
+  "Insert a code block. At the prompt, enter the language which is available.
+
+Completion can be used to insert any language which is loaded in
+org-babel-load-lanuages."
+  (interactive)
+  (setq language (completing-read
+   "Code block : "
+   (mapcar 'symbol-name
+           (mapcar 'car org-babel-load-languages))
+   nil nil))
+  (insert (concat "#+BEGIN_SRC " language "\n\n"))
+  (insert "#+END_SRC")
+  (previous-line))
+
 (defun org-insert-link-global ()
   "Insert a link like Org-mode does.
 This command can be called in any mode to insert a link in Org-mode syntax."

Re: [PATCH] org.el: Added a new interactive function which inserts a code block

[Eric Schulte]

Hi Florian,

You function looks good (although two lines in the middle are not
indented correctly).

Have you tried typing "<s" and then pressing TAB.  This is how I insert
code blocks, as well as <q for quote blocks, etc...

That said your function does more than the <s approach because it also
limits the languages to those which are supported.  If others think this
is generally useful I'd be happy to add it to ob.el.

Thanks for sharing,

Florian Adamsky <fa-orgmode@haktar.org> writes:

> Hello,
>
> I do not always use code blocks in org-mode, but when I do, I have
> forgotten the syntax :-). In order to prevent that situation I wrote a
> little function which is similar to org-insert-link. I called that
> function org-insert-code-block. This function reads the language per
> minibuffer in and supports completion. It only allows languages which
> are loaded via org-babel-load-languages.
>
> Is this function also useful to others? I'm not a long-time Emacs lisp
> hacker, so any comment is welcome. Has anyone an idea for a reasonable
> keybinding for org-insert-code-block which is not already taken by
> org-mode?
>
> Thanks in advance.
>
> Best regards,
> Florian 
>

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

Re: [PATCH] org.el: Added a new interactive function which inserts a code block

[Bastien]

Hi Florian and Eric,

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

> Have you tried typing "<s" and then pressing TAB.  This is how I insert
> code blocks, as well as <q for quote blocks, etc...
>
> That said your function does more than the <s approach because it also
> limits the languages to those which are supported.  If others think this
> is generally useful I'd be happy to add it to ob.el.

Don't we have this already?

<s TAB M-TAB

inserts

#+begin_src 

and offers completion over ̀org-babel-load-languages' (see
`pcomplete/org-mode/block-option/src' in org-pcomplete.el)

This spares us new keybindings :)  

-- 
 Bastien

Re: [PATCH] org.el: Added a new interactive function which inserts a code block

[Michael Hannon]

 Bastien <bzg@gnu.org> wrote:


> Eric Schulte <eric.schulte@gmx.com> writes:
> 
>>  Have you tried typing "<s" and then pressing TAB.  This is how 
> I insert
>>  code blocks, as well as <q for quote blocks, etc...
>> 
>>  That said your function does more than the <s approach because it also
>>  limits the languages to those which are supported.  If others think this
>>  is generally useful I'd be happy to add it to ob.el.
> 
> Don't we have this already?
> 
> <s TAB M-TAB
> 
> inserts
> 
> #+begin_src 
> 
> and offers completion over ̀org-babel-load-languages' (see
> `pcomplete/org-mode/block-option/src' in org-pcomplete.el)
> 
> This spares us new keybindings :)  

That's very cool.  I wasn't aware of that.  I notice that on my system the completion list does not include "cpp", which is indeed accepted and processed correctly.

-- Mike

Re: [PATCH] org.el: Added a new interactive function which inserts a code block

[Eric S Fraga]

Bastien <bzg@gnu.org> writes:

> Hi Florian and Eric,
>
> Eric Schulte <eric.schulte@gmx.com> writes:
>
>> Have you tried typing "<s" and then pressing TAB.  This is how I insert
>> code blocks, as well as <q for quote blocks, etc...
>>
>> That said your function does more than the <s approach because it also
>> limits the languages to those which are supported.  If others think this
>> is generally useful I'd be happy to add it to ob.el.
>
> Don't we have this already?
>
> <s TAB M-TAB
>
> inserts
>
> #+begin_src 
>
> and offers completion over ̀org-babel-load-languages' (see
> `pcomplete/org-mode/block-option/src' in org-pcomplete.el)
>
> This spares us new keybindings :)  

Thanks for this!  I didn't know that completion was possible at that
point.  Mind you, the list of possible completions seems to be somewhat
limited.  I wonder where the list comes from? (I know: I should look at
the code... ;-)

For the OP, I use yasnippet [1] to introduce src code blocks:

,----[ src ]
| #name : #+begin_src language options ...#+end_src
| # --
| #+name: $1
| #+begin_src $2 $3
| $0
| #+end_src
`----


Footnotes: 
[1]  https://github.com/capitaomorte/yasnippet

-- 
: Eric S Fraga (GnuPG: 0xC89193D8FFFCF67D) in Emacs 24.1.50.1
: using Org release_7.8.09-544-g505cc7