Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Note on lazy loading and inverse search #2560

Merged
merged 1 commit into from
Nov 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,12 @@ Or use some other plugin manager:
* [neobundle](https://github.com/Shougo/neobundle.vim)
* [pathogen](https://github.com/tpope/vim-pathogen)

Note that some plugin managers provide mechanisms for lazy loading of plugins,
e.g., based on the filetype. This is explicitly _discouraged_. Firstly, it
complicates some mechansims, e.g., inverse search through PDF viewers.
Secondly, there is also little gain in this since VimTeX is already lazily
loaded as a filetype plugin.

If you use the new package feature in Vim, please note the following:
* Make sure to read and understand the package feature: `:help package`!
* Use the `/pack/foo/start` subdirectory to make sure the filetype plugin is
Expand Down
5 changes: 5 additions & 0 deletions doc/vimtex.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5503,6 +5503,11 @@ This may be avoided, or at least reduced, with the following variants: >
Note: Vim users should be aware that one may need to ensure that the server is
really running, see |vimtex-clientserver|.

Note: Various plugin managers support lazy plugin loading, e.g., based on the
filetype. It is discouraged to use this feature with VimTeX. In
particular, the above command lines for inverse search would need work
around this.

==============================================================================
LATEX DOCUMENTATION *vimtex-latexdoc*

Expand Down