Skip to content

Commit

Permalink
chore: change vimtex -> VimTeX
Browse files Browse the repository at this point in the history
refer: #1894
  • Loading branch information
lervag committed Feb 9, 2021
1 parent 5ac1aba commit 3e76c81
Show file tree
Hide file tree
Showing 155 changed files with 388 additions and 388 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## Branch model

vimtex is developed mainly through the master branch, and pull requests should
VimTeX is developed mainly through the master branch, and pull requests should
be [fork based](https://help.github.com/articles/using-pull-requests/).

## Documentation style

Vim help files have their own specific syntax. There is a Vim help section on
how to write them, see [`:h help-writing`](http://vimdoc.sourceforge.net/htmldoc/helphelp.html#help-writing).

The vimtex documentation style should be relatively clear, and it should be
The VimTeX documentation style should be relatively clear, and it should be
easy to see from the existing documentation how to write it. Still, here are
some pointers:

Expand All @@ -23,7 +23,7 @@ some pointers:

## Code style

When submitting code for vimtex, please adhere to the following standards:
When submitting code for VimTeX, please adhere to the following standards:

- Use `shiftwidth=2` - no tabs!
- Write readable code
Expand Down
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# vimtex
# VimTeX

vimtex is a modern [Vim](http://www.vim.org/) and [neovim](https://neovim.io/) filetype and syntax plugin for LaTeX files.
VimTeX is a modern [Vim](http://www.vim.org/) and [neovim](https://neovim.io/) filetype and syntax plugin for LaTeX files.

[![Gitter](https://badges.gitter.im/vimtex-chat/community.svg)](https://gitter.im/vimtex-chat/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
![CI tests](https://github.com/lervag/vimtex/workflows/CI%20tests/badge.svg)
Expand All @@ -17,10 +17,10 @@ vimtex is a modern [Vim](http://www.vim.org/) and [neovim](https://neovim.io/) f

## Requirements

vimtex requires Vim version 8.0.1453 or neovim version 0.4.3. The requirements
were updated in July 2020 after the release of vimtex 1.0. If you are stuck
VimTeX requires Vim version 8.0.1453 or neovim version 0.4.3. The requirements
were updated in July 2020 after the release of VimTeX 1.0. If you are stuck
on older versions of Vim or neovim, then you should not use the most recent
version of vimtex, but instead remain at the v1.0 tag.
version of VimTeX, but instead remain at the v1.0 tag.

Some features require external tools. For example, the default compiler backend relies on [latexmk](http://users.phys.psu.edu/~collins/software/latexmk-jcc/).
Users are encouraged to read the requirements section in the [documentation](doc/vimtex.txt) (`:h vimtex-requirements`).
Expand All @@ -46,7 +46,7 @@ If you use the new package feature in Vim, please note the following:
* Helptags are not generated automatically. Run `:helptags` to generate them.
* Please note that by default Vim puts custom `/start/` plugin directories at
the end of the `&runtimepath`. This means the built in filetype plugin is
loaded, which prevents Vimtex from loading. See
loaded, which prevents VimTeX from loading. See
[#1413](https://github.com/lervag/vimtex/issues/1413) for two suggested
solutions to this. To see which scripts are loaded and in which order, use
`:scriptnames`.
Expand All @@ -55,16 +55,16 @@ If you use the new package feature in Vim, please note the following:

## Quick Start

The following is a simple guide for how to use vimtex. It only displays the
The following is a simple guide for how to use VimTeX. It only displays the
most basic features. Users are _strongly_ encouraged to read or at least skim
through the documentation to learn about the different features and
possibilities provided by vimtex (see [`:h vimtex`](doc/vimtex.txt)).
possibilities provided by VimTeX (see [`:h vimtex`](doc/vimtex.txt)).

![Quick start gif](media/quick_start.gif?raw=true)

## Features

Below is a list of features offered by vimtex. The features are accessible as
Below is a list of features offered by VimTeX. The features are accessible as
both commands and mappings. The mappings generally start with
`<localleader>l`, but if desired one can disable default mappings to define
custom mappings. All features are enabled by default, but each feature may be
Expand Down Expand Up @@ -140,11 +140,11 @@ disabled if desired.
- [import](http://ctan.uib.no/macros/latex/contrib/import/import.pdf)
- [subfiles](http://ctan.uib.no/macros/latex/contrib/subfiles/subfiles.pdf)

See the documentation for a thorough introduction to vimtex (e.g. `:h vimtex`).
See the documentation for a thorough introduction to VimTeX (e.g. `:h vimtex`).

## Other relevant plugins

Even though vimtex provides a lot of nice features for working with LaTeX
Even though VimTeX provides a lot of nice features for working with LaTeX
documents, there are several features that are better served by other,
dedicated plugins. For a more detailed listing of these, please see [`:help
vimtex-non-features`](doc/vimtex.txt#L156).
Expand All @@ -170,28 +170,28 @@ The following are some alternative LaTeX plugins for Vim:

* [LaTeX-Suite](http://vim-latex.sourceforge.net)

The main difference between vimtex and LaTeX-Suite (aka vim-latex) is
probably that vimtex does not try to implement a full fledged IDE for LaTeX
The main difference between VimTeX and LaTeX-Suite (aka vim-latex) is
probably that VimTeX does not try to implement a full fledged IDE for LaTeX
inside Vim. E.g.:

* vimtex does not provide a full snippet feature, because this is better
* VimTeX does not provide a full snippet feature, because this is better
handled by [UltiSnips](https://github.com/SirVer/ultisnips) or
[neosnippet](https://github.com/Shougo/neosnippet.vim) or similar snippet
engines.
* vimtex builds upon Vim principles: It provides text objects for
* VimTeX builds upon Vim principles: It provides text objects for
environments, inline math, it provides motions for sections and
paragraphs
* vimtex uses `latexmk`, `latexrun`, `tectonic` or `arara` for compilation
* VimTeX uses `latexmk`, `latexrun`, `tectonic` or `arara` for compilation
with a callback feature to get instant feedback on compilation errors
* vimtex is very modular: if you don't like a feature, you can turn it off.
* VimTeX is very modular: if you don't like a feature, you can turn it off.

* [LaTeX-Box](https://github.com/LaTeX-Box-Team/LaTeX-Box)

vimtex currently has most of the features of LaTeX-Box, as well as
VimTeX currently has most of the features of LaTeX-Box, as well as
some additional ones. See [here](#features) for a relatively complete list
of features.

One particular feature that LaTeX-Box has but vimtex misses, is the ability
One particular feature that LaTeX-Box has but VimTeX misses, is the ability
to do single-shot compilation _with callback_. This functionality was
removed because it adds a lot of complexity for relatively little gain
(IMHO).
Expand Down
6 changes: 3 additions & 3 deletions after/ftplugin/tex.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand All @@ -21,7 +21,7 @@ let s:latexbox = !empty(filter(copy(s:scriptnames), "v:val =~# 'latex-box'"))
if s:latexbox
call vimtex#log#warning([
\ 'Conflicting plugin detected: LaTeX-Box',
\ 'vimtex does not work as expected when LaTeX-Box is installed!',
\ 'Please disable or remove it to use vimtex!',
\ 'VimTeX does not work as expected when LaTeX-Box is installed!',
\ 'Please disable or remove it to use VimTeX!',
\])
endif
8 changes: 4 additions & 4 deletions autoload/health/vimtex.vim
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
function! health#vimtex#check() abort
call vimtex#options#init()

call health#report_start('vimtex')
call health#report_start('VimTeX')

call s:check_general()
call s:check_plugin_clash()
Expand All @@ -11,7 +11,7 @@ endfunction

function! s:check_general() abort " {{{1
if !has('nvim') || v:version < 800
call health#report_warn('vimtex works best with Vim 8 or neovim')
call health#report_warn('VimTeX works best with Vim 8 or neovim')
else
call health#report_ok('Vim version should have full support!')
endif
Expand Down Expand Up @@ -66,8 +66,8 @@ function! s:check_plugin_clash() abort " {{{1
let l:latexbox = !empty(filter(copy(l:scriptnames), "v:val =~# 'latex-box'"))
if l:latexbox
call health#report_warn('Conflicting plugin detected: LaTeX-Box')
call health#report_info('vimtex does not work as expected when LaTeX-Box is installed!')
call health#report_info('Please disable or remove it to use vimtex!')
call health#report_info('VimTeX does not work as expected when LaTeX-Box is installed!')
call health#report_info('Please disable or remove it to use VimTeX!')
endif
endfunction

Expand Down
2 changes: 1 addition & 1 deletion autoload/unite/sources/vimtex.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/bib.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/cache.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/cmd.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
4 changes: 2 additions & 2 deletions autoload/vimtex/compiler.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down Expand Up @@ -44,7 +44,7 @@ function! vimtex#compiler#init_state(state) abort " {{{1
\}
let a:state.compiler
\ = vimtex#compiler#{g:vimtex_compiler_method}#init(l:options)
catch /vimtex: Requirements not met/
catch /VimTeX: Requirements not met/
call vimtex#log#error('Compiler was not initialized!')
catch /E117/
call vimtex#log#error(
Expand Down
4 changes: 2 additions & 2 deletions autoload/vimtex/compiler/arara.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down Expand Up @@ -29,7 +29,7 @@ function! s:compiler.init(options) abort dict " {{{1

if !executable('arara')
call vimtex#log#warning('arara is not executable!')
throw 'vimtex: Requirements not met'
throw 'VimTeX: Requirements not met'
endif

let l:backend = has('nvim') ? 'nvim' : 'jobs'
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/compiler/generic.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
6 changes: 3 additions & 3 deletions autoload/vimtex/compiler/latexmk.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down Expand Up @@ -49,7 +49,7 @@ function! vimtex#compiler#latexmk#get_rc_opt(root, opt, type, default) abort " {
elseif a:type == 2
let l:pattern = '^\s*@' . a:opt . '\s*=\s*(\(.*\))'
else
throw 'vimtex: argument error'
throw 'VimTeX: Argument error'
endif

" Candidate files
Expand Down Expand Up @@ -216,7 +216,7 @@ function! s:compiler.init_check_requirements() abort dict " {{{1
for l:cmd in l:missing
call vimtex#log#warning(l:cmd . ' is not executable')
endfor
throw 'vimtex: Requirements not met'
throw 'VimTeX: Requirements not met'
endif
endfunction

Expand Down
4 changes: 2 additions & 2 deletions autoload/vimtex/compiler/latexrun.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down Expand Up @@ -33,7 +33,7 @@ function! s:compiler.init(options) abort dict " {{{1

if !executable('latexrun')
call vimtex#log#warning('latexrun is not executable!')
throw 'vimtex: Requirements not met'
throw 'VimTeX: Requirements not met'
endif

" Check if environment variable exists; it has the highest priority
Expand Down
4 changes: 2 additions & 2 deletions autoload/vimtex/compiler/tectonic.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down Expand Up @@ -33,7 +33,7 @@ function! s:compiler.init(options) abort dict " {{{1

if !executable('tectonic')
call vimtex#log#warning('tectonic is not executable!')
throw 'vimtex: Requirements not met'
throw 'VimTeX: Requirements not met'
endif

" Check if environment variable exists; it has the highest priority
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/complete.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/complete/tools/convert-cwl
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/usr/bin/env python
"""Convert texstudio cwl files to vimtex format"""
"""Convert texstudio cwl files to VimTeX format"""
import os
import re

Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/context.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/context/cite.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/debug.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/delim.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/doc.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/echo.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/env.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/fold.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/fold/cmd_addplot.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/fold/cmd_multi.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/fold/cmd_single.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/fold/cmd_single_opt.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/fold/comments.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/fold/env_options.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion autoload/vimtex/fold/envs.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
" vimtex - LaTeX plugin for Vim
" VimTeX - LaTeX plugin for Vim
"
" Maintainer: Karl Yngve Lervåg
" Email: [email protected]
Expand Down
Loading

0 comments on commit 3e76c81

Please sign in to comment.