summaryrefslogtreecommitdiff
path: root/macros/context/contrib/context-vim/doc/context/third/vim/vim.txt
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-04-30 03:01:50 +0000
committerNorbert Preining <norbert@preining.info>2020-04-30 03:01:50 +0000
commitb273a879fbed76480fb7368ad555010024f3e411 (patch)
tree8c29aac231a89dfd7f5de12355da70f573b70d6d /macros/context/contrib/context-vim/doc/context/third/vim/vim.txt
parent817ecb96eab4ed6494ddb6b8d0f17c2947a91196 (diff)
CTAN sync 202004300301
Diffstat (limited to 'macros/context/contrib/context-vim/doc/context/third/vim/vim.txt')
-rw-r--r--macros/context/contrib/context-vim/doc/context/third/vim/vim.txt26
1 files changed, 25 insertions, 1 deletions
diff --git a/macros/context/contrib/context-vim/doc/context/third/vim/vim.txt b/macros/context/contrib/context-vim/doc/context/third/vim/vim.txt
index 11c17cf59e..43d55333c4 100644
--- a/macros/context/contrib/context-vim/doc/context/third/vim/vim.txt
+++ b/macros/context/contrib/context-vim/doc/context/third/vim/vim.txt
@@ -543,7 +543,9 @@ after the comma in the options to `\startframedtext` will result in an error.
Clearly, `/BTEX ... /ETEX` is not a valid syntax in any language, so if these
tags are used outside of a comment region (as is the case in the above
example), the code will not compile. So, if the code also needs to run, then
-these annotations have to be restricted to the comment region of the code.
+these annotations have to be restricted to the comment region of the code or
+the output typeset by ConTeXt has to be manually tested for correctness prior
+to the release of your document.
Although, in practice, the use of both escape mechanisms is restricted to
comments, the two mechanism have subtle differences. When using
@@ -677,6 +679,28 @@ a different meaning than `option=on`. To avoid confusion, I have made these
synonyms. Thus, whenever the documentation says `option=yes`, you may use
`option=on`. And vice-versa. One less thing to worry about!
+Name (and location) of the VIM executable
+-----------------------------------------
+
+By default, the `t-vim` module calls the program `vim` to do syntax
+highlighting. If the `vim` program is not in the `$PATH`, the `vimcommand`
+option may be used to specify the compete path of `vim`:
+
+ \setupvimtyping[vimcommand=/path/to/vim]
+
+This option may also be used to call [Neovim] instead of `vim` to do syntax
+highlighting, by either using
+
+ \setupvimtyping[vimcommand=nvim]
+
+or, if `nvim` is not in the `$PATH`, using
+
+ \setupvimtyping[vimcommand=/path/to/nvim]
+
+[Neovim]: https://neovim.io/
+
+As of 2020.04.29, `nvim` is about 10% faster than `vim`.
+
A bit of a history
------------------