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.0055 or later. If you are using Vim 7, see

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> (these commands are available only . === Setting a custom typesetting engine === The <tt>:ConTeXt</tt> command invokes the <tt>mtxrun</tt> script that is found in Vim 8<tt>$PATH</tt>.0For more fine grained control over the command and its environment, you may invoke `context.0047 Typeset()` directly (or later`context#Typeset()` 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 <tt>~/.vim/after/ftplugin/context.vim</tt>, creating the file and the directories if they do not exist):

An alternative way to typeset a document is to use <tt>:make</tt>. Set the current workingdirectory to the directory of the current buffer, then execute <tt>:make</tt>: :lcd /path/to/my/project :makeIf a <tt>Makefile</tt> exists in 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 is found, <tt>mtxrun</tt> will be invoked directly.Note that <tt>:make</tt> always performs synchronous typesetting. Also, if there areerrors, the quickfix list is populated, but you have to open it manually with <tt>:copen</tt>import autoload 'context.vim'

It is recommended that you map the above commands. For example, you may add def MyConTeXt() nnoremap <silent> <leader>tt const env = {'PATH':<cprintf("%s/context/tex/texmf-u>update<cros>:ConTeXt<cr>to your -<ttarch>vimrc</tt>bin:%s", $HOME, or (better$PATH)} nnoremap <buffer> <silent> <leader>tt :<c-u>update<cr>:ConTeXt<cr>to <tt>~/.vim/after/ftplugin/ context.vim</tt>Typeset("%", after which pressing <tt>\tt</tt> (where <tt>\</tt> is your leader keyenv)will save and compile the file. enddef

You may customize the path to the <tt>mtxrun</tt> executable by setting <tt>g:context_mtxrun</tt>.For example, if you want to and perhaps use your ConTeXt Beta installation at <tt>~/Applications/ConTeXt-Beta</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/binit with a mapping:$PATH mtxrun'

To enable/disable SyncTeX, use nnoremap <ttsilent>\setupsynctex[state=start]</ttbuffer> and <ttleader>\setupsynctex[state=stop]t </ttscriptcmd>MyConTeXt()<cr>, respectively, in your document.

You may pass <tt>mtxruncontext.Typeset()</tt> additional options by putting them in 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. For example:  def ConTeXtCustomCommand(path: string): list<string> return ['mtxrun', '--script', 'context', '--nonstopmode', path] enddef  context.ConTeXtTypeset("%", 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>g:context_extra_optionsConTeXt</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 exampleinstance:  let g% !TEX root = ../MyRoot.tex Vim searches for the magic line in the first ten lines of the current buffer:context_extra_options if the magic line is found, the document specified by that line is typeset rather than theone in the current buffer. The root document does not have to be opened inVim. = '--arrange --autopdf'== Updating the syntax files === The Vim includes syntax files generated by <tt>--autogeneratemtxrun</tt> and . If you want to use more up-to-date files, overriding those distributed with Vim, you may proceed as follows. Assuming your Vim configuration lives in <tt>--nonstopmode~/.vim</tt> options are always included in the, you may type:  mkdir -p ~/.vim/syntax/shared cd ~/.vim/syntax/shared mtxrun --script interface --vim The last command.will create the 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>.

In the asciicast at the top of this page µcomplete MUcomplete was used.