option to make gf open local copy of latex documentation

[alexandreroberts]

Is your feature request related to a problem? Please describe it.
As far as I can tell from :h vimtex-latexdoc-offline, there is currently no way to ask vimtex to open a local PDF copy of latex documentation instead of the online copy.

Describe the solution you'd like
I would like there to be a vimtex option that makes gf when the cursor is on a package name (e.g., \usepackage{biblatex} to open up the local PDF of that documentation stored in the texlive directory, much as (e.g., for biblatex do the equivalent of the shell command texdoc biblatex).

[gwuen]

This exact case should be covered by:

let g:vimtex_doc_handlers = ['vimtex#doc#handlers#texdoc']

Or with a Lua config:

vim.g.vimtex_doc_handlers = { "vimtex#doc#handlers#texdoc" }

You are right that this isn't described directly in :h vimtex-latexdoc-offline, I think this could be improved.

[alexandreroberts]

Thanks! I added that line to ftplugin/tex.vim, but that does not seem to work: gf over \usepackage{import} in a .tex file, for example, simply opens import.sty in my texlive directory in the same nvim window -- rather than calling texdoc import to open the PDF.

Should I be putting this line somewhere else?

[gwuen]

Sorry, I didn't mention, this will just change what the <plug>(vimtex-doc-package) command does, which is still mapped to 'K' by default. If you want to use 'gf' for that instead, you'll still need to create a custom mapping:

" ftplugin/tex.vim
nmap <buffer> gf <Plug>(vim-doc-package)

In this case, VimTeX will also skip creating the default 'K' mapping, if that is something you want.

[alexandreroberts]

Ah! That makes sense. I'm happy to use K, I just didn't think of that. I tried it just now, and it worked. Thanks again!

[lervag]

Thanks for helping, @gwuen! <3

You are right that this isn't described directly in :h vimtex-latexdoc-offline, I think this could be improved.

I'll update the docs.

[alexandreroberts]

Thanks, @lervag !