adam/vim
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

runtime(doc): Normalise ellipsis dots in syntax.txt

Browse Source 
Use three dots rather than two.

closes: #18521

Signed-off-by: Doug Kearns <dougkearns@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Doug Kearns
2025-10-08 16:20:23 +00:00
committed by Christian Brabandt
parent d8ae4163e2
commit ec19075f61
1 changed files with 29 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
runtime/doc/syntax.txt
View File

@ -1,4 +1,4 @@
*syntax.txt* For Vim version 9.1. Last change: 2025 Oct 07 *syntax.txt* For Vim version 9.1. Last change: 2025 Oct 08
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -4284,9 +4284,9 @@ Vim understands three types of syntax items:
Several syntax ITEMs can be put into one syntax GROUP. For a syntax group Several syntax ITEMs can be put into one syntax GROUP. For a syntax group
you can give highlighting attributes. For example, you could have an item you can give highlighting attributes. For example, you could have an item
to define a "/* .. */" comment and another one that defines a "// .." comment, to define a "/* ... */" comment and another one that defines a "// ..."
and put them both in the "Comment" group. You can then specify that a comment, and put them both in the "Comment" group. You can then specify that
"Comment" will be in bold font and have a blue color. You are free to make a "Comment" will be in bold font and have a blue color. You are free to make
one highlight group for one syntax item, or put all items into one group. one highlight group for one syntax item, or put all items into one group.
This depends on how you want to specify your highlighting attributes. Putting This depends on how you want to specify your highlighting attributes. Putting
each item in its own group results in having to specify the highlighting each item in its own group results in having to specify the highlighting
@ -4486,9 +4486,9 @@ DEFINING REGIONS *:syn-region* *:syn-start* *:syn-skip* *:syn-end*
[keepend] [keepend]
[extend] [extend]
[excludenl] [excludenl]
start={start-pattern} .. start={start-pattern} ...
[skip={skip-pattern}] [skip={skip-pattern}]
end={end-pattern} .. end={end-pattern} ...
[{options}] [{options}]
This defines one region. It may span several lines. This defines one region. It may span several lines.
@ -4822,7 +4822,7 @@ from its syntax items.
*:syn-contains* *E405* *E406* *E407* *E408* *E409* *:syn-contains* *E405* *E406* *E407* *E408* *E409*
contains={group-name},.. contains={group-name},...
The "contains" argument is followed by a list of syntax group names. These The "contains" argument is followed by a list of syntax group names. These
groups will be allowed to begin inside the item (they may extend past the groups will be allowed to begin inside the item (they may extend past the
@ -4835,7 +4835,7 @@ contains=ALL
If the only item in the contains list is "ALL", then all If the only item in the contains list is "ALL", then all
groups will be accepted inside the item. groups will be accepted inside the item.
contains=ALLBUT,{group-name},.. contains=ALLBUT,{group-name},...
If the first item in the contains list is "ALLBUT", then all If the first item in the contains list is "ALLBUT", then all
groups will be accepted inside the item, except the ones that groups will be accepted inside the item, except the ones that
are listed. Example: > are listed. Example: >
@ -4845,14 +4845,14 @@ contains=TOP
If the first item in the contains list is "TOP", then all If the first item in the contains list is "TOP", then all
groups will be accepted that don't have the "contained" groups will be accepted that don't have the "contained"
argument. argument.
contains=TOP,{group-name},.. contains=TOP,{group-name},...
Like "TOP", but excluding the groups that are listed. Like "TOP", but excluding the groups that are listed.
contains=CONTAINED contains=CONTAINED
If the first item in the contains list is "CONTAINED", then If the first item in the contains list is "CONTAINED", then
all groups will be accepted that have the "contained" all groups will be accepted that have the "contained"
argument. argument.
contains=CONTAINED,{group-name},.. contains=CONTAINED,{group-name},...
Like "CONTAINED", but excluding the groups that are Like "CONTAINED", but excluding the groups that are
listed. listed.
@ -4875,7 +4875,7 @@ region where contained items do match. Note that this may also limit the
area that is highlighted area that is highlighted
containedin={group-name}... *:syn-containedin* containedin={group-name},... *:syn-containedin*
The "containedin" argument is followed by a list of syntax group names. The The "containedin" argument is followed by a list of syntax group names. The
item will be allowed to begin inside these groups. This works as if the item will be allowed to begin inside these groups. This works as if the
@ -4888,7 +4888,7 @@ neither contains this item via |:syn-contains| nor is named in this item's
Note that a |:syn-transparent| region still enforces its own |:syn-contains| Note that a |:syn-transparent| region still enforces its own |:syn-contains|
list. list.
The {group-name}... can be used just like for "contains", as explained above. The {group-name},... can be used just like for "contains", as explained above.
This is useful when adding a syntax item afterwards. An item can be told to This is useful when adding a syntax item afterwards. An item can be told to
be included inside an already existing item, without changing the definition be included inside an already existing item, without changing the definition
@ -4905,7 +4905,7 @@ work.
See also: |:syn-contains|, |:syn-transparent|. See also: |:syn-contains|, |:syn-transparent|.
nextgroup={group-name},.. *:syn-nextgroup* nextgroup={group-name},... *:syn-nextgroup*
The "nextgroup" argument is followed by a list of syntax group names, The "nextgroup" argument is followed by a list of syntax group names,
separated by commas (just like with "contains", so you can also use patterns). separated by commas (just like with "contains", so you can also use patterns).
@ -5161,22 +5161,22 @@ cannot be referred to.
============================================================================== ==============================================================================
9. Syntax clusters *:syn-cluster* *E400* 9. Syntax clusters *:syn-cluster* *E400*
:sy[ntax] cluster {cluster-name} [contains={group-name}..] :sy[ntax] cluster {cluster-name} [contains={group-name},...]
[add={group-name}..] [add={group-name},...]
[remove={group-name}..] [remove={group-name},...]
This command allows you to cluster a list of syntax groups together under a This command allows you to cluster a list of syntax groups together under a
single name. single name.
contains={group-name}.. contains={group-name},...
The cluster is set to the specified list of groups. The cluster is set to the specified list of groups.
add={group-name}.. add={group-name},...
The specified groups are added to the cluster. The specified groups are added to the cluster.
remove={group-name}.. remove={group-name},...
The specified groups are removed from the cluster. The specified groups are removed from the cluster.
A cluster so defined may be referred to in a contains=.., containedin=.., A cluster so defined may be referred to in a contains=..., containedin=...,
nextgroup=.., add=.. or remove=.. list with a "@" prefix. You can also use nextgroup=..., add=... or remove=... list with a "@" prefix. You can also use
this notation to implicitly declare a cluster before specifying its contents. this notation to implicitly declare a cluster before specifying its contents.
Example: > Example: >
@ -5391,7 +5391,7 @@ highlighting. The reduced number of patterns means it will go (much)
faster.] faster.]
*syn-sync-grouphere* *E393* *E394* *syn-sync-grouphere* *E393* *E394*
:syntax sync match {sync-group-name} grouphere {group-name} "pattern" .. :syntax sync match {sync-group-name} grouphere {group-name} "pattern" ...
Define a match that is used for syncing. {group-name} is the Define a match that is used for syncing. {group-name} is the
name of a syntax group that follows just after the match. Parsing name of a syntax group that follows just after the match. Parsing
@ -5400,7 +5400,7 @@ faster.]
"NONE" can be used for when there is no syntax group after the match. "NONE" can be used for when there is no syntax group after the match.
*syn-sync-groupthere* *syn-sync-groupthere*
:syntax sync match {sync-group-name} groupthere {group-name} "pattern" .. :syntax sync match {sync-group-name} groupthere {group-name} "pattern" ...
Like "grouphere", but {group-name} is the name of a syntax group that Like "grouphere", but {group-name} is the name of a syntax group that
is to be used at the start of the line where searching for the sync is to be used at the start of the line where searching for the sync
@ -5413,8 +5413,8 @@ faster.]
it's a bit more complicated, because the "/*" and "*/" could appear it's a bit more complicated, because the "/*" and "*/" could appear
inside a string. That's left as an exercise to the reader...). inside a string. That's left as an exercise to the reader...).
:syntax sync match .. :syntax sync match ...
:syntax sync region .. :syntax sync region ...
Without a "groupthere" argument. Define a region or match that is Without a "groupthere" argument. Define a region or match that is
skipped while searching for a sync point. skipped while searching for a sync point.
@ -5435,7 +5435,7 @@ You can clear all sync settings with: >
:syntax sync clear :syntax sync clear
You can clear specific sync patterns with: > You can clear specific sync patterns with: >
:syntax sync clear {sync-group-name} .. :syntax sync clear {sync-group-name} ...
============================================================================== ==============================================================================
12. Listing syntax items *:syntax* *:sy* *:syn* *:syn-list* 12. Listing syntax items *:syntax* *:sy* *:syn* *:syn-list*
@ -5570,7 +5570,7 @@ in their own color.
Disable the highlighting for one highlight group. It Disable the highlighting for one highlight group. It
is _not_ set back to the default colors. is _not_ set back to the default colors.
:hi[ghlight] [default] {group-name} {key}={arg} .. :hi[ghlight] [default] {group-name} {key}={arg} ...
Add a highlight group, or change the highlighting for Add a highlight group, or change the highlighting for
an existing group. If a given color name is not an existing group. If a given color name is not
recognized, each `colors/lists/default.vim` found on recognized, each `colors/lists/default.vim` found on
@ -6209,11 +6209,11 @@ The command also deletes the "b:current_syntax" variable, since no syntax is
loaded after this command. loaded after this command.
To clean up specific syntax groups for the current buffer: > To clean up specific syntax groups for the current buffer: >
:syntax clear {group-name} .. :syntax clear {group-name} ...
This removes all patterns and keywords for {group-name}. This removes all patterns and keywords for {group-name}.
To clean up specific syntax group lists for the current buffer: > To clean up specific syntax group lists for the current buffer: >
:syntax clear @{grouplist-name} .. :syntax clear @{grouplist-name} ...
This sets {grouplist-name}'s contents to an empty list. This sets {grouplist-name}'s contents to an empty list.
*:syntax-off* *:syn-off* *:syntax-off* *:syn-off*