1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
\documentclass{article}
% These are only here for the sake of this tutorial.
\usepackage{amsmath}
\newcommand{\lt}{\textbackslash{}lt }
\newcommand{\lk}{\textbackslash{}lk }
\newcommand{\lv}{\textbackslash{}lv }
\newcommand{\lc}{\textbackslash{}lc }
\renewcommand{\ll}{\textbackslash{}ll }
\renewcommand{\le}{\textbackslash{}le }
\begin{document}
\section{Compiling}
Press \ll to start (or stop) compiling the document.
This turns on automatic compiling if supported by your compiler, meaning your
document will be compiled each time you save.
Press \lk to stop the compilation process
Press \lc to clear auxiliary files.
\section{Forward and Backward Search}
Press \lv to forward search. This will open the compiled PDF.
Some PDF viewers support the ability to jump to the current location in the PDF.
Some also support backward search (jumping from PDF to source).
\section{Errors, Warnings and the QuickFix window}
VimTeX will populate the QuickFix menu with any errors and warnings it finds in
the log file.
This is done after (attempting to) compile or pressing \le.
\le also closes the QuickFix menu when it is open.
\emph{Example.} Let's put some undefined commands here and compile:
Moving to the QuickFix window and pressing enter on the error entry moves the
cursor to the line containing the error. We can fix the error and continue.
\section{Document Overview}
Press \lt to show a window with a table of contents for your document.
Also shows labels, references and TODOs.
Can be used to jump to sections, labels, references and TODOs.
% TODO: Show table of contents.
\section{Motions and Text Objects}
VimTeX adds various LaTeX specific motions and text objects.
\emph{Example motion.} move between section boundaries with [[, [], ][ and ]].
\emph{Example text object.} ic refers to a LaTeX command excluding the
backslash. ac includes the backslash.
cic: \( \alpha \)
dac: \( \)
\section{Other Cool Stuff}
cse changes the surrounding environment:
\begin{equation}
v \cdot \nabla_x f_1 = -\sigma_a f_1, \quad f_1 \rvert_{\Gamma_-} = \phi(x,v).
\end{equation}
tsd toggles between () and \( \left( \right) \):
\begin{equation*}
\frac{d}{ds} \left[ e^{\int_k^s \sigma_a(x + tv)\,dt} F_1(s) \right] = 0
\end{equation*}
tse toggles the * in environments:
\begin{equation}
f_1(x, v) = e^{-\int_0^{\tau_-(x, v)} \sigma_a(x - sv)\,dt} \phi(x_-, v),
\end{equation}
This is only a tiny sliver of what VimTeX offers.
Read the README for an overview, and read :h vimtex for a full description of
all things VimTeX.
\end{document}
|
