3,897
edits
Changes
Jump to navigation
Jump to search
m
< [[Text Editors]] | [[Related Programs]] >
You may To enable synctex by setting <tt>g:context_synctex</tt> to disable SyncTeX, use <tt>1\setupsynctex[state=start]</tt> (the default is and <tt>0\setupsynctex[state=stop]</tt>): let g:context_synctex = 1, respectively, in your document.
* 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>):
== Other useful Vim plugins == runtime/autoload/context.vim runtime/autoload/contextcomplete.vim runtime/compiler/context.vim runtime/ftplugin/{context,mf,mp}.vim runtime/indent/{context,mf,mp}.vim runtime/syntax/{context,mf,mp}.vim
=== Autocompletion ===If you get the following error when you open a ConTeXt or MetaPost document:
Vim offers a rich completion mechanism (<tt> E410:help ins-completion</tt>), but there are several pluginsthat improve on it, in particular, to provide automatic completion of keywordsInvalid :syntax subcommand: iskeyword
* µcomplete[https:edit the syntax files and remove the <tt>syn iskeyword</tt> or <tt>syntax iskeyword</githubtt> line.com/lifepillar/vim-mucomplete]* Completor[https:Instead, put a corresponding command in <tt>~//github.com/maralla/completor.vim]* NeoComplete[https:/after/github.comftplugin/Shougo/neocompletecontext.vim]* Deoplete (for NeoVim)[https://github.com</Shougo/deoplete.nvim]* YouCompleteMe[httpstt>://github.com/Valloric/YouCompleteMe]* AutoComplPop[https://github.com/vim-scripts/AutoComplPop]* SuperTab[https://github.com/ervandew/supertab]
The asciicast at the top of this page uses µcomplete. setlocal iskeyword=@,48-57,a-z,A-Z,192-255
=== Snippets ===and in <tt>~/.vim/after/ftplugin/mp.vim</tt> for MetaPost:
Vim allows you to define abbreviations for frequently used pieces of text (see <tt>:help abbreviations</tt>).If you need more sophisticated support for snippets of code setlocal iskeyword=@, UltiSnips[https://github.com/SirVer/ultisnips]is the plugin to use. Here are a few examples of useful UltiSnips snippets for ConTeXt:_
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>Everything should work, at least with Vim 7. Click on the asciicast linked at the top of this document to see UltiSnips snippets in action4.
Tagbar[https://github.com/majutsushi/tagbar] is a useful plugin to display an outline or a table of contents of a document* Extract data from texweb and create syntax highlighting definitions for ConTeXt.It uses Ctags, which you must install, too. Ctags does not * Some essential math support ConTeXt out of the box, but it is easy to extend.Create * Proper URL highlighting ('%' doesn't start a <tt>.ctags</tt> file in your home directorycomment, then copy and paste the following: --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>*(.+)\}/\. \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>*(.+)\}/\.\. \1/s,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>request by VnPenguin]]</nowiki>*(.+)\}/\.\.\. \1/s,subsubsection/ --regex-context=/^<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\\startchapter<nowiki>[[</nowiki>Perhaps borrow something from https:space:<nowiki>]]</nowiki>*\<nowiki>[[</nowiki>^<nowiki>]]<github.com/nowiki>*title<nowiki>[[<lervag/nowiki>:space:<nowiki>]]</nowiki>*=<nowiki>[[</nowiki>:spacevimtex or http:<nowiki>]]</nowiki>*\{<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*(.+)\}/\1/c,chapter/ --regexvim-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>]]</nowiki>*(latex.+)\}/SUBJ \1/c,subject/ --regex-context=/^<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\\startpart<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>*(sourceforge.+)\}/\1/p,partnet/ 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 === [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 ==
{{Installation navbox}}
drop dup title and navbox
http://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 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 (https://github.com/vim/vim) under the <tt>runtime</tt> directory, into correspondingfolders in your <tt>.vim</tt> folder (so, for example <tt>ftplugin/context.vim</tt> must be copied into<tt>~/.vim/ftplugin/context.vim</tt>).Everything should work, at least with Vim 7.4' below.
== Using ConTeXt in Vim ==
An alternative way to typeset a document is to use <tt>:make</tt>. Set the current working
directory to the directory of the current buffer, then execute <tt>:make</tt>:
:lcd /path/to/my/project
:make
If a <tt>Makefile</tt> exists in the working directory, it is used (see below for a sample 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 are
errors, the quickfix list is populated, but you have to open it manually with <tt>:copen</tt>.
It is recommended that you map 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)
let g:context_mtxrun = 'PATH=$HOME/Applications/ConTeXt-Beta/tex/texmf-osx-64/bin:$PATH mtxrun'
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>, and <tt>--nonstopmode</tt> and <tt>--synctex</tt> options are always included in the
command.
Vim searches for files in the locations specified by the <tt>path</tt> option. You may
need to adjust the value of <tt>path</tt> for the above to work (see <tt>:help 'path'</tt>).
=== Integration with MetaPost ===
Besides, when you are inside a MetaPost environment, you may press CTRL-X followed by CTRL-O
to complete a MetaPost/MetaFun keyword (see below for a list of several autocompletion plugins to streamline this).
This works out of the box: no configuration is required. Watch the asciicast above for a demo.
=== Integration with other languages ===
The key is the name of the filetype and the corresponding value is name of the command.
=== TODO Using the scripts with an older Vim ===
=== Outline of a document TODO ===
TeX (Plain TeX), LaTex and ConTeXt all use the <tt>.tex</tt> extension for files, which makes it difficult to detect the filetype based on the extension. From Vim 7 onwards, Vim does some intelligent checking to see it the file is <tt>plaintex</tt> or <tt>latex</tt> or <tt>context</tt>.
Currently no other formats are recognized.
* 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>
let g:tex_flavor = "context"
* If you only use ConTeXt, you can add the following lines to <tt>filetype.vim</tt>:
so the next time you open a <tt>*.tex</tt> file, Vim will always recognize it as a ConTeXt document.
== A note on spell Spell checking ==
Vim 7 or later has a built-in spell checker. To enable it or disable it, use:
Use lowercase letters (<tt>en_us</tt>, not <tt>en_US</tt>). When you set <tt>spelllang</tt>, Vim offers to
download the language data into your <tt>.vim</tt> folder, if such language is not available.
You can put the above settings in your <tt>.vimrc</tt> if you like.
== Powerful key mappings ==
the prefix for user-defined mappings.
By default, the leader is the backslash character, but that may be changed by the user.
For example, to use a comma as a leader, put this in your <tt>.vimrc</tt>:
map <leader> ,
Rather than overriding the default leader, you may define an alternative key. The <tt><space></tt> is a good
choice, because by default it has the same function as the <tt><right></tt> key, and it is comfortable to type:
map <space> <leader> " Use <space> as an alternative leader (backslash can still be used)
=== Clean up auxiliary files ===
The following function can be used to clean up temporary files:
fun! ConTeXtClean()
let l:currdir = expand("%:p:h")
let l:tmpdirs = ['out'] " Temporary directories
let l:suffixes = ['aux', 'bbl', 'blg', 'fls', 'log', 'tuc'] " Suffixes of temporary files
for ff in glob(l:currdir . '/*.{' . join(l:suffixes, ',') . '}', 1, 1)
call delete(ff)
endfor
for dd in l:tmpdirs
let l:subdir = l:currdir . '/' . dd
if isdirectory(l:subdir)
for ff in glob(l:subdir . '/*.{' . join(l:suffixes, ',') . '}', 1, 1)
call delete(ff)
endfor
endif
call delete(l:subdir) " Delete directory (only if empty)
endfor
echomsg "Aux files removed"
endf
Customize <tt>l:tmpdirs</tt> and <tt>l:suffixes</tt> to suit your needs.
In Windows systems, you may have to replace each slash with a backslash, too.
The following mapping allows you to remove auxiliary files by pressing <tt>\tc</tt>:
nnoremap <silent><buffer> <leader>tc :<c-u>call ConTeXtClean()<cr>
=== Snippets ===
Vim allows you to define abbreviations for frequently used pieces of text (see <tt>:help abbreviations</tt>).
Here are a few examples:
<pre>
fun! Eatchar(pat) " See :help abbreviations
let c = nr2char(getchar(0))
return (c =~ a:pat) ? '' : c
endfun
iab <buffer> ch- \startchapter[title={<c-o>ma}]<cr><c-o>mb<cr>\stopchapter<esc>`a`b<c-o>a<c-r>=Eatchar('\s')<cr>
iab <buffer> s- \startsection[title={<c-o>ma}]<cr><c-o>mb<cr>\stopsection<esc>`a`b<c-o>a<c-r>=Eatchar('\s')<cr>
iab <buffer> ss- \startsubsection[title={<c-o>ma}]<cr><c-o>mb<cr>\stopsubsection<esc>`a`b<c-o>a<c-r>=Eatchar('\s')<cr>
iab <buffer> sss- \startsubsubsection[title={<c-o>ma}]<cr><c-o>mb<cr>\stopsubsubsection<esc>`a`b<c-o>a<c-r>=Eatchar('\s')<cr>
iab <buffer> slide- \startslide[title={<c-o>ma}]<cr><c-o>mb<cr>\stopslide<esc>`a`b<c-o>a<c-r>=Eatchar('\s')<cr>
iab <buffer> fig- \startplacefigure<cr><tab>\externalfigure[<c-o>ma]%<cr>[]<c-o>mb<cr><c-d>\stopplacefigure<esc>`a`b<c-o>a<c-r>=Eatchar('\s')<cr>
iab <buffer> item- \startitemize<cr><cr>\stopitemize<up><tab>\item
iab <buffer> enum- \startitemize[n]<cr><cr>\stopitemize<up><tab>\item
iab <buffer> i- \item
</pre>
Type the abbreviation followed by Space to expand the snippet, then continue typing normally.
Inside the definition of an abbreviation, marks may be set (see <tt>:h m</tt>), which allow you to jump between the different
parts of a snippet with TAB (CTRL-i) and CTRL-O (in Normal mode) after the abbreviation is expanded (see <tt>:h jump-motions</tt>).
For example, after typing <tt>ch- </tt>, the cursor will be at the title's position. If you press <tt><esc><tab></tt> (or
<tt><c-o><tab></tt> if you want to stay in Insert mode after the jump), you will jump between <tt>\startchapter</tt>
and <tt>\stopchapter</tt>.
=== Buffer-local Insert-mode macros to speed up editing ===
You can reset the key mapping to speed ConTeXt compiling.
Just add the following code to your <tt>_vimrc</t>tt> (or <tt>.vimrc</tt> file under Linux) file:
<pre>
"run setup and complie, then open the result pdf file
"run setup and make list of the current file
map <F8> <Esc><Esc>:sil ! "D:\context\tex\setuptex.bat && texmfstart texexec.pl --autopdf --pdf --list --result=%:p:r_list %"<CR><CR>
</pre>
nnoremap <silent> ]q :<c-u><c-r>=v:count1<cr>cnext<cr>zz
nnoremap <silent> [q :<c-u><c-r>=v:count1<cr>cprevious<cr>zz
nnoremap <silent> ]Q :<c-u>clast<cr>zz
nnoremap <silent> [Q :<c-u>cfirst<cr>zz
Or install Tim Pope's <i>unimpaired</i> plugin.
rm *.aux *.bbl *.blg *.log *.tuc
If you put these mappings to your <code>.vimrc</code> file, you can then compile the document with F9 and preview it with F8:
" map ":make" to the F9 key
nmap <F8> :exe "lcd" fnameescape(expand("%:p:h"))<CR>:make test<CR>
== Other useful Vim plugins ==
=== Autocompletion ===
Vim offers a rich completion mechanism (<tt>:help ins-completion</tt>), but there are several plugins
that improve on it, in particular, to provide automatic completion of keywords:
* MUcomplete[https://github.com/lifepillar/vim-mucomplete]
* Coc [https://github.com/neoclide/coc.nvim].
* Completor[https://github.com/maralla/completor.vim]
* NeoComplete[https://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]
In the asciicast at the top of this page MUcomplete was used.
=== UltiSnips ===
UltiSnips[https://github.com/SirVer/ultisnips] is a sophisticated snippets manager.
Here are a few examples of useful UltiSnips snippets for ConTeXt:
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.
=== Outline of a document ===
Tagbar[https://github.com/majutsushi/tagbar] is a useful plugin to display an outline or a table of contents of a document.
It uses Ctags, which you must install, too. Ctags does not support ConTeXt out of the box, but it is easy to extend.
Create a <tt>.ctags</tt> file in your home directory, then copy and paste the following:
--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>*(.+)\}/\. \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>*(.+)\}/\.\. \1/s,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>]]</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>:space:<nowiki>]]</nowiki>*=<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*\{<nowiki>[[</nowiki>:space:<nowiki>]]</nowiki>*(.+)\}/\1/p,part/
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 ===
[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'
[[Category:Text Editors]]
