/ 
Vim-Snippet-Converter-0.082
River stage zero No dependents
/ Vim::Snippet::Converter

NAME

Vim::Snippet::Converter - A Template Converter for Slippery Snippet Vim Plugin

VERSION

Version 0.082

SYNOPSIS

#!perl
use Vim::Snippet::Converter;

my $vsc = Vim::Snippet::Converter->new();
open my $in , "<" , "perl.snt";
open my $out , ">" , "perl_snippets.vim";
$vsc->convert( $in , $out );
close ($in , $out);

DESCRIPTION

This module provides template conversion for Vim SnippetEmu Plugin ( http://www.vim.org/scripts/script.php?script_id=1318 )

You can write your template simply. see "TEMPLATE FORMAT"

SCRIPT

convert template file (*.snt)

$ scc -s [filename]  [-i {path}] [-c {path}]

for example:

# generate snippet vim script to stdout
$ scc -s perl.snt

$ scc -s filename.snt > perl_snippets.vim


# to replace the previous install automatically.
$ scc -s filename.snt -i ~/.vim/syntax/perl.vim

-s, --src  [filename]
    specify source file path

-i, --install-to [filename]
    specify vim script path, e.g.  ~/.vim/syntax/perl.vim

-c, --create-completion [filepath]
    create snippet keyword completion file for vim

to save triggers into vim completion file:

$ scc -s perl.snt -c vim_completion

VIM COMPLETION DICTIONARY

save triggers into vim completion file:

$ scc -s perl.snt -c vim_completion

append the below setting to your .vimrc , it is located in your home directory.

set dictionary+=/path/to/vim_completion

when you want to call the keyword completion , just press Ctrl-X Ctrl-K in Insert-Mode.

TEMPLATE FORMAT

# comments
;sub
sub <<function>> ( <<prototype>> ) {
    my <<>> = <<>>;
    return <<returnValue>>;
}
;end

sub is a trigger name , when you press <Tab> , the trigger will be replaced with the template.

<<function>> is called Place Holder , when you press <Tab> again , curosr will jump to the next position to let you enter some text.

FUNCTIONS

new

convert

_gen_trigger

_gen_snippet

parse

gen_header

AUTHOR

Cornelius, <cornelius.howl+cpan at gmail.com>

BUGS

Please report any bugs or feature requests to bug-vim-snippet-compiler at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Vim-Snippet-Converter. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Vim::Snippet::Converter

You can also look for information at:

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2007 Cornelius, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.