vim/vimtex
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Cf. #566: Add documentation

Browse Source
This commit is contained in:
Karl Yngve Lervåg 2016-10-25 20:31:13 +02:00
parent a3e79bd451
commit 5506728347
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/vimtex.txt
View File

@ -1356,7 +1356,8 @@ dictionary argument: >
\ 'lhs' : lhs, \ 'lhs' : lhs,
\ 'rhs' : rhs, \ 'rhs' : rhs,
\ 'leader' : leader_key, \ 'leader' : leader_key,
\ 'wrapper' : function_name \ 'wrapper' : function_name,
\ 'context' : value,
\ } \ }
Explanation of the keys: Explanation of the keys:
@ -1375,15 +1376,25 @@ Explanation of the keys:
The name of a wrapper function that is used to generate the `rhs`. Two The name of a wrapper function that is used to generate the `rhs`. Two
functions are available from |vimtex|: functions are available from |vimtex|:
`vimtex#imaps#wrap_trivial` Trivial wrapper: Simply returns `rhs`. `vimtex#imaps#wrap_trivial`
`vimtex#imaps#wrap_math` Only define `rhs` if inside a math environment. Trivial wrapper: Simply returns `rhs`.
This is the default wrapper function and will
be used if no other wrapper is supplied. `vimtex#imaps#wrap_math`
Only define `rhs` if inside a math environment. This is the default
wrapper function and will be used if no other wrapper is supplied.
`vimtex#imaps#wrap_environment`
Only define `rhs` if inside one of the environments specified through
a list of environment names. The list must be supplied through the
`context` key.
Of course, one may use custom wrapper functions. To write a custom wrapper Of course, one may use custom wrapper functions. To write a custom wrapper
function, please see the source for examples on how the |vimtex| wrappers function, please see the source for examples on how the |vimtex| wrappers
are written. are written.
context~
A value that can be used by the chosen wrapper function.
*vimtex-neosnippet* *vimtex-neosnippet*
*vimtex-UltiSnips* *vimtex-UltiSnips*
Note: that this feature is not the same as the snippet feature of |UltiSnips| Note: that this feature is not the same as the snippet feature of |UltiSnips|