Skip to content

Commit 2b1ca66

Browse files
committed
merge: improve docs
refer: #3201
2 parents 6fabe8b + 2d958a8 commit 2b1ca66

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

doc/vimtex.txt

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2949,7 +2949,7 @@ OPTIONS *vimtex-options*
29492949
Default value: 0
29502950

29512951
*g:vimtex_syntax_packages*
2952-
A dictionary for package specific syntax configuration. Each key represent
2952+
A dictionary for package specific syntax configuration. Each key represents
29532953
a single package and the values are themselves configuration dictionaries.
29542954
All packages share the following options:
29552955

@@ -4303,27 +4303,27 @@ automatically, see |g:vimtex_text_obj_variant| for more info.
43034303

43044304
Some examples of how to use the text objects can be useful. The following is
43054305
a simple table that shows the original text on the left, the keys that are
4306-
typed in the middle, and the result on the right. The bar "|" indicates the
4306+
typed in the middle, and the result on the right. The bar "" indicates the
43074307
cursor position before the operation. >
43084308
43094309
BEFORE KEYS AFTER
4310-
\comm|and{arg} dic \command{}
4311-
\command{a|rg} gUac \COMMAND{ARG}
4310+
\command{arg} dic \command{}
4311+
\command{arg} gUac \COMMAND{ARG}
43124312
4313-
\lef|t( asd \right) cid \left(| \right)
4313+
\left( asd \right) cid \left( \right)
43144314
43154315
\begin{x} die \begin{x}
4316-
hello world| \end{x}
4316+
hello world \end{x}
43174317
\end{x}
43184318
4319-
$math | here$ da$
4319+
$math here$ da$
43204320
43214321
\begin{itemize} \begin{itemize}
4322-
\item hello moon| cim \item |
4322+
\item hello moon cim \item
43234323
\end{itemize} \end{itemize}
43244324
43254325
\begin{itemize} \begin{itemize}
4326-
\item hello moon| dam \end{itemize}
4326+
\item hello moon dam \end{itemize}
43274327
\end{itemize}
43284328
43294329
Note: The "greediness" of the command text objects (`ic` and `ac`) can be
@@ -5727,7 +5727,7 @@ A common workflow is to utilize the |location-list| with |:lmake|:
57275727

57285728
After linting, the compiler or linter messages are added to the location list.
57295729
This list may be displayed in the location-list window with |:lwindow|, and
5730-
one may jump between the entries with |:lN| and |:lp|. To automatically open
5730+
one may jump between the entries with |:lne| and |:lp|. To automatically open
57315731
the location-list window after linting is finished, one may add the following
57325732
to one's |vimrc|: >vim
57335733

@@ -5763,7 +5763,7 @@ allows one to use the location list. For `AsyncRun`, one may define a custom
57635763
\ AsyncRun<bang> -auto=make -program=make
57645764

57655765
The quickfix window that lists the linter errors and warnings can then be
5766-
opened by |:cwindow| and they can be jumped to by |:cN| respectively |:cp|.
5766+
opened by |:cwindow| and they can be jumped to by |:cn| and |:cp| respectively.
57675767

57685768
Often, a syntax error in a BibTeX file is due to a missing comma after an
57695769
entry. One may define a command to automatically add such missing commas, e.g.
@@ -6439,7 +6439,7 @@ Note: This reference is currently a work in progress!
64396439

64406440
*vimtex#cite#get_key*
64416441
Returns the citation key under the cursor. Can be useful e.g. to create
6442-
a function to open a citation in another progrem such as BibDesk or Zotero.
6442+
a function to open a citation in another program such as BibDesk or Zotero.
64436443
For example: >vim
64446444

64456445
function! OpenInBibDesk() abort
@@ -6870,8 +6870,8 @@ A: VimTeX implements a traditional syntax script for syntax highlighting of
68706870

68716871
However, it is hard to write a general parser for LaTeX. This is because
68726872
LaTeX is a semantic language with a large amount of different commands and
6873-
macros from thousands of available packages, many of which makes sense to
6874-
highlight in a different manner. That is, we need to handle a whole lot of
6873+
macros from thousands of available packages, many of which make sense to be
6874+
highlighted in a different manner. That is, we need to handle a whole lot of
68756875
special cases and edge cases!
68766876

68776877
Furthermore, Tree-sitter highlighting does not currently support
@@ -6948,7 +6948,7 @@ A: Start by reading the section on |vimtex-view-texshop|. The examples below
69486948
was opened. If the buffer is not active, in a hidden tab or if the file is
69496949
not open at all, inverse search will fail.
69506950

6951-
As alternative, to `VimtexInverseSearch`if the .tex document was opened
6951+
As an alternative to `VimtexInverseSearch`, if the .tex document was opened
69526952
with the `--remote-silent` option, i.e.: >bash
69536953

69546954
/usr/local/bin/mvim --remote-silent foo.tex
@@ -6989,7 +6989,7 @@ the quickfix window does not load.
69896989

69906990
Tips:
69916991
1. Ensure that a latexmk process and a Perl process have started. If they have
6992-
not been started, then these two programs may not accessible given your
6992+
not been started, then these two programs may not be accessible given your
69936993
operating system's PATH environment variable.
69946994
2. Ensure that the option `-interaction=nonstopmode` is provided to latexmk.
69956995
This is done by default by VimTeX, unless the user provides custom options

0 commit comments

Comments
 (0)