-
Notifications
You must be signed in to change notification settings - Fork 521
ExtraFeatures
The structure of the LaTeX project (\chapter
, \section
, \subsection
, ...) is accessible via the TeX panel on the left of the editor. The entry corresponding to the cursor position in the editor is automatically selected and follows the cursor. The outline hierarchy is defined by latex-workshop.view.outline.sections
.
Note that the Explorer panel also contains an outline view but it only shows the structure of the current file and does not take into account any included file.
The section names of LaTeX outline hierarchy. It is also used by the folding mechanism. See Code folding for more details.
This property is an array of case-sensitive strings in the order of the document structure hierarchy. For multiple tags of the same level, separate the tags with |
as delimiters, e.g., section|alternative
.
type | default value |
---|---|
array of strings | [ "part", "chapter", "section", "subsection", "subsubsection" ] |
The structure of the document can be obtained
The names of the commands to be shown in the outline/structure views. Reload vscode to make any change in this configuration effective.
type | default value |
---|---|
array of strings | ["label"] |
The commands must be called in the form \commandname{arg}
.
Show the floating objects (figures and tables) in the outline/structure views.
type | default value |
---|---|
boolean | true |
Show the float number in the outline/structure views.
type | default value |
---|---|
boolean | true |
Show the float caption in the outline/structure views.
type | default value |
---|---|
boolean | true |
Show the sectioning numbers in the outline/structure views.
type | default value |
---|---|
boolean | true |
Scrolling the editor will also reveal the corresponding structure items.
type | default value |
---|---|
boolean | true |
Clicking on a structure item will also call synctex
to scroll the PDF viewer to the corresponding location.
type | default value |
---|---|
boolean | false |
The following regions (along with their *
-starred versions) can be folded.
Region |
---|
\documentclass{} ... \begin{document} |
\part{} |
\chapter{} |
\section{} , \subsection{} , \subsubsection{} , etc. |
\begin{<envname>} ... \end{<envname>} |
\begingroup ... \endgroup |
The folding mechanism ignores comments, so comments can be used to fold code using the same keywords as above. This means commented out sections and the like can be easily folded for easier editing. To fold arbitrary regions, we recommend using the following comments.
%\begingroup
...
%\endgroup
or
% region
...
% endregion
The keywords region
and endregion
may start with a capital letter and be preceded by the #
sign.
To count the number of words in the current document, call Count words in LaTeX document from the Command Palette (the associated command is latex-workshop.wordcount
). Setting latex-workshop.texcount.autorun
to onSave
counts the number of words on every file save and displays it in the status bar.
When to call texcount
. Default is never.
type | default value |
---|---|
string | "onSave" | "never" |
The minimal time interval between two consecutive runs of texcount
in milliseconds when latex-workshop.texcount.autorun
is set to onSave
.
type | default value |
---|---|
number | 1000 |
Define the location of TeXCount executive file/script
type | default value |
---|---|
string | "texcount" |
This command will be joint with latex-workshop.texcount.args
and required arguments to form a complete command of TeXCount
TeXCount arguments to count words in LaTeX document of the entire project from the root file, or the current document.
type | default value |
---|---|
array of strings | [] |
Arguments must be in separate strings in the array.
Additional arguments, i.e., -merge %DOC%
for the project and the current document path for counting current file, will be appended when constructing the command.
Note that if latex-workshop.texcount.args
already contains -merge
, it will not be added again.
To use the -inc
mode of texcount
instead, set this to ["-merge", "-inc", "-total"]
;
the -merge
is to prevent LaTeX Workshop appending -merge
at the end,
the -inc
then immediately overrides this setting,
and the -total
ensures that LaTex Workshop is able to parse the output.
We support the following the programming languages inside a LaTeX document
-
Julia
code using Weave.jl. See Building a.jnw
file. We use thejlweave
language mode for this and recognize the following file extensions.jnw
, and.jtexw
. -
R
code using knitr or Sweave. See Building a.rnw
file for how to compile LaTeX files using Sweave. We use thersweave
language mode for this and recognize the following file extensions.rnw
,.Rnw
,.Rtex
,.rtex
,.snw
and.Snw
.
For syntax highlighting to be properly working, you need to install the VSCode extension that gives support for the corresponding programming language.
The markdown
package allows to mix LaTeX and Markdown code inside the markdown environment. If you want to use this package, keep the .tex
extension to your file but set its language to markdown_latex_combined
.
Note that the language markdown_latex_combined
is not meant to be used for .md
files using LaTeX code.