VimTeX 2.6

It is again time for a release. There's been plenty of updates!

Note: After updating, please open some .tex file and run :VimtexClearCache ALL (see #2095 for more details on why).

Features

• Separate cite completion menu from completion match string for "smart" mode (#2095) -- this change requires users to clear the cache
• Add :VimtexClearCache command (#2095)
• Ignore *Notes.bib files from revtex* class (#2090)
• Allow to specify length of author field in menu_fmt, see :help g:vimtex_complete_bib (#2091)
• Add folding and foldtext for .bib files (#2089, #2066)
• Append to instead of overwrite latexmk's success_cmd and failure_cmd (#2088, #2085, #2079, #2076, #1237)
  • This was tricky, as it required some OS specific alternative forms. There were several PRs by @Nicholas42. Credits should also be given to @yongrenjie who helped test and find a solution that works on Windows.
• Add arXiv action to cite context menu (#2082)
• More improvements to syntax scripts
  • Support \*@ifnextchar (#2094)
  • Conceals for amssymb commands (#2068)

Fixes

• Fixed a regression on the exit callback for latexmk (#768)
• Fixed minor error in documentclass detection (#2092)
• Fixed tex2unicode substitutions (#2091)
• Restore alternate buffer after ToC use (#2073)
• Allow hyphens in bib field names (#2071)
• Fixed unnecessary redraw before coming back from quickfix window (#2067, #1595)
• Fix .bib file globbing (#2035, #1658)

Documentation

• Improved text for :help vimtex-complete-cites (#2095, #2091)
• Add docs for nvim-compe (#2072)
• Minor improvemens

Ackowledgements
Thanks to @TpmKranz, @andryandrew, @otreblan, @paniash, @savq, @Nicholas42, @postylem, and @yongrenjie for the PR contributions! Also a special thanks to @clason who is being helpful in answering questions and providing thoughtful comments and suggestions in many issues and threads.

VimTeX 2.5

It is time for another release. Mostly due to the number of minor changes and fixes. There is no major change in this release. The most important updates are listed below.

Features

• Changed <space> behaviour in ToC windows (#2062)
• Allow citation completion in \*cites commands (#2016)
• Support for folding, ToC, motions, and text objects for KOMA-script section commands (#2003)
• Add option g:vimtex_toc_config_matchers to allow more user customization of ToC matchers (#2011)
• Add option g:vimtex_view_automatic_xwin to avoid searching for existing viewers with Zathura/MuPDF (#2026)
• Several improvements to syntax scripts, e.g.:
  • Allow % VimTeX: SynIgnore on|off to handle difficult syntax situations (#2038)
  • Better glossaries support (#2058)
  • Support for \parbox and minipage environment (#2044)
  • Support for mhequ package (#2042)
  • Support for KOMA-script add(sec|part|chap) (#2003)
  • Support for todonotes package
  • Allow custom command syntax styling with g:vimtex_syntax_custom_cmds (#1972)
  • Improved conceal support (#1965, #1968, #2034, #2040, )
  • And more (e.g. #1988, #2043)

Documentation

• New and improved quick start section in the README (#1946)
• Several minor improvements to the documentation (e.g. #1797, #2012, #2039)

Fixes

• Set ToC windows to fixed with winfix* (#2060)
• Fixed issue where caddfile caused unwanted autocmds to fire (#2029)
• Adjust default g:vimtex_indent_conditionals (#1078, #2023)
• Several more or less minor fixes (e.g. #2013, #2043, #2048, #2052, #2055)
• Use fdm=diff when refreshing folds in diff mode (#2014)

Other

• Moved media files to external locations to reduce size of the repo (#1946)

Ackowledgements
Thanks to @postylem, @jaekyeom, and @kunzaatko for the PR contributions!

VimTeX 2.4

This is a minor release with some improvements and fixes (see below). I'm vere happy to notice that there's been a large number of contributors with pull requests for this release!

Features

• Syntax highlighting
  • Conceal support for citations (#1965, #2002).
    • Two variants are available and can be configered through the option g:vimtex_syntax_conceal_cites:
      i) \cite{Knuth1981} -> [Knuth1981]
      ii) \cite{Knuth1981} -> 📖
  • Improve highlighting of style commands (e.g. \textsl and \mathbf); both in general and with additional conceal support (#1968, #1991).
  • Improve syntax rules for \url - allow percent symbol (#1990).
  • Add support for comment package (#1988).
  • Improved nested syntax highlighitng of Lua code (#1958).
  • Fix categorisation of some math delimiters (#1977).
• Add option to make it possible to disable extra indents of multi-line TikZ commands, g:vimtex_indent_tikz_commands (#1960, #1970).
• Enable ac and ic for math mode spacing commands, e.g. \; (#1966).

Fixes

• Fixed syntax issue with \lstset (#2000, #2001).
• Fixed problem with spaces in paths for vimtex#fzf#toc (#1996).
• Fixed folding of starred lists (#1994).
• Fixed a bug in the get_pid() method of the Zathura viewer (#947, #1971).
• Fixed comment highlighting in documented TeX format (#1988).
• Fixed issue with Vim stuttering after compilation due to fsync (#1986).
• Ensure bib parsing is executed from project root for cite context menu (#1974).

Other

• Added supplementary documentation of VimTeX code (#1961).
• Several general improvements to the documentation.
• Some other minor improvements and fixes.

Ackowledgements
Thanks to @rsekman, @IngoMeyer441, @patricknraanes, @Airwan, @psvenk, @JingMatrix, @cridemichel, @TornaxO7, @WeixuanZ, @144026, @pereBohigas for submitting PRs!

VimTeX 2.3

This is a new minor release with a few fixes and improvements, and one important change.

Changes

• The default map for the context menu was changed from <cr> to <localleader>la to avoid mapping a key that already has a specific meaning in Vim/neovim. See #1541.

Features

• Improved fold text for beamer frames (#1830).
• Improved syntax support for \lstinline (#1956).
• Allow cse and similar to match "unmatched" environment pairs (#1952).
• Minor improvement to bibtex quickfix parser.

Other

• Improved docs on custom imaps (#1612).

Ackowledgements

Thanks to @bk90 for submitting a PR!

VimTeX 2.2

This is again a minor release with fixes to some issues and some minor improvements. However, there is one milestone change on the meta level: @salutis suggested in #1894 that the proper spelling of Vimtex should be VimTeX, and after a vote on Reddit I decided to go with this. Thus, VimTeX is now the proper spelling.

In addition to some fixes and refinements, there has been some work on the docs, and some feature improvements. The detailed log is in the commit history, the following are some highlights.

Features

• Improvements to UI functions
• Improvements to syntax highlighting
• Support opening docs for environments with the K mapping (#1928)
• Added a generic compiler interface (regard as WIP for now, see :help vimtex-generic-compiler and #1898)

Ackowledgements

Thanks to @patricknraanes, @Toromtomtom, @shuber2, @apfelkuchen6, @ThePaulrBear, @ces42, @LinuxMercedes, and @JingMatrix for submitting PRs!

vimtex 2.1

This is a minor release that mainly addresses some issues with the new syntax plugin released in version 2.0.

The release brings one breaking change with respect to the old version: The syntax plugin used the naming scheme tex{type}Region for syntax regions, e.g. texMathRegion for math-mode regions. However, since this was only a minor change from the name tex{type}Zone that is used in the internal syntax plugin, and since a lot of people are using simple scripts to detect math mode based on the syntax, the change brought by Vimtex version 2.0 seems unnecessary and only means things get more complicated for a lot of people. Thus, in this minor release we revert the naming scheme back to tex{type}Zone. For more information and related discussions, see #1880 and #1883.

Features

• Improved conceal support (see e.g. #1881)
• Add syntax matching for \if, \else, and \fi
• Add match for \let
• Add umbrella syntax group for \let, \def and \newcommand
• vimtex#syntax#in_mathzone now accounts for \text arguments (#1884)

Acknowledgements
Thanks to @j1-lee, @Konfekt, and @tomtomjhj for the PR contributions!

vimtex 2.0

Major version release
Full syntax support has now been adopted into Vimtex (see #1799 and #1834 for releated discussions). This marks a major change. Some important notes:

• Vimtex assumes that people want LaTeX filetype for all .tex files. One may still specify g:tex_flavor specifically to avoid this. That is, Vimtex respects the setting of g:tex_flavor if it is explicitly defined.
• Vimtex no longer respects the "internal" options such as g:tex_fast and g:tex_conceal. For conceals, see :help g:vimtex_syntax_conceal.
• The Vimtex syntax script is very different from the built-in syntax support. There may be some minor overlap of syntax group names, but most of the groups have new names.
• The Vimtex syntax script is developed to be consistent, structured, and as simple as possible. One goal has been to make it easy to customize syntax highlighting and LaTeX specific colorschemes.
• The Vimtex syntax script does not support syntax folding.
• See :help vimtex-syntax for a more complete reference and documentation of the new syntax feature. See also the wiki for an example of how to customize the highlight groups.

New options

• g:vimtex_syntax_conceal
• g:vimtex_syntax_conceal_default
• g:vimtex_syntax_packages

Deprecated options

• g:vimtex_syntax_autoload_packages (in favor of the new g:vimtex_syntax_packages)

Acknowledgements
This has been quite a lot of work. It would have been much harder without the very useful and constructive feedback from and review by @clason and @Rmano. Thank you!

vimtex 1.6

It's again time for a minor release.

Features and improvements
This release brings a few improvements and minor fixes:

• New motions for beamer frames: ]r, ]R, [r, [R (see #1853)
• Improvements to the vlty grammar compiler (see #1856, #1839)
• Improvements to the textidote grammar compiler (see #1857)
• Added new option g:vimtex_subfile_start_local (see #1838)
• Fixed minor annoyance where jump list was not intact after certain motions
• Updated some autocomplete regexes (see e.g. #1852)
• Some improvements to docs (#1842, #1840)

Thanks to everyone who reports problems and submits ideas for improving Vimtex. And a special thanks to all PR contributors: @matze-dd, @yongrenjie, and @she30.

Important
This is the last version 1 release. The next release brings a major change as hinted in the v1.5 release: full syntax support. See #1799 and #1834 for details.

vimtex 1.5

It's time for a new release that includes both new features and some fixes and improvements to the backend code.

Features and improvements

• Motions to jump to start and end of math zones: ]n, ]N, [n, and [N (see #1818).
• The vlty grammar compiler has had some improvement (see #1821).
• The textidote grammar compiler has had some improvement (see #1805).
• Added option g:vimtex_context_pdf_viewer (see #1817).
• ToC support for fixme LaTeX package (see #1770).

Thanks to @openkork, @matze-dd, @mwageringel, @prataffel, and @bratekarate for PR contributions, and to everyone who contributes through opening issues with ideas, bug reports and discussions!

Teaser

For the curious, please note that there is now an ongoing project to embrace full syntax support within vimtex. I hope to finish this before Christmas and to announce it as a major version release (but I make no promises!). See #1799 for details.

vimtex 1.4

This release brings some new features:

• A context menu for citations (:VimtexContextMenu mapped to <cr> by default).
• An environment variable for specifying the output directory (see :help VIMTEX_OUTPUT_DIRECTORY).
• Basic support for syntax highlighting of the IEEEtrantools package.
• New option: g:vimtex_complete_bib.bibliography_commands
• New option: g:vimtex_toc_config.indent_levels
• New event: VimtexEventInitPre
• Added user/dev API's vimtex#view#view and vimtex#view#reverse_search

The option g:vimtex_quickfix_latexlog is now deprecated in favour of the more versatile g:vimtex_quickfix_ignore_filters.

There was also some maintenance of the code with minor improvements to both code and tests. Several minor issues have been resolved. vim-polyglot no longer bundles a LaTeX plugin, so the note about polyglot in the docs has been removed.