How to use a template in vim

Question

Hi Vim'ers

This i really a newbie question - but basically how do I enable a template for certain filetypes.

Basically I just want the template to insert a header of sorts, that is with some functions that I find usefull, and libraries loaded etc.

I intepret

:help templates

the way that I should place this in my vimrc

au BufNewFile,BufRead ~/.vim/skeleton.R

Running a R script then shows that something could happen, but apparently does not:

--- Auto-Commands ---

maybe because a template consist of commands (and there are no such in skeleton.R) - and in this case I just want it to insert a text header (which skelton.R consist of).

Sorry if this question is mind boggeling stupid ;-/

Answer 1

The command that you've suggested is not going to work: what this will do is run no Vim command whenever you open ~/.vim/skeleton.R

A crude way of achieving what you want would be to use:

:au BufNewFile *.R r ~/.vim/skeleton.R

This will read (:r) your file whenever a new *.R file is created. You want to avoid having BufRead in the autocmd, or it will read the skeleton file into your working file every time you open the file!

There are many plugins that add a lot more control to this process. Being the author and therefore completely biased, I'd recommend this one, but there are plenty of others listed here.

---

Shameless plug:

They all work in a relatively similar way, but to explain my script:

You install the plugin as described on the linked page and then create some templates in ~/.vim/templates. These templates should have the same extension as the 'target' file, so if it's a template for .R files, call it something like skeleton.R. In your .vimrc, add something like this:

let g:file_template_default = {}
let g:file_template_default['R'] = 'skeleton'

Then create your new .R file (with a filename, so save it if it's new) and enter:

:LoadFileTemplate

You can also skip the .vimrc editing and just do:

:LoadFileTemplate skeleton

See the website for more details.

Answer 2

There exist many template-file expanders -- you'll also find there explanations on how to implement a rudimentary template-file expander.

For my part, I'm maintaining the fork of muTemplate. For a simple start, just drop a {ft}.template file into {rtp}/template/. If you want to use any (viml) variable or expression, just do. You can even put vim code (and now even functions) into the template-file if you wish. Several smart decisions are already implemented for C++ and vim files.

Answer 3

What about using the snipmate plugin? See here