Changes

httphttps://www.vim.org/

This page is about editing ConTeXt source in Vim, gVim, MacVim, NeoVim, and other Vim clones.The page describes the scripts available with in Vim v8.0.0047 0055 or later.If you are using an older Vim7, you may copy see''Using the <tt>context.vim</tt> scripts from with an older Vim's distribution ' below.(https://github.com/vim/vim) under the <tt>runtime</tt> directory, into correspondingfolders in your <ttb>.vim</tt> folder (soIf you feel that something is missing, for example <tt>ftplugin/context.vimplease contribute!</ttb> must be copied into<tt>~/.vim/ftplugin/context.vim</tt>).Everything should work, at least with Vim 7.4Information about providing feedback is in the header of the scripts.

They are part of the official Vim 7, and were expanded and improved in Vim 8. Starting with Vim 9.0.0218, the scripts supporting ConTeXt in Vim have been rewritten in Vim 9 script (the new Vim's scripting language). For the complete documentation, see <btt>If you feel that something is missing, please contribute!:help ft-context</btt> Information about providing feedback is in the header of the scripts.

:ConTeXt%

Typesetting happens in the background if you are using Vim 8.0.0047 or later,so you may continue working on your document. If there are errors, the quickfix window opens will open automaticallyto show the errors (one per line). The cursor stays will stay in the main document, so your typing workflow is will notbe disrupted. You may use standard quickfix commands to jump between errors: <tt>:cfirst</tt>, <tt>:cprev</tt>,

running jobs with <tt>:ConTeXtStopJobs</tt> . === Setting a custom typesetting engine === The <tt>:ConTeXt</tt> command invokes the <tt>mtxrun</tt> script that is found in <tt>$PATH</tt>. For more fine grained control over the command and its environment, you may invoke `context.Typeset()` directly (or `context#Typeset(these commands are available only )` from legacy Vim script). For instance, if you have installed a version of ConTeXt in <tt>$HOME/context</tt> (where <tt>$HOME</tt> is the path to your home directory), you may define a function to use it similar to the following (you may put the following code in Vim 8<tt>~/.vim/after/ftplugin/context.vim</tt>, creating the file and the directories if they do not exist):  import autoload 'context.vim'  def MyConTeXt() const env = {'PATH': printf("%s/context/tex/texmf-<os>-<arch>/bin:%s", $HOME, $PATH)} context.Typeset("%", env) enddef and perhaps use it with a mapping:  nnoremap <silent><buffer><leader>t <scriptcmd>MyConTeXt()<cr> <tt>context.Typeset()</tt> accepts a third optional argument to specify a customtypesetting command. That must be a function that takes a path and returns thecommand as a List.0For example:  def ConTeXtCustomCommand(path: string): list<string> return ['mtxrun', '--script', 'context', '--nonstopmode', path] enddef  context.0047 or laterConTeXtTypeset("%", v:none, ConTeXtCustomCommand) === Working with large projects === Large projects are often organized as a root document and various chapterfiles. When editing a chapter file, it is convenient to invoke <tt>:ConTeXt</tt>directly on it, rather than having to switch to the root file. A “magic line”can be added at the beginning of each chapter file, which specifies therelative path to the root file. For instance:  % !TEX root = ../MyRoot.tex

An alternative way to typeset a document is to use <tt>:make</tt>. Set Vim searches for the current workingdirectory to magic line in the directory first ten lines of the current buffer, then execute <tt>:make</tt>: lcd /path/to/my/project :makeIf a <tt>Makefile</tt> exists in if the working directory, it is used (see below for a sample Makefile).You may <tt>let g:context_ignore_makefile=1</tt> to ignore an existing Makefile.If no Makefile magic line is found, <tt>mtxrun</tt> will be invoked directly.Note the document specified by that <tt>:make</tt> always performs synchronous typesetting. Also, if there areline is typeset rather than theerrors, one in the quickfix list is populated, but you current buffer. The root document does not have open it manually with <tt>:copen</tt>to be opened inVim.

It is recommended that you map === Updating the above commands. For example, you may add nnoremap <silent> <leader>tt :<c-u>update<cr>:ConTeXt<cr>to your <tt>.vimrc</tt>, or (better) nnoremap <buffer> <silent> <leader>tt :<c-u>update<cr>:ConTeXt<cr>to <tt>~/.vim/after/ftplugin/context.vim</tt>, after which pressing <tt>\tt</tt> (where <tt>\</tt> is your leader key)will save and compile the file.syntax files ===

You may customize the path to the Vim includes syntax files generated by <tt>mtxrun</tt> executable by setting <tt>g:context_mtxrun</tt>.For example, if If you want to use more up-to-date files, overriding those distributed with Vim, you may proceed as follows. Assuming your ConTeXt Beta installation at Vim configuration lives in <tt>~/Applications/ConTeXt-Beta.vim</tt>,and you are using macOS, you may set the variable as follows: let g:context_mtxrun = 'PATH=$HOME/Applications/ConTeXt-Beta/tex/texmf-osx-64/bintype:$PATH mtxrun'

You may enable synctex by setting <tt>g:context_synctex< mkdir -p ~/.vim/syntax/shared cd ~/tt> to <tt>1<.vim/tt> (the default is <tt>0<syntax/tt>):shared let g:context_synctex = 1mtxrun --script interface --vim

You may pass <tt>mtxrun</tt> additional options by putting them in <tt>g:context_extra_options</tt>.For example: let g:context_extra_options = '--arrange --autopdf'The <tt>--autogenerate</tt>, <tt>--nonstopmode</tt> and <tt>--synctex</tt> options are always included in last command will create thecommand.following syntax files:

Finally, for each of the above variables, a corresponding buffer* <tt>context-local variable with the same namedata-context.vim</tt>;may be defined, whose value takes precedence over the global value* <tt>context-data-interfaces.vim</tt>;* <tt>context-data-metafun.vim</tt>;* <tt>context-data-tex.vim</tt>.

This works out of the box: no configuration is required. Watch the asciicast above for a demo.

=== TODO Using the scripts with an older Vim ===

* Extract data If you are using an older Vim, you may copy the following scripts from texweb and create syntax highlighting definitions for ConTeXt.* Some essential math support.Vim's distribution * Proper URL highlighting ('%' doesn't start a comment, ...) [request by VnPenguin].* Perhaps borrow something from https://github.com/lervagvim/vim) into correspondingfolders in your <tt>.vim</vimtex or http:tt> folder (so, for example <tt>runtime/ftplugin/context.vim-latex</tt> must be copied into<tt>~/.sourceforgevim/ftplugin/context.netvim</?tt>):

Vim offers If you get the following error when you open a rich completion mechanism (<tt>:help ins-completion</tt>), but there are several pluginsthat improve on it, in particular, to provide automatic completion of keywordsConTeXt or MetaPost document:

* µcomplete[https E410://github.com/lifepillar/vim-mucomplete]* Completor[httpsInvalid ://github.com/maralla/completor.vim]* NeoComplete[httpssyntax subcommand://github.com/Shougo/neocomplete.vim]* Deoplete (for NeoVim)[https://github.com/Shougo/deoplete.nvim]* YouCompleteMe[https://github.com/Valloric/YouCompleteMe]* AutoComplPop[https://github.com/vim-scripts/AutoComplPop]* SuperTab[https://github.com/ervandew/supertab]iskeyword

The asciicast at edit the top of this page uses µcompletesyntax files and remove the <tt>syn iskeyword</tt> or <tt>syntax iskeyword</tt> line.Instead, put a corresponding command in <tt>~/.vim/after/ftplugin/context.vim</tt>:

setlocal iskeyword=== Snippets ===@,48-57,a-z,A-Z,192-255

Vim allows you to define abbreviations for frequently used pieces of text (see and in <tt>:help abbreviations<~/tt>).If you need more sophisticated support for snippets of code, UltiSnips[https:vim/after/ftplugin/githubmp.comvim</SirVer/ultisnips]is the plugin to use. Here are a few examples of useful UltiSnips snippets tt> for ConTeXtMetaPost:

snippet "s(tart)?" "start / stop" br \start${1:something}$2 ${3:${VISUAL}} \stop$1 endsnippet snippet enum "Enumerate" b \startitemize[n] \item ${0:${VISUAL}} \stopitemize endsnippet snippet item "Itemize" b \startitemize \item ${0:${VISUAL}} \stopitemize endsnippet snippet it "Individual item" b \item ${0:${VISUAL}} endsnippet snippet fig "External figure" b \startplacefigure \externalfigure[${1:${VISUAL}}][$2] \stopplacefigure endsnippet Save the above text into <tt>~/.vim/UltiSnips/context.snippets</tt>. Click on the asciicast linked at the top of this document to see UltiSnips snippets in action.setlocal iskeyword=@,_

--langdef=context --regex-context=/^<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\\startsection<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\<nowiki>[[</nowiki>^<nowiki>]]</nowiki>*title<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*=<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\{<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*(Some essential math support.+)\}/\. \1/s,section/ --regex-context=/^<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\\startsubsection<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\<nowiki>[[</nowiki>^<nowiki>]]</nowiki>*title<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*=<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\{<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*Proper URL highlighting (.+)\}/\.\. \1/s'%' doesn't start a comment,subsection/ --regex-context=/^<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\\startsubsubsection<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\<nowiki>[[</nowiki>^<nowiki>]]</nowiki>*title<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*=<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\{<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*(.+)\}/\.\.\. \1/s,subsubsection/ --regex-context=/^<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\\startchapter<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\<nowiki>[[</nowiki>^<nowiki>]]</nowiki>*title<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*=<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\{<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*(.+)\}/\1/c,chapter/ --regex-context=/^<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\\startsubject<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\<nowiki>[[</nowiki>^<nowiki>]]</nowiki>*title<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*=<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\{<nowiki>[[</nowiki>:space:<nowiki>]request by VnPenguin]</nowiki>*(.+)\}/SUBJ \1/c,subject/ --regex-context=/^<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\\startpart<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\<nowiki>[[</nowiki>^<nowiki>]]</nowiki>*title<nowiki>[[</nowiki>:spacePerhaps borrow something from https:<nowiki>]]</nowiki>*=<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\{<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*(github.+)\}/\1com/p,partlervag/ Put this in your <tt>vimrc</tt>: let g:tagbar_type_context = { \ 'ctagstype': 'context', \ 'kinds': [ \ 'p:parts', \ 'c:chapters', \ 's:sections' \ ], \ 'sort': 0 \ } That's it! See the image at the top of this document for an example. === Using LaTeX-Suite === [vimtex or http://vim-latex.sourceforge.net/ latex-suite] currently doesn't support ConTeXt, but if you use it, here's what you have to do to compile ConTeXt documents: 1. After downloading and installing latex-suite, locate the file "texrc" (usually located in <code>~/.vim/ftplugin/latex-suite</code>). Copy this file to <code>~/.vim/ftplugin/tex/texrc</code> 2. Open this copy in your favorite editor (vim comes to mind...) 3. After line 80 in this file, there is a series of "Compiler rules." Just add this line to the section:  TexLet g:Tex_CompileRule_cont = 'texexec --pdf --nonstopmode $*' This will add compilation for ConTeXT. In order to use it: 4. When you're in vim normal mode, run this command:  TGTarget cont [that's "colon TGTarger cont"]  5. Edit your TeX-files, save the changes; when you want to compile, switch to normal mode and just type <code>\ll</code> (that's '' 'backslash el el' '') Voila, compilation should start. You'll have to specify this compiler target every timeI you open a TeX-file in Vim. If you want to make this the default compiler, you should have this line in your texrc:  TexLet g:Tex_DefaultTargetFormat = 'cont' ?

== A note on filetype Filetype detection ==

* If you use ConTeXt most of the time, but occasionally use LaTeX or Plain TeX, you can add the following to your <tt>.vimrc</tt>

== A note on spell Spell checking ==

You can put the above settings in your <tt>.vimrc</tt> if you like.

For example, to use a comma as a leader, put this in your <tt>.vimrc</tt>:

Just add the following code to your <tt>_vimrc</t>tt> (or <tt>.vimrc</tt> file under Linux) file:

If you put these mappings to your <code>.vimrc</code> file, you can then compile the document with F9 and preview it with F8: