vim-patch:partial:624bb83: runtime(doc): Tweak documentation style a bit (#31148)

closes: vim/vim#11419

624bb83619

Skip syncolor.vim and v:colornames

Co-authored-by: h-east <h.east.727@gmail.com>
This commit is contained in:
zeertzjq
2024-11-10 09:11:06 +08:00
committed by GitHub
parent 7d8dd8234a
commit 7232b54aee
5 changed files with 46 additions and 45 deletions

View File

@@ -1046,8 +1046,8 @@ To enable: >
let g:typst_folding = 1 let g:typst_folding = 1
< <
*g:typst_foldnested* *g:typst_foldnested*
When |TRUE| the Typst filetype plugin will fold nested heading under their parents When |TRUE| the Typst filetype plugin will fold nested heading under their
(default: |TRUE|) parents. (default: |TRUE|)
To disable: > To disable: >
let g:typst_foldnested = 0 let g:typst_foldnested = 0

View File

@@ -154,7 +154,7 @@ or auto suspended with nohlsearch plugin. See |nohlsearch-install|.
When 'shortmess' does not include the "S" flag, Vim will automatically show an When 'shortmess' does not include the "S" flag, Vim will automatically show an
index, on which the cursor is. This can look like this: > index, on which the cursor is. This can look like this: >
[1/5] Cursor is on first of 5 matches. [1/5] Cursor is on first of 5 matches.
[1/>99] Cursor is on first of more than 99 matches. [1/>99] Cursor is on first of more than 99 matches.
@@ -743,7 +743,7 @@ overview.
\([a-z]\+\)\zs,\1 ",abc" in "abc,abc" \([a-z]\+\)\zs,\1 ",abc" in "abc,abc"
\@123<= \@123<=
Like "\@<=" but only look back 123 bytes. This avoids trying lots Like "\@<=" but only look back 123 bytes. This avoids trying lots
of matches that are known to fail and make executing the pattern very of matches that are known to fail and make executing the pattern very
slow. Example, check if there is a "<" just before "span": slow. Example, check if there is a "<" just before "span":
/<\@1<=span /<\@1<=span
@@ -769,7 +769,7 @@ overview.
\(\/\/.*\)\@<!in "in" which is not after "//" \(\/\/.*\)\@<!in "in" which is not after "//"
\@123<! \@123<!
Like "\@<!" but only look back 123 bytes. This avoids trying lots of Like "\@<!" but only look back 123 bytes. This avoids trying lots of
matches that are known to fail and make executing the pattern very matches that are known to fail and make executing the pattern very
slow. slow.
@@ -892,7 +892,7 @@ $ At end of pattern or in front of "\|", "\)" or "\n" ('magic' on):
inside the Visual area put it at the start and just before the end of inside the Visual area put it at the start and just before the end of
the pattern, e.g.: > the pattern, e.g.: >
/\%Vfoo.*ba\%Vr /\%Vfoo.*ba\%Vr
< This also works if only "foo bar" was Visually selected. This: > < This also works if only "foo bar" was Visually selected. This: >
/\%Vfoo.*bar\%V /\%Vfoo.*bar\%V
< would match "foo bar" if the Visual selection continues after the "r". < would match "foo bar" if the Visual selection continues after the "r".
Only works for the current buffer. Only works for the current buffer.
@@ -999,7 +999,7 @@ $ At end of pattern or in front of "\|", "\)" or "\n" ('magic' on):
< To match all characters after the current virtual column (where the < To match all characters after the current virtual column (where the
cursor is): > cursor is): >
/\%>.v.* /\%>.v.*
< Column 17 is not included, because this is a |/zero-width| match. To < Column 17 is not included, because this is a |/zero-width| match. To
include the column use: > include the column use: >
/^.*\%17v. /^.*\%17v.
< This command does the same thing, but also matches when there is no < This command does the same thing, but also matches when there is no
@@ -1123,11 +1123,11 @@ x A single character, with no special meaning, matches itself
in the collection: "[^xyz]" matches anything but 'x', 'y' and 'z'. in the collection: "[^xyz]" matches anything but 'x', 'y' and 'z'.
- If two characters in the sequence are separated by '-', this is - If two characters in the sequence are separated by '-', this is
shorthand for the full list of ASCII characters between them. E.g., shorthand for the full list of ASCII characters between them. E.g.,
"[0-9]" matches any decimal digit. If the starting character exceeds "[0-9]" matches any decimal digit. If the starting character exceeds
the ending character, e.g. [c-a], E944 occurs. Non-ASCII characters the ending character, e.g. [c-a], E944 occurs. Non-ASCII characters
can be used, but the character values must not be more than 256 apart can be used, but the character values must not be more than 256 apart
in the old regexp engine. For example, searching by [\u3000-\u4000] in the old regexp engine. For example, searching by [\u3000-\u4000]
after setting re=1 emits a E945 error. Prepending \%#=2 will fix it. after setting re=1 emits a E945 error. Prepending \%#=2 will fix it.
- A character class expression is evaluated to the set of characters - A character class expression is evaluated to the set of characters
belonging to that character class. The following character classes belonging to that character class. The following character classes
are supported: are supported:
@@ -1193,7 +1193,7 @@ x A single character, with no special meaning, matches itself
any character that's not in "^]-\bdertnoUux". "[\xyz]" matches '\', any character that's not in "^]-\bdertnoUux". "[\xyz]" matches '\',
'x', 'y' and 'z'. It's better to use "\\" though, future expansions 'x', 'y' and 'z'. It's better to use "\\" though, future expansions
may use other characters after '\'. may use other characters after '\'.
- Omitting the trailing ] is not considered an error. "[]" works like - Omitting the trailing ] is not considered an error. "[]" works like
"[]]", it matches the ']' character. "[]]", it matches the ']' character.
- The following translations are accepted when the 'l' flag is not - The following translations are accepted when the 'l' flag is not
included in 'cpoptions': included in 'cpoptions':
@@ -1425,14 +1425,14 @@ Finally, these constructs are unique to Perl:
display you may get unexpected results. That is because Vim display you may get unexpected results. That is because Vim
looks for a match in the line where redrawing starts. looks for a match in the line where redrawing starts.
Also see |matcharg()| and |getmatches()|. The former returns Also see |matcharg()| and |getmatches()|. The former returns
the highlight group and pattern of a previous |:match| the highlight group and pattern of a previous |:match|
command. The latter returns a list with highlight groups and command. The latter returns a list with highlight groups and
patterns defined by both |matchadd()| and |:match|. patterns defined by both |matchadd()| and |:match|.
Highlighting matches using |:match| are limited to three Highlighting matches using |:match| are limited to three
matches (aside from |:match|, |:2match| and |:3match| are matches (aside from |:match|, |:2match| and |:3match| are
available). |matchadd()| does not have this limitation and in available). |matchadd()| does not have this limitation and in
addition makes it possible to prioritize matches. addition makes it possible to prioritize matches.
Another example, which highlights all characters in virtual Another example, which highlights all characters in virtual
@@ -1461,7 +1461,7 @@ Finally, these constructs are unique to Perl:
with the lowest number has priority if several match at the with the lowest number has priority if several match at the
same position. It uses the match id 3. same position. It uses the match id 3.
The ":3match" command is used by (older Vims) |matchparen| The ":3match" command is used by (older Vims) |matchparen|
plugin. You are suggested to use ":match" for manual matching plugin. You are suggested to use ":match" for manual matching
and ":2match" for another plugin or even better make use of and ":2match" for another plugin or even better make use of
the more flexible |matchadd()| (and similar) functions instead. the more flexible |matchadd()| (and similar) functions instead.
@@ -1470,10 +1470,10 @@ Finally, these constructs are unique to Perl:
Fuzzy matching refers to matching strings using a non-exact search string. Fuzzy matching refers to matching strings using a non-exact search string.
Fuzzy matching will match a string, if all the characters in the search string Fuzzy matching will match a string, if all the characters in the search string
are present anywhere in the string in the same order. Case is ignored. In a are present anywhere in the string in the same order. Case is ignored. In a
matched string, other characters can be present between two consecutive matched string, other characters can be present between two consecutive
characters in the search string. If the search string has multiple words, then characters in the search string. If the search string has multiple words, then
each word is matched separately. So the words in the search string can be each word is matched separately. So the words in the search string can be
present in any order in a string. present in any order in a string.
Fuzzy matching assigns a score for each matched string based on the following Fuzzy matching assigns a score for each matched string based on the following
@@ -1492,8 +1492,8 @@ will match the strings "GetPattern", "PatternGet", "getPattern", "patGetter",
"getSomePattern", "MatchpatternGet" etc. "getSomePattern", "MatchpatternGet" etc.
The functions |matchfuzzy()| and |matchfuzzypos()| can be used to fuzzy search The functions |matchfuzzy()| and |matchfuzzypos()| can be used to fuzzy search
a string in a List of strings. The matchfuzzy() function returns a List of a string in a List of strings. The matchfuzzy() function returns a List of
matching strings. The matchfuzzypos() functions returns the List of matches, matching strings. The matchfuzzypos() functions returns the List of matches,
the matching positions and the fuzzy match scores. the matching positions and the fuzzy match scores.
The "f" flag of `:vimgrep` enables fuzzy matching. The "f" flag of `:vimgrep` enables fuzzy matching.

