1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
*sonictemplate-vim.txt* SonicTemplate for Vim
-------------------------------------------------------
SonicTemplate: hi speed coding method
-------------------------------------------------------
Author: Yasuhiro Matsumoto <mattn.jp@gmail.com>
WebSite: http://mattn.kaoriya.net/
Repository: http://github.com/mattn/sonictemplate-vim
Site: http://mattn.github.com/sonictemplate-vim
License: BSD style license
==============================================================================
CONTENTS *sonictemplate-vim-contents*
Introduction |sonictemplate-vim-introduction|
Install |sonictemplate-vim-install|
Tutorial |sonictemplate-vim-tutorial|
Customize |sonictemplate-vim-customize|
Unite Source |sonictemplate-vim-unitesource|
Write Your Template |sonictemplate-vim-writetemplate|
==============================================================================
INTRODUCTION *sonictemplate-vim-introduction*
|SonicTemplate| is easy and high speed coding method.
* Choose template for the filetype
* Few typings.
* Flexible customization.
==============================================================================
INSTALL *sonictemplate-vim-install*
Install the distributed files into Vim runtime directory which is usually
~/.vim/, or $HOME/vimfiles on Windows.
If you install pathogen that provided from Tim Pope, you should extract the
file into 'bundle' directory.
==============================================================================
TUTORIAL *sonictemplate-vim-tutorial*
For example, you are writing C++ file.
1. Create main function
Open new C++ file, and type following.
>
:Template boost-main
<
Then you can see following.
>
#include <iostream>
#include <string>
#include <boost/foreach.hpp>
int
main(int argc, char* argv[]) {
_
return 0;
}
<
The cursor is in the position of |_|.
2. Add foreach loop
Type following.
>
:Template boost-for
<
Then you will be asked like following.
>
variable:
<
Then type "foo".
>
#include <iostream>
#include <string>
#include <boost/foreach.hpp>
int
main(int argc, char* argv[]) {
BOOST_FOREACH(auto x, foo) {
_
}
return 0;
}
<
3. Add std::cout << xxx << std::endl;
>
:Template cout
<
Answer "x" for the question "string:".
>
#include <iostream>
#include <string>
#include <boost/foreach.hpp>
int
main(int argc, char* argv[]) {
BOOST_FOREACH(auto x, foo) {
std::cout << x << std::endl;
}
return 0;
}
<
==============================================================================
CUSTOMIZE *sonictemplate-vim-customize*
You can modify template directory for your-self templates: >
let g:sonictemplate_vim_template_dir = '/path/to/your/template/directory'
<
or >
let g:sonictemplate_vim_template_dir = [
\ '$HOME/.vim/template',
\ '/path/to/another/template/directory'
\]
<
You can override default template to make same structures. For example, a
default C language template 'main' is like following.
>
#include <stdio.h>
int
main(int argc, char* argv[]) {
{{_cursor_}}
return 0;
}
This template is stored in 'sonictemplate-vim/template/c/base-main.c'.
If you store base-main.c in another template directory that is specified
|g:sonictemplate_vim_template_dir|, it will be overrided with your's one.
==============================================================================
UNITE SOURCE *sonictemplate-vim-unitesource*
You can use unite source for sonictemplate. For example,
>
:Unite sonictemplate
<
==============================================================================
WRITE YOUR TEMPLATE *sonictemplate-vim-writetemplate*
Templates are stored in the directory that "g:sonictemplate_vim_template_dir"
variable specified. On unix, directory structure is following.
Note that I'm using pathogen-vim.
>
~/.vim/bundle/sonictemplate-vim
plugin
sonictemplate.vim
doc
sonictemplate.txt
template
go ... filetype go
base-main.go ... base main
base-package.go ... base package
snip-goroutine.go ... snippet for goroutine
...
perl ... filetype perl
base-package.pl ... base package
base-script.pl ... base script
snip-dbi-connect-sqlite.pl ... snippet for DBI/SQLite
...
clojure ... filetype clojure
file-project-base.clj ... file project base
_ ... global template
base-foo.go ... base foo
snip-foo.go ... snip foo
<
Global template '_' can be applied to any filetypes.
1. The filename have following rule.
|[kind]|-|[name]|.|[extension]|
|[kind]| 'base' or 'snip' or 'file' should be used.
'base' is used when buffer is empty.
'file' should be matched if buffer name is leading as template name.
For example, "initialize.c" should be expanded template files like
"file-initialize-qt.c" or "file-initialize-gtk.c".
|[name]| template name
Words in the name must join with '-'.
|[extension]| file name extension like ".c".
If several extensions are exists in same directory, the first found is used.
2. Template can have some keywords.
|{{_name_}}| the filename without extension.
If you are opening "foo.pl" for perl, {{_name_}} become "foo".
|{{_cursor_}}| : cursor position.
When expanded template, cursor will be moved to there.
|{{_input_:var}}| : ask the value of "var".
You'll be asked "var: " in prompt.
|{{_expr_:xxx}}| : expression in vimscript.
For example: "Current Time:|{{_expr_:strftime('%c')}}|" will be
>
Current Time: 2011/10/27 20:19:00
<
|{{_if_:expr;foo;bar}}| : ternary operator
For example: When today is saturday,
"Today is |{{_if_:strftime('%w')%6;OrdinaryDay;Holiday}}|" will be
>
Today is Holiday
<
|{{_inline_}}| : inline expand.
If it's contained, template will be expanded as one line.
This operator affect to snip templates.
For example: When type "<c-y>t" on "left _ right" (_ is cursor),
>
foo
bar
<
Above template will be expanded as oneline
>
left foobar right
<
|{{_filter_:xxx}}| : template filter
If it's contained, some templates are listed prior.
For example: When `base-helloworld.go` define filter as 'foo',
`snip-foo.go` is located first than `snip-bar.go` in the template list
>
base-helloworld.go
snip-foo.go
snip-bar.go
<
==============================================================================
vim:tw=78:ts=8:ft=help:norl:noet:fen:fdl=0:
|
