Hover
Hover can also be triggered using C-k C-i.
To open a package documentation, hover the package name inside the \usepackage call and click on the View documentation link. As it internally calls texdoc, if it is not in your path you may need to set latex-workshop.texdoc.path to the full path of texdoc and tweak latex-workshop.texdoc.args.
You may also directly call one the following commands
-
LaTex Workshop: Show package documentation: you will get an input box to type in the package name. If you want to define a keybinding for this feature, associate it to the internal command
latex-workshop.texdoc. -
LaTex Workshop: Show package documentation actually used : you can select the package name within a list. If you want to define a keybinding for this feature, associate it to the internal command
latex-workshop.texdocUsepackages.
When you move the mouse cursor over inline math, \[, $$, \begin{align}, and \begin{...} of other math environments, math preview on hover is rendered. When you move the mouse cursor over \ref, and other reference commands referring math equations, math preview on hover is also rendered.
Supported math environments are align, align*, alignat, alignat*, aligned, alignedat, array, Bmatrix, bmatrix, cases, CD, eqnarray, eqnarray*, equation, equation*, gather, gather*, gathered, matrix, multline, multline*, pmatrix, smallmatrix, split, subarray, Vmatrix, vmatrix.
The tabular environment is not supported.
| Setting key | Description |
|---|---|
latex-workshop.hover.preview.enabled |
Enable hover preview |
latex-workshop.hover.preview.scale |
Scale of hover preview |
latex-workshop.hover.preview.cursor.enabled |
Render cursor in hover preview |
latex-workshop.hover.preview.cursor.symbol |
Define the cursor symbol |
latex-workshop.hover.preview.cursor.color |
Define the cursor color |
latex-workshop.hover.preview.newcommand.parseTeXFile.enabled |
Add newcommands to preview |
latex-workshop.hover.preview.newcommand.newcommandFile |
Path of a file containing newcommands |
latex-workshop.hover.preview.mathjax.extensions |
MathJax extensions to load |
You can preview equation in realtime in a separate editor by using the math preview panel. The position of the editor is determined by latex-workshop.mathpreviewpanel.editorGroup
- To open the panel call Open Math Preview Panel (internal command is
latex-workshop.openMathPreviewPanel) - To close the panel call Close Math Preview Panel" (internal command is
latex-workshop.closeMathPreviewPanel) - To toggle the panel call Toggle Math Preview Panel (internal command is
latex-workshop.toggleMathPreviewPanel)
Only math environments with less than latex-workshop.hover.preview.maxLines lines are properly updated.
When latex-workshop.hover.preview.enabled is set to true, moving the mouse over an argument of \includegraphics shows a preview of the graphics file.
When latex-workshop.hover.citation.enabled is set to true, moving the mouse over an argument of a \cite related command displays the details of the bibliography as a tooltip. See latex-workshop.intellisense.citation.format
When latex-workshop.hover.ref.enabled is set to true, moving the mouse over a \ref related command displays the piece of tex with the corresponding label as a tooltip. Moreover, if the label refers to a math environment as described in Previewing equations, math preview is rendered instead of showing the tex content. The tooltip has a View on pdf link to jump to the corresponding location in the PDF viewer. It only calls synctex as if you were directly calling SyncTeX from cursor and therefore it requires a PDF viewer for the current .tex file to be opened.
| Setting key | Description |
|---|---|
latex-workshop.hover.ref.enabled |
Enable hover on references |
latex-workshop.hover.ref.number.enabled |
Show number assigned to the reference in the previous compilation |
When latex-workshop.hover.command.enabled is set to true, moving the mouse over a command displays the different forms (signatures) of the command with their arguments as a tooltip. You can directly access the documentation of the package(s) defining the command by clicking on the package name(s).
Enable Hover on References.
| type | default value |
|---|---|
| boolean | true |
Show the number assigned to the reference in the previous compilation.
| type | default value |
|---|---|
| boolean | true |
Enable Hover on Citations.
| type | default value |
|---|---|
| boolean | true |
Enable Hover on Commands to show the possible signatures.
| type | default value |
|---|---|
| boolean | true |
Enable preview on hover.
| type | default value |
|---|---|
| boolean | true |
Scale of preview on hover.
| type | default value |
|---|---|
| number | 1 |
Enable newcommands defined in the current TeX file to be included in Hover Preview. We currently only support commands defined on a single line.
| type | default value |
|---|---|
| boolean | true |
Set the path of a file containing newcommands to be used in Hover Preview. If the path is relative, it is joined with the root dir.
| type | default value |
|---|---|
| string | "" |
MathJax extensions to load for Hover Preview. See the list. Notice that extensions, ams, color, newcommand, noerrors, and noundefined are loaded by default. They cannot be disabled.
| type | default value | possible values |
|---|---|---|
| array | [] |
"amscd", "bbox", "boldsymbol", "braket", "bussproofs", "cancel", "cases", "centernot", "colortbl", "empheq", "enclose", "extpfeil", "gensymb", "html", "mathtools", "mhchem", "physics", "textcomp", "textmacros", "unicode", "upgreek", "verb"
|
Render cursor in math preview on hover at the current position.
| type | default value |
|---|---|
| boolean | true |
Define the cursor symbol in math preview on hover.
| type | default value |
|---|---|
| string | \ddagger |
Define the color of the cursor in math preview on hover.
| type | default value | possible values |
|---|---|---|
| string | "auto" |
"auto", "black", "blue", "brown", "cyan", "darkgray", "gray", "green", "lightgray", "lime", "magenta", "olive", "orange", "pink", "purple", "red", "teal", "violet", "white", "yellow"
|
PDF viewer used for [View on PDF] link on hover over \ref, and other reference commands.
| type | default value | possible values |
|---|---|---|
| string | "auto" |
"auto", "tabOrBrowser", "external"
|
Define the location of texdoc executable.
| type | default value |
|---|---|
| string | "texdoc" |
Texdoc arguments to see a package documentation.
| type | default value |
|---|---|
| array | ["--view"] |
The package name is automatically appended to the arguments.
The editor group in which to open the math preview panel.
| type | default value |
|---|---|
| string | "below" |
The accepted values are:
- current: Use the current editor group
- left: Put the math preview panel in a new group on the left of the current one
- right: Put the math preview panel in a new group on the right of the current one
- above: Put the math preview panel in a new group above the current one
- below: Put the math preview panel in a new group below the current one
This feature is experimental. If you report an issue to us on this feature, we may not fix it. We will not accept any pull requests. Render a cursor on the math preview panel.
| type | default value |
|---|---|
| boolean | false |
Maximum number of lines between the beginning of the math environment and the cursor position to allow preview.
| type | default value |
|---|---|
| number | 20 |