View File

@@ -1533,7 +1533,7 @@ Associated setting variables:
|g:netrw_nogx| prevent gx map while editing |g:netrw_nogx| prevent gx map while editing
|g:netrw_suppress_gx_mesg| controls gx's suppression of browser messages |g:netrw_suppress_gx_mesg| controls gx's suppression of browser messages
OPENING FILES AND LAUNCHING APPS *netrw-gx* *:Open* *:Launch* {{{2 OPENING FILES AND LAUNCHING APPS *netrw-gx* *:Open* *:Launch* {{{2
Netrw determines which special handler by the following method: Netrw determines which special handler by the following method:

View File

@@ -1209,20 +1209,20 @@ on" command in your .vimrc file.
When you edit an existing Fortran file, the syntax script will assume free When you edit an existing Fortran file, the syntax script will assume free
source form if the fortran_free_source variable has been set, and assumes source form if the fortran_free_source variable has been set, and assumes
fixed source form if the fortran_fixed_source variable has been set. Suppose fixed source form if the fortran_fixed_source variable has been set. Suppose
neither of these variables have been set. In that case, the syntax script attempts to neither of these variables have been set. In that case, the syntax script
determine which source form has been used by examining the file extension attempts to determine which source form has been used by examining the file
using conventions common to the ifort, gfortran, Cray, NAG, and PathScale extension using conventions common to the ifort, gfortran, Cray, NAG, and
compilers (.f, .for, .f77 for fixed-source, .f90, .f95, .f03, .f08 for PathScale compilers (.f, .for, .f77 for fixed-source, .f90, .f95, .f03, .f08
free-source). No default is used for the .fpp and .ftn file extensions because for free-source). No default is used for the .fpp and .ftn file extensions
different compilers treat them differently. If none of this works, then the because different compilers treat them differently. If none of this works,
script examines the first five columns of the first 500 lines of your file. If then the script examines the first five columns of the first 500 lines of your
no signs of free source form are detected, then the file is assumed to be in file. If no signs of free source form are detected, then the file is assumed
fixed source form. The algorithm should work in the vast majority of cases. to be in fixed source form. The algorithm should work in the vast majority of
In some cases, such as a file that begins with 500 or more full-line comments, cases. In some cases, such as a file that begins with 500 or more full-line
the script may incorrectly decide that the code is in fixed form. If that comments, the script may incorrectly decide that the code is in fixed form.
happens, just add a non-comment statement beginning anywhere in the first five If that happens, just add a non-comment statement beginning anywhere in the
columns of the first twenty-five lines, save (:w), and then reload (:e!) the first five columns of the first twenty-five lines, save (:w), and then reload
file. (:e!) the file.
Vendor extensions ~ Vendor extensions ~
Fixed-form Fortran requires a maximum line length of 72 characters but the Fixed-form Fortran requires a maximum line length of 72 characters but the
@@ -1753,9 +1753,9 @@ define the vim variable 'lace_case_insensitive' in your startup file: >
LF (LFRC) *lf.vim* *ft-lf-syntax* *g:lf_shell_syntax* LF (LFRC) *lf.vim* *ft-lf-syntax* *g:lf_shell_syntax*
*b:lf_shell_syntax* *b:lf_shell_syntax*
For the lf file manager configuration files (lfrc) the shell commands For the lf file manager configuration files (lfrc) the shell commands syntax
syntax highlighting can be changed globally and per buffer by setting highlighting can be changed globally and per buffer by setting a different
a different 'include' command search pattern using these variables: 'include' command search pattern using these variables: >
let g:lf_shell_syntax = "syntax/dosbatch.vim" let g:lf_shell_syntax = "syntax/dosbatch.vim"
let b:lf_shell_syntax = "syntax/zsh.vim" let b:lf_shell_syntax = "syntax/zsh.vim"
@@ -2065,9 +2065,10 @@ set "msql_minlines" to the value you desire. Example: >
:let msql_minlines = 200 :let msql_minlines = 200
NEOMUTT *neomutt.vim* *ft-neomuttrc-syntax* *ft-neomuttlog-syntax* NEOMUTT *neomutt.vim* *ft-neomuttrc-syntax*
*ft-neomuttlog-syntax*
To disable the default NeoMutt log colors > To disable the default NeoMutt log colors: >
:let g:neolog_disable_default_colors = 1 :let g:neolog_disable_default_colors = 1
@@ -2236,9 +2237,9 @@ specified. Default = 1 >
:let g:pandoc#syntax#codeblocks#embeds#use = 1 :let g:pandoc#syntax#codeblocks#embeds#use = 1
For specify what languages and using what syntax files to highlight embeds. This is a For specify what languages and using what syntax files to highlight embeds.
list of language names. When the language pandoc and vim use don't match, you This is a list of language names. When the language pandoc and vim use don't
can use the "PANDOC=VIM" syntax. For example: > match, you can use the "PANDOC=VIM" syntax. For example: >
:let g:pandoc#syntax#codeblocks#embeds#langs = ["ruby", "bash=sh"] :let g:pandoc#syntax#codeblocks#embeds#langs = ["ruby", "bash=sh"]
@@ -3446,7 +3447,7 @@ set "tf_minlines" to the value you desire. Example: >
:let tf_minlines = your choice :let tf_minlines = your choice
< <
TYPESCRIPT *typescript.vim* *ft-typescript-syntax* TYPESCRIPT *typescript.vim* *ft-typescript-syntax*
*typescriptreact.vim* *ft-typescriptreact-syntax* *typescriptreact.vim* *ft-typescriptreact-syntax*
There is one option to control the TypeScript syntax highlighting. There is one option to control the TypeScript syntax highlighting.

View File

@@ -184,7 +184,7 @@ g- Go to older text state. With a count repeat that many
g+ Go to newer text state. With a count repeat that many g+ Go to newer text state. With a count repeat that many
times. times.
*:lat* *:later* *:lat* *:later*
:lat[er] {count} Go to newer text state {count} times. :lat[er] {count} Go to newer text state {count} times.
:lat[er] {N}s Go to newer text state about {N} seconds later. :lat[er] {N}s Go to newer text state about {N} seconds later.
:lat[er] {N}m Go to newer text state about {N} minutes later. :lat[er] {N}m Go to newer text state about {N} minutes later.
:lat[er] {N}h Go to newer text state about {N} hours later. :lat[er] {N}h Go to newer text state about {N} hours later.