Mercurial > vim
annotate runtime/doc/syntax.txt @ 13100:656ab57d1ddc
update a few runtime files
commit https://github.com/vim/vim/commit/df980db69b831381c37c3e2973a6eefa10df305c
Author: Bram Moolenaar <Bram@vim.org>
Date: Sun Dec 24 13:22:00 2017 +0100
update a few runtime files
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Sun, 24 Dec 2017 13:30:05 +0100 |
| parents | 3b26420fc639 |
| children | 371ceeebbdaa |
| rev | line source |
|---|---|
|
13100
656ab57d1ddc
update a few runtime files
Christian Brabandt <cb@256bit.org>
parents:
12756
diff
changeset
|
1 *syntax.txt* For Vim version 8.0. Last change: 2017 Dec 22 |
| 7 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 5 | |
| 6 | |
| 7 Syntax highlighting *syntax* *syntax-highlighting* *coloring* | |
| 8 | |
| 9 Syntax highlighting enables Vim to show parts of the text in another font or | |
| 10 color. Those parts can be specific keywords or text matching a pattern. Vim | |
| 11 doesn't parse the whole file (to keep it fast), so the highlighting has its | |
| 12 limitations. Lexical highlighting might be a better name, but since everybody | |
| 13 calls it syntax highlighting we'll stick with that. | |
| 14 | |
| 15 Vim supports syntax highlighting on all terminals. But since most ordinary | |
| 16 terminals have very limited highlighting possibilities, it works best in the | |
| 17 GUI version, gvim. | |
| 18 | |
| 19 In the User Manual: | |
| 20 |usr_06.txt| introduces syntax highlighting. | |
| 21 |usr_44.txt| introduces writing a syntax file. | |
| 22 | |
| 23 1. Quick start |:syn-qstart| | |
| 24 2. Syntax files |:syn-files| | |
| 25 3. Syntax loading procedure |syntax-loading| | |
| 26 4. Syntax file remarks |:syn-file-remarks| | |
| 27 5. Defining a syntax |:syn-define| | |
| 28 6. :syntax arguments |:syn-arguments| | |
| 29 7. Syntax patterns |:syn-pattern| | |
| 30 8. Syntax clusters |:syn-cluster| | |
| 31 9. Including syntax files |:syn-include| | |
| 32 10. Synchronizing |:syn-sync| | |
| 33 11. Listing syntax items |:syntax| | |
| 34 12. Highlight command |:highlight| | |
| 35 13. Linking groups |:highlight-link| | |
| 36 14. Cleaning up |:syn-clear| | |
| 37 15. Highlighting tags |tag-highlight| | |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
38 16. Window-local syntax |:ownsyntax| |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
39 17. Color xterms |xterm-color| |
|
4764
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
40 18. When syntax is slow |:syntime| |
| 7 | 41 |
| 42 {Vi does not have any of these commands} | |
| 43 | |
| 44 Syntax highlighting is not available when the |+syntax| feature has been | |
| 45 disabled at compile time. | |
| 46 | |
| 47 ============================================================================== | |
| 48 1. Quick start *:syn-qstart* | |
| 49 | |
| 50 *:syn-enable* *:syntax-enable* | |
| 51 This command switches on syntax highlighting: > | |
| 52 | |
| 53 :syntax enable | |
| 54 | |
| 55 What this command actually does is to execute the command > | |
| 56 :source $VIMRUNTIME/syntax/syntax.vim | |
| 57 | |
| 58 If the VIM environment variable is not set, Vim will try to find | |
| 59 the path in another way (see |$VIMRUNTIME|). Usually this works just | |
| 60 fine. If it doesn't, try setting the VIM environment variable to the | |
| 61 directory where the Vim stuff is located. For example, if your syntax files | |
| 62 are in the "/usr/vim/vim50/syntax" directory, set $VIMRUNTIME to | |
| 63 "/usr/vim/vim50". You must do this in the shell, before starting Vim. | |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
64 This command also sources the |menu.vim| script when the GUI is running or |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
65 will start soon. See |'go-M'| about avoiding that. |
| 7 | 66 |
| 67 *:syn-on* *:syntax-on* | |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
68 The `:syntax enable` command will keep your current color settings. This |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
69 allows using `:highlight` commands to set your preferred colors before or |
| 7 | 70 after using this command. If you want Vim to overrule your settings with the |
| 71 defaults, use: > | |
| 72 :syntax on | |
| 73 < | |
| 74 *:hi-normal* *:highlight-normal* | |
| 75 If you are running in the GUI, you can get white text on a black background | |
| 76 with: > | |
| 77 :highlight Normal guibg=Black guifg=White | |
| 78 For a color terminal see |:hi-normal-cterm|. | |
| 79 For setting up your own colors syntax highlighting see |syncolor|. | |
| 80 | |
| 81 NOTE: The syntax files on MS-DOS and Windows have lines that end in <CR><NL>. | |
| 82 The files for Unix end in <NL>. This means you should use the right type of | |
| 83 file for your system. Although on MS-DOS and Windows the right format is | |
| 84 automatically selected if the 'fileformats' option is not empty. | |
| 85 | |
| 86 NOTE: When using reverse video ("gvim -fg white -bg black"), the default value | |
| 87 of 'background' will not be set until the GUI window is opened, which is after | |
| 819 | 88 reading the |gvimrc|. This will cause the wrong default highlighting to be |
| 7 | 89 used. To set the default value of 'background' before switching on |
| 819 | 90 highlighting, include the ":gui" command in the |gvimrc|: > |
| 7 | 91 |
| 92 :gui " open window and set default for 'background' | |
| 93 :syntax on " start highlighting, use 'background' to set colors | |
| 94 | |
| 819 | 95 NOTE: Using ":gui" in the |gvimrc| means that "gvim -f" won't start in the |
| 7 | 96 foreground! Use ":gui -f" then. |
| 97 | |
| 2520 | 98 *g:syntax_on* |
| 99 You can toggle the syntax on/off with this command: > | |
| 100 :if exists("g:syntax_on") | syntax off | else | syntax enable | endif | |
| 7 | 101 |
| 102 To put this into a mapping, you can use: > | |
| 2520 | 103 :map <F7> :if exists("g:syntax_on") <Bar> |
| 7 | 104 \ syntax off <Bar> |
| 105 \ else <Bar> | |
| 106 \ syntax enable <Bar> | |
| 107 \ endif <CR> | |
| 108 [using the |<>| notation, type this literally] | |
| 109 | |
| 1624 | 110 Details: |
| 7 | 111 The ":syntax" commands are implemented by sourcing a file. To see exactly how |
| 112 this works, look in the file: | |
| 113 command file ~ | |
| 114 :syntax enable $VIMRUNTIME/syntax/syntax.vim | |
| 115 :syntax on $VIMRUNTIME/syntax/syntax.vim | |
| 116 :syntax manual $VIMRUNTIME/syntax/manual.vim | |
| 117 :syntax off $VIMRUNTIME/syntax/nosyntax.vim | |
| 118 Also see |syntax-loading|. | |
| 119 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
120 NOTE: If displaying long lines is slow and switching off syntax highlighting |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
121 makes it fast, consider setting the 'synmaxcol' option to a lower value. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
122 |
| 7 | 123 ============================================================================== |
| 124 2. Syntax files *:syn-files* | |
| 125 | |
| 126 The syntax and highlighting commands for one language are normally stored in | |
| 127 a syntax file. The name convention is: "{name}.vim". Where {name} is the | |
| 128 name of the language, or an abbreviation (to fit the name in 8.3 characters, | |
| 129 a requirement in case the file is used on a DOS filesystem). | |
| 130 Examples: | |
| 131 c.vim perl.vim java.vim html.vim | |
| 132 cpp.vim sh.vim csh.vim | |
| 133 | |
| 134 The syntax file can contain any Ex commands, just like a vimrc file. But | |
| 135 the idea is that only commands for a specific language are included. When a | |
| 136 language is a superset of another language, it may include the other one, | |
| 137 for example, the cpp.vim file could include the c.vim file: > | |
| 138 :so $VIMRUNTIME/syntax/c.vim | |
| 139 | |
| 140 The .vim files are normally loaded with an autocommand. For example: > | |
| 141 :au Syntax c runtime! syntax/c.vim | |
| 142 :au Syntax cpp runtime! syntax/cpp.vim | |
| 143 These commands are normally in the file $VIMRUNTIME/syntax/synload.vim. | |
| 144 | |
| 145 | |
| 146 MAKING YOUR OWN SYNTAX FILES *mysyntaxfile* | |
| 147 | |
| 148 When you create your own syntax files, and you want to have Vim use these | |
| 149 automatically with ":syntax enable", do this: | |
| 150 | |
| 151 1. Create your user runtime directory. You would normally use the first item | |
| 152 of the 'runtimepath' option. Example for Unix: > | |
| 153 mkdir ~/.vim | |
| 154 | |
| 155 2. Create a directory in there called "syntax". For Unix: > | |
| 156 mkdir ~/.vim/syntax | |
| 157 | |
| 158 3. Write the Vim syntax file. Or download one from the internet. Then write | |
| 159 it in your syntax directory. For example, for the "mine" syntax: > | |
| 160 :w ~/.vim/syntax/mine.vim | |
| 161 | |
| 162 Now you can start using your syntax file manually: > | |
| 163 :set syntax=mine | |
| 164 You don't have to exit Vim to use this. | |
| 165 | |
| 166 If you also want Vim to detect the type of file, see |new-filetype|. | |
| 167 | |
| 168 If you are setting up a system with many users and you don't want each user | |
| 169 to add the same syntax file, you can use another directory from 'runtimepath'. | |
| 170 | |
| 171 | |
| 172 ADDING TO AN EXISTING SYNTAX FILE *mysyntaxfile-add* | |
| 173 | |
| 174 If you are mostly satisfied with an existing syntax file, but would like to | |
| 175 add a few items or change the highlighting, follow these steps: | |
| 176 | |
| 177 1. Create your user directory from 'runtimepath', see above. | |
| 178 | |
| 179 2. Create a directory in there called "after/syntax". For Unix: > | |
| 180 mkdir ~/.vim/after | |
| 181 mkdir ~/.vim/after/syntax | |
| 182 | |
| 183 3. Write a Vim script that contains the commands you want to use. For | |
| 184 example, to change the colors for the C syntax: > | |
| 185 highlight cComment ctermfg=Green guifg=Green | |
| 186 | |
| 187 4. Write that file in the "after/syntax" directory. Use the name of the | |
| 188 syntax, with ".vim" added. For our C syntax: > | |
| 189 :w ~/.vim/after/syntax/c.vim | |
| 190 | |
| 191 That's it. The next time you edit a C file the Comment color will be | |
| 192 different. You don't even have to restart Vim. | |
| 193 | |
| 169 | 194 If you have multiple files, you can use the filetype as the directory name. |
| 195 All the "*.vim" files in this directory will be used, for example: | |
| 196 ~/.vim/after/syntax/c/one.vim | |
| 197 ~/.vim/after/syntax/c/two.vim | |
| 198 | |
| 7 | 199 |
| 200 REPLACING AN EXISTING SYNTAX FILE *mysyntaxfile-replace* | |
| 201 | |
| 202 If you don't like a distributed syntax file, or you have downloaded a new | |
| 203 version, follow the same steps as for |mysyntaxfile| above. Just make sure | |
| 204 that you write the syntax file in a directory that is early in 'runtimepath'. | |
| 3445 | 205 Vim will only load the first syntax file found, assuming that it sets |
| 206 b:current_syntax. | |
| 7 | 207 |
| 208 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
209 NAMING CONVENTIONS *group-name* *{group-name}* *E669* *W18* |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
210 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
211 A syntax group name is to be used for syntax items that match the same kind of |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
212 thing. These are then linked to a highlight group that specifies the color. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
213 A syntax group name doesn't specify any color or attributes itself. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
214 |
| 7 | 215 The name for a highlight or syntax group must consist of ASCII letters, digits |
| 6647 | 216 and the underscore. As a regexp: "[a-zA-Z0-9_]*". However, Vim does not give |
| 217 an error when using other characters. | |
| 7 | 218 |
| 219 To be able to allow each user to pick his favorite set of colors, there must | |
| 220 be preferred names for highlight groups that are common for many languages. | |
| 221 These are the suggested group names (if syntax highlighting works properly | |
| 222 you can see the actual color, except for "Ignore"): | |
| 223 | |
| 224 *Comment any comment | |
| 225 | |
| 226 *Constant any constant | |
| 227 String a string constant: "this is a string" | |
| 228 Character a character constant: 'c', '\n' | |
| 229 Number a number constant: 234, 0xff | |
| 230 Boolean a boolean constant: TRUE, false | |
| 231 Float a floating point constant: 2.3e10 | |
| 232 | |
| 233 *Identifier any variable name | |
| 234 Function function name (also: methods for classes) | |
| 235 | |
| 236 *Statement any statement | |
| 237 Conditional if, then, else, endif, switch, etc. | |
| 238 Repeat for, do, while, etc. | |
| 239 Label case, default, etc. | |
| 240 Operator "sizeof", "+", "*", etc. | |
| 241 Keyword any other keyword | |
| 242 Exception try, catch, throw | |
| 243 | |
| 244 *PreProc generic Preprocessor | |
| 245 Include preprocessor #include | |
| 246 Define preprocessor #define | |
| 247 Macro same as Define | |
| 248 PreCondit preprocessor #if, #else, #endif, etc. | |
| 249 | |
| 250 *Type int, long, char, etc. | |
| 251 StorageClass static, register, volatile, etc. | |
| 252 Structure struct, union, enum, etc. | |
| 253 Typedef A typedef | |
| 254 | |
| 255 *Special any special symbol | |
| 256 SpecialChar special character in a constant | |
| 257 Tag you can use CTRL-] on this | |
| 258 Delimiter character that needs attention | |
| 259 SpecialComment special things inside a comment | |
| 260 Debug debugging statements | |
| 261 | |
| 262 *Underlined text that stands out, HTML links | |
| 263 | |
|
2386
fb8cce4174f0
Better text for 'concealcursor' in :options window.
Bram Moolenaar <bram@vim.org>
parents:
2378
diff
changeset
|
264 *Ignore left blank, hidden |hl-Ignore| |
| 7 | 265 |
| 266 *Error any erroneous construct | |
| 267 | |
| 268 *Todo anything that needs extra attention; mostly the | |
| 269 keywords TODO FIXME and XXX | |
| 270 | |
| 271 The names marked with * are the preferred groups; the others are minor groups. | |
| 272 For the preferred groups, the "syntax.vim" file contains default highlighting. | |
| 273 The minor groups are linked to the preferred groups, so they get the same | |
| 274 highlighting. You can override these defaults by using ":highlight" commands | |
| 275 after sourcing the "syntax.vim" file. | |
| 276 | |
| 277 Note that highlight group names are not case sensitive. "String" and "string" | |
| 278 can be used for the same group. | |
| 279 | |
| 280 The following names are reserved and cannot be used as a group name: | |
| 281 NONE ALL ALLBUT contains contained | |
| 282 | |
|
2386
fb8cce4174f0
Better text for 'concealcursor' in :options window.
Bram Moolenaar <bram@vim.org>
parents:
2378
diff
changeset
|
283 *hl-Ignore* |
|
fb8cce4174f0
Better text for 'concealcursor' in :options window.
Bram Moolenaar <bram@vim.org>
parents:
2378
diff
changeset
|
284 When using the Ignore group, you may also consider using the conceal |
|
fb8cce4174f0
Better text for 'concealcursor' in :options window.
Bram Moolenaar <bram@vim.org>
parents:
2378
diff
changeset
|
285 mechanism. See |conceal|. |
|
fb8cce4174f0
Better text for 'concealcursor' in :options window.
Bram Moolenaar <bram@vim.org>
parents:
2378
diff
changeset
|
286 |
| 7 | 287 ============================================================================== |
| 288 3. Syntax loading procedure *syntax-loading* | |
| 289 | |
| 290 This explains the details that happen when the command ":syntax enable" is | |
| 291 issued. When Vim initializes itself, it finds out where the runtime files are | |
| 292 located. This is used here as the variable |$VIMRUNTIME|. | |
| 293 | |
| 294 ":syntax enable" and ":syntax on" do the following: | |
| 295 | |
| 296 Source $VIMRUNTIME/syntax/syntax.vim | |
| 297 | | |
| 298 +- Clear out any old syntax by sourcing $VIMRUNTIME/syntax/nosyntax.vim | |
| 299 | | |
| 300 +- Source first syntax/synload.vim in 'runtimepath' | |
| 301 | | | |
| 302 | +- Setup the colors for syntax highlighting. If a color scheme is | |
| 303 | | defined it is loaded again with ":colors {name}". Otherwise | |
| 304 | | ":runtime! syntax/syncolor.vim" is used. ":syntax on" overrules | |
| 305 | | existing colors, ":syntax enable" only sets groups that weren't | |
| 306 | | set yet. | |
| 307 | | | |
| 308 | +- Set up syntax autocmds to load the appropriate syntax file when | |
| 309 | | the 'syntax' option is set. *synload-1* | |
| 310 | | | |
| 311 | +- Source the user's optional file, from the |mysyntaxfile| variable. | |
| 312 | This is for backwards compatibility with Vim 5.x only. *synload-2* | |
| 313 | | |
| 314 +- Do ":filetype on", which does ":runtime! filetype.vim". It loads any | |
| 315 | filetype.vim files found. It should always Source | |
| 316 | $VIMRUNTIME/filetype.vim, which does the following. | |
| 317 | | | |
| 318 | +- Install autocmds based on suffix to set the 'filetype' option | |
| 319 | | This is where the connection between file name and file type is | |
| 320 | | made for known file types. *synload-3* | |
| 321 | | | |
| 322 | +- Source the user's optional file, from the *myfiletypefile* | |
| 323 | | variable. This is for backwards compatibility with Vim 5.x only. | |
| 324 | | *synload-4* | |
| 325 | | | |
| 326 | +- Install one autocommand which sources scripts.vim when no file | |
| 327 | | type was detected yet. *synload-5* | |
| 328 | | | |
| 329 | +- Source $VIMRUNTIME/menu.vim, to setup the Syntax menu. |menu.vim| | |
| 330 | | |
| 331 +- Install a FileType autocommand to set the 'syntax' option when a file | |
| 332 | type has been detected. *synload-6* | |
| 333 | | |
| 334 +- Execute syntax autocommands to start syntax highlighting for each | |
| 335 already loaded buffer. | |
| 336 | |
| 337 | |
| 338 Upon loading a file, Vim finds the relevant syntax file as follows: | |
| 339 | |
| 340 Loading the file triggers the BufReadPost autocommands. | |
| 341 | | |
| 342 +- If there is a match with one of the autocommands from |synload-3| | |
| 343 | (known file types) or |synload-4| (user's file types), the 'filetype' | |
| 344 | option is set to the file type. | |
| 345 | | |
| 346 +- The autocommand at |synload-5| is triggered. If the file type was not | |
| 347 | found yet, then scripts.vim is searched for in 'runtimepath'. This | |
| 348 | should always load $VIMRUNTIME/scripts.vim, which does the following. | |
| 349 | | | |
| 350 | +- Source the user's optional file, from the *myscriptsfile* | |
| 351 | | variable. This is for backwards compatibility with Vim 5.x only. | |
| 352 | | | |
| 353 | +- If the file type is still unknown, check the contents of the file, | |
| 354 | again with checks like "getline(1) =~ pattern" as to whether the | |
| 355 | file type can be recognized, and set 'filetype'. | |
| 356 | | |
| 357 +- When the file type was determined and 'filetype' was set, this | |
| 358 | triggers the FileType autocommand |synload-6| above. It sets | |
| 359 | 'syntax' to the determined file type. | |
| 360 | | |
| 361 +- When the 'syntax' option was set above, this triggers an autocommand | |
| 362 | from |synload-1| (and |synload-2|). This find the main syntax file in | |
| 363 | 'runtimepath', with this command: | |
| 364 | runtime! syntax/<name>.vim | |
| 365 | | |
| 366 +- Any other user installed FileType or Syntax autocommands are | |
| 367 triggered. This can be used to change the highlighting for a specific | |
| 368 syntax. | |
| 369 | |
| 370 ============================================================================== | |
| 371 4. Syntax file remarks *:syn-file-remarks* | |
| 372 | |
| 373 *b:current_syntax-variable* | |
| 374 Vim stores the name of the syntax that has been loaded in the | |
| 375 "b:current_syntax" variable. You can use this if you want to load other | |
| 376 settings, depending on which syntax is active. Example: > | |
| 377 :au BufReadPost * if b:current_syntax == "csh" | |
| 378 :au BufReadPost * do-some-things | |
| 379 :au BufReadPost * endif | |
| 380 | |
| 381 | |
| 382 2HTML *2html.vim* *convert-to-HTML* | |
| 383 | |
| 384 This is not a syntax file itself, but a script that converts the current | |
|
5003
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
385 window into HTML. Vim opens a new window in which it builds the HTML file. |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
386 |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
387 After you save the resulting file, you can view it with any browser. The |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
388 colors should be exactly the same as you see them in Vim. With |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
389 |g:html_line_ids| you can jump to specific lines by adding (for example) #L123 |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
390 or #123 to the end of the URL in your browser's address bar. And with |
|
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4437
diff
changeset
|
391 |g:html_dynamic_folds| enabled, you can show or hide the text that is folded |
|
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4437
diff
changeset
|
392 in Vim. |
| 3713 | 393 |
| 7 | 394 You are not supposed to set the 'filetype' or 'syntax' option to "2html"! |
| 395 Source the script to convert the current file: > | |
| 396 | |
| 397 :runtime! syntax/2html.vim | |
| 398 < | |
| 3713 | 399 Many variables affect the output of 2html.vim; see below. Any of the on/off |
| 400 options listed below can be enabled or disabled by setting them explicitly to | |
| 401 the desired value, or restored to their default by removing the variable using | |
| 402 |:unlet|. | |
| 7 | 403 |
| 404 Remarks: | |
|
2496
a29075150aee
Improve handling of user settings in :TOhtml. Default to generating CSS.
Bram Moolenaar <bram@vim.org>
parents:
2494
diff
changeset
|
405 - Some truly ancient browsers may not show the background colors. |
| 7 | 406 - From most browsers you can also print the file (in color)! |
| 3713 | 407 - The latest TOhtml may actually work with older versions of Vim, but some |
| 2642 | 408 features such as conceal support will not function, and the colors may be |
| 409 incorrect for an old Vim without GUI support compiled in. | |
| 7 | 410 |
| 411 Here is an example how to run the script over all .c and .h files from a | |
| 412 Unix shell: > | |
| 413 for f in *.[ch]; do gvim -f +"syn on" +"run! syntax/2html.vim" +"wq" +"q" $f; done | |
| 414 < | |
| 3713 | 415 *g:html_start_line* *g:html_end_line* |
| 416 To restrict the conversion to a range of lines, use a range with the |:TOhtml| | |
| 417 command below, or set "g:html_start_line" and "g:html_end_line" to the first | |
| 418 and last line to be converted. Example, using the last set Visual area: > | |
| 419 | |
| 420 :let g:html_start_line = line("'<") | |
| 421 :let g:html_end_line = line("'>") | |
| 422 :runtime! syntax/2html.vim | |
| 423 < | |
| 424 *:TOhtml* | |
| 425 :[range]TOhtml The ":TOhtml" command is defined in a standard plugin. | |
| 426 This command will source |2html.vim| for you. When a | |
|
7176
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
427 range is given, this command sets |g:html_start_line| |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
428 and |g:html_end_line| to the start and end of the |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
429 range, respectively. Default range is the entire |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
430 buffer. |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
431 |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
432 If the current window is part of a |diff|, unless |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
433 |g:html_diff_one_file| is set, :TOhtml will convert |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
434 all windows which are part of the diff in the current |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
435 tab and place them side-by-side in a <table> element |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
436 in the generated HTML. With |g:html_line_ids| you can |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
437 jump to lines in specific windows with (for example) |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
438 #W1L42 for line 42 in the first diffed window, or |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
439 #W3L87 for line 87 in the third. |
| 3713 | 440 |
| 441 Examples: > | |
| 442 | |
| 443 :10,40TOhtml " convert lines 10-40 to html | |
| 444 :'<,'>TOhtml " convert current/last visual selection | |
| 445 :TOhtml " convert entire buffer | |
| 446 < | |
| 447 *g:html_diff_one_file* | |
| 448 Default: 0. | |
|
5003
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
449 When 0, and using |:TOhtml| all windows involved in a |diff| in the current tab |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
450 page are converted to HTML and placed side-by-side in a <table> element. When |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
451 1, only the current buffer is converted. |
| 3713 | 452 Example: > |
| 453 | |
| 454 let g:html_diff_one_file = 1 | |
| 455 < | |
| 456 *g:html_whole_filler* | |
| 457 Default: 0. | |
| 458 When 0, if |g:html_diff_one_file| is 1, a sequence of more than 3 filler lines | |
| 459 is displayed as three lines with the middle line mentioning the total number | |
| 460 of inserted lines. | |
| 461 When 1, always display all inserted lines as if |g:html_diff_one_file| were | |
| 462 not set. | |
| 463 > | |
| 464 :let g:html_whole_filler = 1 | |
| 465 < | |
| 466 *TOhtml-performance* *g:html_no_progress* | |
| 467 Default: 0. | |
| 468 When 0, display a progress bar in the statusline for each major step in the | |
| 469 2html.vim conversion process. | |
| 470 When 1, do not display the progress bar. This offers a minor speed improvement | |
| 471 but you won't have any idea how much longer the conversion might take; for big | |
| 472 files it can take a long time! | |
| 473 Example: > | |
| 474 | |
| 475 let g:html_no_progress = 1 | |
| 476 < | |
| 477 You can obtain better performance improvements by also instructing Vim to not | |
| 478 run interactively, so that too much time is not taken to redraw as the script | |
| 479 moves through the buffer, switches windows, and the like: > | |
| 480 | |
| 481 vim -E -s -c "let g:html_no_progress=1" -c "syntax on" -c "set ft=c" -c "runtime syntax/2html.vim" -cwqa myfile.c | |
| 482 < | |
| 483 Note that the -s flag prevents loading your .vimrc and any plugins, so you | |
| 484 need to explicitly source/enable anything that will affect the HTML | |
| 485 conversion. See |-E| and |-s-ex| for details. It is probably best to create a | |
| 486 script to replace all the -c commands and use it with the -u flag instead of | |
| 487 specifying each command separately. | |
| 488 | |
| 489 *g:html_number_lines* | |
| 490 Default: current 'number' setting. | |
| 491 When 0, buffer text is displayed in the generated HTML without line numbering. | |
| 492 When 1, a column of line numbers is added to the generated HTML with the same | |
| 493 highlighting as the line number column in Vim (|hl-LineNr|). | |
| 494 Force line numbers even if 'number' is not set: > | |
| 495 :let g:html_number_lines = 1 | |
| 496 Force to omit the line numbers: > | |
| 497 :let g:html_number_lines = 0 | |
| 498 Go back to the default to use 'number' by deleting the variable: > | |
| 499 :unlet g:html_number_lines | |
| 500 < | |
|
5003
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
501 *g:html_line_ids* |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
502 Default: 1 if |g:html_number_lines| is set, 0 otherwise. |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
503 When 1, adds an HTML id attribute to each line number, or to an empty <span> |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
504 inserted for that purpose if no line numbers are shown. This ID attribute |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
505 takes the form of L123 for single-buffer HTML pages, or W2L123 for diff-view |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
506 pages, and is used to jump to a specific line (in a specific window of a diff |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
507 view). Javascript is inserted to open any closed dynamic folds |
| 6180 | 508 (|g:html_dynamic_folds|) containing the specified line before jumping. The |
|
5003
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
509 javascript also allows omitting the window ID in the url, and the leading L. |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
510 For example: > |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
511 |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
512 page.html#L123 jumps to line 123 in a single-buffer file |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
513 page.html#123 does the same |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
514 |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
515 diff.html#W1L42 jumps to line 42 in the first window in a diff |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
516 diff.html#42 does the same |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
517 < |
| 3713 | 518 *g:html_use_css* |
| 519 Default: 1. | |
| 520 When 1, generate valid HTML 4.01 markup with CSS1 styling, supported in all | |
| 521 modern browsers and most old browsers. | |
| 522 When 0, generate <font> tags and similar outdated markup. This is not | |
| 523 recommended but it may work better in really old browsers, email clients, | |
| 524 forum posts, and similar situations where basic CSS support is unavailable. | |
| 525 Example: > | |
| 526 :let g:html_use_css = 0 | |
| 527 < | |
| 528 *g:html_ignore_conceal* | |
| 529 Default: 0. | |
| 530 When 0, concealed text is removed from the HTML and replaced with a character | |
| 531 from |:syn-cchar| or 'listchars' as appropriate, depending on the current | |
| 532 value of 'conceallevel'. | |
| 533 When 1, include all text from the buffer in the generated HTML, even if it is | |
| 534 |conceal|ed. | |
| 535 | |
| 536 Either of the following commands will ensure that all text in the buffer is | |
| 537 included in the generated HTML (unless it is folded): > | |
| 538 :let g:html_ignore_conceal = 1 | |
| 539 :setl conceallevel=0 | |
| 540 < | |
| 541 *g:html_ignore_folding* | |
| 542 Default: 0. | |
| 543 When 0, text in a closed fold is replaced by the text shown for the fold in | |
| 544 Vim (|fold-foldtext|). See |g:html_dynamic_folds| if you also want to allow | |
| 545 the user to expand the fold as in Vim to see the text inside. | |
| 546 When 1, include all text from the buffer in the generated HTML; whether the | |
| 547 text is in a fold has no impact at all. |g:html_dynamic_folds| has no effect. | |
| 548 | |
| 549 Either of these commands will ensure that all text in the buffer is included | |
| 550 in the generated HTML (unless it is concealed): > | |
| 551 zR | |
| 552 :let g:html_ignore_folding = 1 | |
| 553 < | |
| 554 *g:html_dynamic_folds* | |
| 555 Default: 0. | |
| 556 When 0, text in a closed fold is not included at all in the generated HTML. | |
| 557 When 1, generate javascript to open a fold and show the text within, just like | |
| 558 in Vim. | |
| 559 | |
| 560 Setting this variable to 1 causes 2html.vim to always use CSS for styling, | |
| 561 regardless of what |g:html_use_css| is set to. | |
| 562 | |
| 563 This variable is ignored when |g:html_ignore_folding| is set. | |
| 564 > | |
| 565 :let g:html_dynamic_folds = 1 | |
| 566 < | |
| 567 *g:html_no_foldcolumn* | |
| 568 Default: 0. | |
| 569 When 0, if |g:html_dynamic_folds| is 1, generate a column of text similar to | |
| 570 Vim's foldcolumn (|fold-foldcolumn|) the user can click on to toggle folds | |
| 571 open or closed. The minimum width of the generated text column is the current | |
| 572 'foldcolumn' setting. | |
| 573 When 1, do not generate this column; instead, hovering the mouse cursor over | |
| 574 folded text will open the fold as if |g:html_hover_unfold| were set. | |
| 575 > | |
| 576 :let g:html_no_foldcolumn = 1 | |
| 577 < | |
| 578 *TOhtml-uncopyable-text* *g:html_prevent_copy* | |
| 579 Default: empty string. | |
| 580 This option prevents certain regions of the generated HTML from being copied, | |
| 581 when you select all text in document rendered in a browser and copy it. Useful | |
| 582 for allowing users to copy-paste only the source text even if a fold column or | |
| 583 line numbers are shown in the generated content. Specify regions to be | |
| 584 affected in this way as follows: | |
| 585 f: fold column | |
| 586 n: line numbers (also within fold text) | |
| 587 t: fold text | |
| 588 d: diff filler | |
| 589 | |
| 590 Example, to make the fold column and line numbers uncopyable: > | |
| 591 :let g:html_prevent_copy = "fn" | |
| 592 < | |
| 593 This feature is currently implemented by inserting read-only <input> elements | |
| 594 into the markup to contain the uncopyable areas. This does not work well in | |
| 595 all cases. When pasting to some applications which understand HTML, the | |
| 596 <input> elements also get pasted. But plain-text paste destinations should | |
| 597 always work. | |
| 598 | |
| 599 *g:html_no_invalid* | |
| 600 Default: 0. | |
| 601 When 0, if |g:html_prevent_copy| is non-empty, an invalid attribute is | |
| 602 intentionally inserted into the <input> element for the uncopyable areas. This | |
| 603 increases the number of applications you can paste to without also pasting the | |
| 604 <input> elements. Specifically, Microsoft Word will not paste the <input> | |
| 605 elements if they contain this invalid attribute. | |
| 606 When 1, no invalid markup is ever intentionally inserted, and the generated | |
| 607 page should validate. However, be careful pasting into Microsoft Word when | |
| 608 |g:html_prevent_copy| is non-empty; it can be hard to get rid of the <input> | |
| 609 elements which get pasted. | |
| 610 | |
| 611 *g:html_hover_unfold* | |
| 612 Default: 0. | |
| 613 When 0, the only way to open a fold generated by 2html.vim with | |
| 614 |g:html_dynamic_folds| set, is to click on the generated fold column. | |
| 615 When 1, use CSS 2.0 to allow the user to open a fold by moving the mouse | |
| 616 cursor over the displayed fold text. This is useful to allow users with | |
| 617 disabled javascript to view the folded text. | |
| 618 | |
| 619 Note that old browsers (notably Internet Explorer 6) will not support this | |
| 620 feature. Browser-specific markup for IE6 is included to fall back to the | |
| 621 normal CSS1 styling so that the folds show up correctly for this browser, but | |
| 622 they will not be openable without a foldcolumn. | |
| 623 > | |
| 624 :let g:html_hover_unfold = 1 | |
| 625 < | |
|
5003
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
626 *g:html_id_expr* |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
627 Default: "" |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
628 Dynamic folding and jumping to line IDs rely on unique IDs within the document |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
629 to work. If generated HTML is copied into a larger document, these IDs are no |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
630 longer guaranteed to be unique. Set g:html_id_expr to an expression Vim can |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
631 evaluate to get a unique string to append to each ID used in a given document, |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
632 so that the full IDs will be unique even when combined with other content in a |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
633 larger HTML document. Example, to append _ and the buffer number to each ID: > |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
634 |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
635 :let g:html_id_expr = '"_".bufnr("%")' |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
636 < |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
637 To append a string "_mystring" to the end of each ID: > |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
638 |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
639 :let g:html_id_expr = '"_mystring"' |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
640 < |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
641 Note, when converting a diff view to HTML, the expression will only be |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
642 evaluated for the first window in the diff, and the result used for all the |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
643 windows. |
|
ad6996a23e3e
Updated runtime files. New version of TOhtml plugin.
Bram Moolenaar <bram@vim.org>
parents:
4992
diff
changeset
|
644 |
| 3713 | 645 *TOhtml-wrap-text* *g:html_pre_wrap* |
| 646 Default: current 'wrap' setting. | |
| 647 When 0, if |g:html_no_pre| is 0 or unset, the text in the generated HTML does | |
| 648 not wrap at the edge of the browser window. | |
| 649 When 1, if |g:html_use_css| is 1, the CSS 2.0 "white-space:pre-wrap" value is | |
| 650 used, causing the text to wrap at whitespace at the edge of the browser | |
| 651 window. | |
| 652 Explicitly enable text wrapping: > | |
| 653 :let g:html_pre_wrap = 1 | |
| 654 Explicitly disable wrapping: > | |
| 655 :let g:html_pre_wrap = 0 | |
| 656 Go back to default, determine wrapping from 'wrap' setting: > | |
| 657 :unlet g:html_pre_wrap | |
| 658 < | |
| 659 *g:html_no_pre* | |
| 660 Default: 0. | |
| 661 When 0, buffer text in the generated HTML is surrounded by <pre>...</pre> | |
| 662 tags. Series of whitespace is shown as in Vim without special markup, and tab | |
| 663 characters can be included literally (see |g:html_expand_tabs|). | |
| 664 When 1 (not recommended), the <pre> tags are omitted, and a plain <div> is | |
| 665 used instead. Whitespace is replaced by a series of character | |
| 666 references, and <br> is used to end each line. This is another way to allow | |
| 667 text in the generated HTML is wrap (see |g:html_pre_wrap|) which also works in | |
| 668 old browsers, but may cause noticeable differences between Vim's display and | |
| 669 the rendered page generated by 2html.vim. | |
| 670 > | |
| 671 :let g:html_no_pre = 1 | |
| 672 < | |
| 673 *g:html_expand_tabs* | |
| 674 Default: 1 if 'tabstop' is 8, 'expandtab' is 0, and no fold column or line | |
| 675 numbers occur in the generated HTML; | |
| 676 0 otherwise. | |
| 677 When 0, <Tab> characters in the buffer text are replaced with an appropriate | |
| 678 number of space characters, or references if |g:html_no_pre| is 1. | |
| 679 When 1, if |g:html_no_pre| is 0 or unset, <Tab> characters in the buffer text | |
| 680 are included as-is in the generated HTML. This is useful for when you want to | |
| 681 allow copy and paste from a browser without losing the actual whitespace in | |
| 682 the source document. Note that this can easily break text alignment and | |
| 683 indentation in the HTML, unless set by default. | |
| 684 | |
| 685 Force |2html.vim| to keep <Tab> characters: > | |
| 686 :let g:html_expand_tabs = 0 | |
| 687 < | |
| 688 Force tabs to be expanded: > | |
| 689 :let g:html_expand_tabs = 1 | |
| 690 < | |
| 691 *TOhtml-encoding-detect* *TOhtml-encoding* | |
| 692 It is highly recommended to set your desired encoding with | |
| 693 |g:html_use_encoding| for any content which will be placed on a web server. | |
| 694 | |
| 695 If you do not specify an encoding, |2html.vim| uses the preferred IANA name | |
| 696 for the current value of 'fileencoding' if set, or 'encoding' if not. | |
| 697 'encoding' is always used for certain 'buftype' values. 'fileencoding' will be | |
| 698 set to match the chosen document encoding. | |
| 699 | |
| 700 Automatic detection works for the encodings mentioned specifically by name in | |
| 701 |encoding-names|, but TOhtml will only automatically use those encodings with | |
| 702 wide browser support. However, you can override this to support specific | |
| 703 encodings that may not be automatically detected by default (see options | |
| 704 below). See http://www.iana.org/assignments/character-sets for the IANA names. | |
| 705 | |
| 706 Note, by default all Unicode encodings are converted to UTF-8 with no BOM in | |
| 707 the generated HTML, as recommended by W3C: | |
| 708 | |
| 709 http://www.w3.org/International/questions/qa-choosing-encodings | |
| 710 http://www.w3.org/International/questions/qa-byte-order-mark | |
| 711 | |
| 712 *g:html_use_encoding* | |
| 713 Default: none, uses IANA name for current 'fileencoding' as above. | |
| 714 To overrule all automatic charset detection, set g:html_use_encoding to the | |
| 715 name of the charset to be used. It is recommended to set this variable to | |
| 716 something widely supported, like UTF-8, for anything you will be hosting on a | |
| 717 webserver: > | |
| 718 :let g:html_use_encoding = "UTF-8" | |
| 719 You can also use this option to omit the line that specifies the charset | |
| 720 entirely, by setting g:html_use_encoding to an empty string (NOT recommended): > | |
| 721 :let g:html_use_encoding = "" | |
| 722 To go back to the automatic mechanism, delete the |g:html_use_encoding| | |
| 723 variable: > | |
| 724 :unlet g:html_use_encoding | |
| 725 < | |
| 726 *g:html_encoding_override* | |
| 727 Default: none, autoload/tohtml.vim contains default conversions for encodings | |
| 728 mentioned by name at |encoding-names|. | |
| 729 This option allows |2html.vim| to detect the correct 'fileencoding' when you | |
| 730 specify an encoding with |g:html_use_encoding| which is not in the default | |
| 731 list of conversions. | |
| 732 | |
| 733 This is a dictionary of charset-encoding pairs that will replace existing | |
| 734 pairs automatically detected by TOhtml, or supplement with new pairs. | |
| 735 | |
| 736 Detect the HTML charset "windows-1252" as the encoding "8bit-cp1252": > | |
| 737 :let g:html_encoding_override = {'windows-1252': '8bit-cp1252'} | |
| 738 < | |
| 739 *g:html_charset_override* | |
| 740 Default: none, autoload/tohtml.vim contains default conversions for encodings | |
| 741 mentioned by name at |encoding-names| and which have wide | |
| 742 browser support. | |
| 743 This option allows |2html.vim| to detect the HTML charset for any | |
| 744 'fileencoding' or 'encoding' which is not detected automatically. You can also | |
| 745 use it to override specific existing encoding-charset pairs. For example, | |
| 746 TOhtml will by default use UTF-8 for all Unicode/UCS encodings. To use UTF-16 | |
| 747 and UTF-32 instead, use: > | |
| 748 :let g:html_charset_override = {'ucs-4': 'UTF-32', 'utf-16': 'UTF-16'} | |
| 749 | |
| 750 Note that documents encoded in either UTF-32 or UTF-16 have known | |
| 751 compatibility problems with some major browsers. | |
| 752 | |
|
7176
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
753 *g:html_font* |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
754 Default: "monospace" |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
755 You can specify the font or fonts used in the converted document using |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
756 g:html_font. If this option is set to a string, then the value will be |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
757 surrounded with single quotes. If this option is set to a list then each list |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
758 item is surrounded by single quotes and the list is joined with commas. Either |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
759 way, "monospace" is added as the fallback generic family name and the entire |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
760 result used as the font family (using CSS) or font face (if not using CSS). |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
761 Examples: > |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
762 |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
763 " font-family: 'Consolas', monospace; |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
764 :let g:html_font = "Consolas" |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
765 |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
766 " font-family: 'DejaVu Sans Mono', 'Consolas', monospace; |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
767 :let g:html_font = ["DejaVu Sans Mono", "Consolas"] |
|
30042ddff503
commit https://github.com/vim/vim/commit/60cce2fb736c8ff6fdb9603f502d3c15f1f7a25d
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
768 < |
| 3713 | 769 *convert-to-XML* *convert-to-XHTML* *g:html_use_xhtml* |
| 770 Default: 0. | |
| 771 When 0, generate standard HTML 4.01 (strict when possible). | |
| 772 When 1, generate XHTML 1.0 instead (XML compliant HTML). | |
| 773 > | |
| 774 :let g:html_use_xhtml = 1 | |
| 775 < | |
| 7 | 776 |
| 501 | 777 ABEL *abel.vim* *ft-abel-syntax* |
| 7 | 778 |
| 779 ABEL highlighting provides some user-defined options. To enable them, assign | |
| 780 any value to the respective variable. Example: > | |
| 781 :let abel_obsolete_ok=1 | |
| 782 To disable them use ":unlet". Example: > | |
| 783 :unlet abel_obsolete_ok | |
| 784 | |
| 785 Variable Highlight ~ | |
| 786 abel_obsolete_ok obsolete keywords are statements, not errors | |
| 787 abel_cpp_comments_illegal do not interpret '//' as inline comment leader | |
| 788 | |
| 789 | |
| 1125 | 790 ADA |
| 791 | |
| 792 See |ft-ada-syntax| | |
| 7 | 793 |
| 794 | |
| 501 | 795 ANT *ant.vim* *ft-ant-syntax* |
| 7 | 796 |
| 797 The ant syntax file provides syntax highlighting for javascript and python | |
| 237 | 798 by default. Syntax highlighting for other script languages can be installed |
| 7 | 799 by the function AntSyntaxScript(), which takes the tag name as first argument |
| 237 | 800 and the script syntax file name as second argument. Example: > |
| 7 | 801 |
| 802 :call AntSyntaxScript('perl', 'perl.vim') | |
| 803 | |
| 804 will install syntax perl highlighting for the following ant code > | |
| 805 | |
| 806 <script language = 'perl'><![CDATA[ | |
| 807 # everything inside is highlighted as perl | |
| 808 ]]></script> | |
| 809 | |
| 810 See |mysyntaxfile-add| for installing script languages permanently. | |
| 811 | |
| 812 | |
| 501 | 813 APACHE *apache.vim* *ft-apache-syntax* |
| 7 | 814 |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
815 The apache syntax file provides syntax highlighting for Apache HTTP server |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
816 version 2.2.3. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
817 |
| 7 | 818 |
| 819 *asm.vim* *asmh8300.vim* *nasm.vim* *masm.vim* *asm68k* | |
| 501 | 820 ASSEMBLY *ft-asm-syntax* *ft-asmh8300-syntax* *ft-nasm-syntax* |
| 821 *ft-masm-syntax* *ft-asm68k-syntax* *fasm.vim* | |
| 7 | 822 |
| 823 Files matching "*.i" could be Progress or Assembly. If the automatic detection | |
| 824 doesn't work for you, or you don't edit Progress at all, use this in your | |
| 825 startup vimrc: > | |
| 826 :let filetype_i = "asm" | |
| 827 Replace "asm" with the type of assembly you use. | |
| 828 | |
| 829 There are many types of assembly languages that all use the same file name | |
| 830 extensions. Therefore you will have to select the type yourself, or add a | |
| 831 line in the assembly file that Vim will recognize. Currently these syntax | |
| 832 files are included: | |
| 833 asm GNU assembly (the default) | |
| 834 asm68k Motorola 680x0 assembly | |
| 835 asmh8300 Hitachi H-8300 version of GNU assembly | |
| 836 ia64 Intel Itanium 64 | |
| 837 fasm Flat assembly (http://flatassembler.net) | |
| 838 masm Microsoft assembly (probably works for any 80x86) | |
| 839 nasm Netwide assembly | |
| 840 tasm Turbo Assembly (with opcodes 80x86 up to Pentium, and | |
| 841 MMX) | |
| 842 pic PIC assembly (currently for PIC16F84) | |
| 843 | |
| 844 The most flexible is to add a line in your assembly file containing: > | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
845 asmsyntax=nasm |
| 7 | 846 Replace "nasm" with the name of the real assembly syntax. This line must be |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
847 one of the first five lines in the file. No non-white text must be |
| 3682 | 848 immediately before or after this text. Note that specifying asmsyntax=foo is |
| 849 equivalent to setting ft=foo in a |modeline|, and that in case of a conflict | |
| 850 between the two settings the one from the modeline will take precedence (in | |
| 851 particular, if you have ft=asm in the modeline, you will get the GNU syntax | |
| 852 highlighting regardless of what is specified as asmsyntax). | |
| 7 | 853 |
| 854 The syntax type can always be overruled for a specific buffer by setting the | |
| 855 b:asmsyntax variable: > | |
| 1624 | 856 :let b:asmsyntax = "nasm" |
| 7 | 857 |
| 858 If b:asmsyntax is not set, either automatically or by hand, then the value of | |
| 859 the global variable asmsyntax is used. This can be seen as a default assembly | |
| 860 language: > | |
| 1624 | 861 :let asmsyntax = "nasm" |
| 7 | 862 |
| 863 As a last resort, if nothing is defined, the "asm" syntax is used. | |
| 864 | |
| 865 | |
| 866 Netwide assembler (nasm.vim) optional highlighting ~ | |
| 867 | |
| 868 To enable a feature: > | |
| 869 :let {variable}=1|set syntax=nasm | |
| 870 To disable a feature: > | |
| 871 :unlet {variable} |set syntax=nasm | |
| 872 | |
| 873 Variable Highlight ~ | |
| 874 nasm_loose_syntax unofficial parser allowed syntax not as Error | |
| 875 (parser dependent; not recommended) | |
| 876 nasm_ctx_outside_macro contexts outside macro not as Error | |
| 877 nasm_no_warn potentially risky syntax not as ToDo | |
| 878 | |
| 879 | |
| 501 | 880 ASPPERL and ASPVBS *ft-aspperl-syntax* *ft-aspvbs-syntax* |
| 7 | 881 |
| 882 *.asp and *.asa files could be either Perl or Visual Basic script. Since it's | |
| 883 hard to detect this you can set two global variables to tell Vim what you are | |
| 884 using. For Perl script use: > | |
| 885 :let g:filetype_asa = "aspperl" | |
| 886 :let g:filetype_asp = "aspperl" | |
| 887 For Visual Basic use: > | |
| 888 :let g:filetype_asa = "aspvbs" | |
| 889 :let g:filetype_asp = "aspvbs" | |
| 890 | |
| 891 | |
| 856 | 892 BAAN *baan.vim* *baan-syntax* |
| 844 | 893 |
| 894 The baan.vim gives syntax support for BaanC of release BaanIV upto SSA ERP LN | |
| 895 for both 3 GL and 4 GL programming. Large number of standard defines/constants | |
| 896 are supported. | |
| 897 | |
| 898 Some special violation of coding standards will be signalled when one specify | |
| 899 in ones |.vimrc|: > | |
| 900 let baan_code_stds=1 | |
| 901 | |
| 902 *baan-folding* | |
| 903 | |
| 904 Syntax folding can be enabled at various levels through the variables | |
| 905 mentioned below (Set those in your |.vimrc|). The more complex folding on | |
| 906 source blocks and SQL can be CPU intensive. | |
| 907 | |
| 908 To allow any folding and enable folding at function level use: > | |
| 909 let baan_fold=1 | |
| 910 Folding can be enabled at source block level as if, while, for ,... The | |
| 911 indentation preceding the begin/end keywords has to match (spaces are not | |
| 912 considered equal to a tab). > | |
| 913 let baan_fold_block=1 | |
| 914 Folding can be enabled for embedded SQL blocks as SELECT, SELECTDO, | |
| 856 | 915 SELECTEMPTY, ... The indentation preceding the begin/end keywords has to |
| 844 | 916 match (spaces are not considered equal to a tab). > |
| 917 let baan_fold_sql=1 | |
| 856 | 918 Note: Block folding can result in many small folds. It is suggested to |:set| |
| 844 | 919 the options 'foldminlines' and 'foldnestmax' in |.vimrc| or use |:setlocal| in |
| 920 .../after/syntax/baan.vim (see |after-directory|). Eg: > | |
| 921 set foldminlines=5 | |
| 922 set foldnestmax=6 | |
| 923 | |
| 924 | |
| 501 | 925 BASIC *basic.vim* *vb.vim* *ft-basic-syntax* *ft-vb-syntax* |
| 7 | 926 |
| 927 Both Visual Basic and "normal" basic use the extension ".bas". To detect | |
| 928 which one should be used, Vim checks for the string "VB_Name" in the first | |
| 929 five lines of the file. If it is not found, filetype will be "basic", | |
| 930 otherwise "vb". Files with the ".frm" extension will always be seen as Visual | |
| 931 Basic. | |
| 932 | |
| 933 | |
| 501 | 934 C *c.vim* *ft-c-syntax* |
| 7 | 935 |
| 936 A few things in C highlighting are optional. To enable them assign any value | |
| 937 to the respective variable. Example: > | |
| 1624 | 938 :let c_comment_strings = 1 |
| 7 | 939 To disable them use ":unlet". Example: > |
| 940 :unlet c_comment_strings | |
| 941 | |
| 942 Variable Highlight ~ | |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
943 *c_gnu* GNU gcc specific items |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
944 *c_comment_strings* strings and numbers inside a comment |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
945 *c_space_errors* trailing white space and spaces before a <Tab> |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
946 *c_no_trail_space_error* ... but no trailing spaces |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
947 *c_no_tab_space_error* ... but no spaces before a <Tab> |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
948 *c_no_bracket_error* don't highlight {}; inside [] as errors |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
949 *c_no_curly_error* don't highlight {}; inside [] and () as errors; |
| 140 | 950 except { and } in first column |
|
9860
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
951 Default is to highlight them, otherwise you |
|
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
952 can't spot a missing ")". |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
953 *c_curly_error* highlight a missing }; this forces syncing from the |
| 1624 | 954 start of the file, can be slow |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
955 *c_no_ansi* don't do standard ANSI types and constants |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
956 *c_ansi_typedefs* ... but do standard ANSI types |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
957 *c_ansi_constants* ... but do standard ANSI constants |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
958 *c_no_utf* don't highlight \u and \U in strings |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
959 *c_syntax_for_h* for *.h files use C syntax instead of C++ and use objc |
| 3445 | 960 syntax instead of objcpp |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
961 *c_no_if0* don't highlight "#if 0" blocks as comments |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
962 *c_no_cformat* don't highlight %-formats in strings |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
963 *c_no_c99* don't highlight C99 standard items |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
964 *c_no_c11* don't highlight C11 standard items |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
965 *c_no_bsd* don't highlight BSD specific types |
| 7 | 966 |
| 36 | 967 When 'foldmethod' is set to "syntax" then /* */ comments and { } blocks will |
| 968 become a fold. If you don't want comments to become a fold use: > | |
| 969 :let c_no_comment_fold = 1 | |
| 842 | 970 "#if 0" blocks are also folded, unless: > |
| 971 :let c_no_if0_fold = 1 | |
| 36 | 972 |
| 7 | 973 If you notice highlighting errors while scrolling backwards, which are fixed |
| 974 when redrawing with CTRL-L, try setting the "c_minlines" internal variable | |
| 975 to a larger number: > | |
| 976 :let c_minlines = 100 | |
| 977 This will make the syntax synchronization start 100 lines before the first | |
| 978 displayed line. The default value is 50 (15 when c_no_if0 is set). The | |
| 979 disadvantage of using a larger number is that redrawing can become slow. | |
| 980 | |
| 981 When using the "#if 0" / "#endif" comment highlighting, notice that this only | |
| 982 works when the "#if 0" is within "c_minlines" from the top of the window. If | |
| 983 you have a long "#if 0" construct it will not be highlighted correctly. | |
| 984 | |
| 985 To match extra items in comments, use the cCommentGroup cluster. | |
| 986 Example: > | |
| 987 :au Syntax c call MyCadd() | |
| 988 :function MyCadd() | |
| 989 : syn keyword cMyItem contained Ni | |
| 990 : syn cluster cCommentGroup add=cMyItem | |
| 991 : hi link cMyItem Title | |
| 992 :endfun | |
| 993 | |
| 994 ANSI constants will be highlighted with the "cConstant" group. This includes | |
| 995 "NULL", "SIG_IGN" and others. But not "TRUE", for example, because this is | |
| 996 not in the ANSI standard. If you find this confusing, remove the cConstant | |
| 997 highlighting: > | |
| 998 :hi link cConstant NONE | |
| 999 | |
| 1000 If you see '{' and '}' highlighted as an error where they are OK, reset the | |
| 1001 highlighting for cErrInParen and cErrInBracket. | |
| 1002 | |
| 1003 If you want to use folding in your C files, you can add these lines in a file | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
1004 in the "after" directory in 'runtimepath'. For Unix this would be |
| 7 | 1005 ~/.vim/after/syntax/c.vim. > |
| 1006 syn sync fromstart | |
| 1007 set foldmethod=syntax | |
| 1008 | |
| 501 | 1009 CH *ch.vim* *ft-ch-syntax* |
| 22 | 1010 |
| 1011 C/C++ interpreter. Ch has similar syntax highlighting to C and builds upon | |
| 1012 the C syntax file. See |c.vim| for all the settings that are available for C. | |
| 1013 | |
| 1014 By setting a variable you can tell Vim to use Ch syntax for *.h files, instead | |
| 1015 of C or C++: > | |
| 1016 :let ch_syntax_for_h = 1 | |
| 1017 | |
| 7 | 1018 |
| 501 | 1019 CHILL *chill.vim* *ft-chill-syntax* |
| 7 | 1020 |
| 1021 Chill syntax highlighting is similar to C. See |c.vim| for all the settings | |
| 1022 that are available. Additionally there is: | |
| 1023 | |
| 1024 chill_space_errors like c_space_errors | |
| 1025 chill_comment_string like c_comment_strings | |
| 1026 chill_minlines like c_minlines | |
| 1027 | |
| 1028 | |
| 501 | 1029 CHANGELOG *changelog.vim* *ft-changelog-syntax* |
| 7 | 1030 |
| 1031 ChangeLog supports highlighting spaces at the start of a line. | |
| 1032 If you do not like this, add following line to your .vimrc: > | |
| 1033 let g:changelog_spacing_errors = 0 | |
| 1034 This works the next time you edit a changelog file. You can also use | |
| 1035 "b:changelog_spacing_errors" to set this per buffer (before loading the syntax | |
| 1036 file). | |
| 1037 | |
| 1038 You can change the highlighting used, e.g., to flag the spaces as an error: > | |
| 1039 :hi link ChangelogError Error | |
| 1040 Or to avoid the highlighting: > | |
| 1041 :hi link ChangelogError NONE | |
| 1042 This works immediately. | |
| 1043 | |
| 1044 | |
| 5763 | 1045 CLOJURE *ft-clojure-syntax* |
| 1046 | |
|
9644
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1047 The default syntax groups can be augmented through the |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1048 *g:clojure_syntax_keywords* and *b:clojure_syntax_keywords* variables. The |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1049 value should be a |Dictionary| of syntax group names to a |List| of custom |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1050 identifiers: |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1051 > |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1052 let g:clojure_syntax_keywords = { |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1053 \ 'clojureMacro': ["defproject", "defcustom"], |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1054 \ 'clojureFunc': ["string/join", "string/replace"] |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1055 \ } |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1056 < |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1057 Refer to the Clojure syntax script for valid syntax group names. |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1058 |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1059 If the |buffer-variable| *b:clojure_syntax_without_core_keywords* is set, only |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1060 language constants and special forms are matched. |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1061 |
| 5763 | 1062 Setting *g:clojure_fold* enables folding Clojure code via the syntax engine. |
| 1063 Any list, vector, or map that extends over more than one line can be folded | |
| 1064 using the standard Vim |fold-commands|. | |
| 1065 | |
| 1066 Please note that this option does not work with scripts that redefine the | |
| 1067 bracket syntax regions, such as rainbow-parentheses plugins. | |
| 1068 | |
| 1069 This option is off by default. | |
| 1070 > | |
| 1071 " Default | |
| 1072 let g:clojure_fold = 0 | |
| 1073 < | |
| 1074 | |
| 501 | 1075 COBOL *cobol.vim* *ft-cobol-syntax* |
| 7 | 1076 |
| 1077 COBOL highlighting has different needs for legacy code than it does for fresh | |
| 1078 development. This is due to differences in what is being done (maintenance | |
| 1079 versus development) and other factors. To enable legacy code highlighting, | |
| 1080 add this line to your .vimrc: > | |
| 1081 :let cobol_legacy_code = 1 | |
| 1082 To disable it again, use this: > | |
| 1083 :unlet cobol_legacy_code | |
| 1084 | |
| 1085 | |
| 501 | 1086 COLD FUSION *coldfusion.vim* *ft-coldfusion-syntax* |
| 7 | 1087 |
| 237 | 1088 The ColdFusion has its own version of HTML comments. To turn on ColdFusion |
| 7 | 1089 comment highlighting, add the following line to your startup file: > |
| 1090 | |
| 1091 :let html_wrong_comments = 1 | |
| 1092 | |
| 1093 The ColdFusion syntax file is based on the HTML syntax file. | |
| 1094 | |
| 1095 | |
| 4186 | 1096 CPP *cpp.vim* *ft-cpp-syntax* |
| 1097 | |
| 1098 Most of things are same as |ft-c-syntax|. | |
| 1099 | |
| 1100 Variable Highlight ~ | |
|
7183
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7176
diff
changeset
|
1101 cpp_no_cpp11 don't highlight C++11 standard items |
|
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
1102 cpp_no_cpp14 don't highlight C++14 standard items |
| 4186 | 1103 |
| 1104 | |
| 501 | 1105 CSH *csh.vim* *ft-csh-syntax* |
| 7 | 1106 |
| 1107 This covers the shell named "csh". Note that on some systems tcsh is actually | |
| 1108 used. | |
| 1109 | |
| 1110 Detecting whether a file is csh or tcsh is notoriously hard. Some systems | |
| 1111 symlink /bin/csh to /bin/tcsh, making it almost impossible to distinguish | |
| 1112 between csh and tcsh. In case VIM guesses wrong you can set the | |
| 2965 | 1113 "filetype_csh" variable. For using csh: *g:filetype_csh* |
| 1114 > | |
| 1115 :let g:filetype_csh = "csh" | |
| 7 | 1116 |
| 1117 For using tcsh: > | |
| 1118 | |
| 2965 | 1119 :let g:filetype_csh = "tcsh" |
| 7 | 1120 |
| 1121 Any script with a tcsh extension or a standard tcsh filename (.tcshrc, | |
| 1122 tcsh.tcshrc, tcsh.login) will have filetype tcsh. All other tcsh/csh scripts | |
| 237 | 1123 will be classified as tcsh, UNLESS the "filetype_csh" variable exists. If the |
| 7 | 1124 "filetype_csh" variable exists, the filetype will be set to the value of the |
| 1125 variable. | |
| 1126 | |
| 1127 | |
| 501 | 1128 CYNLIB *cynlib.vim* *ft-cynlib-syntax* |
| 7 | 1129 |
| 1130 Cynlib files are C++ files that use the Cynlib class library to enable | |
| 237 | 1131 hardware modelling and simulation using C++. Typically Cynlib files have a .cc |
| 7 | 1132 or a .cpp extension, which makes it very difficult to distinguish them from a |
| 237 | 1133 normal C++ file. Thus, to enable Cynlib highlighting for .cc files, add this |
| 7 | 1134 line to your .vimrc file: > |
| 1135 | |
| 1136 :let cynlib_cyntax_for_cc=1 | |
| 1137 | |
| 1138 Similarly for cpp files (this extension is only usually used in Windows) > | |
| 1139 | |
| 1140 :let cynlib_cyntax_for_cpp=1 | |
| 1141 | |
| 1142 To disable these again, use this: > | |
| 1143 | |
| 1144 :unlet cynlib_cyntax_for_cc | |
| 1145 :unlet cynlib_cyntax_for_cpp | |
| 1146 < | |
| 1147 | |
| 501 | 1148 CWEB *cweb.vim* *ft-cweb-syntax* |
| 7 | 1149 |
| 1150 Files matching "*.w" could be Progress or cweb. If the automatic detection | |
| 1151 doesn't work for you, or you don't edit Progress at all, use this in your | |
| 1152 startup vimrc: > | |
| 1153 :let filetype_w = "cweb" | |
| 1154 | |
| 1155 | |
| 501 | 1156 DESKTOP *desktop.vim* *ft-desktop-syntax* |
| 7 | 1157 |
| 1158 Primary goal of this syntax file is to highlight .desktop and .directory files | |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
1159 according to freedesktop.org standard: |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
1160 http://standards.freedesktop.org/desktop-entry-spec/latest/ |
| 7 | 1161 But actually almost none implements this standard fully. Thus it will |
| 237 | 1162 highlight all Unix ini files. But you can force strict highlighting according |
| 7 | 1163 to standard by placing this in your vimrc file: > |
| 1164 :let enforce_freedesktop_standard = 1 | |
| 1165 | |
| 1166 | |
| 6476 | 1167 DIFF *diff.vim* |
| 1168 | |
| 1169 The diff highlighting normally finds translated headers. This can be slow if | |
| 1170 there are very long lines in the file. To disable translations: > | |
| 1171 | |
| 1172 :let diff_translations = 0 | |
| 1173 | |
| 6583 | 1174 Also see |diff-slow|. |
| 1175 | |
| 6476 | 1176 |
| 501 | 1177 DIRCOLORS *dircolors.vim* *ft-dircolors-syntax* |
| 7 | 1178 |
| 1179 The dircolors utility highlighting definition has one option. It exists to | |
| 1180 provide compatibility with the Slackware GNU/Linux distributions version of | |
| 1181 the command. It adds a few keywords that are generally ignored by most | |
| 1182 versions. On Slackware systems, however, the utility accepts the keywords and | |
| 1183 uses them for processing. To enable the Slackware keywords add the following | |
| 1184 line to your startup file: > | |
| 1185 let dircolors_is_slackware = 1 | |
| 1186 | |
| 1187 | |
| 501 | 1188 DOCBOOK *docbk.vim* *ft-docbk-syntax* *docbook* |
| 2662 | 1189 DOCBOOK XML *docbkxml.vim* *ft-docbkxml-syntax* |
| 1190 DOCBOOK SGML *docbksgml.vim* *ft-docbksgml-syntax* | |
| 7 | 1191 |
| 1192 There are two types of DocBook files: SGML and XML. To specify what type you | |
| 1193 are using the "b:docbk_type" variable should be set. Vim does this for you | |
| 1194 automatically if it can recognize the type. When Vim can't guess it the type | |
| 1195 defaults to XML. | |
| 1196 You can set the type manually: > | |
| 1197 :let docbk_type = "sgml" | |
| 1198 or: > | |
| 1199 :let docbk_type = "xml" | |
| 1200 You need to do this before loading the syntax file, which is complicated. | |
| 1201 Simpler is setting the filetype to "docbkxml" or "docbksgml": > | |
| 1202 :set filetype=docbksgml | |
| 1203 or: > | |
| 1204 :set filetype=docbkxml | |
| 1205 | |
| 3967 | 1206 You can specify the DocBook version: > |
| 1207 :let docbk_ver = 3 | |
| 1208 When not set 4 is used. | |
| 1209 | |
| 7 | 1210 |
| 501 | 1211 DOSBATCH *dosbatch.vim* *ft-dosbatch-syntax* |
| 7 | 1212 |
| 1213 There is one option with highlighting DOS batch files. This covers new | |
| 1214 extensions to the Command Interpreter introduced with Windows 2000 and | |
| 1215 is controlled by the variable dosbatch_cmdextversion. For Windows NT | |
| 1216 this should have the value 1, and for Windows 2000 it should be 2. | |
| 1217 Select the version you want with the following line: > | |
| 1218 | |
| 15 | 1219 :let dosbatch_cmdextversion = 1 |
| 7 | 1220 |
| 1221 If this variable is not defined it defaults to a value of 2 to support | |
| 1222 Windows 2000. | |
| 1223 | |
| 15 | 1224 A second option covers whether *.btm files should be detected as type |
| 237 | 1225 "dosbatch" (MS-DOS batch files) or type "btm" (4DOS batch files). The latter |
| 1226 is used by default. You may select the former with the following line: > | |
| 15 | 1227 |
| 1228 :let g:dosbatch_syntax_for_btm = 1 | |
| 1229 | |
| 1230 If this variable is undefined or zero, btm syntax is selected. | |
| 1231 | |
| 1232 | |
| 832 | 1233 DOXYGEN *doxygen.vim* *doxygen-syntax* |
| 1234 | |
| 1235 Doxygen generates code documentation using a special documentation format | |
| 1698 | 1236 (similar to Javadoc). This syntax script adds doxygen highlighting to c, cpp, |
| 1237 idl and php files, and should also work with java. | |
| 832 | 1238 |
| 1224 | 1239 There are a few of ways to turn on doxygen formatting. It can be done |
| 1240 explicitly or in a modeline by appending '.doxygen' to the syntax of the file. | |
| 1241 Example: > | |
| 832 | 1242 :set syntax=c.doxygen |
| 1243 or > | |
| 1244 // vim:syntax=c.doxygen | |
| 1245 | |
| 3356 | 1246 It can also be done automatically for C, C++, C#, IDL and PHP files by setting |
| 1247 the global or buffer-local variable load_doxygen_syntax. This is done by | |
| 1248 adding the following to your .vimrc. > | |
| 832 | 1249 :let g:load_doxygen_syntax=1 |
| 1250 | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
1251 There are a couple of variables that have an effect on syntax highlighting, and |
| 832 | 1252 are to do with non-standard highlighting options. |
| 1253 | |
| 1254 Variable Default Effect ~ | |
| 1255 g:doxygen_enhanced_color | |
| 1256 g:doxygen_enhanced_colour 0 Use non-standard highlighting for | |
| 1257 doxygen comments. | |
| 1258 | |
| 1259 doxygen_my_rendering 0 Disable rendering of HTML bold, italic | |
| 1260 and html_my_rendering underline. | |
| 1261 | |
| 1262 doxygen_javadoc_autobrief 1 Set to 0 to disable javadoc autobrief | |
| 1263 colour highlighting. | |
| 1264 | |
| 1265 doxygen_end_punctuation '[.]' Set to regexp match for the ending | |
| 856 | 1266 punctuation of brief |
| 832 | 1267 |
| 1268 There are also some hilight groups worth mentioning as they can be useful in | |
| 1269 configuration. | |
| 1270 | |
| 1271 Highlight Effect ~ | |
| 1272 doxygenErrorComment The colour of an end-comment when missing | |
| 1273 punctuation in a code, verbatim or dot section | |
| 1274 doxygenLinkError The colour of an end-comment when missing the | |
| 1275 \endlink from a \link section. | |
| 1276 | |
| 7 | 1277 |
| 501 | 1278 DTD *dtd.vim* *ft-dtd-syntax* |
| 7 | 1279 |
| 237 | 1280 The DTD syntax highlighting is case sensitive by default. To disable |
| 7 | 1281 case-sensitive highlighting, add the following line to your startup file: > |
| 1282 | |
| 1283 :let dtd_ignore_case=1 | |
| 1284 | |
| 237 | 1285 The DTD syntax file will highlight unknown tags as errors. If |
| 7 | 1286 this is annoying, it can be turned off by setting: > |
| 1287 | |
| 1288 :let dtd_no_tag_errors=1 | |
| 1289 | |
| 1290 before sourcing the dtd.vim syntax file. | |
| 1291 Parameter entity names are highlighted in the definition using the | |
| 1292 'Type' highlighting group and 'Comment' for punctuation and '%'. | |
| 1293 Parameter entity instances are highlighted using the 'Constant' | |
| 1294 highlighting group and the 'Type' highlighting group for the | |
| 237 | 1295 delimiters % and ;. This can be turned off by setting: > |
| 7 | 1296 |
| 1297 :let dtd_no_param_entities=1 | |
| 1298 | |
| 1299 The DTD syntax file is also included by xml.vim to highlight included dtd's. | |
| 1300 | |
| 1301 | |
| 501 | 1302 EIFFEL *eiffel.vim* *ft-eiffel-syntax* |
| 7 | 1303 |
| 1304 While Eiffel is not case-sensitive, its style guidelines are, and the | |
| 237 | 1305 syntax highlighting file encourages their use. This also allows to |
| 1306 highlight class names differently. If you want to disable case-sensitive | |
| 7 | 1307 highlighting, add the following line to your startup file: > |
| 1308 | |
| 1309 :let eiffel_ignore_case=1 | |
| 1310 | |
| 1311 Case still matters for class names and TODO marks in comments. | |
| 1312 | |
| 1313 Conversely, for even stricter checks, add one of the following lines: > | |
| 1314 | |
| 1315 :let eiffel_strict=1 | |
| 1316 :let eiffel_pedantic=1 | |
| 1317 | |
| 1318 Setting eiffel_strict will only catch improper capitalization for the | |
| 1319 five predefined words "Current", "Void", "Result", "Precursor", and | |
| 1320 "NONE", to warn against their accidental use as feature or class names. | |
| 1321 | |
| 1322 Setting eiffel_pedantic will enforce adherence to the Eiffel style | |
| 1323 guidelines fairly rigorously (like arbitrary mixes of upper- and | |
| 1324 lowercase letters as well as outdated ways to capitalize keywords). | |
| 1325 | |
| 1326 If you want to use the lower-case version of "Current", "Void", | |
| 1327 "Result", and "Precursor", you can use > | |
| 1328 | |
| 1329 :let eiffel_lower_case_predef=1 | |
| 1330 | |
| 1331 instead of completely turning case-sensitive highlighting off. | |
| 1332 | |
| 1333 Support for ISE's proposed new creation syntax that is already | |
| 1334 experimentally handled by some compilers can be enabled by: > | |
| 1335 | |
| 1336 :let eiffel_ise=1 | |
| 1337 | |
| 237 | 1338 Finally, some vendors support hexadecimal constants. To handle them, add > |
| 7 | 1339 |
| 1340 :let eiffel_hex_constants=1 | |
| 1341 | |
| 1342 to your startup file. | |
| 1343 | |
| 1344 | |
| 5697 | 1345 EUPHORIA *euphoria3.vim* *euphoria4.vim* *ft-euphoria-syntax* |
| 1346 | |
| 1347 Two syntax highlighting files exists for Euphoria. One for Euphoria | |
| 1348 version 3.1.1, which is the default syntax highlighting file, and one for | |
| 1349 Euphoria version 4.0.5 or later. | |
| 1350 | |
| 1351 Euphoria version 3.1.1 (http://www.rapideuphoria.com/) is still necessary | |
| 1352 for developing applications for the DOS platform, which Euphoria version 4 | |
| 1353 (http://www.openeuphoria.org/) does not support. | |
| 1354 | |
| 1355 The following file extensions are auto-detected as Euphoria file type: | |
| 1356 | |
| 1357 *.e, *.eu, *.ew, *.ex, *.exu, *.exw | |
| 1358 *.E, *.EU, *.EW, *.EX, *.EXU, *.EXW | |
| 1359 | |
| 1360 To select syntax highlighting file for Euphoria, as well as for | |
| 1361 auto-detecting the *.e and *.E file extensions as Euphoria file type, | |
| 1362 add the following line to your startup file: > | |
| 1363 | |
| 1364 :let filetype_euphoria="euphoria3" | |
| 1365 | |
| 1366 or | |
| 1367 | |
| 1368 :let filetype_euphoria="euphoria4" | |
| 1369 | |
| 1370 | |
| 501 | 1371 ERLANG *erlang.vim* *ft-erlang-syntax* |
| 7 | 1372 |
| 4437 | 1373 Erlang is a functional programming language developed by Ericsson. Files with |
|
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4437
diff
changeset
|
1374 the following extensions are recognized as Erlang files: erl, hrl, yaws. |
| 4437 | 1375 |
| 1376 The BIFs (built-in functions) are highlighted by default. To disable this, | |
| 1377 put the following line in your vimrc: > | |
| 1378 | |
| 1379 :let g:erlang_highlight_bifs = 0 | |
| 1380 | |
| 1381 To enable highlighting some special atoms, put this in your vimrc: > | |
| 1382 | |
| 1383 :let g:erlang_highlight_special_atoms = 1 | |
| 7 | 1384 |
| 1385 | |
| 857 | 1386 FLEXWIKI *flexwiki.vim* *ft-flexwiki-syntax* |
| 1387 | |
| 1388 FlexWiki is an ASP.NET-based wiki package available at http://www.flexwiki.com | |
| 2826 | 1389 NOTE: this site currently doesn't work, on Wikipedia is mentioned that |
| 1390 development stopped in 2009. | |
| 857 | 1391 |
| 1392 Syntax highlighting is available for the most common elements of FlexWiki | |
| 1393 syntax. The associated ftplugin script sets some buffer-local options to make | |
| 1394 editing FlexWiki pages more convenient. FlexWiki considers a newline as the | |
| 1395 start of a new paragraph, so the ftplugin sets 'tw'=0 (unlimited line length), | |
| 1396 'wrap' (wrap long lines instead of using horizontal scrolling), 'linebreak' | |
| 1397 (to wrap at a character in 'breakat' instead of at the last char on screen), | |
| 1398 and so on. It also includes some keymaps that are disabled by default. | |
| 1399 | |
| 1400 If you want to enable the keymaps that make "j" and "k" and the cursor keys | |
| 1401 move up and down by display lines, add this to your .vimrc: > | |
| 1402 :let flexwiki_maps = 1 | |
| 1403 | |
| 1404 | |
| 501 | 1405 FORM *form.vim* *ft-form-syntax* |
| 7 | 1406 |
| 1407 The coloring scheme for syntax elements in the FORM file uses the default | |
| 1408 modes Conditional, Number, Statement, Comment, PreProc, Type, and String, | |
| 1275 | 1409 following the language specifications in 'Symbolic Manipulation with FORM' by |
| 7 | 1410 J.A.M. Vermaseren, CAN, Netherlands, 1991. |
| 1411 | |
| 1412 If you want include your own changes to the default colors, you have to | |
| 1413 redefine the following syntax groups: | |
| 1414 | |
| 1415 - formConditional | |
| 1416 - formNumber | |
| 1417 - formStatement | |
| 1418 - formHeaderStatement | |
| 1419 - formComment | |
| 1420 - formPreProc | |
| 1421 - formDirective | |
| 1422 - formType | |
| 1423 - formString | |
| 1424 | |
| 1425 Note that the form.vim syntax file implements FORM preprocessor commands and | |
| 1426 directives per default in the same syntax group. | |
| 1427 | |
| 1428 A predefined enhanced color mode for FORM is available to distinguish between | |
| 237 | 1429 header statements and statements in the body of a FORM program. To activate |
| 7 | 1430 this mode define the following variable in your vimrc file > |
| 1431 | |
| 1432 :let form_enhanced_color=1 | |
| 1433 | |
| 1434 The enhanced mode also takes advantage of additional color features for a dark | |
| 237 | 1435 gvim display. Here, statements are colored LightYellow instead of Yellow, and |
| 7 | 1436 conditionals are LightBlue for better distinction. |
| 1437 | |
| 1438 | |
| 501 | 1439 FORTRAN *fortran.vim* *ft-fortran-syntax* |
| 7 | 1440 |
| 1441 Default highlighting and dialect ~ | |
| 3256 | 1442 Highlighting appropriate for Fortran 2008 is used by default. This choice |
| 4992 | 1443 should be appropriate for most users most of the time because Fortran 2008 is |
| 1444 almost a superset of previous versions (Fortran 2003, 95, 90, and 77). | |
| 7 | 1445 |
| 1446 Fortran source code form ~ | |
| 3281 | 1447 Fortran code can be in either fixed or free source form. Note that the |
| 7 | 1448 syntax highlighting will not be correct if the form is incorrectly set. |
| 1449 | |
| 1450 When you create a new fortran file, the syntax script assumes fixed source | |
| 237 | 1451 form. If you always use free source form, then > |
| 7 | 1452 :let fortran_free_source=1 |
| 237 | 1453 in your .vimrc prior to the :syntax on command. If you always use fixed source |
| 7 | 1454 form, then > |
| 1455 :let fortran_fixed_source=1 | |
| 1456 in your .vimrc prior to the :syntax on command. | |
| 1457 | |
|
7384
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1458 If the form of the source code depends, in a non-standard way, upon the file |
|
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1459 extension, then it is most convenient to set fortran_free_source in a ftplugin |
|
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1460 file. For more information on ftplugin files, see |ftplugin|. Note that this |
|
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1461 will work only if the "filetype plugin indent on" command precedes the "syntax |
|
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1462 on" command in your .vimrc file. |
| 7 | 1463 |
| 1464 When you edit an existing fortran file, the syntax script will assume free | |
| 1465 source form if the fortran_free_source variable has been set, and assumes | |
| 237 | 1466 fixed source form if the fortran_fixed_source variable has been set. If |
| 7 | 1467 neither of these variables have been set, the syntax script attempts to |
|
7384
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1468 determine which source form has been used by examining the file extension |
|
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1469 using conventions common to the ifort, gfortran, Cray, NAG, and PathScale |
|
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1470 compilers (.f, .for, .f77 for fixed-source, .f90, .f95, .f03, .f08 for |
|
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1471 free-source). If none of this works, then the script examines the first five |
|
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1472 columns of the first 500 lines of your file. If no signs of free source form |
|
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1473 are detected, then the file is assumed to be in fixed source form. The |
|
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1474 algorithm should work in the vast majority of cases. In some cases, such as a |
|
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1475 file that begins with 500 or more full-line comments, the script may |
|
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1476 incorrectly decide that the fortran code is in fixed form. If that happens, |
|
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1477 just add a non-comment statement beginning anywhere in the first five columns |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
1478 of the first twenty-five lines, save (:w) and then reload (:e!) the file. |
| 7 | 1479 |
| 1480 Tabs in fortran files ~ | |
| 237 | 1481 Tabs are not recognized by the Fortran standards. Tabs are not a good idea in |
| 7 | 1482 fixed format fortran source code which requires fixed column boundaries. |
| 237 | 1483 Therefore, tabs are marked as errors. Nevertheless, some programmers like |
| 1484 using tabs. If your fortran files contain tabs, then you should set the | |
| 7 | 1485 variable fortran_have_tabs in your .vimrc with a command such as > |
| 1486 :let fortran_have_tabs=1 | |
| 237 | 1487 placed prior to the :syntax on command. Unfortunately, the use of tabs will |
| 7 | 1488 mean that the syntax file will not be able to detect incorrect margins. |
| 1489 | |
| 1490 Syntax folding of fortran files ~ | |
| 1491 If you wish to use foldmethod=syntax, then you must first set the variable | |
| 1492 fortran_fold with a command such as > | |
| 1493 :let fortran_fold=1 | |
| 1494 to instruct the syntax script to define fold regions for program units, that | |
| 1495 is main programs starting with a program statement, subroutines, function | |
| 237 | 1496 subprograms, block data subprograms, interface blocks, and modules. If you |
| 7 | 1497 also set the variable fortran_fold_conditionals with a command such as > |
| 1498 :let fortran_fold_conditionals=1 | |
| 1499 then fold regions will also be defined for do loops, if blocks, and select | |
| 237 | 1500 case constructs. If you also set the variable |
| 7 | 1501 fortran_fold_multilinecomments with a command such as > |
| 1502 :let fortran_fold_multilinecomments=1 | |
| 1503 then fold regions will also be defined for three or more consecutive comment | |
| 237 | 1504 lines. Note that defining fold regions can be slow for large files. |
| 7 | 1505 |
| 1506 If fortran_fold, and possibly fortran_fold_conditionals and/or | |
| 1507 fortran_fold_multilinecomments, have been set, then vim will fold your file if | |
| 237 | 1508 you set foldmethod=syntax. Comments or blank lines placed between two program |
| 7 | 1509 units are not folded because they are seen as not belonging to any program |
| 1510 unit. | |
| 1511 | |
| 1512 More precise fortran syntax ~ | |
| 1513 If you set the variable fortran_more_precise with a command such as > | |
| 1514 :let fortran_more_precise=1 | |
| 237 | 1515 then the syntax coloring will be more precise but slower. In particular, |
| 7 | 1516 statement labels used in do, goto and arithmetic if statements will be |
| 1517 recognized, as will construct names at the end of a do, if, select or forall | |
| 1518 construct. | |
| 1519 | |
| 1520 Non-default fortran dialects ~ | |
| 3281 | 1521 The syntax script supports two Fortran dialects: f08 and F. You will probably |
| 1522 find the default highlighting (f08) satisfactory. A few legacy constructs | |
| 1523 deleted or declared obsolescent in the 2008 standard are highlighted as todo | |
| 1524 items. | |
| 1525 | |
| 1526 If you use F, the advantage of setting the dialect appropriately is that | |
| 1527 other legacy features excluded from F will be highlighted as todo items and | |
| 4992 | 1528 that free source form will be assumed. |
| 3281 | 1529 |
| 1530 The dialect can be selected in various ways. If all your fortran files use | |
| 1531 the same dialect, set the global variable fortran_dialect in your .vimrc prior | |
| 1532 to your syntax on statement. The case-sensitive, permissible values of | |
| 1533 fortran_dialect are "f08" or "F". Invalid values of fortran_dialect are | |
| 1534 ignored. | |
| 1535 | |
| 1536 If the dialect depends upon the file extension, then it is most convenient to | |
| 1537 set a buffer-local variable in a ftplugin file. For more information on | |
| 1538 ftplugin files, see |ftplugin|. For example, if all your fortran files with | |
| 1539 an .f90 extension are written in the F subset, your ftplugin file should | |
| 1540 contain the code > | |
| 7 | 1541 let s:extfname = expand("%:e") |
| 1542 if s:extfname ==? "f90" | |
| 3281 | 1543 let b:fortran_dialect="F" |
| 7 | 1544 else |
| 3281 | 1545 unlet! b:fortran_dialect |
| 7 | 1546 endif |
| 1547 Note that this will work only if the "filetype plugin indent on" command | |
| 1548 precedes the "syntax on" command in your .vimrc file. | |
| 1549 | |
| 1550 Finer control is necessary if the file extension does not uniquely identify | |
| 3281 | 1551 the dialect. You can override the default dialect, on a file-by-file basis, |
| 1552 by including a comment with the directive "fortran_dialect=xx" (where xx=F or | |
| 1553 f08) in one of the first three lines in your file. For example, your older .f | |
| 1554 files may be legacy code but your newer ones may be F codes, and you would | |
| 1555 identify the latter by including in the first three lines of those files a | |
| 1556 Fortran comment of the form > | |
| 7 | 1557 ! fortran_dialect=F |
| 3281 | 1558 |
| 1559 For previous versions of the syntax, you may have set fortran_dialect to the | |
| 1560 now-obsolete values "f77", "f90", "f95", or "elf". Such settings will be | |
| 1561 silently handled as "f08". Users of "elf" may wish to experiment with "F" | |
| 4992 | 1562 instead. |
| 3281 | 1563 |
| 1564 The syntax/fortran.vim script contains embedded comments that tell you how to | |
| 1565 comment and/or uncomment some lines to (a) activate recognition of some | |
| 1566 non-standard, vendor-supplied intrinsics and (b) to prevent features deleted | |
| 1567 or declared obsolescent in the 2008 standard from being highlighted as todo | |
| 4992 | 1568 items. |
| 7 | 1569 |
| 1570 Limitations ~ | |
| 237 | 1571 Parenthesis checking does not catch too few closing parentheses. Hollerith |
| 1572 strings are not recognized. Some keywords may be highlighted incorrectly | |
| 7 | 1573 because Fortran90 has no reserved words. |
| 1574 | |
| 501 | 1575 For further information related to fortran, see |ft-fortran-indent| and |
| 1576 |ft-fortran-plugin|. | |
| 1577 | |
| 1578 | |
| 1579 FVWM CONFIGURATION FILES *fvwm.vim* *ft-fvwm-syntax* | |
| 7 | 1580 |
| 1581 In order for Vim to recognize Fvwm configuration files that do not match | |
| 1582 the patterns *fvwmrc* or *fvwm2rc* , you must put additional patterns | |
| 1583 appropriate to your system in your myfiletypes.vim file. For these | |
| 1584 patterns, you must set the variable "b:fvwm_version" to the major version | |
| 1585 number of Fvwm, and the 'filetype' option to fvwm. | |
| 1586 | |
| 1587 For example, to make Vim identify all files in /etc/X11/fvwm2/ | |
| 1588 as Fvwm2 configuration files, add the following: > | |
| 1589 | |
| 1590 :au! BufNewFile,BufRead /etc/X11/fvwm2/* let b:fvwm_version = 2 | | |
| 1591 \ set filetype=fvwm | |
| 1592 | |
| 1593 If you'd like Vim to highlight all valid color names, tell it where to | |
| 1594 find the color database (rgb.txt) on your system. Do this by setting | |
| 1595 "rgb_file" to its location. Assuming your color database is located | |
| 1596 in /usr/X11/lib/X11/, you should add the line > | |
| 1597 | |
| 1598 :let rgb_file = "/usr/X11/lib/X11/rgb.txt" | |
| 1599 | |
| 1600 to your .vimrc file. | |
| 1601 | |
| 1602 | |
| 501 | 1603 GSP *gsp.vim* *ft-gsp-syntax* |
| 7 | 1604 |
| 1605 The default coloring style for GSP pages is defined by |html.vim|, and | |
| 1606 the coloring for java code (within java tags or inline between backticks) | |
| 1607 is defined by |java.vim|. The following HTML groups defined in |html.vim| | |
| 1608 are redefined to incorporate and highlight inline java code: | |
| 1609 | |
| 1610 htmlString | |
| 1611 htmlValue | |
| 1612 htmlEndTag | |
| 1613 htmlTag | |
| 1614 htmlTagN | |
| 1615 | |
| 1616 Highlighting should look fine most of the places where you'd see inline | |
| 1617 java code, but in some special cases it may not. To add another HTML | |
| 1618 group where you will have inline java code where it does not highlight | |
| 1619 correctly, just copy the line you want from |html.vim| and add gspJava | |
| 1620 to the contains clause. | |
| 1621 | |
| 1622 The backticks for inline java are highlighted according to the htmlError | |
| 1623 group to make them easier to see. | |
| 1624 | |
| 1625 | |
| 501 | 1626 GROFF *groff.vim* *ft-groff-syntax* |
| 7 | 1627 |
| 1628 The groff syntax file is a wrapper for |nroff.vim|, see the notes | |
| 237 | 1629 under that heading for examples of use and configuration. The purpose |
| 7 | 1630 of this wrapper is to set up groff syntax extensions by setting the |
| 1631 filetype from a |modeline| or in a personal filetype definitions file | |
| 1632 (see |filetype.txt|). | |
| 1633 | |
| 1634 | |
| 501 | 1635 HASKELL *haskell.vim* *lhaskell.vim* *ft-haskell-syntax* |
| 7 | 1636 |
| 1637 The Haskell syntax files support plain Haskell code as well as literate | |
| 237 | 1638 Haskell code, the latter in both Bird style and TeX style. The Haskell |
| 7 | 1639 syntax highlighting will also highlight C preprocessor directives. |
| 1640 | |
| 1641 If you want to highlight delimiter characters (useful if you have a | |
| 1642 light-coloured background), add to your .vimrc: > | |
| 1643 :let hs_highlight_delimiters = 1 | |
| 1644 To treat True and False as keywords as opposed to ordinary identifiers, | |
| 1645 add: > | |
| 1646 :let hs_highlight_boolean = 1 | |
| 1647 To also treat the names of primitive types as keywords: > | |
| 1648 :let hs_highlight_types = 1 | |
| 1649 And to treat the names of even more relatively common types as keywords: > | |
| 1650 :let hs_highlight_more_types = 1 | |
| 1651 If you want to highlight the names of debugging functions, put in | |
| 1652 your .vimrc: > | |
| 1653 :let hs_highlight_debug = 1 | |
| 1654 | |
| 1655 The Haskell syntax highlighting also highlights C preprocessor | |
| 1656 directives, and flags lines that start with # but are not valid | |
| 237 | 1657 directives as erroneous. This interferes with Haskell's syntax for |
| 1658 operators, as they may start with #. If you want to highlight those | |
| 7 | 1659 as operators as opposed to errors, put in your .vimrc: > |
| 1660 :let hs_allow_hash_operator = 1 | |
| 1661 | |
| 1662 The syntax highlighting for literate Haskell code will try to | |
| 1663 automatically guess whether your literate Haskell code contains | |
| 1664 TeX markup or not, and correspondingly highlight TeX constructs | |
| 237 | 1665 or nothing at all. You can override this globally by putting |
| 7 | 1666 in your .vimrc > |
| 1667 :let lhs_markup = none | |
| 1668 for no highlighting at all, or > | |
| 1669 :let lhs_markup = tex | |
| 1670 to force the highlighting to always try to highlight TeX markup. | |
| 1671 For more flexibility, you may also use buffer local versions of | |
| 1672 this variable, so e.g. > | |
| 1673 :let b:lhs_markup = tex | |
| 237 | 1674 will force TeX highlighting for a particular buffer. It has to be |
| 7 | 1675 set before turning syntax highlighting on for the buffer or |
| 1676 loading a file. | |
| 1677 | |
| 1678 | |
| 501 | 1679 HTML *html.vim* *ft-html-syntax* |
| 7 | 1680 |
| 1681 The coloring scheme for tags in the HTML file works as follows. | |
| 1682 | |
| 1683 The <> of opening tags are colored differently than the </> of a closing tag. | |
| 1684 This is on purpose! For opening tags the 'Function' color is used, while for | |
| 1685 closing tags the 'Type' color is used (See syntax.vim to check how those are | |
| 1686 defined for you) | |
| 1687 | |
| 1688 Known tag names are colored the same way as statements in C. Unknown tag | |
| 1689 names are colored with the same color as the <> or </> respectively which | |
| 1690 makes it easy to spot errors | |
| 1691 | |
| 237 | 1692 Note that the same is true for argument (or attribute) names. Known attribute |
| 7 | 1693 names are colored differently than unknown ones. |
| 1694 | |
| 237 | 1695 Some HTML tags are used to change the rendering of text. The following tags |
| 7 | 1696 are recognized by the html.vim syntax coloring file and change the way normal |
| 1697 text is shown: <B> <I> <U> <EM> <STRONG> (<EM> is used as an alias for <I>, | |
| 1698 while <STRONG> as an alias for <B>), <H1> - <H6>, <HEAD>, <TITLE> and <A>, but | |
| 237 | 1699 only if used as a link (that is, it must include a href as in |
| 1224 | 1700 <A href="somefile.html">). |
| 7 | 1701 |
| 1702 If you want to change how such text is rendered, you must redefine the | |
| 1703 following syntax groups: | |
| 1704 | |
| 1705 - htmlBold | |
| 1706 - htmlBoldUnderline | |
| 1707 - htmlBoldUnderlineItalic | |
| 1708 - htmlUnderline | |
| 1709 - htmlUnderlineItalic | |
| 1710 - htmlItalic | |
| 1711 - htmlTitle for titles | |
| 1712 - htmlH1 - htmlH6 for headings | |
| 1713 | |
| 1714 To make this redefinition work you must redefine them all with the exception | |
| 1715 of the last two (htmlTitle and htmlH[1-6], which are optional) and define the | |
| 1716 following variable in your vimrc (this is due to the order in which the files | |
| 1717 are read during initialization) > | |
| 1718 :let html_my_rendering=1 | |
| 1719 | |
| 1720 If you'd like to see an example download mysyntax.vim at | |
| 1721 http://www.fleiner.com/vim/download.html | |
| 1722 | |
| 1723 You can also disable this rendering by adding the following line to your | |
| 1724 vimrc file: > | |
| 1725 :let html_no_rendering=1 | |
| 1726 | |
| 1727 HTML comments are rather special (see an HTML reference document for the | |
| 1728 details), and the syntax coloring scheme will highlight all errors. | |
| 1729 However, if you prefer to use the wrong style (starts with <!-- and | |
|
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
5968
diff
changeset
|
1730 ends with -->) you can define > |
| 7 | 1731 :let html_wrong_comments=1 |
| 1732 | |
| 1733 JavaScript and Visual Basic embedded inside HTML documents are highlighted as | |
| 1734 'Special' with statements, comments, strings and so on colored as in standard | |
| 237 | 1735 programming languages. Note that only JavaScript and Visual Basic are currently |
| 7 | 1736 supported, no other scripting language has been added yet. |
| 1737 | |
| 1738 Embedded and inlined cascading style sheets (CSS) are highlighted too. | |
| 1739 | |
| 237 | 1740 There are several html preprocessor languages out there. html.vim has been |
| 1741 written such that it should be trivial to include it. To do so add the | |
| 7 | 1742 following two lines to the syntax coloring file for that language |
| 1743 (the example comes from the asp.vim file): | |
| 1744 | |
| 1745 runtime! syntax/html.vim | |
| 1746 syn cluster htmlPreproc add=asp | |
| 1747 | |
| 1748 Now you just need to make sure that you add all regions that contain | |
| 1749 the preprocessor language to the cluster htmlPreproc. | |
| 1750 | |
| 1751 | |
| 501 | 1752 HTML/OS (by Aestiva) *htmlos.vim* *ft-htmlos-syntax* |
| 7 | 1753 |
| 1754 The coloring scheme for HTML/OS works as follows: | |
| 1755 | |
| 1756 Functions and variable names are the same color by default, because VIM | |
| 1757 doesn't specify different colors for Functions and Identifiers. To change | |
| 1758 this (which is recommended if you want function names to be recognizable in a | |
| 1759 different color) you need to add the following line to either your ~/.vimrc: > | |
| 1760 :hi Function term=underline cterm=bold ctermfg=LightGray | |
| 1761 | |
| 1762 Of course, the ctermfg can be a different color if you choose. | |
| 1763 | |
| 1764 Another issues that HTML/OS runs into is that there is no special filetype to | |
| 1765 signify that it is a file with HTML/OS coding. You can change this by opening | |
| 1766 a file and turning on HTML/OS syntax by doing the following: > | |
| 1767 :set syntax=htmlos | |
| 1768 | |
| 1769 Lastly, it should be noted that the opening and closing characters to begin a | |
| 1770 block of HTML/OS code can either be << or [[ and >> or ]], respectively. | |
| 1771 | |
| 1772 | |
| 501 | 1773 IA64 *ia64.vim* *intel-itanium* *ft-ia64-syntax* |
| 7 | 1774 |
| 1775 Highlighting for the Intel Itanium 64 assembly language. See |asm.vim| for | |
| 1776 how to recognize this filetype. | |
| 1777 | |
| 1778 To have *.inc files be recognized as IA64, add this to your .vimrc file: > | |
| 1779 :let g:filetype_inc = "ia64" | |
| 1780 | |
| 1781 | |
| 501 | 1782 INFORM *inform.vim* *ft-inform-syntax* |
| 7 | 1783 |
| 1784 Inform highlighting includes symbols provided by the Inform Library, as | |
| 1785 most programs make extensive use of it. If do not wish Library symbols | |
| 1786 to be highlighted add this to your vim startup: > | |
| 1787 :let inform_highlight_simple=1 | |
| 1788 | |
| 1789 By default it is assumed that Inform programs are Z-machine targeted, | |
| 1790 and highlights Z-machine assembly language symbols appropriately. If | |
| 1791 you intend your program to be targeted to a Glulx/Glk environment you | |
| 1792 need to add this to your startup sequence: > | |
| 1793 :let inform_highlight_glulx=1 | |
| 1794 | |
| 1795 This will highlight Glulx opcodes instead, and also adds glk() to the | |
| 1796 set of highlighted system functions. | |
| 1797 | |
| 1798 The Inform compiler will flag certain obsolete keywords as errors when | |
| 1799 it encounters them. These keywords are normally highlighted as errors | |
| 1800 by Vim. To prevent such error highlighting, you must add this to your | |
| 1801 startup sequence: > | |
| 1802 :let inform_suppress_obsolete=1 | |
| 1803 | |
| 1804 By default, the language features highlighted conform to Compiler | |
| 1805 version 6.30 and Library version 6.11. If you are using an older | |
| 1806 Inform development environment, you may with to add this to your | |
| 1807 startup sequence: > | |
| 1808 :let inform_highlight_old=1 | |
| 1809 | |
| 829 | 1810 IDL *idl.vim* *idl-syntax* |
| 1811 | |
| 1812 IDL (Interface Definition Language) files are used to define RPC calls. In | |
| 1813 Microsoft land, this is also used for defining COM interfaces and calls. | |
| 1814 | |
| 1815 IDL's structure is simple enough to permit a full grammar based approach to | |
| 1816 rather than using a few heuristics. The result is large and somewhat | |
| 1224 | 1817 repetitive but seems to work. |
| 829 | 1818 |
| 1819 There are some Microsoft extensions to idl files that are here. Some of them | |
| 1820 are disabled by defining idl_no_ms_extensions. | |
| 1821 | |
| 1822 The more complex of the extensions are disabled by defining idl_no_extensions. | |
| 1823 | |
| 1824 Variable Effect ~ | |
| 1825 | |
| 1826 idl_no_ms_extensions Disable some of the Microsoft specific | |
| 1827 extensions | |
| 1828 idl_no_extensions Disable complex extensions | |
| 1829 idlsyntax_showerror Show IDL errors (can be rather intrusive, but | |
| 1830 quite helpful) | |
| 1831 idlsyntax_showerror_soft Use softer colours by default for errors | |
| 1832 | |
| 7 | 1833 |
| 501 | 1834 JAVA *java.vim* *ft-java-syntax* |
| 7 | 1835 |
| 1836 The java.vim syntax highlighting file offers several options: | |
| 1837 | |
| 1838 In Java 1.0.2 it was never possible to have braces inside parens, so this was | |
| 1839 flagged as an error. Since Java 1.1 this is possible (with anonymous | |
| 237 | 1840 classes), and therefore is no longer marked as an error. If you prefer the old |
| 7 | 1841 way, put the following line into your vim startup file: > |
| 1842 :let java_mark_braces_in_parens_as_errors=1 | |
| 1843 | |
| 1844 All identifiers in java.lang.* are always visible in all classes. To | |
| 1845 highlight them use: > | |
| 1846 :let java_highlight_java_lang_ids=1 | |
| 1847 | |
| 237 | 1848 You can also highlight identifiers of most standard Java packages if you |
| 7 | 1849 download the javaid.vim script at http://www.fleiner.com/vim/download.html. |
| 1850 If you prefer to only highlight identifiers of a certain package, say java.io | |
| 1851 use the following: > | |
| 1852 :let java_highlight_java_io=1 | |
| 1853 Check the javaid.vim file for a list of all the packages that are supported. | |
| 1854 | |
| 1855 Function names are not highlighted, as the way to find functions depends on | |
| 237 | 1856 how you write Java code. The syntax file knows two possible ways to highlight |
| 7 | 1857 functions: |
| 1858 | |
| 1859 If you write function declarations that are always indented by either | |
| 1860 a tab, 8 spaces or 2 spaces you may want to set > | |
| 1861 :let java_highlight_functions="indent" | |
| 1862 However, if you follow the Java guidelines about how functions and classes are | |
| 1863 supposed to be named (with respect to upper and lowercase), use > | |
| 1864 :let java_highlight_functions="style" | |
| 1865 If both options do not work for you, but you would still want function | |
| 1866 declarations to be highlighted create your own definitions by changing the | |
| 1867 definitions in java.vim or by creating your own java.vim which includes the | |
| 1868 original one and then adds the code to highlight functions. | |
| 1869 | |
| 237 | 1870 In Java 1.1 the functions System.out.println() and System.err.println() should |
| 8 | 1871 only be used for debugging. Therefore it is possible to highlight debugging |
| 237 | 1872 statements differently. To do this you must add the following definition in |
| 7 | 1873 your startup file: > |
| 1874 :let java_highlight_debug=1 | |
| 1875 The result will be that those statements are highlighted as 'Special' | |
| 237 | 1876 characters. If you prefer to have them highlighted differently you must define |
| 7 | 1877 new highlightings for the following groups.: |
| 1878 Debug, DebugSpecial, DebugString, DebugBoolean, DebugType | |
| 1879 which are used for the statement itself, special characters used in debug | |
| 237 | 1880 strings, strings, boolean constants and types (this, super) respectively. I |
| 7 | 1881 have opted to chose another background for those statements. |
| 1882 | |
| 237 | 1883 Javadoc is a program that takes special comments out of Java program files and |
| 1884 creates HTML pages. The standard configuration will highlight this HTML code | |
| 1885 similarly to HTML files (see |html.vim|). You can even add Javascript | |
| 1886 and CSS inside this code (see below). There are four differences however: | |
| 7 | 1887 1. The title (all characters up to the first '.' which is followed by |
| 1888 some white space or up to the first '@') is colored differently (to change | |
| 1889 the color change the group CommentTitle). | |
| 1890 2. The text is colored as 'Comment'. | |
| 1891 3. HTML comments are colored as 'Special' | |
| 237 | 1892 4. The special Javadoc tags (@see, @param, ...) are highlighted as specials |
| 7 | 1893 and the argument (for @see, @param, @exception) as Function. |
| 1894 To turn this feature off add the following line to your startup file: > | |
| 1895 :let java_ignore_javadoc=1 | |
| 1896 | |
| 237 | 1897 If you use the special Javadoc comment highlighting described above you |
| 1898 can also turn on special highlighting for Javascript, visual basic | |
| 1899 scripts and embedded CSS (stylesheets). This makes only sense if you | |
| 1900 actually have Javadoc comments that include either Javascript or embedded | |
| 1901 CSS. The options to use are > | |
| 7 | 1902 :let java_javascript=1 |
| 1903 :let java_css=1 | |
| 1904 :let java_vb=1 | |
| 1905 | |
| 1906 In order to highlight nested parens with different colors define colors | |
| 1907 for javaParen, javaParen1 and javaParen2, for example with > | |
| 1908 :hi link javaParen Comment | |
| 1909 or > | |
| 1910 :hi javaParen ctermfg=blue guifg=#0000ff | |
| 1911 | |
| 1912 If you notice highlighting errors while scrolling backwards, which are fixed | |
| 1913 when redrawing with CTRL-L, try setting the "java_minlines" internal variable | |
| 1914 to a larger number: > | |
| 1915 :let java_minlines = 50 | |
| 1916 This will make the syntax synchronization start 50 lines before the first | |
| 1917 displayed line. The default value is 10. The disadvantage of using a larger | |
| 1918 number is that redrawing can become slow. | |
| 1919 | |
| 1920 | |
| 501 | 1921 LACE *lace.vim* *ft-lace-syntax* |
| 7 | 1922 |
| 1923 Lace (Language for Assembly of Classes in Eiffel) is case insensitive, but the | |
| 1924 style guide lines are not. If you prefer case insensitive highlighting, just | |
| 1925 define the vim variable 'lace_case_insensitive' in your startup file: > | |
| 1926 :let lace_case_insensitive=1 | |
| 1927 | |
| 1928 | |
| 501 | 1929 LEX *lex.vim* *ft-lex-syntax* |
| 7 | 1930 |
| 1931 Lex uses brute-force synchronizing as the "^%%$" section delimiter | |
| 1932 gives no clue as to what section follows. Consequently, the value for > | |
| 1933 :syn sync minlines=300 | |
| 1934 may be changed by the user if s/he is experiencing synchronization | |
| 1935 difficulties (such as may happen with large lex files). | |
| 1936 | |
| 1937 | |
|
2412
ca3f40b0d95e
Prepare for 7.3b release. Fix src/Makefile enabling python3 by default.
Bram Moolenaar <bram@vim.org>
parents:
2410
diff
changeset
|
1938 LIFELINES *lifelines.vim* *ft-lifelines-syntax* |
|
ca3f40b0d95e
Prepare for 7.3b release. Fix src/Makefile enabling python3 by default.
Bram Moolenaar <bram@vim.org>
parents:
2410
diff
changeset
|
1939 |
|
ca3f40b0d95e
Prepare for 7.3b release. Fix src/Makefile enabling python3 by default.
Bram Moolenaar <bram@vim.org>
parents:
2410
diff
changeset
|
1940 To highlight deprecated functions as errors, add in your .vimrc: > |
|
ca3f40b0d95e
Prepare for 7.3b release. Fix src/Makefile enabling python3 by default.
Bram Moolenaar <bram@vim.org>
parents:
2410
diff
changeset
|
1941 |
|
ca3f40b0d95e
Prepare for 7.3b release. Fix src/Makefile enabling python3 by default.
Bram Moolenaar <bram@vim.org>
parents:
2410
diff
changeset
|
1942 :let g:lifelines_deprecated = 1 |
|
ca3f40b0d95e
Prepare for 7.3b release. Fix src/Makefile enabling python3 by default.
Bram Moolenaar <bram@vim.org>
parents:
2410
diff
changeset
|
1943 < |
|
ca3f40b0d95e
Prepare for 7.3b release. Fix src/Makefile enabling python3 by default.
Bram Moolenaar <bram@vim.org>
parents:
2410
diff
changeset
|
1944 |
| 555 | 1945 LISP *lisp.vim* *ft-lisp-syntax* |
| 1946 | |
| 1947 The lisp syntax highlighting provides two options: > | |
| 1948 | |
| 1949 g:lisp_instring : if it exists, then "(...)" strings are highlighted | |
| 1950 as if the contents of the string were lisp. | |
| 1951 Useful for AutoLisp. | |
| 1952 g:lisp_rainbow : if it exists and is nonzero, then differing levels | |
| 1953 of parenthesization will receive different | |
| 1954 highlighting. | |
| 1955 < | |
| 1956 The g:lisp_rainbow option provides 10 levels of individual colorization for | |
| 1957 the parentheses and backquoted parentheses. Because of the quantity of | |
| 1958 colorization levels, unlike non-rainbow highlighting, the rainbow mode | |
| 1959 specifies its highlighting using ctermfg and guifg, thereby bypassing the | |
| 1960 usual colorscheme control using standard highlighting groups. The actual | |
| 1961 highlighting used depends on the dark/bright setting (see |'bg'|). | |
| 1962 | |
| 1963 | |
| 501 | 1964 LITE *lite.vim* *ft-lite-syntax* |
| 7 | 1965 |
| 1966 There are two options for the lite syntax highlighting. | |
| 1967 | |
| 1968 If you like SQL syntax highlighting inside Strings, use this: > | |
| 1969 | |
| 1970 :let lite_sql_query = 1 | |
| 1971 | |
| 1972 For syncing, minlines defaults to 100. If you prefer another value, you can | |
| 1973 set "lite_minlines" to the value you desire. Example: > | |
| 1974 | |
| 1975 :let lite_minlines = 200 | |
| 1976 | |
| 1977 | |
| 501 | 1978 LPC *lpc.vim* *ft-lpc-syntax* |
| 7 | 1979 |
| 237 | 1980 LPC stands for a simple, memory-efficient language: Lars Pensj| C. The |
| 7 | 1981 file name of LPC is usually *.c. Recognizing these files as LPC would bother |
| 1982 users writing only C programs. If you want to use LPC syntax in Vim, you | |
| 1983 should set a variable in your .vimrc file: > | |
| 1984 | |
| 1985 :let lpc_syntax_for_c = 1 | |
| 1986 | |
| 1987 If it doesn't work properly for some particular C or LPC files, use a | |
| 1988 modeline. For a LPC file: | |
| 1989 | |
| 1990 // vim:set ft=lpc: | |
| 1991 | |
| 1992 For a C file that is recognized as LPC: | |
| 1993 | |
| 1994 // vim:set ft=c: | |
| 1995 | |
| 1996 If you don't want to set the variable, use the modeline in EVERY LPC file. | |
| 1997 | |
| 1998 There are several implementations for LPC, we intend to support most widely | |
| 237 | 1999 used ones. Here the default LPC syntax is for MudOS series, for MudOS v22 |
| 7 | 2000 and before, you should turn off the sensible modifiers, and this will also |
| 5814 | 2001 assert the new efuns after v22 to be invalid, don't set this variable when |
| 7 | 2002 you are using the latest version of MudOS: > |
| 2003 | |
| 2004 :let lpc_pre_v22 = 1 | |
| 2005 | |
| 2006 For LpMud 3.2 series of LPC: > | |
| 2007 | |
| 2008 :let lpc_compat_32 = 1 | |
| 2009 | |
| 2010 For LPC4 series of LPC: > | |
| 2011 | |
| 2012 :let lpc_use_lpc4_syntax = 1 | |
| 2013 | |
| 2014 For uLPC series of LPC: | |
| 2015 uLPC has been developed to Pike, so you should use Pike syntax | |
| 2016 instead, and the name of your source file should be *.pike | |
| 2017 | |
| 2018 | |
| 501 | 2019 LUA *lua.vim* *ft-lua-syntax* |
| 7 | 2020 |
| 3356 | 2021 The Lua syntax file can be used for versions 4.0, 5.0, 5.1 and 5.2 (5.2 is |
| 838 | 2022 the default). You can select one of these versions using the global variables |
| 2023 lua_version and lua_subversion. For example, to activate Lua | |
| 3356 | 2024 5.1 syntax highlighting, set the variables like this: |
| 838 | 2025 |
| 2026 :let lua_version = 5 | |
| 2027 :let lua_subversion = 1 | |
| 7 | 2028 |
| 2029 | |
| 501 | 2030 MAIL *mail.vim* *ft-mail.vim* |
| 7 | 2031 |
| 2032 Vim highlights all the standard elements of an email (headers, signatures, | |
| 237 | 2033 quoted text and URLs / email addresses). In keeping with standard conventions, |
| 7 | 2034 signatures begin in a line containing only "--" followed optionally by |
| 2035 whitespaces and end with a newline. | |
| 2036 | |
| 2037 Vim treats lines beginning with ']', '}', '|', '>' or a word followed by '>' | |
| 237 | 2038 as quoted text. However Vim highlights headers and signatures in quoted text |
| 7 | 2039 only if the text is quoted with '>' (optionally followed by one space). |
| 2040 | |
| 2041 By default mail.vim synchronises syntax to 100 lines before the first | |
| 237 | 2042 displayed line. If you have a slow machine, and generally deal with emails |
| 7 | 2043 with short headers, you can change this to a smaller value: > |
| 2044 | |
| 2045 :let mail_minlines = 30 | |
| 2046 | |
| 2047 | |
| 501 | 2048 MAKE *make.vim* *ft-make-syntax* |
| 7 | 2049 |
| 2050 In makefiles, commands are usually highlighted to make it easy for you to spot | |
| 2051 errors. However, this may be too much coloring for you. You can turn this | |
| 2052 feature off by using: > | |
| 2053 | |
| 2054 :let make_no_commands = 1 | |
| 2055 | |
| 2056 | |
| 501 | 2057 MAPLE *maple.vim* *ft-maple-syntax* |
| 7 | 2058 |
| 2059 Maple V, by Waterloo Maple Inc, supports symbolic algebra. The language | |
| 2060 supports many packages of functions which are selectively loaded by the user. | |
| 2061 The standard set of packages' functions as supplied in Maple V release 4 may be | |
| 2062 highlighted at the user's discretion. Users may place in their .vimrc file: > | |
| 2063 | |
| 2064 :let mvpkg_all= 1 | |
| 2065 | |
| 2066 to get all package functions highlighted, or users may select any subset by | |
| 2067 choosing a variable/package from the table below and setting that variable to | |
| 2068 1, also in their .vimrc file (prior to sourcing | |
| 2069 $VIMRUNTIME/syntax/syntax.vim). | |
| 2070 | |
| 2071 Table of Maple V Package Function Selectors > | |
| 2072 mv_DEtools mv_genfunc mv_networks mv_process | |
| 2073 mv_Galois mv_geometry mv_numapprox mv_simplex | |
| 2074 mv_GaussInt mv_grobner mv_numtheory mv_stats | |
| 2075 mv_LREtools mv_group mv_orthopoly mv_student | |
| 2076 mv_combinat mv_inttrans mv_padic mv_sumtools | |
| 2077 mv_combstruct mv_liesymm mv_plots mv_tensor | |
| 2078 mv_difforms mv_linalg mv_plottools mv_totorder | |
| 2079 mv_finance mv_logic mv_powseries | |
| 2080 | |
| 2081 | |
| 501 | 2082 MATHEMATICA *mma.vim* *ft-mma-syntax* *ft-mathematica-syntax* |
| 271 | 2083 |
| 2084 Empty *.m files will automatically be presumed to be Matlab files unless you | |
| 2085 have the following in your .vimrc: > | |
| 2086 | |
| 2087 let filetype_m = "mma" | |
| 2088 | |
| 2089 | |
| 501 | 2090 MOO *moo.vim* *ft-moo-syntax* |
| 7 | 2091 |
| 2092 If you use C-style comments inside expressions and find it mangles your | |
| 2093 highlighting, you may want to use extended (slow!) matches for C-style | |
| 2094 comments: > | |
| 2095 | |
| 2096 :let moo_extended_cstyle_comments = 1 | |
| 2097 | |
| 2098 To disable highlighting of pronoun substitution patterns inside strings: > | |
| 2099 | |
| 2100 :let moo_no_pronoun_sub = 1 | |
| 2101 | |
| 2102 To disable highlighting of the regular expression operator '%|', and matching | |
| 2103 '%(' and '%)' inside strings: > | |
| 2104 | |
| 2105 :let moo_no_regexp = 1 | |
| 2106 | |
| 2107 Unmatched double quotes can be recognized and highlighted as errors: > | |
| 2108 | |
| 2109 :let moo_unmatched_quotes = 1 | |
| 2110 | |
| 2111 To highlight builtin properties (.name, .location, .programmer etc.): > | |
| 2112 | |
| 2113 :let moo_builtin_properties = 1 | |
| 2114 | |
| 237 | 2115 Unknown builtin functions can be recognized and highlighted as errors. If you |
| 7 | 2116 use this option, add your own extensions to the mooKnownBuiltinFunction group. |
| 2117 To enable this option: > | |
| 2118 | |
| 2119 :let moo_unknown_builtin_functions = 1 | |
| 2120 | |
| 2121 An example of adding sprintf() to the list of known builtin functions: > | |
| 2122 | |
| 2123 :syn keyword mooKnownBuiltinFunction sprintf contained | |
| 2124 | |
| 2125 | |
| 501 | 2126 MSQL *msql.vim* *ft-msql-syntax* |
| 7 | 2127 |
| 2128 There are two options for the msql syntax highlighting. | |
| 2129 | |
| 2130 If you like SQL syntax highlighting inside Strings, use this: > | |
| 2131 | |
| 2132 :let msql_sql_query = 1 | |
| 2133 | |
| 2134 For syncing, minlines defaults to 100. If you prefer another value, you can | |
| 2135 set "msql_minlines" to the value you desire. Example: > | |
| 2136 | |
| 2137 :let msql_minlines = 200 | |
| 2138 | |
| 2139 | |
| 12254 | 2140 N1QL *n1ql.vim* *ft-n1ql-syntax* |
| 2141 | |
| 2142 N1QL is a SQL-like declarative language for manipulating JSON documents in | |
| 2143 Couchbase Server databases. | |
| 2144 | |
| 2145 Vim syntax highlights N1QL statements, keywords, operators, types, comments, | |
| 2146 and special values. Vim ignores syntactical elements specific to SQL or its | |
| 2147 many dialects, like COLUMN or CHAR, that don't exist in N1QL. | |
| 2148 | |
| 2149 | |
| 501 | 2150 NCF *ncf.vim* *ft-ncf-syntax* |
| 7 | 2151 |
| 2152 There is one option for NCF syntax highlighting. | |
| 2153 | |
| 2154 If you want to have unrecognized (by ncf.vim) statements highlighted as | |
| 2155 errors, use this: > | |
| 2156 | |
| 2157 :let ncf_highlight_unknowns = 1 | |
| 2158 | |
| 2159 If you don't want to highlight these errors, leave it unset. | |
| 2160 | |
| 2161 | |
| 501 | 2162 NROFF *nroff.vim* *ft-nroff-syntax* |
| 7 | 2163 |
| 2164 The nroff syntax file works with AT&T n/troff out of the box. You need to | |
| 2165 activate the GNU groff extra features included in the syntax file before you | |
| 2166 can use them. | |
| 2167 | |
| 2168 For example, Linux and BSD distributions use groff as their default text | |
| 237 | 2169 processing package. In order to activate the extra syntax highlighting |
| 7 | 2170 features for groff, add the following option to your start-up files: > |
| 2171 | |
| 2172 :let b:nroff_is_groff = 1 | |
| 2173 | |
| 2174 Groff is different from the old AT&T n/troff that you may still find in | |
| 2175 Solaris. Groff macro and request names can be longer than 2 characters and | |
| 2176 there are extensions to the language primitives. For example, in AT&T troff | |
| 237 | 2177 you access the year as a 2-digit number with the request \(yr. In groff you |
| 7 | 2178 can use the same request, recognized for compatibility, or you can use groff's |
| 2179 native syntax, \[yr]. Furthermore, you can use a 4-digit year directly: | |
| 2180 \[year]. Macro requests can be longer than 2 characters, for example, GNU mm | |
| 2181 accepts the requests ".VERBON" and ".VERBOFF" for creating verbatim | |
| 2182 environments. | |
| 2183 | |
| 2184 In order to obtain the best formatted output g/troff can give you, you should | |
| 2185 follow a few simple rules about spacing and punctuation. | |
| 2186 | |
| 2187 1. Do not leave empty spaces at the end of lines. | |
| 2188 | |
| 2189 2. Leave one space and one space only after an end-of-sentence period, | |
| 2190 exclamation mark, etc. | |
| 2191 | |
| 2192 3. For reasons stated below, it is best to follow all period marks with a | |
| 2193 carriage return. | |
| 2194 | |
| 2195 The reason behind these unusual tips is that g/n/troff have a line breaking | |
| 2196 algorithm that can be easily upset if you don't follow the rules given above. | |
| 2197 | |
| 2198 Unlike TeX, troff fills text line-by-line, not paragraph-by-paragraph and, | |
| 2199 furthermore, it does not have a concept of glue or stretch, all horizontal and | |
| 2200 vertical space input will be output as is. | |
| 2201 | |
| 2202 Therefore, you should be careful about not using more space between sentences | |
| 2203 than you intend to have in your final document. For this reason, the common | |
| 2204 practice is to insert a carriage return immediately after all punctuation | |
| 237 | 2205 marks. If you want to have "even" text in your final processed output, you |
| 4264 | 2206 need to maintain regular spacing in the input text. To mark both trailing |
| 7 | 2207 spaces and two or more spaces after a punctuation as an error, use: > |
| 2208 | |
| 2209 :let nroff_space_errors = 1 | |
| 2210 | |
| 2211 Another technique to detect extra spacing and other errors that will interfere | |
| 2212 with the correct typesetting of your file, is to define an eye-catching | |
| 2213 highlighting definition for the syntax groups "nroffDefinition" and | |
| 237 | 2214 "nroffDefSpecial" in your configuration files. For example: > |
| 7 | 2215 |
| 2216 hi def nroffDefinition term=italic cterm=italic gui=reverse | |
| 2217 hi def nroffDefSpecial term=italic,bold cterm=italic,bold | |
| 2218 \ gui=reverse,bold | |
| 2219 | |
| 2220 If you want to navigate preprocessor entries in your source file as easily as | |
| 2221 with section markers, you can activate the following option in your .vimrc | |
| 2222 file: > | |
| 2223 | |
| 2224 let b:preprocs_as_sections = 1 | |
| 2225 | |
| 9 | 2226 As well, the syntax file adds an extra paragraph marker for the extended |
| 7 | 2227 paragraph macro (.XP) in the ms package. |
| 2228 | |
| 2229 Finally, there is a |groff.vim| syntax file that can be used for enabling | |
| 2230 groff syntax highlighting either on a file basis or globally by default. | |
| 2231 | |
| 2232 | |
| 501 | 2233 OCAML *ocaml.vim* *ft-ocaml-syntax* |
| 7 | 2234 |
| 2235 The OCaml syntax file handles files having the following prefixes: .ml, | |
| 2236 .mli, .mll and .mly. By setting the following variable > | |
| 2237 | |
| 2238 :let ocaml_revised = 1 | |
| 2239 | |
| 2240 you can switch from standard OCaml-syntax to revised syntax as supported | |
| 2241 by the camlp4 preprocessor. Setting the variable > | |
| 2242 | |
| 2243 :let ocaml_noend_error = 1 | |
| 2244 | |
| 2245 prevents highlighting of "end" as error, which is useful when sources | |
| 2246 contain very long structures that Vim does not synchronize anymore. | |
| 2247 | |
| 2248 | |
| 501 | 2249 PAPP *papp.vim* *ft-papp-syntax* |
| 7 | 2250 |
| 2251 The PApp syntax file handles .papp files and, to a lesser extend, .pxml | |
| 2252 and .pxsl files which are all a mixture of perl/xml/html/other using xml | |
| 237 | 2253 as the top-level file format. By default everything inside phtml or pxml |
| 2254 sections is treated as a string with embedded preprocessor commands. If | |
| 7 | 2255 you set the variable: > |
| 2256 | |
| 2257 :let papp_include_html=1 | |
| 2258 | |
| 2259 in your startup file it will try to syntax-hilight html code inside phtml | |
| 2260 sections, but this is relatively slow and much too colourful to be able to | |
| 237 | 2261 edit sensibly. ;) |
| 7 | 2262 |
| 2263 The newest version of the papp.vim syntax file can usually be found at | |
| 2264 http://papp.plan9.de. | |
| 2265 | |
| 2266 | |
| 501 | 2267 PASCAL *pascal.vim* *ft-pascal-syntax* |
| 7 | 2268 |
| 2269 Files matching "*.p" could be Progress or Pascal. If the automatic detection | |
| 2270 doesn't work for you, or you don't edit Progress at all, use this in your | |
| 2271 startup vimrc: > | |
| 2272 | |
| 2273 :let filetype_p = "pascal" | |
| 2274 | |
| 2275 The Pascal syntax file has been extended to take into account some extensions | |
| 2276 provided by Turbo Pascal, Free Pascal Compiler and GNU Pascal Compiler. | |
| 237 | 2277 Delphi keywords are also supported. By default, Turbo Pascal 7.0 features are |
| 7 | 2278 enabled. If you prefer to stick with the standard Pascal keywords, add the |
| 2279 following line to your startup file: > | |
| 2280 | |
| 2281 :let pascal_traditional=1 | |
| 2282 | |
| 2283 To switch on Delphi specific constructions (such as one-line comments, | |
| 2284 keywords, etc): > | |
| 2285 | |
| 2286 :let pascal_delphi=1 | |
| 2287 | |
| 2288 | |
| 2289 The option pascal_symbol_operator controls whether symbol operators such as +, | |
| 2290 *, .., etc. are displayed using the Operator color or not. To colorize symbol | |
| 2291 operators, add the following line to your startup file: > | |
| 2292 | |
| 2293 :let pascal_symbol_operator=1 | |
| 2294 | |
| 2295 Some functions are highlighted by default. To switch it off: > | |
| 2296 | |
| 2297 :let pascal_no_functions=1 | |
| 2298 | |
|
2283
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2269
diff
changeset
|
2299 Furthermore, there are specific variables for some compilers. Besides |
| 7 | 2300 pascal_delphi, there are pascal_gpc and pascal_fpc. Default extensions try to |
| 2301 match Turbo Pascal. > | |
| 2302 | |
| 2303 :let pascal_gpc=1 | |
| 2304 | |
| 2305 or > | |
| 2306 | |
| 2307 :let pascal_fpc=1 | |
| 2308 | |
| 2309 To ensure that strings are defined on a single line, you can define the | |
| 2310 pascal_one_line_string variable. > | |
| 2311 | |
| 2312 :let pascal_one_line_string=1 | |
| 2313 | |
| 2314 If you dislike <Tab> chars, you can set the pascal_no_tabs variable. Tabs | |
| 2315 will be highlighted as Error. > | |
| 2316 | |
| 2317 :let pascal_no_tabs=1 | |
| 2318 | |
| 2319 | |
| 2320 | |
| 501 | 2321 PERL *perl.vim* *ft-perl-syntax* |
| 7 | 2322 |
| 2323 There are a number of possible options to the perl syntax highlighting. | |
| 2324 | |
| 4992 | 2325 Inline POD highlighting is now turned on by default. If you don't wish |
| 2326 to have the added complexity of highlighting POD embedded within Perl | |
| 2327 files, you may set the 'perl_include_pod' option to 0: > | |
| 2328 | |
| 2329 :let perl_include_pod = 0 | |
| 7 | 2330 |
| 5968 | 2331 To reduce the complexity of parsing (and increase performance) you can switch |
| 22 | 2332 off two elements in the parsing of variable names and contents. > |
| 2333 | |
| 2334 To handle package references in variable and function names not differently | |
| 2335 from the rest of the name (like 'PkgName::' in '$PkgName::VarName'): > | |
| 2336 | |
| 2337 :let perl_no_scope_in_variables = 1 | |
| 2338 | |
| 2339 (In Vim 6.x it was the other way around: "perl_want_scope_in_variables" | |
| 2340 enabled it.) | |
| 2341 | |
| 2342 If you do not want complex things like '@{${"foo"}}' to be parsed: > | |
| 2343 | |
| 2344 :let perl_no_extended_vars = 1 | |
| 2345 | |
| 26 | 2346 (In Vim 6.x it was the other way around: "perl_extended_vars" enabled it.) |
| 7 | 2347 |
| 237 | 2348 The coloring strings can be changed. By default strings and qq friends will be |
| 2349 highlighted like the first line. If you set the variable | |
| 7 | 2350 perl_string_as_statement, it will be highlighted as in the second line. |
| 2351 | |
| 2352 "hello world!"; qq|hello world|; | |
| 2353 ^^^^^^^^^^^^^^NN^^^^^^^^^^^^^^^N (unlet perl_string_as_statement) | |
| 2354 S^^^^^^^^^^^^SNNSSS^^^^^^^^^^^SN (let perl_string_as_statement) | |
| 2355 | |
| 2356 (^ = perlString, S = perlStatement, N = None at all) | |
| 2357 | |
| 237 | 2358 The syncing has 3 options. The first two switch off some triggering of |
| 7 | 2359 synchronization and should only be needed in case it fails to work properly. |
| 2360 If while scrolling all of a sudden the whole screen changes color completely | |
| 237 | 2361 then you should try and switch off one of those. Let me know if you can figure |
| 7 | 2362 out the line that causes the mistake. |
| 2363 | |
| 2364 One triggers on "^\s*sub\s*" and the other on "^[$@%]" more or less. > | |
| 2365 | |
| 2366 :let perl_no_sync_on_sub | |
| 2367 :let perl_no_sync_on_global_var | |
| 2368 | |
| 2369 Below you can set the maximum distance VIM should look for starting points for | |
| 2370 its attempts in syntax highlighting. > | |
| 2371 | |
| 2372 :let perl_sync_dist = 100 | |
| 2373 | |
| 2374 If you want to use folding with perl, set perl_fold: > | |
| 2375 | |
| 22 | 2376 :let perl_fold = 1 |
| 2377 | |
| 2378 If you want to fold blocks in if statements, etc. as well set the following: > | |
| 2379 | |
| 2380 :let perl_fold_blocks = 1 | |
| 7 | 2381 |
| 4992 | 2382 Subroutines are folded by default if 'perl_fold' is set. If you do not want |
| 2383 this, you can set 'perl_nofold_subs': > | |
| 2384 | |
| 2385 :let perl_nofold_subs = 1 | |
| 2386 | |
| 2387 Anonymous subroutines are not folded by default; you may enable their folding | |
| 2388 via 'perl_fold_anonymous_subs': > | |
| 2389 | |
| 2390 :let perl_fold_anonymous_subs = 1 | |
| 2391 | |
| 2392 Packages are also folded by default if 'perl_fold' is set. To disable this | |
| 2393 behavior, set 'perl_nofold_packages': > | |
| 2394 | |
| 2395 :let perl_nofold_packages = 1 | |
| 7 | 2396 |
| 501 | 2397 PHP3 and PHP4 *php.vim* *php3.vim* *ft-php-syntax* *ft-php3-syntax* |
| 7 | 2398 |
| 2399 [note: previously this was called "php3", but since it now also supports php4 | |
| 2400 it has been renamed to "php"] | |
| 2401 | |
| 2402 There are the following options for the php syntax highlighting. | |
| 2403 | |
| 2404 If you like SQL syntax highlighting inside Strings: > | |
| 2405 | |
| 2406 let php_sql_query = 1 | |
| 2407 | |
| 2408 For highlighting the Baselib methods: > | |
| 2409 | |
| 2410 let php_baselib = 1 | |
| 2411 | |
| 2412 Enable HTML syntax highlighting inside strings: > | |
| 2413 | |
| 2414 let php_htmlInStrings = 1 | |
| 2415 | |
| 2416 Using the old colorstyle: > | |
| 2417 | |
| 2418 let php_oldStyle = 1 | |
| 2419 | |
| 2420 Enable highlighting ASP-style short tags: > | |
| 2421 | |
| 2422 let php_asp_tags = 1 | |
| 2423 | |
| 2424 Disable short tags: > | |
| 2425 | |
| 2426 let php_noShortTags = 1 | |
| 2427 | |
| 2428 For highlighting parent error ] or ): > | |
| 2429 | |
| 2430 let php_parent_error_close = 1 | |
| 2431 | |
|
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4437
diff
changeset
|
2432 For skipping a php end tag, if there exists an open ( or [ without a closing |
| 7 | 2433 one: > |
| 2434 | |
| 2435 let php_parent_error_open = 1 | |
| 2436 | |
| 2437 Enable folding for classes and functions: > | |
| 2438 | |
| 2439 let php_folding = 1 | |
| 2440 | |
| 2441 Selecting syncing method: > | |
| 2442 | |
| 2443 let php_sync_method = x | |
| 2444 | |
| 2445 x = -1 to sync by search (default), | |
| 2446 x > 0 to sync at least x lines backwards, | |
| 2447 x = 0 to sync from start. | |
| 2448 | |
| 2449 | |
| 816 | 2450 PLAINTEX *plaintex.vim* *ft-plaintex-syntax* |
| 2451 | |
| 2452 TeX is a typesetting language, and plaintex is the file type for the "plain" | |
| 2453 variant of TeX. If you never want your *.tex files recognized as plain TeX, | |
| 856 | 2454 see |ft-tex-plugin|. |
| 816 | 2455 |
| 2456 This syntax file has the option > | |
| 2457 | |
| 2458 let g:plaintex_delimiters = 1 | |
| 2459 | |
| 2460 if you want to highlight brackets "[]" and braces "{}". | |
| 2461 | |
| 2462 | |
| 501 | 2463 PPWIZARD *ppwiz.vim* *ft-ppwiz-syntax* |
| 7 | 2464 |
| 2465 PPWizard is a preprocessor for HTML and OS/2 INF files | |
| 2466 | |
| 2467 This syntax file has the options: | |
| 2468 | |
| 2469 - ppwiz_highlight_defs : determines highlighting mode for PPWizard's | |
| 237 | 2470 definitions. Possible values are |
| 7 | 2471 |
| 2472 ppwiz_highlight_defs = 1 : PPWizard #define statements retain the | |
| 237 | 2473 colors of their contents (e.g. PPWizard macros and variables) |
| 7 | 2474 |
| 2475 ppwiz_highlight_defs = 2 : preprocessor #define and #evaluate | |
| 2476 statements are shown in a single color with the exception of line | |
| 2477 continuation symbols | |
| 2478 | |
| 2479 The default setting for ppwiz_highlight_defs is 1. | |
| 2480 | |
| 2481 - ppwiz_with_html : If the value is 1 (the default), highlight literal | |
| 2482 HTML code; if 0, treat HTML code like ordinary text. | |
| 2483 | |
| 2484 | |
| 501 | 2485 PHTML *phtml.vim* *ft-phtml-syntax* |
| 7 | 2486 |
| 2487 There are two options for the phtml syntax highlighting. | |
| 2488 | |
| 2489 If you like SQL syntax highlighting inside Strings, use this: > | |
| 2490 | |
| 2491 :let phtml_sql_query = 1 | |
| 2492 | |
| 2493 For syncing, minlines defaults to 100. If you prefer another value, you can | |
| 2494 set "phtml_minlines" to the value you desire. Example: > | |
| 2495 | |
| 2496 :let phtml_minlines = 200 | |
| 2497 | |
| 2498 | |
| 501 | 2499 POSTSCRIPT *postscr.vim* *ft-postscr-syntax* |
| 7 | 2500 |
| 2501 There are several options when it comes to highlighting PostScript. | |
| 2502 | |
| 2503 First which version of the PostScript language to highlight. There are | |
| 2504 currently three defined language versions, or levels. Level 1 is the original | |
| 2505 and base version, and includes all extensions prior to the release of level 2. | |
| 2506 Level 2 is the most common version around, and includes its own set of | |
| 2507 extensions prior to the release of level 3. Level 3 is currently the highest | |
| 2508 level supported. You select which level of the PostScript language you want | |
| 2509 highlighted by defining the postscr_level variable as follows: > | |
| 2510 | |
| 2511 :let postscr_level=2 | |
| 2512 | |
| 2513 If this variable is not defined it defaults to 2 (level 2) since this is | |
| 2514 the most prevalent version currently. | |
| 2515 | |
| 2516 Note, not all PS interpreters will support all language features for a | |
| 2517 particular language level. In particular the %!PS-Adobe-3.0 at the start of | |
| 2518 PS files does NOT mean the PostScript present is level 3 PostScript! | |
| 2519 | |
| 2520 If you are working with Display PostScript, you can include highlighting of | |
| 2521 Display PS language features by defining the postscr_display variable as | |
| 2522 follows: > | |
| 2523 | |
| 2524 :let postscr_display=1 | |
| 2525 | |
| 2526 If you are working with Ghostscript, you can include highlighting of | |
| 2527 Ghostscript specific language features by defining the variable | |
| 2528 postscr_ghostscript as follows: > | |
| 2529 | |
| 2530 :let postscr_ghostscript=1 | |
| 2531 | |
| 2532 PostScript is a large language, with many predefined elements. While it | |
| 2533 useful to have all these elements highlighted, on slower machines this can | |
| 2534 cause Vim to slow down. In an attempt to be machine friendly font names and | |
| 2535 character encodings are not highlighted by default. Unless you are working | |
| 2536 explicitly with either of these this should be ok. If you want them to be | |
| 2537 highlighted you should set one or both of the following variables: > | |
| 2538 | |
| 2539 :let postscr_fonts=1 | |
| 2540 :let postscr_encodings=1 | |
| 2541 | |
| 2542 There is a stylistic option to the highlighting of and, or, and not. In | |
| 2543 PostScript the function of these operators depends on the types of their | |
| 2544 operands - if the operands are booleans then they are the logical operators, | |
| 2545 if they are integers then they are binary operators. As binary and logical | |
| 2546 operators can be highlighted differently they have to be highlighted one way | |
| 2547 or the other. By default they are treated as logical operators. They can be | |
| 2548 highlighted as binary operators by defining the variable | |
| 2549 postscr_andornot_binary as follows: > | |
| 2550 | |
| 2551 :let postscr_andornot_binary=1 | |
| 2552 < | |
| 2553 | |
| 501 | 2554 *ptcap.vim* *ft-printcap-syntax* |
| 2555 PRINTCAP + TERMCAP *ft-ptcap-syntax* *ft-termcap-syntax* | |
| 7 | 2556 |
| 2557 This syntax file applies to the printcap and termcap databases. | |
| 2558 | |
| 2559 In order for Vim to recognize printcap/termcap files that do not match | |
| 2560 the patterns *printcap*, or *termcap*, you must put additional patterns | |
| 2561 appropriate to your system in your |myfiletypefile| file. For these | |
| 2562 patterns, you must set the variable "b:ptcap_type" to either "print" or | |
| 2563 "term", and then the 'filetype' option to ptcap. | |
| 2564 | |
| 2565 For example, to make Vim identify all files in /etc/termcaps/ as termcap | |
| 2566 files, add the following: > | |
| 2567 | |
| 2568 :au BufNewFile,BufRead /etc/termcaps/* let b:ptcap_type = "term" | | |
| 2569 \ set filetype=ptcap | |
| 2570 | |
| 2571 If you notice highlighting errors while scrolling backwards, which | |
| 2572 are fixed when redrawing with CTRL-L, try setting the "ptcap_minlines" | |
| 2573 internal variable to a larger number: > | |
| 2574 | |
| 2575 :let ptcap_minlines = 50 | |
| 2576 | |
| 2577 (The default is 20 lines.) | |
| 2578 | |
| 2579 | |
| 501 | 2580 PROGRESS *progress.vim* *ft-progress-syntax* |
| 7 | 2581 |
| 2582 Files matching "*.w" could be Progress or cweb. If the automatic detection | |
| 2583 doesn't work for you, or you don't edit cweb at all, use this in your | |
| 2584 startup vimrc: > | |
| 2585 :let filetype_w = "progress" | |
| 2586 The same happens for "*.i", which could be assembly, and "*.p", which could be | |
| 2587 Pascal. Use this if you don't use assembly and Pascal: > | |
| 2588 :let filetype_i = "progress" | |
| 2589 :let filetype_p = "progress" | |
| 2590 | |
| 2591 | |
| 501 | 2592 PYTHON *python.vim* *ft-python-syntax* |
| 7 | 2593 |
| 4186 | 2594 There are six options to control Python syntax highlighting. |
| 7 | 2595 |
| 2596 For highlighted numbers: > | |
| 4186 | 2597 :let python_no_number_highlight = 1 |
| 7 | 2598 |
| 2599 For highlighted builtin functions: > | |
| 4186 | 2600 :let python_no_builtin_highlight = 1 |
| 7 | 2601 |
| 2602 For highlighted standard exceptions: > | |
| 4186 | 2603 :let python_no_exception_highlight = 1 |
| 2604 | |
| 2605 For highlighted doctests and code inside: > | |
| 2606 :let python_no_doctest_highlight = 1 | |
| 2607 or > | |
| 2608 :let python_no_doctest_code_highlight = 1 | |
| 2609 (first option implies second one). | |
| 7 | 2610 |
| 2596 | 2611 For highlighted trailing whitespace and mix of spaces and tabs: > |
| 4186 | 2612 :let python_space_error_highlight = 1 |
| 7 | 2613 |
| 2614 If you want all possible Python highlighting (the same as setting the | |
| 4186 | 2615 preceding last option and unsetting all other ones): > |
| 7 | 2616 :let python_highlight_all = 1 |
| 2617 | |
| 4992 | 2618 Note: only existence of these options matter, not their value. You can replace |
| 4186 | 2619 1 above with anything. |
| 2620 | |
| 7 | 2621 |
| 501 | 2622 QUAKE *quake.vim* *ft-quake-syntax* |
| 7 | 2623 |
| 2624 The Quake syntax definition should work for most any FPS (First Person | |
| 237 | 2625 Shooter) based on one of the Quake engines. However, the command names vary |
| 7 | 2626 a bit between the three games (Quake, Quake 2, and Quake 3 Arena) so the |
| 2627 syntax definition checks for the existence of three global variables to allow | |
| 237 | 2628 users to specify what commands are legal in their files. The three variables |
| 7 | 2629 can be set for the following effects: |
| 2630 | |
| 2631 set to highlight commands only available in Quake: > | |
| 2632 :let quake_is_quake1 = 1 | |
| 2633 | |
| 2634 set to highlight commands only available in Quake 2: > | |
| 2635 :let quake_is_quake2 = 1 | |
| 2636 | |
| 2637 set to highlight commands only available in Quake 3 Arena: > | |
| 2638 :let quake_is_quake3 = 1 | |
| 2639 | |
| 2640 Any combination of these three variables is legal, but might highlight more | |
| 2641 commands than are actually available to you by the game. | |
| 2642 | |
| 2643 | |
| 501 | 2644 READLINE *readline.vim* *ft-readline-syntax* |
| 7 | 2645 |
| 2646 The readline library is primarily used by the BASH shell, which adds quite a | |
| 237 | 2647 few commands and options to the ones already available. To highlight these |
| 7 | 2648 items as well you can add the following to your |vimrc| or just type it in the |
| 2649 command line before loading a file with the readline syntax: > | |
| 2650 let readline_has_bash = 1 | |
| 2651 | |
| 2652 This will add highlighting for the commands that BASH (version 2.05a and | |
| 2653 later, and part earlier) adds. | |
| 2654 | |
| 2655 | |
| 3920 | 2656 RESTRUCTURED TEXT *rst.vim* *ft-rst-syntax* |
| 2657 | |
| 11062 | 2658 You may set what syntax definitions should be used for code blocks via > |
| 3920 | 2659 let rst_syntax_code_list = ['vim', 'lisp', ...] |
| 11062 | 2660 < |
| 3920 | 2661 |
| 501 | 2662 REXX *rexx.vim* *ft-rexx-syntax* |
| 7 | 2663 |
| 2664 If you notice highlighting errors while scrolling backwards, which are fixed | |
| 2665 when redrawing with CTRL-L, try setting the "rexx_minlines" internal variable | |
| 2666 to a larger number: > | |
| 2667 :let rexx_minlines = 50 | |
| 2668 This will make the syntax synchronization start 50 lines before the first | |
| 2669 displayed line. The default value is 10. The disadvantage of using a larger | |
| 2670 number is that redrawing can become slow. | |
| 2671 | |
| 2965 | 2672 Vim tries to guess what type a ".r" file is. If it can't be detected (from |
| 2673 comment lines), the default is "r". To make the default rexx add this line to | |
| 2674 your .vimrc: *g:filetype_r* | |
| 2675 > | |
| 2676 :let g:filetype_r = "r" | |
| 2677 | |
| 7 | 2678 |
| 501 | 2679 RUBY *ruby.vim* *ft-ruby-syntax* |
| 7 | 2680 |
|
10186
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2681 Ruby: Operator highlighting |ruby_operators| |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2682 Ruby: Whitespace errors |ruby_space_errors| |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2683 Ruby: Folding |ruby_fold| |ruby_foldable_groups| |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2684 Ruby: Reducing expensive operations |ruby_no_expensive| |ruby_minlines| |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2685 Ruby: Spellchecking strings |ruby_spellcheck_strings| |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2686 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2687 *ruby_operators* |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2688 Ruby: Operator highlighting ~ |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2689 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2690 Operators can be highlighted by defining "ruby_operators": > |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2691 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2692 :let ruby_operators = 1 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2693 < |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2694 *ruby_space_errors* |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2695 Ruby: Whitespace errors ~ |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2696 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2697 Whitespace errors can be highlighted by defining "ruby_space_errors": > |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2698 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2699 :let ruby_space_errors = 1 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2700 < |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2701 This will highlight trailing whitespace and tabs preceded by a space character |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2702 as errors. This can be refined by defining "ruby_no_trail_space_error" and |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2703 "ruby_no_tab_space_error" which will ignore trailing whitespace and tabs after |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2704 spaces respectively. |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2705 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2706 *ruby_fold* *ruby_foldable_groups* |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2707 Ruby: Folding ~ |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2708 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2709 Folding can be enabled by defining "ruby_fold": > |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2710 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2711 :let ruby_fold = 1 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2712 < |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2713 This will set the value of 'foldmethod' to "syntax" locally to the current |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2714 buffer or window, which will enable syntax-based folding when editing Ruby |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2715 filetypes. |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2716 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2717 Default folding is rather detailed, i.e., small syntax units like "if", "do", |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2718 "%w[]" may create corresponding fold levels. |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2719 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2720 You can set "ruby_foldable_groups" to restrict which groups are foldable: > |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2721 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2722 :let ruby_foldable_groups = 'if case %' |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2723 < |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2724 The value is a space-separated list of keywords: |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2725 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2726 keyword meaning ~ |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2727 -------- ------------------------------------- ~ |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2728 ALL Most block syntax (default) |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2729 NONE Nothing |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2730 if "if" or "unless" block |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2731 def "def" block |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2732 class "class" block |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2733 module "module" block |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2734 do "do" block |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2735 begin "begin" block |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2736 case "case" block |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2737 for "for", "while", "until" loops |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2738 { Curly bracket block or hash literal |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2739 [ Array literal |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2740 % Literal with "%" notation, e.g.: %w(STRING), %!STRING! |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2741 / Regexp |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2742 string String and shell command output (surrounded by ', ", `) |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2743 : Symbol |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2744 # Multiline comment |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2745 << Here documents |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2746 __END__ Source code after "__END__" directive |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2747 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2748 *ruby_no_expensive* |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2749 Ruby: Reducing expensive operations ~ |
| 7 | 2750 |
| 2751 By default, the "end" keyword is colorized according to the opening statement | |
| 572 | 2752 of the block it closes. While useful, this feature can be expensive; if you |
| 7 | 2753 experience slow redrawing (or you are on a terminal with poor color support) |
| 2754 you may want to turn it off by defining the "ruby_no_expensive" variable: > | |
| 572 | 2755 |
| 7 | 2756 :let ruby_no_expensive = 1 |
| 1224 | 2757 < |
| 7 | 2758 In this case the same color will be used for all control keywords. |
| 2759 | |
|
10186
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2760 *ruby_minlines* |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2761 |
| 7 | 2762 If you do want this feature enabled, but notice highlighting errors while |
| 2763 scrolling backwards, which are fixed when redrawing with CTRL-L, try setting | |
| 2764 the "ruby_minlines" variable to a value larger than 50: > | |
| 572 | 2765 |
| 7 | 2766 :let ruby_minlines = 100 |
| 1224 | 2767 < |
| 7 | 2768 Ideally, this value should be a number of lines large enough to embrace your |
| 2769 largest class or module. | |
| 2770 | |
|
10186
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2771 *ruby_spellcheck_strings* |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2772 Ruby: Spellchecking strings ~ |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2773 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2774 Ruby syntax will perform spellchecking of strings if you define |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2775 "ruby_spellcheck_strings": > |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2776 |
|
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
2777 :let ruby_spellcheck_strings = 1 |
| 1224 | 2778 < |
| 1125 | 2779 |
| 501 | 2780 SCHEME *scheme.vim* *ft-scheme-syntax* |
| 17 | 2781 |
| 2782 By default only R5RS keywords are highlighted and properly indented. | |
| 2783 | |
| 2784 MzScheme-specific stuff will be used if b:is_mzscheme or g:is_mzscheme | |
| 2785 variables are defined. | |
| 856 | 2786 |
| 36 | 2787 Also scheme.vim supports keywords of the Chicken Scheme->C compiler. Define |
| 2788 b:is_chicken or g:is_chicken, if you need them. | |
| 17 | 2789 |
| 2790 | |
| 501 | 2791 SDL *sdl.vim* *ft-sdl-syntax* |
| 7 | 2792 |
| 2793 The SDL highlighting probably misses a few keywords, but SDL has so many | |
| 2794 of them it's almost impossibly to cope. | |
| 2795 | |
| 2796 The new standard, SDL-2000, specifies that all identifiers are | |
| 2797 case-sensitive (which was not so before), and that all keywords can be | |
| 237 | 2798 used either completely lowercase or completely uppercase. To have the |
| 7 | 2799 highlighting reflect this, you can set the following variable: > |
| 2800 :let sdl_2000=1 | |
| 2801 | |
| 237 | 2802 This also sets many new keywords. If you want to disable the old |
| 7 | 2803 keywords, which is probably a good idea, use: > |
| 2804 :let SDL_no_96=1 | |
| 2805 | |
| 2806 | |
| 2807 The indentation is probably also incomplete, but right now I am very | |
| 2808 satisfied with it for my own projects. | |
| 2809 | |
| 2810 | |
| 501 | 2811 SED *sed.vim* *ft-sed-syntax* |
| 7 | 2812 |
| 2813 To make tabs stand out from regular blanks (accomplished by using Todo | |
| 2814 highlighting on the tabs), define "highlight_sedtabs" by putting > | |
| 2815 | |
| 2816 :let highlight_sedtabs = 1 | |
| 2817 | |
| 2818 in the vimrc file. (This special highlighting only applies for tabs | |
| 2819 inside search patterns, replacement texts, addresses or text included | |
| 2820 by an Append/Change/Insert command.) If you enable this option, it is | |
| 2821 also a good idea to set the tab width to one character; by doing that, | |
| 2822 you can easily count the number of tabs in a string. | |
| 2823 | |
| 2824 Bugs: | |
| 2825 | |
| 2826 The transform command (y) is treated exactly like the substitute | |
| 2827 command. This means that, as far as this syntax file is concerned, | |
| 2828 transform accepts the same flags as substitute, which is wrong. | |
| 2829 (Transform accepts no flags.) I tolerate this bug because the | |
| 2830 involved commands need very complex treatment (95 patterns, one for | |
| 2831 each plausible pattern delimiter). | |
| 2832 | |
| 2833 | |
| 501 | 2834 SGML *sgml.vim* *ft-sgml-syntax* |
| 7 | 2835 |
| 2836 The coloring scheme for tags in the SGML file works as follows. | |
| 2837 | |
| 2838 The <> of opening tags are colored differently than the </> of a closing tag. | |
| 2839 This is on purpose! For opening tags the 'Function' color is used, while for | |
| 2840 closing tags the 'Type' color is used (See syntax.vim to check how those are | |
| 2841 defined for you) | |
| 2842 | |
| 2843 Known tag names are colored the same way as statements in C. Unknown tag | |
| 2844 names are not colored which makes it easy to spot errors. | |
| 2845 | |
| 237 | 2846 Note that the same is true for argument (or attribute) names. Known attribute |
| 7 | 2847 names are colored differently than unknown ones. |
| 2848 | |
| 237 | 2849 Some SGML tags are used to change the rendering of text. The following tags |
| 7 | 2850 are recognized by the sgml.vim syntax coloring file and change the way normal |
| 2851 text is shown: <varname> <emphasis> <command> <function> <literal> | |
| 2852 <replaceable> <ulink> and <link>. | |
| 2853 | |
| 2854 If you want to change how such text is rendered, you must redefine the | |
| 2855 following syntax groups: | |
| 2856 | |
| 2857 - sgmlBold | |
| 2858 - sgmlBoldItalic | |
| 2859 - sgmlUnderline | |
| 2860 - sgmlItalic | |
| 2861 - sgmlLink for links | |
| 2862 | |
| 2863 To make this redefinition work you must redefine them all and define the | |
| 2864 following variable in your vimrc (this is due to the order in which the files | |
| 2865 are read during initialization) > | |
| 2866 let sgml_my_rendering=1 | |
| 2867 | |
| 2868 You can also disable this rendering by adding the following line to your | |
| 2869 vimrc file: > | |
| 2870 let sgml_no_rendering=1 | |
| 2871 | |
| 2872 (Adapted from the html.vim help text by Claudio Fleiner <claudio@fleiner.com>) | |
| 2873 | |
| 2874 | |
|
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2875 *ft-posix-synax* *ft-dash-syntax* |
|
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2876 SH *sh.vim* *ft-sh-syntax* *ft-bash-syntax* *ft-ksh-syntax* |
|
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2877 |
|
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2878 This covers syntax highlighting for the older Unix (Bourne) sh, and newer |
|
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2879 shells such as bash, dash, posix, and the Korn shells. |
| 7 | 2880 |
| 2881 Vim attempts to determine which shell type is in use by specifying that | |
| 2882 various filenames are of specific types: > | |
| 2883 | |
| 2884 ksh : .kshrc* *.ksh | |
| 2885 bash: .bashrc* bashrc bash.bashrc .bash_profile* *.bash | |
| 2886 < | |
| 2887 If none of these cases pertain, then the first line of the file is examined | |
|
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2888 (ex. looking for /bin/sh /bin/ksh /bin/bash). If the first line specifies a |
|
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2889 shelltype, then that shelltype is used. However some files (ex. .profile) are |
|
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2890 known to be shell files but the type is not apparent. Furthermore, on many |
|
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2891 systems sh is symbolically linked to "bash" (Linux, Windows+cygwin) or "ksh" |
|
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2892 (Posix). |
|
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2893 |
|
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2894 One may specify a global default by instantiating one of the following |
| 7 | 2895 variables in your <.vimrc>: |
| 2896 | |
|
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2897 ksh: > |
| 828 | 2898 let g:is_kornshell = 1 |
|
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2899 < posix: (using this is the nearly the same as setting g:is_kornshell to 1) > |
| 828 | 2900 let g:is_posix = 1 |
| 7 | 2901 < bash: > |
| 828 | 2902 let g:is_bash = 1 |
| 1624 | 2903 < sh: (default) Bourne shell > |
| 828 | 2904 let g:is_sh = 1 |
| 7 | 2905 |
|
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2906 < (dash users should use posix) |
|
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2907 |
| 819 | 2908 If there's no "#! ..." line, and the user hasn't availed himself/herself of a |
| 2909 default sh.vim syntax setting as just shown, then syntax/sh.vim will assume | |
| 1624 | 2910 the Bourne shell syntax. No need to quote RFCs or market penetration |
| 2911 statistics in error reports, please -- just select the default version of the | |
|
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2912 sh your system uses and install the associated "let..." in your <.vimrc>. |
| 1624 | 2913 |
| 2914 The syntax/sh.vim file provides several levels of syntax-based folding: > | |
| 2915 | |
| 2916 let g:sh_fold_enabled= 0 (default, no syntax folding) | |
| 2917 let g:sh_fold_enabled= 1 (enable function folding) | |
| 2918 let g:sh_fold_enabled= 2 (enable heredoc folding) | |
| 2919 let g:sh_fold_enabled= 4 (enable if/do/for folding) | |
| 7 | 2920 > |
|
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2921 then various syntax items (ie. HereDocuments and function bodies) become |
| 1624 | 2922 syntax-foldable (see |:syn-fold|). You also may add these together |
| 2923 to get multiple types of folding: > | |
| 2924 | |
| 2925 let g:sh_fold_enabled= 3 (enables function and heredoc folding) | |
| 2926 | |
| 2927 If you notice highlighting errors while scrolling backwards which are fixed | |
| 2928 when one redraws with CTRL-L, try setting the "sh_minlines" internal variable | |
| 7 | 2929 to a larger number. Example: > |
| 2930 | |
| 2931 let sh_minlines = 500 | |
| 2932 | |
| 2933 This will make syntax synchronization start 500 lines before the first | |
| 2934 displayed line. The default value is 200. The disadvantage of using a larger | |
| 2935 number is that redrawing can become slow. | |
| 2936 | |
| 2937 If you don't have much to synchronize on, displaying can be very slow. To | |
| 2938 reduce this, the "sh_maxlines" internal variable can be set. Example: > | |
| 2939 | |
| 2940 let sh_maxlines = 100 | |
| 2941 < | |
| 2942 The default is to use the twice sh_minlines. Set it to a smaller number to | |
| 2943 speed up displaying. The disadvantage is that highlight errors may appear. | |
| 2944 | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
2945 syntax/sh.vim tries to flag certain problems as errors; usually things like |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
2946 extra ']'s, 'done's, 'fi's, etc. If you find the error handling problematic |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
2947 for your purposes, you may suppress such error highlighting by putting |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
2948 the following line in your .vimrc: > |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
2949 |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
2950 let g:sh_no_error= 1 |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
2951 < |
|
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
2952 |
|
3099
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2953 *sh-embed* *sh-awk* |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2954 Sh: EMBEDDING LANGUAGES~ |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2955 |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2956 You may wish to embed languages into sh. I'll give an example courtesy of |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2957 Lorance Stinson on how to do this with awk as an example. Put the following |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2958 file into $HOME/.vim/after/syntax/sh/awkembed.vim: > |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2959 |
|
8303
88207f4b861a
commit https://github.com/vim/vim/commit/dae8d21dd291df6a6679a00be64e18bca0156576
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
2960 " AWK Embedding: |
|
3099
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2961 " ============== |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2962 " Shamelessly ripped from aspperl.vim by Aaron Hope. |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2963 if exists("b:current_syntax") |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2964 unlet b:current_syntax |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2965 endif |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2966 syn include @AWKScript syntax/awk.vim |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2967 syn region AWKScriptCode matchgroup=AWKCommand start=+[=\\]\@<!'+ skip=+\\'+ end=+'+ contains=@AWKScript contained |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2968 syn region AWKScriptEmbedded matchgroup=AWKCommand start=+\<awk\>+ skip=+\\$+ end=+[=\\]\@<!'+me=e-1 contains=@shIdList,@shExprList2 nextgroup=AWKScriptCode |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2969 syn cluster shCommandSubList add=AWKScriptEmbedded |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2970 hi def link AWKCommand Type |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2971 < |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2972 This code will then let the awk code in the single quotes: > |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2973 awk '...awk code here...' |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2974 be highlighted using the awk highlighting syntax. Clearly this may be |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2975 extended to other languages. |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2976 |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2977 |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2978 SPEEDUP *spup.vim* *ft-spup-syntax* |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
2979 (AspenTech plant simulator) |
| 7 | 2980 |
| 2981 The Speedup syntax file has some options: | |
| 2982 | |
| 2983 - strict_subsections : If this variable is defined, only keywords for | |
| 2984 sections and subsections will be highlighted as statements but not | |
| 2985 other keywords (like WITHIN in the OPERATION section). | |
| 2986 | |
| 2987 - highlight_types : Definition of this variable causes stream types | |
| 2988 like temperature or pressure to be highlighted as Type, not as a | |
| 237 | 2989 plain Identifier. Included are the types that are usually found in |
| 7 | 2990 the DECLARE section; if you defined own types, you have to include |
| 2991 them in the syntax file. | |
| 2992 | |
| 2993 - oneline_comments : this value ranges from 1 to 3 and determines the | |
| 2994 highlighting of # style comments. | |
| 2995 | |
| 2996 oneline_comments = 1 : allow normal Speedup code after an even | |
| 2997 number of #s. | |
| 2998 | |
| 2999 oneline_comments = 2 : show code starting with the second # as | |
| 237 | 3000 error. This is the default setting. |
| 7 | 3001 |
| 3002 oneline_comments = 3 : show the whole line as error if it contains | |
| 3003 more than one #. | |
| 3004 | |
| 3005 Since especially OPERATION sections tend to become very large due to | |
| 237 | 3006 PRESETting variables, syncing may be critical. If your computer is |
| 7 | 3007 fast enough, you can increase minlines and/or maxlines near the end of |
| 3008 the syntax file. | |
| 3009 | |
| 3010 | |
| 501 | 3011 SQL *sql.vim* *ft-sql-syntax* |
| 3012 *sqlinformix.vim* *ft-sqlinformix-syntax* | |
| 720 | 3013 *sqlanywhere.vim* *ft-sqlanywhere-syntax* |
| 3014 | |
| 3015 While there is an ANSI standard for SQL, most database engines add their own | |
| 3016 custom extensions. Vim currently supports the Oracle and Informix dialects of | |
| 3017 SQL. Vim assumes "*.sql" files are Oracle SQL by default. | |
| 3018 | |
| 3019 Vim currently has SQL support for a variety of different vendors via syntax | |
| 3020 scripts. You can change Vim's default from Oracle to any of the current SQL | |
| 3021 supported types. You can also easily alter the SQL dialect being used on a | |
| 3022 buffer by buffer basis. | |
| 3023 | |
| 1624 | 3024 For more detailed instructions see |ft_sql.txt|. |
| 22 | 3025 |
| 3026 | |
| 501 | 3027 TCSH *tcsh.vim* *ft-tcsh-syntax* |
| 7 | 3028 |
| 3029 This covers the shell named "tcsh". It is a superset of csh. See |csh.vim| | |
| 3030 for how the filetype is detected. | |
| 3031 | |
| 3032 Tcsh does not allow \" in strings unless the "backslash_quote" shell variable | |
| 237 | 3033 is set. If you want VIM to assume that no backslash quote constructs exist add |
| 7 | 3034 this line to your .vimrc: > |
| 3035 | |
| 3036 :let tcsh_backslash_quote = 0 | |
| 3037 | |
| 3038 If you notice highlighting errors while scrolling backwards, which are fixed | |
| 3039 when redrawing with CTRL-L, try setting the "tcsh_minlines" internal variable | |
| 3040 to a larger number: > | |
| 3041 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3042 :let tcsh_minlines = 1000 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3043 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3044 This will make the syntax synchronization start 1000 lines before the first |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3045 displayed line. If you set "tcsh_minlines" to "fromstart", then |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3046 synchronization is done from the start of the file. The default value for |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3047 tcsh_minlines is 100. The disadvantage of using a larger number is that |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3048 redrawing can become slow. |
| 7 | 3049 |
| 3050 | |
| 4992 | 3051 TEX *tex.vim* *ft-tex-syntax* *latex-syntax* |
| 3052 | |
| 3053 Tex Contents~ | |
| 3054 Tex: Want Syntax Folding? |tex-folding| | |
| 3055 Tex: No Spell Checking Wanted |g:tex_nospell| | |
| 3056 Tex: Don't Want Spell Checking In Comments? |tex-nospell| | |
| 3057 Tex: Want Spell Checking in Verbatim Zones? |tex-verb| | |
| 3058 Tex: Run-on Comments or MathZones |tex-runon| | |
| 3059 Tex: Slow Syntax Highlighting? |tex-slow| | |
| 3060 Tex: Want To Highlight More Commands? |tex-morecommands| | |
| 3061 Tex: Excessive Error Highlighting? |tex-error| | |
| 3062 Tex: Need a new Math Group? |tex-math| | |
| 3063 Tex: Starting a New Style? |tex-style| | |
| 3064 Tex: Taking Advantage of Conceal Mode |tex-conceal| | |
| 3065 Tex: Selective Conceal Mode |g:tex_conceal| | |
| 3066 Tex: Controlling iskeyword |g:tex_isk| | |
| 6213 | 3067 Tex: Fine Subscript and Superscript Control |tex-supersub| |
| 4992 | 3068 |
| 3069 *tex-folding* *g:tex_fold_enabled* | |
|
2535
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3070 Tex: Want Syntax Folding? ~ |
| 477 | 3071 |
| 3072 As of version 28 of <syntax/tex.vim>, syntax-based folding of parts, chapters, | |
| 3073 sections, subsections, etc are supported. Put > | |
| 3074 let g:tex_fold_enabled=1 | |
| 3075 in your <.vimrc>, and :set fdm=syntax. I suggest doing the latter via a | |
| 3076 modeline at the end of your LaTeX file: > | |
| 3077 % vim: fdm=syntax | |
|
3099
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
3078 If your system becomes too slow, then you might wish to look into > |
| 4992 | 3079 https://vimhelp.appspot.com/vim_faq.txt.html#faq-29.7 |
| 477 | 3080 < |
| 4992 | 3081 *g:tex_nospell* |
| 3082 Tex: No Spell Checking Wanted~ | |
| 3083 | |
| 3084 If you don't want spell checking anywhere in your LaTeX document, put > | |
| 3085 let g:tex_nospell=1 | |
| 3086 into your .vimrc. If you merely wish to suppress spell checking inside | |
| 3087 comments only, see |g:tex_comment_nospell|. | |
| 3088 | |
| 3089 *tex-nospell* *g:tex_comment_nospell* | |
|
2535
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3090 Tex: Don't Want Spell Checking In Comments? ~ |
| 1624 | 3091 |
| 3092 Some folks like to include things like source code in comments and so would | |
| 3093 prefer that spell checking be disabled in comments in LaTeX files. To do | |
| 3094 this, put the following in your <.vimrc>: > | |
| 3095 let g:tex_comment_nospell= 1 | |
| 4992 | 3096 If you want to suppress spell checking everywhere inside your LaTeX document, |
| 3097 see |g:tex_nospell|. | |
| 3098 | |
| 3099 *tex-verb* *g:tex_verbspell* | |
|
2535
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3100 Tex: Want Spell Checking in Verbatim Zones?~ |
|
2494
ed997d0ceb26
Updated syntax files. (Charles Campbell)
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
3101 |
|
ed997d0ceb26
Updated syntax files. (Charles Campbell)
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
3102 Often verbatim regions are used for things like source code; seldom does |
|
ed997d0ceb26
Updated syntax files. (Charles Campbell)
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
3103 one want source code spell-checked. However, for those of you who do |
|
ed997d0ceb26
Updated syntax files. (Charles Campbell)
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
3104 want your verbatim zones spell-checked, put the following in your <.vimrc>: > |
|
ed997d0ceb26
Updated syntax files. (Charles Campbell)
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
3105 let g:tex_verbspell= 1 |
|
2535
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3106 < |
| 4992 | 3107 *tex-runon* *tex-stopzone* |
|
2535
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3108 Tex: Run-on Comments or MathZones ~ |
| 7 | 3109 |
| 477 | 3110 The <syntax/tex.vim> highlighting supports TeX, LaTeX, and some AmsTeX. The |
| 3111 highlighting supports three primary zones/regions: normal, texZone, and | |
| 3112 texMathZone. Although considerable effort has been made to have these zones | |
| 3113 terminate properly, zones delineated by $..$ and $$..$$ cannot be synchronized | |
| 3114 as there's no difference between start and end patterns. Consequently, a | |
| 7 | 3115 special "TeX comment" has been provided > |
| 3116 %stopzone | |
| 3117 which will forcibly terminate the highlighting of either a texZone or a | |
| 3118 texMathZone. | |
| 3119 | |
| 4992 | 3120 *tex-slow* *tex-sync* |
|
2535
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3121 Tex: Slow Syntax Highlighting? ~ |
| 7 | 3122 |
| 3123 If you have a slow computer, you may wish to reduce the values for > | |
| 3124 :syn sync maxlines=200 | |
| 3125 :syn sync minlines=50 | |
| 3126 (especially the latter). If your computer is fast, you may wish to | |
| 237 | 3127 increase them. This primarily affects synchronizing (i.e. just what group, |
| 7 | 3128 if any, is the text at the top of the screen supposed to be in?). |
| 3129 | |
|
3099
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
3130 Another cause of slow highlighting is due to syntax-driven folding; see |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
3131 |tex-folding| for a way around this. |
|
887d6d91882e
Updated a few runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2965
diff
changeset
|
3132 |
| 4992 | 3133 *g:tex_fast* |
| 3134 | |
| 3135 Finally, if syntax highlighting is still too slow, you may set > | |
| 3136 | |
| 3137 :let g:tex_fast= "" | |
| 3138 | |
| 3139 in your .vimrc. Used this way, the g:tex_fast variable causes the syntax | |
| 3140 highlighting script to avoid defining any regions and associated | |
| 3141 synchronization. The result will be much faster syntax highlighting; the | |
| 3142 price: you will no longer have as much highlighting or any syntax-based | |
| 3143 folding, and you will be missing syntax-based error checking. | |
| 3144 | |
| 3145 You may decide that some syntax is acceptable; you may use the following table | |
| 3146 selectively to enable just some syntax highlighting: > | |
| 3147 | |
| 3148 b : allow bold and italic syntax | |
| 3149 c : allow texComment syntax | |
| 3150 m : allow texMatcher syntax (ie. {...} and [...]) | |
| 3151 M : allow texMath syntax | |
| 3152 p : allow parts, chapter, section, etc syntax | |
| 3153 r : allow texRefZone syntax (nocite, bibliography, label, pageref, eqref) | |
| 3154 s : allow superscript/subscript regions | |
| 3155 S : allow texStyle syntax | |
| 3156 v : allow verbatim syntax | |
| 3157 V : allow texNewEnv and texNewCmd syntax | |
| 3158 < | |
| 3159 As an example, let g:tex_fast= "M" will allow math-associated highlighting | |
| 3160 but suppress all the other region-based syntax highlighting. | |
| 6213 | 3161 (also see: |g:tex_conceal| and |tex-supersub|) |
| 4992 | 3162 |
| 3163 *tex-morecommands* *tex-package* | |
|
2535
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3164 Tex: Want To Highlight More Commands? ~ |
| 1125 | 3165 |
| 3166 LaTeX is a programmable language, and so there are thousands of packages full | |
| 3167 of specialized LaTeX commands, syntax, and fonts. If you're using such a | |
| 3168 package you'll often wish that the distributed syntax/tex.vim would support | |
| 3169 it. However, clearly this is impractical. So please consider using the | |
| 3170 techniques in |mysyntaxfile-add| to extend or modify the highlighting provided | |
| 3237 | 3171 by syntax/tex.vim. Please consider uploading any extensions that you write, |
| 3172 which typically would go in $HOME/after/syntax/tex/[pkgname].vim, to | |
| 3173 http://vim.sf.net/. | |
| 1125 | 3174 |
| 4992 | 3175 *tex-error* *g:tex_no_error* |
|
2535
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3176 Tex: Excessive Error Highlighting? ~ |
| 7 | 3177 |
| 3178 The <tex.vim> supports lexical error checking of various sorts. Thus, | |
| 3179 although the error checking is ofttimes very useful, it can indicate | |
| 3180 errors where none actually are. If this proves to be a problem for you, | |
| 3181 you may put in your <.vimrc> the following statement: > | |
| 4992 | 3182 let g:tex_no_error=1 |
| 477 | 3183 and all error checking by <syntax/tex.vim> will be suppressed. |
| 3184 | |
| 1624 | 3185 *tex-math* |
|
2535
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3186 Tex: Need a new Math Group? ~ |
| 7 | 3187 |
| 3188 If you want to include a new math group in your LaTeX, the following | |
| 3189 code shows you an example as to how you might do so: > | |
| 477 | 3190 call TexNewMathZone(sfx,mathzone,starform) |
| 3191 You'll want to provide the new math group with a unique suffix | |
| 3192 (currently, A-L and V-Z are taken by <syntax/tex.vim> itself). | |
| 3193 As an example, consider how eqnarray is set up by <syntax/tex.vim>: > | |
| 3194 call TexNewMathZone("D","eqnarray",1) | |
| 3195 You'll need to change "mathzone" to the name of your new math group, | |
| 3196 and then to the call to it in .vim/after/syntax/tex.vim. | |
| 3197 The "starform" variable, if true, implies that your new math group | |
| 3198 has a starred form (ie. eqnarray*). | |
| 3199 | |
| 4992 | 3200 *tex-style* *b:tex_stylish* |
|
2535
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3201 Tex: Starting a New Style? ~ |
| 7 | 3202 |
| 3203 One may use "\makeatletter" in *.tex files, thereby making the use of "@" in | |
| 3204 commands available. However, since the *.tex file doesn't have one of the | |
| 3205 following suffices: sty cls clo dtx ltx, the syntax highlighting will flag | |
| 3206 such use of @ as an error. To solve this: > | |
| 3207 | |
| 3208 :let b:tex_stylish = 1 | |
| 3209 :set ft=tex | |
| 3210 | |
| 3211 Putting "let g:tex_stylish=1" into your <.vimrc> will make <syntax/tex.vim> | |
| 3212 always accept such use of @. | |
| 3213 | |
| 2417 | 3214 *tex-cchar* *tex-cole* *tex-conceal* |
|
2535
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3215 Tex: Taking Advantage of Conceal Mode~ |
| 2417 | 3216 |
| 2426 | 3217 If you have |'conceallevel'| set to 2 and if your encoding is utf-8, then a |
| 3218 number of character sequences can be translated into appropriate utf-8 glyphs, | |
| 3219 including various accented characters, Greek characters in MathZones, and | |
| 3220 superscripts and subscripts in MathZones. Not all characters can be made into | |
| 3221 superscripts or subscripts; the constraint is due to what utf-8 supports. | |
| 3222 In fact, only a few characters are supported as subscripts. | |
| 3223 | |
| 3224 One way to use this is to have vertically split windows (see |CTRL-W_v|); one | |
| 3225 with |'conceallevel'| at 0 and the other at 2; and both using |'scrollbind'|. | |
| 2417 | 3226 |
| 4992 | 3227 *g:tex_conceal* |
|
2535
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3228 Tex: Selective Conceal Mode~ |
|
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3229 |
|
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3230 You may selectively use conceal mode by setting g:tex_conceal in your |
| 4992 | 3231 <.vimrc>. By default, g:tex_conceal is set to "admgs" to enable concealment |
| 3232 for the following sets of characters: > | |
|
2535
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3233 |
|
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3234 a = accents/ligatures |
| 3492 | 3235 b = bold and italic |
|
2535
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3236 d = delimiters |
|
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3237 m = math symbols |
|
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3238 g = Greek |
|
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3239 s = superscripts/subscripts |
|
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3240 < |
|
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3241 By leaving one or more of these out, the associated conceal-character |
|
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3242 substitution will not be made. |
|
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
3243 |
| 4992 | 3244 *g:tex_isk* *g:tex_stylish* |
| 3245 Tex: Controlling iskeyword~ | |
| 3246 | |
| 3247 Normally, LaTeX keywords support 0-9, a-z, A-z, and 192-255 only. Latex | |
| 3248 keywords don't support the underscore - except when in *.sty files. The | |
| 3249 syntax highlighting script handles this with the following logic: | |
| 3250 | |
| 3251 * If g:tex_stylish exists and is 1 | |
| 3252 then the file will be treated as a "sty" file, so the "_" | |
| 3253 will be allowed as part of keywords | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3254 (regardless of g:tex_isk) |
| 4992 | 3255 * Else if the file's suffix is sty, cls, clo, dtx, or ltx, |
| 3256 then the file will be treated as a "sty" file, so the "_" | |
| 3257 will be allowed as part of keywords | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
3258 (regardless of g:tex_isk) |
| 4992 | 3259 |
| 3260 * If g:tex_isk exists, then it will be used for the local 'iskeyword' | |
| 3261 * Else the local 'iskeyword' will be set to 48-57,a-z,A-Z,192-255 | |
| 3262 | |
| 6213 | 3263 *tex-supersub* *g:tex_superscripts* *g:tex_subscripts* |
| 3264 Tex: Fine Subscript and Superscript Control~ | |
| 3265 | |
| 3266 See |tex-conceal| for how to enable concealed character replacement. | |
| 3267 | |
| 3268 See |g:tex_conceal| for selectively concealing accents, bold/italic, | |
| 3269 math, Greek, and superscripts/subscripts. | |
| 3270 | |
| 3271 One may exert fine control over which superscripts and subscripts one | |
| 3272 wants syntax-based concealment for (see |:syn-cchar|). Since not all | |
| 3273 fonts support all characters, one may override the | |
| 3274 concealed-replacement lists; by default these lists are given by: > | |
| 3275 | |
| 3276 let g:tex_superscripts= "[0-9a-zA-W.,:;+-<>/()=]" | |
| 3277 let g:tex_subscripts= "[0-9aehijklmnoprstuvx,+-/().]" | |
| 3278 < | |
| 3279 For example, I use Luxi Mono Bold; it doesn't support subscript | |
| 3280 characters for "hklmnpst", so I put > | |
| 3281 let g:tex_subscripts= "[0-9aeijoruvx,+-/().]" | |
| 3282 < in ~/.vim/ftplugin/tex/tex.vim in order to avoid having inscrutable | |
| 3283 utf-8 glyphs appear. | |
| 3284 | |
| 4992 | 3285 |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5003
diff
changeset
|
3286 TF *tf.vim* *ft-tf-syntax* |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5003
diff
changeset
|
3287 |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5003
diff
changeset
|
3288 There is one option for the tf syntax highlighting. |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5003
diff
changeset
|
3289 |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5003
diff
changeset
|
3290 For syncing, minlines defaults to 100. If you prefer another value, you can |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5003
diff
changeset
|
3291 set "tf_minlines" to the value you desire. Example: > |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5003
diff
changeset
|
3292 |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5003
diff
changeset
|
3293 :let tf_minlines = your choice |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5003
diff
changeset
|
3294 < |
| 1624 | 3295 VIM *vim.vim* *ft-vim-syntax* |
| 3296 *g:vimsyn_minlines* *g:vimsyn_maxlines* | |
|
2283
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2269
diff
changeset
|
3297 There is a trade-off between more accurate syntax highlighting versus screen |
| 1624 | 3298 updating speed. To improve accuracy, you may wish to increase the |
| 3299 g:vimsyn_minlines variable. The g:vimsyn_maxlines variable may be used to | |
| 3300 improve screen updating rates (see |:syn-sync| for more on this). > | |
| 3301 | |
| 3302 g:vimsyn_minlines : used to set synchronization minlines | |
| 3303 g:vimsyn_maxlines : used to set synchronization maxlines | |
| 3304 < | |
| 3305 (g:vim_minlines and g:vim_maxlines are deprecated variants of | |
| 3306 these two options) | |
| 3307 | |
| 3308 *g:vimsyn_embed* | |
| 3309 The g:vimsyn_embed option allows users to select what, if any, types of | |
| 3310 embedded script highlighting they wish to have. > | |
| 3311 | |
|
7183
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7176
diff
changeset
|
3312 g:vimsyn_embed == 0 : don't support any embedded scripts |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7176
diff
changeset
|
3313 g:vimsyn_embed =~ 'l' : support embedded lua |
| 5340 | 3314 g:vimsyn_embed =~ 'm' : support embedded mzscheme |
| 3315 g:vimsyn_embed =~ 'p' : support embedded perl | |
| 3316 g:vimsyn_embed =~ 'P' : support embedded python | |
| 3317 g:vimsyn_embed =~ 'r' : support embedded ruby | |
| 3318 g:vimsyn_embed =~ 't' : support embedded tcl | |
| 1624 | 3319 < |
| 5340 | 3320 By default, g:vimsyn_embed is a string supporting interpreters that your vim |
| 3321 itself supports. Concatenate multiple characters to support multiple types | |
| 3322 of embedded interpreters; ie. g:vimsyn_embed= "mp" supports embedded mzscheme | |
| 3323 and embedded perl. | |
| 1624 | 3324 *g:vimsyn_folding* |
| 3325 | |
| 3326 Some folding is now supported with syntax/vim.vim: > | |
| 3327 | |
| 3328 g:vimsyn_folding == 0 or doesn't exist: no syntax-based folding | |
| 3329 g:vimsyn_folding =~ 'a' : augroups | |
| 3330 g:vimsyn_folding =~ 'f' : fold functions | |
|
7183
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7176
diff
changeset
|
3331 g:vimsyn_folding =~ 'l' : fold lua script |
| 1624 | 3332 g:vimsyn_folding =~ 'm' : fold mzscheme script |
| 3333 g:vimsyn_folding =~ 'p' : fold perl script | |
| 3334 g:vimsyn_folding =~ 'P' : fold python script | |
| 3335 g:vimsyn_folding =~ 'r' : fold ruby script | |
| 3336 g:vimsyn_folding =~ 't' : fold tcl script | |
| 3682 | 3337 < |
| 1624 | 3338 *g:vimsyn_noerror* |
|
10942
e05695e59f6d
patch 8.0.0360: sometimes VimL is used instead of "Vim script"
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
3339 Not all error highlighting that syntax/vim.vim does may be correct; Vim script |
|
e05695e59f6d
patch 8.0.0360: sometimes VimL is used instead of "Vim script"
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
3340 is a difficult language to highlight correctly. A way to suppress error |
| 1624 | 3341 highlighting is to put the following line in your |vimrc|: > |
| 3342 | |
| 3343 let g:vimsyn_noerror = 1 | |
| 3344 < | |
| 846 | 3345 |
| 7 | 3346 |
| 501 | 3347 XF86CONFIG *xf86conf.vim* *ft-xf86conf-syntax* |
| 7 | 3348 |
| 3349 The syntax of XF86Config file differs in XFree86 v3.x and v4.x. Both | |
| 3350 variants are supported. Automatic detection is used, but is far from perfect. | |
| 3351 You may need to specify the version manually. Set the variable | |
| 3352 xf86conf_xfree86_version to 3 or 4 according to your XFree86 version in | |
| 3353 your .vimrc. Example: > | |
| 3354 :let xf86conf_xfree86_version=3 | |
| 3355 When using a mix of versions, set the b:xf86conf_xfree86_version variable. | |
| 3356 | |
| 3357 Note that spaces and underscores in option names are not supported. Use | |
| 3358 "SyncOnGreen" instead of "__s yn con gr_e_e_n" if you want the option name | |
| 3359 highlighted. | |
| 3360 | |
| 3361 | |
| 501 | 3362 XML *xml.vim* *ft-xml-syntax* |
| 7 | 3363 |
| 237 | 3364 Xml namespaces are highlighted by default. This can be inhibited by |
| 7 | 3365 setting a global variable: > |
| 3366 | |
| 3367 :let g:xml_namespace_transparent=1 | |
| 3368 < | |
| 3369 *xml-folding* | |
| 3370 The xml syntax file provides syntax |folding| (see |:syn-fold|) between | |
| 237 | 3371 start and end tags. This can be turned on by > |
| 7 | 3372 |
| 3373 :let g:xml_syntax_folding = 1 | |
| 3374 :set foldmethod=syntax | |
| 3375 | |
| 3376 Note: syntax folding might slow down syntax highlighting significantly, | |
| 3377 especially for large files. | |
| 3378 | |
| 3379 | |
| 501 | 3380 X Pixmaps (XPM) *xpm.vim* *ft-xpm-syntax* |
| 7 | 3381 |
| 3382 xpm.vim creates its syntax items dynamically based upon the contents of the | |
| 3383 XPM file. Thus if you make changes e.g. in the color specification strings, | |
| 3384 you have to source it again e.g. with ":set syn=xpm". | |
| 3385 | |
| 3386 To copy a pixel with one of the colors, yank a "pixel" with "yl" and insert it | |
| 3387 somewhere else with "P". | |
| 3388 | |
| 3389 Do you want to draw with the mouse? Try the following: > | |
| 3390 :function! GetPixel() | |
| 823 | 3391 : let c = getline(".")[col(".") - 1] |
| 7 | 3392 : echo c |
| 3393 : exe "noremap <LeftMouse> <LeftMouse>r".c | |
| 3394 : exe "noremap <LeftDrag> <LeftMouse>r".c | |
| 3395 :endfunction | |
| 3396 :noremap <RightMouse> <LeftMouse>:call GetPixel()<CR> | |
| 3397 :set guicursor=n:hor20 " to see the color beneath the cursor | |
| 3398 This turns the right button into a pipette and the left button into a pen. | |
| 3399 It will work with XPM files that have one character per pixel only and you | |
| 3400 must not click outside of the pixel strings, but feel free to improve it. | |
| 3401 | |
| 3402 It will look much better with a font in a quadratic cell size, e.g. for X: > | |
| 3403 :set guifont=-*-clean-medium-r-*-*-8-*-*-*-*-80-* | |
| 3404 | |
| 6741 | 3405 |
| 3406 YAML *yaml.vim* *ft-yaml-syntax* | |
| 3407 | |
| 3408 *g:yaml_schema* *b:yaml_schema* | |
| 3409 A YAML schema is a combination of a set of tags and a mechanism for resolving | |
| 3410 non-specific tags. For user this means that YAML parser may, depending on | |
| 3411 plain scalar contents, treat plain scalar (which can actually be only string | |
| 3412 and nothing else) as a value of the other type: null, boolean, floating-point, | |
| 3413 integer. `g:yaml_schema` option determines according to which schema values | |
| 3414 will be highlighted specially. Supported schemas are | |
| 3415 | |
| 3416 Schema Description ~ | |
| 3417 failsafe No additional highlighting. | |
| 3418 json Supports JSON-style numbers, booleans and null. | |
| 3419 core Supports more number, boolean and null styles. | |
| 3420 pyyaml In addition to core schema supports highlighting timestamps, | |
| 3421 but there are some differences in what is recognized as | |
| 3422 numbers and many additional boolean values not present in core | |
| 3423 schema. | |
| 3424 | |
| 3425 Default schema is `core`. | |
| 3426 | |
| 3427 Note that schemas are not actually limited to plain scalars, but this is the | |
| 3428 only difference between schemas defined in YAML specification and the only | |
| 3429 difference defined in the syntax file. | |
| 3430 | |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
7790
diff
changeset
|
3431 |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
7790
diff
changeset
|
3432 ZSH *zsh.vim* *ft-zsh-syntax* |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
7790
diff
changeset
|
3433 |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
7790
diff
changeset
|
3434 The syntax script for zsh allows for syntax-based folding: > |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
7790
diff
changeset
|
3435 |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
7790
diff
changeset
|
3436 :let g:zsh_fold_enable = 1 |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
7790
diff
changeset
|
3437 |
| 7 | 3438 ============================================================================== |
| 3439 5. Defining a syntax *:syn-define* *E410* | |
| 3440 | |
| 3441 Vim understands three types of syntax items: | |
| 3442 | |
| 419 | 3443 1. Keyword |
| 7 | 3444 It can only contain keyword characters, according to the 'iskeyword' |
| 3445 option. It cannot contain other syntax items. It will only match with a | |
| 3446 complete word (there are no keyword characters before or after the match). | |
| 3447 The keyword "if" would match in "if(a=b)", but not in "ifdef x", because | |
| 3448 "(" is not a keyword character and "d" is. | |
| 3449 | |
| 419 | 3450 2. Match |
| 7 | 3451 This is a match with a single regexp pattern. |
| 3452 | |
| 419 | 3453 3. Region |
| 7 | 3454 This starts at a match of the "start" regexp pattern and ends with a match |
| 3455 with the "end" regexp pattern. Any other text can appear in between. A | |
| 3456 "skip" regexp pattern can be used to avoid matching the "end" pattern. | |
| 3457 | |
| 3458 Several syntax ITEMs can be put into one syntax GROUP. For a syntax group | |
| 3459 you can give highlighting attributes. For example, you could have an item | |
| 3460 to define a "/* .. */" comment and another one that defines a "// .." comment, | |
| 3461 and put them both in the "Comment" group. You can then specify that a | |
| 3462 "Comment" will be in bold font and have a blue color. You are free to make | |
| 3463 one highlight group for one syntax item, or put all items into one group. | |
| 3464 This depends on how you want to specify your highlighting attributes. Putting | |
| 3465 each item in its own group results in having to specify the highlighting | |
| 3466 for a lot of groups. | |
| 3467 | |
| 3468 Note that a syntax group and a highlight group are similar. For a highlight | |
| 3469 group you will have given highlight attributes. These attributes will be used | |
| 3470 for the syntax group with the same name. | |
| 3471 | |
| 3472 In case more than one item matches at the same position, the one that was | |
| 3473 defined LAST wins. Thus you can override previously defined syntax items by | |
| 3474 using an item that matches the same text. But a keyword always goes before a | |
| 3475 match or region. And a keyword with matching case always goes before a | |
| 3476 keyword with ignoring case. | |
| 3477 | |
| 3478 | |
| 3479 PRIORITY *:syn-priority* | |
| 3480 | |
| 3481 When several syntax items may match, these rules are used: | |
| 3482 | |
| 3483 1. When multiple Match or Region items start in the same position, the item | |
| 3484 defined last has priority. | |
| 3485 2. A Keyword has priority over Match and Region items. | |
| 3486 3. An item that starts in an earlier position has priority over items that | |
| 3487 start in later positions. | |
| 3488 | |
| 3489 | |
| 3490 DEFINING CASE *:syn-case* *E390* | |
| 3491 | |
| 419 | 3492 :sy[ntax] case [match | ignore] |
| 7 | 3493 This defines if the following ":syntax" commands will work with |
| 3494 matching case, when using "match", or with ignoring case, when using | |
| 3495 "ignore". Note that any items before this are not affected, and all | |
| 3496 items until the next ":syntax case" command are affected. | |
| 3497 | |
| 10734 | 3498 :sy[ntax] case |
| 3499 Show either "syntax case match" or "syntax case ignore" (translated). | |
| 7 | 3500 |
| 419 | 3501 SPELL CHECKING *:syn-spell* |
| 3502 | |
| 3503 :sy[ntax] spell [toplevel | notoplevel | default] | |
| 3504 This defines where spell checking is to be done for text that is not | |
| 3505 in a syntax item: | |
| 3506 | |
| 3507 toplevel: Text is spell checked. | |
| 3508 notoplevel: Text is not spell checked. | |
| 3509 default: When there is a @Spell cluster no spell checking. | |
| 3510 | |
| 3511 For text in syntax items use the @Spell and @NoSpell clusters | |
| 3512 |spell-syntax|. When there is no @Spell and no @NoSpell cluster then | |
| 3513 spell checking is done for "default" and "toplevel". | |
| 3514 | |
| 3515 To activate spell checking the 'spell' option must be set. | |
| 3516 | |
| 10734 | 3517 :sy[ntax] spell |
| 3518 Show either "syntax spell toplevel", "syntax spell notoplevel" or | |
| 3519 "syntax spell default" (translated). | |
| 3520 | |
| 3521 | |
|
7687
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3522 SYNTAX ISKEYWORD SETTING *:syn-iskeyword* |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3523 |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3524 :sy[ntax] iskeyword [clear | {option}] |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3525 This defines the keyword characters. It's like the 'iskeyword' option |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3526 for but only applies to syntax highlighting. |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3527 |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3528 clear: Syntax specific iskeyword setting is disabled and the |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3529 buffer-local 'iskeyword' setting is used. |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3530 {option} Set the syntax 'iskeyword' option to a new value. |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3531 |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3532 Example: > |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3533 :syntax iskeyword @,48-57,192-255,$,_ |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3534 < |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3535 This would set the syntax specific iskeyword option to include all |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3536 alphabetic characters, plus the numeric characters, all accented |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3537 characters and also includes the "_" and the "$". |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3538 |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3539 If no argument is given, the current value will be output. |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3540 |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3541 Setting this option influences what |/\k| matches in syntax patterns |
|
7790
ca19726d5e83
commit https://github.com/vim/vim/commit/298b440930ecece38d6ea0505a3e582dc817e79b
Christian Brabandt <cb@256bit.org>
parents:
7687
diff
changeset
|
3542 and also determines where |:syn-keyword| will be checked for a new |
|
7687
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3543 match. |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3544 |
|
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
3545 It is recommended when writing syntax files, to use this command to |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
3546 set the correct value for the specific syntax language and not change |
|
7687
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3547 the 'iskeyword' option. |
| 419 | 3548 |
| 7 | 3549 DEFINING KEYWORDS *:syn-keyword* |
| 3550 | |
| 3551 :sy[ntax] keyword {group-name} [{options}] {keyword} .. [{options}] | |
| 3552 | |
| 3553 This defines a number of keywords. | |
| 3554 | |
| 3555 {group-name} Is a syntax group name such as "Comment". | |
| 3556 [{options}] See |:syn-arguments| below. | |
| 3557 {keyword} .. Is a list of keywords which are part of this group. | |
| 3558 | |
| 3559 Example: > | |
| 3560 :syntax keyword Type int long char | |
| 3561 < | |
| 3562 The {options} can be given anywhere in the line. They will apply to | |
| 3563 all keywords given, also for options that come after a keyword. | |
| 3564 These examples do exactly the same: > | |
| 3565 :syntax keyword Type contained int long char | |
| 3566 :syntax keyword Type int long contained char | |
| 3567 :syntax keyword Type int long char contained | |
|
7051
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6951
diff
changeset
|
3568 < *E789* *E890* |
| 7 | 3569 When you have a keyword with an optional tail, like Ex commands in |
| 3570 Vim, you can put the optional characters inside [], to define all the | |
| 3571 variations at once: > | |
| 3572 :syntax keyword vimCommand ab[breviate] n[ext] | |
| 3573 < | |
| 3574 Don't forget that a keyword can only be recognized if all the | |
| 3575 characters are included in the 'iskeyword' option. If one character | |
| 3576 isn't, the keyword will never be recognized. | |
| 3577 Multi-byte characters can also be used. These do not have to be in | |
| 3578 'iskeyword'. | |
|
7687
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
3579 See |:syn-iskeyword| for defining syntax specific iskeyword settings. |
| 7 | 3580 |
| 3581 A keyword always has higher priority than a match or region, the | |
| 3582 keyword is used if more than one item matches. Keywords do not nest | |
| 3583 and a keyword can't contain anything else. | |
| 3584 | |
| 3585 Note that when you have a keyword that is the same as an option (even | |
| 3586 one that isn't allowed here), you can not use it. Use a match | |
| 3587 instead. | |
| 3588 | |
| 3589 The maximum length of a keyword is 80 characters. | |
| 3590 | |
| 3591 The same keyword can be defined multiple times, when its containment | |
| 3592 differs. For example, you can define the keyword once not contained | |
| 3593 and use one highlight group, and once contained, and use a different | |
| 237 | 3594 highlight group. Example: > |
| 7 | 3595 :syn keyword vimCommand tag |
| 3596 :syn keyword vimSetting contained tag | |
| 3597 < When finding "tag" outside of any syntax item, the "vimCommand" | |
| 3598 highlight group is used. When finding "tag" in a syntax item that | |
| 3599 contains "vimSetting", the "vimSetting" group is used. | |
| 3600 | |
| 3601 | |
| 3602 DEFINING MATCHES *:syn-match* | |
| 3603 | |
|
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
3604 :sy[ntax] match {group-name} [{options}] |
|
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
3605 [excludenl] |
|
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
3606 [keepend] |
|
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
3607 {pattern} |
|
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
3608 [{options}] |
| 7 | 3609 |
| 3610 This defines one match. | |
| 3611 | |
| 3612 {group-name} A syntax group name such as "Comment". | |
| 3613 [{options}] See |:syn-arguments| below. | |
| 3614 [excludenl] Don't make a pattern with the end-of-line "$" | |
| 3615 extend a containing match or region. Must be | |
| 3616 given before the pattern. |:syn-excludenl| | |
|
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
3617 keepend Don't allow contained matches to go past a |
|
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
3618 match with the end pattern. See |
|
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
3619 |:syn-keepend|. |
| 7 | 3620 {pattern} The search pattern that defines the match. |
| 3621 See |:syn-pattern| below. | |
| 3622 Note that the pattern may match more than one | |
| 3623 line, which makes the match depend on where | |
| 3624 Vim starts searching for the pattern. You | |
| 3625 need to make sure syncing takes care of this. | |
| 3626 | |
| 3627 Example (match a character constant): > | |
| 3628 :syntax match Character /'.'/hs=s+1,he=e-1 | |
| 3629 < | |
| 3630 | |
| 3631 DEFINING REGIONS *:syn-region* *:syn-start* *:syn-skip* *:syn-end* | |
| 3632 *E398* *E399* | |
| 3633 :sy[ntax] region {group-name} [{options}] | |
| 3634 [matchgroup={group-name}] | |
| 3635 [keepend] | |
| 3636 [extend] | |
| 3637 [excludenl] | |
| 3638 start={start_pattern} .. | |
| 3639 [skip={skip_pattern}] | |
| 3640 end={end_pattern} .. | |
| 3641 [{options}] | |
| 3642 | |
| 3643 This defines one region. It may span several lines. | |
| 3644 | |
| 3645 {group-name} A syntax group name such as "Comment". | |
| 3646 [{options}] See |:syn-arguments| below. | |
| 3647 [matchgroup={group-name}] The syntax group to use for the following | |
| 3648 start or end pattern matches only. Not used | |
| 3649 for the text in between the matched start and | |
| 3650 end patterns. Use NONE to reset to not using | |
| 3651 a different group for the start or end match. | |
| 3652 See |:syn-matchgroup|. | |
| 3653 keepend Don't allow contained matches to go past a | |
| 3654 match with the end pattern. See | |
| 3655 |:syn-keepend|. | |
| 3656 extend Override a "keepend" for an item this region | |
| 237 | 3657 is contained in. See |:syn-extend|. |
| 7 | 3658 excludenl Don't make a pattern with the end-of-line "$" |
| 3659 extend a containing match or item. Only | |
| 3660 useful for end patterns. Must be given before | |
| 3661 the patterns it applies to. |:syn-excludenl| | |
| 3662 start={start_pattern} The search pattern that defines the start of | |
| 3663 the region. See |:syn-pattern| below. | |
| 3664 skip={skip_pattern} The search pattern that defines text inside | |
| 3665 the region where not to look for the end | |
| 3666 pattern. See |:syn-pattern| below. | |
| 3667 end={end_pattern} The search pattern that defines the end of | |
| 3668 the region. See |:syn-pattern| below. | |
| 3669 | |
| 3670 Example: > | |
| 3671 :syntax region String start=+"+ skip=+\\"+ end=+"+ | |
| 3672 < | |
| 3673 The start/skip/end patterns and the options can be given in any order. | |
| 3674 There can be zero or one skip pattern. There must be one or more | |
| 3675 start and end patterns. This means that you can omit the skip | |
| 3676 pattern, but you must give at least one start and one end pattern. It | |
| 3677 is allowed to have white space before and after the equal sign | |
| 3678 (although it mostly looks better without white space). | |
| 3679 | |
| 3680 When more than one start pattern is given, a match with one of these | |
| 3681 is sufficient. This means there is an OR relation between the start | |
| 3682 patterns. The last one that matches is used. The same is true for | |
| 3683 the end patterns. | |
| 3684 | |
| 3685 The search for the end pattern starts right after the start pattern. | |
| 3686 Offsets are not used for this. This implies that the match for the | |
| 3687 end pattern will never overlap with the start pattern. | |
| 3688 | |
| 3689 The skip and end pattern can match across line breaks, but since the | |
| 3690 search for the pattern can start in any line it often does not do what | |
| 3691 you want. The skip pattern doesn't avoid a match of an end pattern in | |
| 3692 the next line. Use single-line patterns to avoid trouble. | |
| 3693 | |
| 3694 Note: The decision to start a region is only based on a matching start | |
| 3695 pattern. There is no check for a matching end pattern. This does NOT | |
| 3696 work: > | |
| 3697 :syn region First start="(" end=":" | |
| 3698 :syn region Second start="(" end=";" | |
| 3699 < The Second always matches before the First (last defined pattern has | |
| 3700 higher priority). The Second region then continues until the next | |
| 3701 ';', no matter if there is a ':' before it. Using a match does work: > | |
| 3702 :syn match First "(\_.\{-}:" | |
| 3703 :syn match Second "(\_.\{-};" | |
| 3704 < This pattern matches any character or line break with "\_." and | |
| 3705 repeats that with "\{-}" (repeat as few as possible). | |
| 3706 | |
| 3707 *:syn-keepend* | |
| 3708 By default, a contained match can obscure a match for the end pattern. | |
| 3709 This is useful for nesting. For example, a region that starts with | |
| 3710 "{" and ends with "}", can contain another region. An encountered "}" | |
| 3711 will then end the contained region, but not the outer region: | |
| 3712 { starts outer "{}" region | |
| 3713 { starts contained "{}" region | |
| 3714 } ends contained "{}" region | |
| 3715 } ends outer "{} region | |
| 3716 If you don't want this, the "keepend" argument will make the matching | |
| 3717 of an end pattern of the outer region also end any contained item. | |
| 3718 This makes it impossible to nest the same region, but allows for | |
| 3719 contained items to highlight parts of the end pattern, without causing | |
| 3720 that to skip the match with the end pattern. Example: > | |
| 3721 :syn match vimComment +"[^"]\+$+ | |
| 3722 :syn region vimCommand start="set" end="$" contains=vimComment keepend | |
| 3723 < The "keepend" makes the vimCommand always end at the end of the line, | |
| 3724 even though the contained vimComment includes a match with the <EOL>. | |
| 3725 | |
| 3726 When "keepend" is not used, a match with an end pattern is retried | |
| 3727 after each contained match. When "keepend" is included, the first | |
| 3728 encountered match with an end pattern is used, truncating any | |
| 3729 contained matches. | |
| 3730 *:syn-extend* | |
| 3731 The "keepend" behavior can be changed by using the "extend" argument. | |
| 3732 When an item with "extend" is contained in an item that uses | |
| 3733 "keepend", the "keepend" is ignored and the containing region will be | |
| 3734 extended. | |
| 3735 This can be used to have some contained items extend a region while | |
| 3736 others don't. Example: > | |
| 3737 | |
| 3738 :syn region htmlRef start=+<a>+ end=+</a>+ keepend contains=htmlItem,htmlScript | |
| 3739 :syn match htmlItem +<[^>]*>+ contained | |
| 3740 :syn region htmlScript start=+<script+ end=+</script[^>]*>+ contained extend | |
| 3741 | |
| 3742 < Here the htmlItem item does not make the htmlRef item continue | |
| 3743 further, it is only used to highlight the <> items. The htmlScript | |
| 3744 item does extend the htmlRef item. | |
| 3745 | |
| 3746 Another example: > | |
| 3747 :syn region xmlFold start="<a>" end="</a>" fold transparent keepend extend | |
| 3748 < This defines a region with "keepend", so that its end cannot be | |
| 3749 changed by contained items, like when the "</a>" is matched to | |
| 3750 highlight it differently. But when the xmlFold region is nested (it | |
| 3751 includes itself), the "extend" applies, so that the "</a>" of a nested | |
| 3752 region only ends that region, and not the one it is contained in. | |
| 3753 | |
| 3754 *:syn-excludenl* | |
| 3755 When a pattern for a match or end pattern of a region includes a '$' | |
| 3756 to match the end-of-line, it will make a region item that it is | |
| 3757 contained in continue on the next line. For example, a match with | |
| 3758 "\\$" (backslash at the end of the line) can make a region continue | |
| 3759 that would normally stop at the end of the line. This is the default | |
| 3760 behavior. If this is not wanted, there are two ways to avoid it: | |
| 3761 1. Use "keepend" for the containing item. This will keep all | |
| 3762 contained matches from extending the match or region. It can be | |
| 3763 used when all contained items must not extend the containing item. | |
| 3764 2. Use "excludenl" in the contained item. This will keep that match | |
| 3765 from extending the containing match or region. It can be used if | |
| 3766 only some contained items must not extend the containing item. | |
| 3767 "excludenl" must be given before the pattern it applies to. | |
| 3768 | |
| 3769 *:syn-matchgroup* | |
| 3770 "matchgroup" can be used to highlight the start and/or end pattern | |
| 3771 differently than the body of the region. Example: > | |
| 3772 :syntax region String matchgroup=Quote start=+"+ skip=+\\"+ end=+"+ | |
| 3773 < This will highlight the quotes with the "Quote" group, and the text in | |
| 3774 between with the "String" group. | |
| 3775 The "matchgroup" is used for all start and end patterns that follow, | |
| 3776 until the next "matchgroup". Use "matchgroup=NONE" to go back to not | |
| 3777 using a matchgroup. | |
| 3778 | |
| 3779 In a start or end pattern that is highlighted with "matchgroup" the | |
| 3780 contained items of the region are not used. This can be used to avoid | |
| 3781 that a contained item matches in the start or end pattern match. When | |
| 3782 using "transparent", this does not apply to a start or end pattern | |
| 3783 match that is highlighted with "matchgroup". | |
| 3784 | |
| 3785 Here is an example, which highlights three levels of parentheses in | |
| 3786 different colors: > | |
| 3787 :sy region par1 matchgroup=par1 start=/(/ end=/)/ contains=par2 | |
| 3788 :sy region par2 matchgroup=par2 start=/(/ end=/)/ contains=par3 contained | |
| 3789 :sy region par3 matchgroup=par3 start=/(/ end=/)/ contains=par1 contained | |
| 3790 :hi par1 ctermfg=red guifg=red | |
| 3791 :hi par2 ctermfg=blue guifg=blue | |
| 3792 :hi par3 ctermfg=darkgreen guifg=darkgreen | |
| 2751 | 3793 < |
| 3794 *E849* | |
| 3795 The maximum number of syntax groups is 19999. | |
| 7 | 3796 |
| 3797 ============================================================================== | |
| 3798 6. :syntax arguments *:syn-arguments* | |
| 3799 | |
| 3800 The :syntax commands that define syntax items take a number of arguments. | |
| 3801 The common ones are explained here. The arguments may be given in any order | |
| 3802 and may be mixed with patterns. | |
| 3803 | |
| 3804 Not all commands accept all arguments. This table shows which arguments | |
| 3805 can not be used for all commands: | |
| 2520 | 3806 *E395* |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3807 contains oneline fold display extend concealends~ |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3808 :syntax keyword - - - - - - |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3809 :syntax match yes - yes yes yes - |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3810 :syntax region yes yes yes yes yes yes |
| 7 | 3811 |
| 3812 These arguments can be used for all three commands: | |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3813 conceal |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3814 cchar |
| 7 | 3815 contained |
| 3816 containedin | |
| 3817 nextgroup | |
| 3818 transparent | |
| 3819 skipwhite | |
| 3820 skipnl | |
| 3821 skipempty | |
| 3822 | |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3823 conceal *conceal* *:syn-conceal* |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3824 |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3825 When the "conceal" argument is given, the item is marked as concealable. |
|
2269
fb627e94e6c6
Couple of small fixes for conceal feature. (Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2254
diff
changeset
|
3826 Whether or not it is actually concealed depends on the value of the |
|
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2370
diff
changeset
|
3827 'conceallevel' option. The 'concealcursor' option is used to decide whether |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2370
diff
changeset
|
3828 concealable items in the current line are displayed unconcealed to be able to |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2370
diff
changeset
|
3829 edit the line. |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
3830 Another way to conceal text is with |matchadd()|. |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3831 |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3832 concealends *:syn-concealends* |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3833 |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3834 When the "concealends" argument is given, the start and end matches of |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3835 the region, but not the contents of the region, are marked as concealable. |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3836 Whether or not they are actually concealed depends on the setting on the |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3837 'conceallevel' option. The ends of a region can only be concealed separately |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3838 in this way when they have their own highlighting via "matchgroup" |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3839 |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3840 cchar *:syn-cchar* |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
3841 *E844* |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3842 The "cchar" argument defines the character shown in place of the item |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3843 when it is concealed (setting "cchar" only makes sense when the conceal |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3844 argument is given.) If "cchar" is not set then the default conceal |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
3845 character defined in the 'listchars' option is used. The character cannot be |
|
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
3846 a control character such as Tab. Example: > |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
3847 :syntax match Entity "&" conceal cchar=& |
|
2296
eb7be7b075a6
Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3848 See |hl-Conceal| for highlighting. |
| 7 | 3849 |
| 3850 contained *:syn-contained* | |
| 3851 | |
| 3852 When the "contained" argument is given, this item will not be recognized at | |
| 3853 the top level, but only when it is mentioned in the "contains" field of | |
| 3854 another match. Example: > | |
| 3855 :syntax keyword Todo TODO contained | |
| 3856 :syntax match Comment "//.*" contains=Todo | |
| 3857 | |
| 3858 | |
| 3859 display *:syn-display* | |
| 3860 | |
| 3861 If the "display" argument is given, this item will be skipped when the | |
| 3862 detected highlighting will not be displayed. This will speed up highlighting, | |
| 3863 by skipping this item when only finding the syntax state for the text that is | |
| 3864 to be displayed. | |
| 3865 | |
| 3866 Generally, you can use "display" for match and region items that meet these | |
| 3867 conditions: | |
| 3868 - The item does not continue past the end of a line. Example for C: A region | |
| 3869 for a "/*" comment can't contain "display", because it continues on the next | |
| 3870 line. | |
| 3871 - The item does not contain items that continue past the end of the line or | |
| 3872 make it continue on the next line. | |
| 3873 - The item does not change the size of any item it is contained in. Example | |
| 3874 for C: A match with "\\$" in a preprocessor match can't have "display", | |
| 3875 because it may make that preprocessor match shorter. | |
| 3876 - The item does not allow other items to match that didn't match otherwise, | |
| 3877 and that item may extend the match too far. Example for C: A match for a | |
| 3878 "//" comment can't use "display", because a "/*" inside that comment would | |
| 3879 match then and start a comment which extends past the end of the line. | |
| 3880 | |
| 3881 Examples, for the C language, where "display" can be used: | |
| 3882 - match with a number | |
| 3883 - match with a label | |
| 3884 | |
| 3885 | |
| 3886 transparent *:syn-transparent* | |
| 3887 | |
| 3888 If the "transparent" argument is given, this item will not be highlighted | |
| 3889 itself, but will take the highlighting of the item it is contained in. This | |
| 3890 is useful for syntax items that don't need any highlighting but are used | |
| 3891 only to skip over a part of the text. | |
| 3892 | |
| 3893 The "contains=" argument is also inherited from the item it is contained in, | |
| 3894 unless a "contains" argument is given for the transparent item itself. To | |
| 3895 avoid that unwanted items are contained, use "contains=NONE". Example, which | |
| 3896 highlights words in strings, but makes an exception for "vim": > | |
| 3897 :syn match myString /'[^']*'/ contains=myWord,myVim | |
| 3898 :syn match myWord /\<[a-z]*\>/ contained | |
| 3899 :syn match myVim /\<vim\>/ transparent contained contains=NONE | |
| 3900 :hi link myString String | |
| 3901 :hi link myWord Comment | |
| 3902 Since the "myVim" match comes after "myWord" it is the preferred match (last | |
| 3903 match in the same position overrules an earlier one). The "transparent" | |
| 3904 argument makes the "myVim" match use the same highlighting as "myString". But | |
| 3905 it does not contain anything. If the "contains=NONE" argument would be left | |
| 3906 out, then "myVim" would use the contains argument from myString and allow | |
| 3907 "myWord" to be contained, which will be highlighted as a Constant. This | |
| 3908 happens because a contained match doesn't match inside itself in the same | |
| 3909 position, thus the "myVim" match doesn't overrule the "myWord" match here. | |
| 3910 | |
| 3911 When you look at the colored text, it is like looking at layers of contained | |
| 3912 items. The contained item is on top of the item it is contained in, thus you | |
| 3913 see the contained item. When a contained item is transparent, you can look | |
| 3914 through, thus you see the item it is contained in. In a picture: | |
| 3915 | |
| 3916 look from here | |
| 3917 | |
| 3918 | | | | | | | |
| 3919 V V V V V V | |
| 3920 | |
| 3921 xxxx yyy more contained items | |
| 3922 .................... contained item (transparent) | |
| 3923 ============================= first item | |
| 3924 | |
| 3925 The 'x', 'y' and '=' represent a highlighted syntax item. The '.' represent a | |
| 3926 transparent group. | |
| 3927 | |
| 3928 What you see is: | |
| 3929 | |
| 3930 =======xxxx=======yyy======== | |
| 3931 | |
| 3932 Thus you look through the transparent "....". | |
| 3933 | |
| 3934 | |
| 3935 oneline *:syn-oneline* | |
| 3936 | |
| 3937 The "oneline" argument indicates that the region does not cross a line | |
| 3938 boundary. It must match completely in the current line. However, when the | |
| 3939 region has a contained item that does cross a line boundary, it continues on | |
| 3940 the next line anyway. A contained item can be used to recognize a line | |
| 3941 continuation pattern. But the "end" pattern must still match in the first | |
| 3942 line, otherwise the region doesn't even start. | |
| 3943 | |
| 3944 When the start pattern includes a "\n" to match an end-of-line, the end | |
| 3945 pattern must be found in the same line as where the start pattern ends. The | |
| 3946 end pattern may also include an end-of-line. Thus the "oneline" argument | |
| 3947 means that the end of the start pattern and the start of the end pattern must | |
| 3948 be within one line. This can't be changed by a skip pattern that matches a | |
| 3949 line break. | |
| 3950 | |
| 3951 | |
| 3952 fold *:syn-fold* | |
| 3953 | |
| 1624 | 3954 The "fold" argument makes the fold level increase by one for this item. |
| 7 | 3955 Example: > |
| 3956 :syn region myFold start="{" end="}" transparent fold | |
| 3957 :syn sync fromstart | |
| 3958 :set foldmethod=syntax | |
| 3959 This will make each {} block form one fold. | |
| 3960 | |
| 3961 The fold will start on the line where the item starts, and end where the item | |
| 3962 ends. If the start and end are within the same line, there is no fold. | |
| 3963 The 'foldnestmax' option limits the nesting of syntax folds. | |
| 3964 {not available when Vim was compiled without |+folding| feature} | |
| 3965 | |
| 3966 | |
| 3967 *:syn-contains* *E405* *E406* *E407* *E408* *E409* | |
| 6259 | 3968 contains={group-name},.. |
| 7 | 3969 |
| 3970 The "contains" argument is followed by a list of syntax group names. These | |
| 3971 groups will be allowed to begin inside the item (they may extend past the | |
| 3972 containing group's end). This allows for recursive nesting of matches and | |
| 3973 regions. If there is no "contains" argument, no groups will be contained in | |
| 3974 this item. The group names do not need to be defined before they can be used | |
| 3975 here. | |
| 3976 | |
| 3977 contains=ALL | |
| 3978 If the only item in the contains list is "ALL", then all | |
| 3979 groups will be accepted inside the item. | |
| 3980 | |
| 3981 contains=ALLBUT,{group-name},.. | |
| 3982 If the first item in the contains list is "ALLBUT", then all | |
| 3983 groups will be accepted inside the item, except the ones that | |
| 3984 are listed. Example: > | |
| 3985 :syntax region Block start="{" end="}" ... contains=ALLBUT,Function | |
| 3986 | |
| 3987 contains=TOP | |
| 3988 If the first item in the contains list is "TOP", then all | |
| 3989 groups will be accepted that don't have the "contained" | |
| 3990 argument. | |
| 3991 contains=TOP,{group-name},.. | |
| 3992 Like "TOP", but excluding the groups that are listed. | |
| 3993 | |
| 3994 contains=CONTAINED | |
| 3995 If the first item in the contains list is "CONTAINED", then | |
| 3996 all groups will be accepted that have the "contained" | |
| 3997 argument. | |
| 3998 contains=CONTAINED,{group-name},.. | |
| 3999 Like "CONTAINED", but excluding the groups that are | |
| 4000 listed. | |
| 4001 | |
| 4002 | |
| 4003 The {group-name} in the "contains" list can be a pattern. All group names | |
| 4004 that match the pattern will be included (or excluded, if "ALLBUT" is used). | |
| 4005 The pattern cannot contain white space or a ','. Example: > | |
| 4006 ... contains=Comment.*,Keyw[0-3] | |
| 4007 The matching will be done at moment the syntax command is executed. Groups | |
| 4008 that are defined later will not be matched. Also, if the current syntax | |
| 4009 command defines a new group, it is not matched. Be careful: When putting | |
| 4010 syntax commands in a file you can't rely on groups NOT being defined, because | |
| 4011 the file may have been sourced before, and ":syn clear" doesn't remove the | |
| 4012 group names. | |
| 4013 | |
| 4014 The contained groups will also match in the start and end patterns of a | |
| 4015 region. If this is not wanted, the "matchgroup" argument can be used | |
| 4016 |:syn-matchgroup|. The "ms=" and "me=" offsets can be used to change the | |
| 4017 region where contained items do match. Note that this may also limit the | |
| 4018 area that is highlighted | |
| 4019 | |
| 4020 | |
| 6259 | 4021 containedin={group-name}... *:syn-containedin* |
| 7 | 4022 |
| 4023 The "containedin" argument is followed by a list of syntax group names. The | |
| 4024 item will be allowed to begin inside these groups. This works as if the | |
| 4025 containing item has a "contains=" argument that includes this item. | |
| 4026 | |
| 6259 | 4027 The {group-name}... can be used just like for "contains", as explained above. |
| 7 | 4028 |
| 4029 This is useful when adding a syntax item afterwards. An item can be told to | |
| 4030 be included inside an already existing item, without changing the definition | |
| 4031 of that item. For example, to highlight a word in a C comment after loading | |
| 4032 the C syntax: > | |
| 4033 :syn keyword myword HELP containedin=cComment contained | |
| 4034 Note that "contained" is also used, to avoid that the item matches at the top | |
| 4035 level. | |
| 4036 | |
| 4037 Matches for "containedin" are added to the other places where the item can | |
| 4038 appear. A "contains" argument may also be added as usual. Don't forget that | |
| 4039 keywords never contain another item, thus adding them to "containedin" won't | |
| 4040 work. | |
| 4041 | |
| 4042 | |
| 6259 | 4043 nextgroup={group-name},.. *:syn-nextgroup* |
| 7 | 4044 |
| 4045 The "nextgroup" argument is followed by a list of syntax group names, | |
| 4046 separated by commas (just like with "contains", so you can also use patterns). | |
| 4047 | |
| 4048 If the "nextgroup" argument is given, the mentioned syntax groups will be | |
| 4049 tried for a match, after the match or region ends. If none of the groups have | |
| 4050 a match, highlighting continues normally. If there is a match, this group | |
| 4051 will be used, even when it is not mentioned in the "contains" field of the | |
| 4052 current group. This is like giving the mentioned group priority over all | |
| 4053 other groups. Example: > | |
| 4054 :syntax match ccFoobar "Foo.\{-}Bar" contains=ccFoo | |
| 4055 :syntax match ccFoo "Foo" contained nextgroup=ccFiller | |
| 4056 :syntax region ccFiller start="." matchgroup=ccBar end="Bar" contained | |
| 4057 | |
| 4058 This will highlight "Foo" and "Bar" differently, and only when there is a | |
| 4059 "Bar" after "Foo". In the text line below, "f" shows where ccFoo is used for | |
| 4060 highlighting, and "bbb" where ccBar is used. > | |
| 4061 | |
| 4062 Foo asdfasd Bar asdf Foo asdf Bar asdf | |
| 4063 fff bbb fff bbb | |
| 4064 | |
| 4065 Note the use of ".\{-}" to skip as little as possible until the next Bar. | |
| 4066 when ".*" would be used, the "asdf" in between "Bar" and "Foo" would be | |
| 4067 highlighted according to the "ccFoobar" group, because the ccFooBar match | |
| 4068 would include the first "Foo" and the last "Bar" in the line (see |pattern|). | |
| 4069 | |
| 4070 | |
| 4071 skipwhite *:syn-skipwhite* | |
| 4072 skipnl *:syn-skipnl* | |
| 4073 skipempty *:syn-skipempty* | |
| 4074 | |
| 4075 These arguments are only used in combination with "nextgroup". They can be | |
| 4076 used to allow the next group to match after skipping some text: | |
| 1275 | 4077 skipwhite skip over space and tab characters |
| 7 | 4078 skipnl skip over the end of a line |
| 4079 skipempty skip over empty lines (implies a "skipnl") | |
| 4080 | |
| 4081 When "skipwhite" is present, the white space is only skipped if there is no | |
| 4082 next group that matches the white space. | |
| 4083 | |
| 4084 When "skipnl" is present, the match with nextgroup may be found in the next | |
| 4085 line. This only happens when the current item ends at the end of the current | |
| 4086 line! When "skipnl" is not present, the nextgroup will only be found after | |
| 4087 the current item in the same line. | |
| 4088 | |
| 4089 When skipping text while looking for a next group, the matches for other | |
| 4090 groups are ignored. Only when no next group matches, other items are tried | |
| 4091 for a match again. This means that matching a next group and skipping white | |
| 4092 space and <EOL>s has a higher priority than other items. | |
| 4093 | |
| 4094 Example: > | |
| 4095 :syn match ifstart "\<if.*" nextgroup=ifline skipwhite skipempty | |
| 4096 :syn match ifline "[^ \t].*" nextgroup=ifline skipwhite skipempty contained | |
| 4097 :syn match ifline "endif" contained | |
| 4098 Note that the "[^ \t].*" match matches all non-white text. Thus it would also | |
| 4099 match "endif". Therefore the "endif" match is put last, so that it takes | |
| 4100 precedence. | |
| 4101 Note that this example doesn't work for nested "if"s. You need to add | |
| 4102 "contains" arguments to make that work (omitted for simplicity of the | |
| 4103 example). | |
| 4104 | |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
4105 IMPLICIT CONCEAL *:syn-conceal-implicit* |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
4106 |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
4107 :sy[ntax] conceal [on|off] |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
4108 This defines if the following ":syntax" commands will define keywords, |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
4109 matches or regions with the "conceal" flag set. After ":syn conceal |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
4110 on", all subsequent ":syn keyword", ":syn match" or ":syn region" |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
4111 defined will have the "conceal" flag set implicitly. ":syn conceal |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
4112 off" returns to the normal state where the "conceal" flag must be |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
4113 given explicitly. |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
4114 |
| 10734 | 4115 :sy[ntax] conceal |
| 4116 Show either "syntax conceal on" or "syntax conceal off" (translated). | |
| 4117 | |
| 7 | 4118 ============================================================================== |
| 4119 7. Syntax patterns *:syn-pattern* *E401* *E402* | |
| 4120 | |
| 4121 In the syntax commands, a pattern must be surrounded by two identical | |
| 4122 characters. This is like it works for the ":s" command. The most common to | |
| 4123 use is the double quote. But if the pattern contains a double quote, you can | |
| 4124 use another character that is not used in the pattern. Examples: > | |
| 4125 :syntax region Comment start="/\*" end="\*/" | |
| 4126 :syntax region String start=+"+ end=+"+ skip=+\\"+ | |
| 4127 | |
| 4128 See |pattern| for the explanation of what a pattern is. Syntax patterns are | |
| 1624 | 4129 always interpreted like the 'magic' option is set, no matter what the actual |
| 7 | 4130 value of 'magic' is. And the patterns are interpreted like the 'l' flag is |
| 4131 not included in 'cpoptions'. This was done to make syntax files portable and | |
| 4132 independent of 'compatible' and 'magic' settings. | |
| 4133 | |
| 4134 Try to avoid patterns that can match an empty string, such as "[a-z]*". | |
| 4135 This slows down the highlighting a lot, because it matches everywhere. | |
| 4136 | |
| 4137 *:syn-pattern-offset* | |
| 4138 The pattern can be followed by a character offset. This can be used to | |
| 4139 change the highlighted part, and to change the text area included in the | |
| 4140 match or region (which only matters when trying to match other items). Both | |
| 4141 are relative to the matched pattern. The character offset for a skip | |
| 4142 pattern can be used to tell where to continue looking for an end pattern. | |
| 4143 | |
| 4144 The offset takes the form of "{what}={offset}" | |
| 4145 The {what} can be one of seven strings: | |
| 4146 | |
| 4147 ms Match Start offset for the start of the matched text | |
| 4148 me Match End offset for the end of the matched text | |
| 4149 hs Highlight Start offset for where the highlighting starts | |
| 4150 he Highlight End offset for where the highlighting ends | |
| 4151 rs Region Start offset for where the body of a region starts | |
| 4152 re Region End offset for where the body of a region ends | |
| 4153 lc Leading Context offset past "leading context" of pattern | |
| 4154 | |
| 4155 The {offset} can be: | |
| 4156 | |
| 4157 s start of the matched pattern | |
| 4158 s+{nr} start of the matched pattern plus {nr} chars to the right | |
| 4159 s-{nr} start of the matched pattern plus {nr} chars to the left | |
| 4160 e end of the matched pattern | |
| 4161 e+{nr} end of the matched pattern plus {nr} chars to the right | |
| 4162 e-{nr} end of the matched pattern plus {nr} chars to the left | |
| 4229 | 4163 {nr} (for "lc" only): start matching {nr} chars right of the start |
| 7 | 4164 |
| 4165 Examples: "ms=s+1", "hs=e-2", "lc=3". | |
| 4166 | |
| 4167 Although all offsets are accepted after any pattern, they are not always | |
| 4168 meaningful. This table shows which offsets are actually used: | |
| 4169 | |
| 4170 ms me hs he rs re lc ~ | |
| 4171 match item yes yes yes yes - - yes | |
| 4172 region item start yes - yes - yes - yes | |
| 4173 region item skip - yes - - - - yes | |
| 4174 region item end - yes - yes - yes yes | |
| 4175 | |
| 4176 Offsets can be concatenated, with a ',' in between. Example: > | |
| 4177 :syn match String /"[^"]*"/hs=s+1,he=e-1 | |
| 4178 < | |
| 4179 some "string" text | |
| 4180 ^^^^^^ highlighted | |
| 4181 | |
| 4182 Notes: | |
| 4183 - There must be no white space between the pattern and the character | |
| 4184 offset(s). | |
| 4185 - The highlighted area will never be outside of the matched text. | |
| 4186 - A negative offset for an end pattern may not always work, because the end | |
| 4187 pattern may be detected when the highlighting should already have stopped. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
4188 - Before Vim 7.2 the offsets were counted in bytes instead of characters. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
4189 This didn't work well for multi-byte characters, so it was changed with the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
4190 Vim 7.2 release. |
| 7 | 4191 - The start of a match cannot be in a line other than where the pattern |
| 4192 matched. This doesn't work: "a\nb"ms=e. You can make the highlighting | |
| 4193 start in another line, this does work: "a\nb"hs=e. | |
| 4194 | |
| 4195 Example (match a comment but don't highlight the /* and */): > | |
| 4196 :syntax region Comment start="/\*"hs=e+1 end="\*/"he=s-1 | |
| 4197 < | |
| 4198 /* this is a comment */ | |
| 4199 ^^^^^^^^^^^^^^^^^^^ highlighted | |
| 4200 | |
| 4201 A more complicated Example: > | |
| 4202 :syn region Exa matchgroup=Foo start="foo"hs=s+2,rs=e+2 matchgroup=Bar end="bar"me=e-1,he=e-1,re=s-1 | |
| 4203 < | |
| 4204 abcfoostringbarabc | |
| 4205 mmmmmmmmmmm match | |
| 625 | 4206 sssrrreee highlight start/region/end ("Foo", "Exa" and "Bar") |
| 7 | 4207 |
| 4208 Leading context *:syn-lc* *:syn-leading* *:syn-context* | |
| 4209 | |
| 4210 Note: This is an obsolete feature, only included for backwards compatibility | |
| 4211 with previous Vim versions. It's now recommended to use the |/\@<=| construct | |
| 4212 in the pattern. | |
| 4213 | |
| 4214 The "lc" offset specifies leading context -- a part of the pattern that must | |
| 4215 be present, but is not considered part of the match. An offset of "lc=n" will | |
| 4216 cause Vim to step back n columns before attempting the pattern match, allowing | |
| 4217 characters which have already been matched in previous patterns to also be | |
| 4218 used as leading context for this match. This can be used, for instance, to | |
| 4219 specify that an "escaping" character must not precede the match: > | |
| 4220 | |
| 4221 :syn match ZNoBackslash "[^\\]z"ms=s+1 | |
| 4222 :syn match WNoBackslash "[^\\]w"lc=1 | |
| 4223 :syn match Underline "_\+" | |
| 4224 < | |
| 4225 ___zzzz ___wwww | |
| 4226 ^^^ ^^^ matches Underline | |
| 4227 ^ ^ matches ZNoBackslash | |
| 4228 ^^^^ matches WNoBackslash | |
| 4229 | |
| 4230 The "ms" offset is automatically set to the same value as the "lc" offset, | |
| 4231 unless you set "ms" explicitly. | |
| 4232 | |
| 4233 | |
| 4234 Multi-line patterns *:syn-multi-line* | |
| 4235 | |
| 4236 The patterns can include "\n" to match an end-of-line. Mostly this works as | |
| 4237 expected, but there are a few exceptions. | |
| 4238 | |
| 4239 When using a start pattern with an offset, the start of the match is not | |
| 4240 allowed to start in a following line. The highlighting can start in a | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
4241 following line though. Using the "\zs" item also requires that the start of |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
4242 the match doesn't move to another line. |
| 7 | 4243 |
| 4244 The skip pattern can include the "\n", but the search for an end pattern will | |
| 4245 continue in the first character of the next line, also when that character is | |
| 4246 matched by the skip pattern. This is because redrawing may start in any line | |
| 4247 halfway a region and there is no check if the skip pattern started in a | |
| 4248 previous line. For example, if the skip pattern is "a\nb" and an end pattern | |
| 4249 is "b", the end pattern does match in the second line of this: > | |
| 4250 x x a | |
| 4251 b x x | |
| 4252 Generally this means that the skip pattern should not match any characters | |
| 4253 after the "\n". | |
| 4254 | |
| 4255 | |
| 4256 External matches *:syn-ext-match* | |
| 4257 | |
| 4258 These extra regular expression items are available in region patterns: | |
| 4259 | |
| 4780 | 4260 */\z(* */\z(\)* *E50* *E52* *E879* |
| 4073 | 4261 \z(\) Marks the sub-expression as "external", meaning that it can be |
| 4262 accessed from another pattern match. Currently only usable in | |
| 4263 defining a syntax region start pattern. | |
| 7 | 4264 |
| 4265 */\z1* */\z2* */\z3* */\z4* */\z5* | |
| 4266 \z1 ... \z9 */\z6* */\z7* */\z8* */\z9* *E66* *E67* | |
| 4267 Matches the same string that was matched by the corresponding | |
| 4268 sub-expression in a previous start pattern match. | |
| 4269 | |
| 4270 Sometimes the start and end patterns of a region need to share a common | |
| 4271 sub-expression. A common example is the "here" document in Perl and many Unix | |
| 4272 shells. This effect can be achieved with the "\z" special regular expression | |
| 4273 items, which marks a sub-expression as "external", in the sense that it can be | |
| 4274 referenced from outside the pattern in which it is defined. The here-document | |
| 4275 example, for instance, can be done like this: > | |
| 4276 :syn region hereDoc start="<<\z(\I\i*\)" end="^\z1$" | |
| 4277 | |
| 4278 As can be seen here, the \z actually does double duty. In the start pattern, | |
| 4279 it marks the "\(\I\i*\)" sub-expression as external; in the end pattern, it | |
|
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
4280 changes the \z1 back-reference into an external reference referring to the |
| 7 | 4281 first external sub-expression in the start pattern. External references can |
| 4282 also be used in skip patterns: > | |
| 4283 :syn region foo start="start \(\I\i*\)" skip="not end \z1" end="end \z1" | |
| 4284 | |
| 4285 Note that normal and external sub-expressions are completely orthogonal and | |
| 4286 indexed separately; for instance, if the pattern "\z(..\)\(..\)" is applied | |
| 4287 to the string "aabb", then \1 will refer to "bb" and \z1 will refer to "aa". | |
| 4288 Note also that external sub-expressions cannot be accessed as back-references | |
| 4289 within the same pattern like normal sub-expressions. If you want to use one | |
| 4290 sub-expression as both a normal and an external sub-expression, you can nest | |
| 4291 the two, as in "\(\z(...\)\)". | |
| 4292 | |
| 4293 Note that only matches within a single line can be used. Multi-line matches | |
| 4294 cannot be referred to. | |
| 4295 | |
| 4296 ============================================================================== | |
| 4297 8. Syntax clusters *:syn-cluster* *E400* | |
| 4298 | |
| 4299 :sy[ntax] cluster {cluster-name} [contains={group-name}..] | |
| 4300 [add={group-name}..] | |
| 4301 [remove={group-name}..] | |
| 4302 | |
| 4303 This command allows you to cluster a list of syntax groups together under a | |
| 4304 single name. | |
| 4305 | |
| 4306 contains={group-name}.. | |
| 4307 The cluster is set to the specified list of groups. | |
| 4308 add={group-name}.. | |
| 4309 The specified groups are added to the cluster. | |
| 4310 remove={group-name}.. | |
| 4311 The specified groups are removed from the cluster. | |
| 4312 | |
| 1624 | 4313 A cluster so defined may be referred to in a contains=.., containedin=.., |
| 4314 nextgroup=.., add=.. or remove=.. list with a "@" prefix. You can also use | |
| 4315 this notation to implicitly declare a cluster before specifying its contents. | |
| 7 | 4316 |
| 4317 Example: > | |
| 4318 :syntax match Thing "# [^#]\+ #" contains=@ThingMembers | |
| 4319 :syntax cluster ThingMembers contains=ThingMember1,ThingMember2 | |
| 4320 | |
| 4321 As the previous example suggests, modifications to a cluster are effectively | |
| 4322 retroactive; the membership of the cluster is checked at the last minute, so | |
| 4323 to speak: > | |
| 4324 :syntax keyword A aaa | |
| 4325 :syntax keyword B bbb | |
| 4326 :syntax cluster AandB contains=A | |
| 4327 :syntax match Stuff "( aaa bbb )" contains=@AandB | |
| 4328 :syntax cluster AandB add=B " now both keywords are matched in Stuff | |
| 4329 | |
| 4330 This also has implications for nested clusters: > | |
| 4331 :syntax keyword A aaa | |
| 4332 :syntax keyword B bbb | |
| 4333 :syntax cluster SmallGroup contains=B | |
| 4334 :syntax cluster BigGroup contains=A,@SmallGroup | |
| 4335 :syntax match Stuff "( aaa bbb )" contains=@BigGroup | |
| 4336 :syntax cluster BigGroup remove=B " no effect, since B isn't in BigGroup | |
| 4337 :syntax cluster SmallGroup remove=B " now bbb isn't matched within Stuff | |
| 2751 | 4338 < |
| 4339 *E848* | |
| 4340 The maximum number of clusters is 9767. | |
| 7 | 4341 |
| 4342 ============================================================================== | |
| 4343 9. Including syntax files *:syn-include* *E397* | |
| 4344 | |
| 4345 It is often useful for one language's syntax file to include a syntax file for | |
| 4346 a related language. Depending on the exact relationship, this can be done in | |
| 4347 two different ways: | |
| 4348 | |
| 4349 - If top-level syntax items in the included syntax file are to be | |
| 4350 allowed at the top level in the including syntax, you can simply use | |
| 4351 the |:runtime| command: > | |
| 4352 | |
| 4353 " In cpp.vim: | |
| 4354 :runtime! syntax/c.vim | |
| 4355 :unlet b:current_syntax | |
| 4356 | |
| 4357 < - If top-level syntax items in the included syntax file are to be | |
| 4358 contained within a region in the including syntax, you can use the | |
| 4359 ":syntax include" command: | |
| 4360 | |
| 4361 :sy[ntax] include [@{grouplist-name}] {file-name} | |
| 4362 | |
| 4363 All syntax items declared in the included file will have the | |
| 4364 "contained" flag added. In addition, if a group list is specified, | |
| 4365 all top-level syntax items in the included file will be added to | |
| 4366 that list. > | |
| 4367 | |
| 4368 " In perl.vim: | |
| 4369 :syntax include @Pod <sfile>:p:h/pod.vim | |
| 4370 :syntax region perlPOD start="^=head" end="^=cut" contains=@Pod | |
| 4371 < | |
| 4372 When {file-name} is an absolute path (starts with "/", "c:", "$VAR" | |
| 4373 or "<sfile>") that file is sourced. When it is a relative path | |
| 4374 (e.g., "syntax/pod.vim") the file is searched for in 'runtimepath'. | |
| 4375 All matching files are loaded. Using a relative path is | |
| 4376 recommended, because it allows a user to replace the included file | |
| 4377 with his own version, without replacing the file that does the ":syn | |
| 4378 include". | |
| 4379 | |
| 2751 | 4380 *E847* |
| 4381 The maximum number of includes is 999. | |
| 4382 | |
| 7 | 4383 ============================================================================== |
| 4384 10. Synchronizing *:syn-sync* *E403* *E404* | |
| 4385 | |
| 4386 Vim wants to be able to start redrawing in any position in the document. To | |
| 4387 make this possible it needs to know the syntax state at the position where | |
| 4388 redrawing starts. | |
| 4389 | |
| 4390 :sy[ntax] sync [ccomment [group-name] | minlines={N} | ...] | |
| 4391 | |
| 4392 There are four ways to synchronize: | |
| 4393 1. Always parse from the start of the file. | |
| 4394 |:syn-sync-first| | |
| 4395 2. Based on C-style comments. Vim understands how C-comments work and can | |
| 4396 figure out if the current line starts inside or outside a comment. | |
| 4397 |:syn-sync-second| | |
| 4398 3. Jumping back a certain number of lines and start parsing there. | |
| 4399 |:syn-sync-third| | |
| 4400 4. Searching backwards in the text for a pattern to sync on. | |
| 4401 |:syn-sync-fourth| | |
| 4402 | |
| 4403 *:syn-sync-maxlines* *:syn-sync-minlines* | |
| 4404 For the last three methods, the line range where the parsing can start is | |
| 4405 limited by "minlines" and "maxlines". | |
| 4406 | |
| 4407 If the "minlines={N}" argument is given, the parsing always starts at least | |
| 4408 that many lines backwards. This can be used if the parsing may take a few | |
| 4409 lines before it's correct, or when it's not possible to use syncing. | |
| 4410 | |
| 4411 If the "maxlines={N}" argument is given, the number of lines that are searched | |
| 4412 for a comment or syncing pattern is restricted to N lines backwards (after | |
| 4413 adding "minlines"). This is useful if you have few things to sync on and a | |
| 4414 slow machine. Example: > | |
| 6647 | 4415 :syntax sync maxlines=500 ccomment |
| 7 | 4416 < |
| 4417 *:syn-sync-linebreaks* | |
| 4418 When using a pattern that matches multiple lines, a change in one line may | |
| 4419 cause a pattern to no longer match in a previous line. This means has to | |
| 4420 start above where the change was made. How many lines can be specified with | |
| 4421 the "linebreaks" argument. For example, when a pattern may include one line | |
| 4422 break use this: > | |
| 4423 :syntax sync linebreaks=1 | |
| 4424 The result is that redrawing always starts at least one line before where a | |
| 4425 change was made. The default value for "linebreaks" is zero. Usually the | |
| 4426 value for "minlines" is bigger than "linebreaks". | |
| 4427 | |
| 4428 | |
| 4429 First syncing method: *:syn-sync-first* | |
| 4430 > | |
| 4431 :syntax sync fromstart | |
| 4432 | |
| 4433 The file will be parsed from the start. This makes syntax highlighting | |
| 4434 accurate, but can be slow for long files. Vim caches previously parsed text, | |
| 4435 so that it's only slow when parsing the text for the first time. However, | |
| 3224 | 4436 when making changes some part of the text needs to be parsed again (worst |
| 7 | 4437 case: to the end of the file). |
| 4438 | |
| 4439 Using "fromstart" is equivalent to using "minlines" with a very large number. | |
| 4440 | |
| 4441 | |
| 4442 Second syncing method: *:syn-sync-second* *:syn-sync-ccomment* | |
| 4443 | |
| 4444 For the second method, only the "ccomment" argument needs to be given. | |
| 4445 Example: > | |
| 4446 :syntax sync ccomment | |
| 4447 | |
| 4448 When Vim finds that the line where displaying starts is inside a C-style | |
| 4449 comment, the last region syntax item with the group-name "Comment" will be | |
| 4450 used. This requires that there is a region with the group-name "Comment"! | |
| 4451 An alternate group name can be specified, for example: > | |
| 4452 :syntax sync ccomment javaComment | |
| 4453 This means that the last item specified with "syn region javaComment" will be | |
| 4454 used for the detected C comment region. This only works properly if that | |
| 4455 region does have a start pattern "\/*" and an end pattern "*\/". | |
| 4456 | |
| 4457 The "maxlines" argument can be used to restrict the search to a number of | |
| 4458 lines. The "minlines" argument can be used to at least start a number of | |
| 4459 lines back (e.g., for when there is some construct that only takes a few | |
| 4460 lines, but it hard to sync on). | |
| 4461 | |
| 4462 Note: Syncing on a C comment doesn't work properly when strings are used | |
| 4463 that cross a line and contain a "*/". Since letting strings cross a line | |
| 4464 is a bad programming habit (many compilers give a warning message), and the | |
| 4465 chance of a "*/" appearing inside a comment is very small, this restriction | |
| 4466 is hardly ever noticed. | |
| 4467 | |
| 4468 | |
| 4469 Third syncing method: *:syn-sync-third* | |
| 4470 | |
| 4471 For the third method, only the "minlines={N}" argument needs to be given. | |
| 4472 Vim will subtract {N} from the line number and start parsing there. This | |
| 4473 means {N} extra lines need to be parsed, which makes this method a bit slower. | |
| 4474 Example: > | |
| 4475 :syntax sync minlines=50 | |
| 4476 | |
| 4477 "lines" is equivalent to "minlines" (used by older versions). | |
| 4478 | |
| 4479 | |
| 4480 Fourth syncing method: *:syn-sync-fourth* | |
| 4481 | |
| 4482 The idea is to synchronize on the end of a few specific regions, called a | |
| 4483 sync pattern. Only regions can cross lines, so when we find the end of some | |
| 4484 region, we might be able to know in which syntax item we are. The search | |
| 4485 starts in the line just above the one where redrawing starts. From there | |
| 4486 the search continues backwards in the file. | |
| 4487 | |
| 4488 This works just like the non-syncing syntax items. You can use contained | |
| 4489 matches, nextgroup, etc. But there are a few differences: | |
| 4490 - Keywords cannot be used. | |
| 4491 - The syntax items with the "sync" keyword form a completely separated group | |
| 4492 of syntax items. You can't mix syncing groups and non-syncing groups. | |
| 4493 - The matching works backwards in the buffer (line by line), instead of | |
| 4494 forwards. | |
| 4495 - A line continuation pattern can be given. It is used to decide which group | |
| 4496 of lines need to be searched like they were one line. This means that the | |
| 4497 search for a match with the specified items starts in the first of the | |
| 4498 consecutive that contain the continuation pattern. | |
| 4499 - When using "nextgroup" or "contains", this only works within one line (or | |
| 4500 group of continued lines). | |
| 4501 - When using a region, it must start and end in the same line (or group of | |
| 4502 continued lines). Otherwise the end is assumed to be at the end of the | |
| 4503 line (or group of continued lines). | |
| 4504 - When a match with a sync pattern is found, the rest of the line (or group of | |
| 4505 continued lines) is searched for another match. The last match is used. | |
| 4506 This is used when a line can contain both the start end the end of a region | |
| 4507 (e.g., in a C-comment like /* this */, the last "*/" is used). | |
| 4508 | |
| 4509 There are two ways how a match with a sync pattern can be used: | |
| 4510 1. Parsing for highlighting starts where redrawing starts (and where the | |
| 4511 search for the sync pattern started). The syntax group that is expected | |
| 4512 to be valid there must be specified. This works well when the regions | |
| 4513 that cross lines cannot contain other regions. | |
| 4514 2. Parsing for highlighting continues just after the match. The syntax group | |
| 4515 that is expected to be present just after the match must be specified. | |
| 4516 This can be used when the previous method doesn't work well. It's much | |
| 4517 slower, because more text needs to be parsed. | |
| 4518 Both types of sync patterns can be used at the same time. | |
| 4519 | |
| 4520 Besides the sync patterns, other matches and regions can be specified, to | |
| 4521 avoid finding unwanted matches. | |
| 4522 | |
| 4523 [The reason that the sync patterns are given separately, is that mostly the | |
| 4524 search for the sync point can be much simpler than figuring out the | |
| 4525 highlighting. The reduced number of patterns means it will go (much) | |
| 4526 faster.] | |
| 4527 | |
| 4528 *syn-sync-grouphere* *E393* *E394* | |
| 4529 :syntax sync match {sync-group-name} grouphere {group-name} "pattern" .. | |
| 4530 | |
| 4531 Define a match that is used for syncing. {group-name} is the | |
| 4532 name of a syntax group that follows just after the match. Parsing | |
| 4533 of the text for highlighting starts just after the match. A region | |
| 4534 must exist for this {group-name}. The first one defined will be used. | |
| 4535 "NONE" can be used for when there is no syntax group after the match. | |
| 4536 | |
| 4537 *syn-sync-groupthere* | |
| 4538 :syntax sync match {sync-group-name} groupthere {group-name} "pattern" .. | |
| 4539 | |
| 4540 Like "grouphere", but {group-name} is the name of a syntax group that | |
| 4541 is to be used at the start of the line where searching for the sync | |
| 4542 point started. The text between the match and the start of the sync | |
| 4543 pattern searching is assumed not to change the syntax highlighting. | |
| 4544 For example, in C you could search backwards for "/*" and "*/". If | |
| 4545 "/*" is found first, you know that you are inside a comment, so the | |
| 4546 "groupthere" is "cComment". If "*/" is found first, you know that you | |
| 4547 are not in a comment, so the "groupthere" is "NONE". (in practice | |
| 4548 it's a bit more complicated, because the "/*" and "*/" could appear | |
| 4549 inside a string. That's left as an exercise to the reader...). | |
| 4550 | |
| 4551 :syntax sync match .. | |
| 4552 :syntax sync region .. | |
| 4553 | |
| 4554 Without a "groupthere" argument. Define a region or match that is | |
| 4555 skipped while searching for a sync point. | |
| 4556 | |
| 856 | 4557 *syn-sync-linecont* |
| 7 | 4558 :syntax sync linecont {pattern} |
| 4559 | |
| 4560 When {pattern} matches in a line, it is considered to continue in | |
| 4561 the next line. This means that the search for a sync point will | |
| 4562 consider the lines to be concatenated. | |
| 4563 | |
| 4564 If the "maxlines={N}" argument is given too, the number of lines that are | |
| 4565 searched for a match is restricted to N. This is useful if you have very | |
| 4566 few things to sync on and a slow machine. Example: > | |
| 4567 :syntax sync maxlines=100 | |
| 4568 | |
| 4569 You can clear all sync settings with: > | |
| 4570 :syntax sync clear | |
| 4571 | |
| 4572 You can clear specific sync patterns with: > | |
| 4573 :syntax sync clear {sync-group-name} .. | |
| 4574 | |
| 4575 ============================================================================== | |
| 4576 11. Listing syntax items *:syntax* *:sy* *:syn* *:syn-list* | |
| 4577 | |
| 534 | 4578 This command lists all the syntax items: > |
| 7 | 4579 |
| 4580 :sy[ntax] [list] | |
| 4581 | |
| 4582 To show the syntax items for one syntax group: > | |
| 4583 | |
| 4584 :sy[ntax] list {group-name} | |
| 4585 | |
| 2581 | 4586 To list the syntax groups in one cluster: *E392* > |
| 7 | 4587 |
| 4588 :sy[ntax] list @{cluster-name} | |
| 4589 | |
| 4590 See above for other arguments for the ":syntax" command. | |
| 4591 | |
| 4592 Note that the ":syntax" command can be abbreviated to ":sy", although ":syn" | |
| 4593 is mostly used, because it looks better. | |
| 4594 | |
| 4595 ============================================================================== | |
| 4596 12. Highlight command *:highlight* *:hi* *E28* *E411* *E415* | |
| 4597 | |
| 4598 There are three types of highlight groups: | |
| 4599 - The ones used for specific languages. For these the name starts with the | |
| 4600 name of the language. Many of these don't have any attributes, but are | |
| 4601 linked to a group of the second type. | |
| 4602 - The ones used for all syntax languages. | |
| 4603 - The ones used for the 'highlight' option. | |
| 4604 *hitest.vim* | |
| 4605 You can see all the groups currently active with this command: > | |
| 4606 :so $VIMRUNTIME/syntax/hitest.vim | |
| 4607 This will open a new window containing all highlight group names, displayed | |
| 4608 in their own color. | |
| 4609 | |
| 4610 *:colo* *:colorscheme* *E185* | |
| 2152 | 4611 :colo[rscheme] Output the name of the currently active color scheme. |
| 4612 This is basically the same as > | |
| 4613 :echo g:colors_name | |
| 4614 < In case g:colors_name has not been defined :colo will | |
| 4615 output "default". When compiled without the |+eval| | |
| 4616 feature it will output "unknown". | |
| 4617 | |
| 7 | 4618 :colo[rscheme] {name} Load color scheme {name}. This searches 'runtimepath' |
|
5138
0d4e0cde36e1
A few updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
5024
diff
changeset
|
4619 for the file "colors/{name}.vim". The first one that |
| 7 | 4620 is found is loaded. |
|
8673
ed7251c3e2d3
commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
4621 Also searches all plugins in 'packpath', first below |
|
ed7251c3e2d3
commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
4622 "start" and then under "opt". |
|
ed7251c3e2d3
commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
4623 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
4624 Doesn't work recursively, thus you can't use |
| 7 | 4625 ":colorscheme" in a color scheme script. |
|
10319
169a62d5bcb9
commit https://github.com/vim/vim/commit/b4ada79aa7d0d1e5da3a659b1a203d7cae9f7f59
Christian Brabandt <cb@256bit.org>
parents:
10261
diff
changeset
|
4626 |
|
169a62d5bcb9
commit https://github.com/vim/vim/commit/b4ada79aa7d0d1e5da3a659b1a203d7cae9f7f59
Christian Brabandt <cb@256bit.org>
parents:
10261
diff
changeset
|
4627 To customize a colorscheme use another name, e.g. |
|
169a62d5bcb9
commit https://github.com/vim/vim/commit/b4ada79aa7d0d1e5da3a659b1a203d7cae9f7f59
Christian Brabandt <cb@256bit.org>
parents:
10261
diff
changeset
|
4628 "~/.vim/colors/mine.vim", and use `:runtime` to load |
|
169a62d5bcb9
commit https://github.com/vim/vim/commit/b4ada79aa7d0d1e5da3a659b1a203d7cae9f7f59
Christian Brabandt <cb@256bit.org>
parents:
10261
diff
changeset
|
4629 the original colorscheme: > |
|
169a62d5bcb9
commit https://github.com/vim/vim/commit/b4ada79aa7d0d1e5da3a659b1a203d7cae9f7f59
Christian Brabandt <cb@256bit.org>
parents:
10261
diff
changeset
|
4630 runtime colors/evening.vim |
|
169a62d5bcb9
commit https://github.com/vim/vim/commit/b4ada79aa7d0d1e5da3a659b1a203d7cae9f7f59
Christian Brabandt <cb@256bit.org>
parents:
10261
diff
changeset
|
4631 hi Statement ctermfg=Blue guifg=Blue |
|
169a62d5bcb9
commit https://github.com/vim/vim/commit/b4ada79aa7d0d1e5da3a659b1a203d7cae9f7f59
Christian Brabandt <cb@256bit.org>
parents:
10261
diff
changeset
|
4632 |
|
169a62d5bcb9
commit https://github.com/vim/vim/commit/b4ada79aa7d0d1e5da3a659b1a203d7cae9f7f59
Christian Brabandt <cb@256bit.org>
parents:
10261
diff
changeset
|
4633 < After the color scheme has been loaded the |
| 12 | 4634 |ColorScheme| autocommand event is triggered. |
| 22 | 4635 For info about writing a colorscheme file: > |
| 4636 :edit $VIMRUNTIME/colors/README.txt | |
| 7 | 4637 |
| 4638 :hi[ghlight] List all the current highlight groups that have | |
| 4639 attributes set. | |
| 4640 | |
| 4641 :hi[ghlight] {group-name} | |
| 4642 List one highlight group. | |
| 4643 | |
| 4644 :hi[ghlight] clear Reset all highlighting to the defaults. Removes all | |
| 4645 highlighting for groups added by the user! | |
| 4646 Uses the current value of 'background' to decide which | |
| 4647 default colors to use. | |
| 4648 | |
| 4649 :hi[ghlight] clear {group-name} | |
| 4650 :hi[ghlight] {group-name} NONE | |
| 4651 Disable the highlighting for one highlight group. It | |
| 4652 is _not_ set back to the default colors. | |
| 4653 | |
| 4654 :hi[ghlight] [default] {group-name} {key}={arg} .. | |
| 4655 Add a highlight group, or change the highlighting for | |
| 4656 an existing group. | |
| 4657 See |highlight-args| for the {key}={arg} arguments. | |
| 4658 See |:highlight-default| for the optional [default] | |
| 4659 argument. | |
| 4660 | |
| 4661 Normally a highlight group is added once when starting up. This sets the | |
| 4662 default values for the highlighting. After that, you can use additional | |
| 4663 highlight commands to change the arguments that you want to set to non-default | |
| 4664 values. The value "NONE" can be used to switch the value off or go back to | |
| 4665 the default value. | |
| 4666 | |
| 4667 A simple way to change colors is with the |:colorscheme| command. This loads | |
| 4668 a file with ":highlight" commands such as this: > | |
| 4669 | |
| 4670 :hi Comment gui=bold | |
| 4671 | |
| 4672 Note that all settings that are not included remain the same, only the | |
| 4673 specified field is used, and settings are merged with previous ones. So, the | |
| 4674 result is like this single command has been used: > | |
| 4675 :hi Comment term=bold ctermfg=Cyan guifg=#80a0ff gui=bold | |
| 4676 < | |
| 856 | 4677 *:highlight-verbose* |
| 448 | 4678 When listing a highlight group and 'verbose' is non-zero, the listing will |
| 4679 also tell where it was last set. Example: > | |
| 4680 :verbose hi Comment | |
| 4681 < Comment xxx term=bold ctermfg=4 guifg=Blue ~ | |
| 856 | 4682 Last set from /home/mool/vim/vim7/runtime/syntax/syncolor.vim ~ |
| 448 | 4683 |
| 484 | 4684 When ":hi clear" is used then the script where this command is used will be |
| 4685 mentioned for the default values. See |:verbose-cmd| for more information. | |
| 448 | 4686 |
| 7 | 4687 *highlight-args* *E416* *E417* *E423* |
| 4688 There are three types of terminals for highlighting: | |
| 4689 term a normal terminal (vt100, xterm) | |
| 4690 cterm a color terminal (MS-DOS console, color-xterm, these have the "Co" | |
| 4691 termcap entry) | |
| 4692 gui the GUI | |
| 4693 | |
| 4694 For each type the highlighting can be given. This makes it possible to use | |
| 4695 the same syntax file on all terminals, and use the optimal highlighting. | |
| 4696 | |
| 4697 1. highlight arguments for normal terminals | |
| 4698 | |
| 301 | 4699 *bold* *underline* *undercurl* |
| 4700 *inverse* *italic* *standout* | |
|
12317
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4701 *nocombine* *strikethrough* |
| 7 | 4702 term={attr-list} *attr-list* *highlight-term* *E418* |
| 4703 attr-list is a comma separated list (without spaces) of the | |
| 4704 following items (in any order): | |
| 4705 bold | |
| 4706 underline | |
| 217 | 4707 undercurl not always available |
|
12317
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4708 strikethrough not always available |
| 7 | 4709 reverse |
| 4710 inverse same as reverse | |
| 4711 italic | |
| 4712 standout | |
|
12068
e1b34958f118
patch 8.0.0914: highlight attributes are always combined
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
4713 nocombine override attributes instead of combining them |
| 7 | 4714 NONE no attributes used (used to reset it) |
| 4715 | |
| 4716 Note that "bold" can be used here and by using a bold font. They | |
| 4717 have the same effect. | |
| 217 | 4718 "undercurl" is a curly underline. When "undercurl" is not possible |
|
12317
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4719 then "underline" is used. In general "undercurl" and "strikethrough" |
|
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4720 is only available in the GUI. The color is set with |highlight-guisp|. |
| 7 | 4721 |
| 4722 start={term-list} *highlight-start* *E422* | |
| 4723 stop={term-list} *term-list* *highlight-stop* | |
| 4724 These lists of terminal codes can be used to get | |
| 4725 non-standard attributes on a terminal. | |
| 4726 | |
| 4727 The escape sequence specified with the "start" argument | |
| 4728 is written before the characters in the highlighted | |
| 4729 area. It can be anything that you want to send to the | |
| 4730 terminal to highlight this area. The escape sequence | |
| 4731 specified with the "stop" argument is written after the | |
| 4732 highlighted area. This should undo the "start" argument. | |
| 4733 Otherwise the screen will look messed up. | |
| 4734 | |
| 4735 The {term-list} can have two forms: | |
| 4736 | |
| 4737 1. A string with escape sequences. | |
| 4738 This is any string of characters, except that it can't start with | |
| 4739 "t_" and blanks are not allowed. The <> notation is recognized | |
| 4740 here, so you can use things like "<Esc>" and "<Space>". Example: | |
| 4741 start=<Esc>[27h;<Esc>[<Space>r; | |
| 4742 | |
| 4743 2. A list of terminal codes. | |
| 4744 Each terminal code has the form "t_xx", where "xx" is the name of | |
| 4745 the termcap entry. The codes have to be separated with commas. | |
| 4746 White space is not allowed. Example: | |
| 4747 start=t_C1,t_BL | |
| 4748 The terminal codes must exist for this to work. | |
| 4749 | |
| 4750 | |
| 4751 2. highlight arguments for color terminals | |
| 4752 | |
| 4753 cterm={attr-list} *highlight-cterm* | |
| 4754 See above for the description of {attr-list} |attr-list|. | |
| 4755 The "cterm" argument is likely to be different from "term", when | |
| 4756 colors are used. For example, in a normal terminal comments could | |
| 4757 be underlined, in a color terminal they can be made Blue. | |
| 4758 Note: Many terminals (e.g., DOS console) can't mix these attributes | |
| 4759 with coloring. Use only one of "cterm=" OR "ctermfg=" OR "ctermbg=". | |
| 4760 | |
| 4761 ctermfg={color-nr} *highlight-ctermfg* *E421* | |
| 4762 ctermbg={color-nr} *highlight-ctermbg* | |
| 4763 The {color-nr} argument is a color number. Its range is zero to | |
| 4764 (not including) the number given by the termcap entry "Co". | |
| 4765 The actual color with this number depends on the type of terminal | |
| 4766 and its settings. Sometimes the color also depends on the settings of | |
| 4767 "cterm". For example, on some systems "cterm=bold ctermfg=3" gives | |
| 4768 another color, on others you just get color 3. | |
| 4769 | |
| 4770 For an xterm this depends on your resources, and is a bit | |
| 4771 unpredictable. See your xterm documentation for the defaults. The | |
| 4772 colors for a color-xterm can be changed from the .Xdefaults file. | |
| 4773 Unfortunately this means that it's not possible to get the same colors | |
| 4774 for each user. See |xterm-color| for info about color xterms. | |
| 4775 | |
| 4776 The MSDOS standard colors are fixed (in a console window), so these | |
| 4777 have been used for the names. But the meaning of color names in X11 | |
| 4778 are fixed, so these color settings have been used, to make the | |
| 4779 highlighting settings portable (complicated, isn't it?). The | |
| 4780 following names are recognized, with the color number used: | |
| 4781 | |
| 4782 *cterm-colors* | |
| 4783 NR-16 NR-8 COLOR NAME ~ | |
| 4784 0 0 Black | |
| 4785 1 4 DarkBlue | |
| 4786 2 2 DarkGreen | |
| 4787 3 6 DarkCyan | |
| 4788 4 1 DarkRed | |
| 4789 5 5 DarkMagenta | |
| 4790 6 3 Brown, DarkYellow | |
| 4791 7 7 LightGray, LightGrey, Gray, Grey | |
| 4792 8 0* DarkGray, DarkGrey | |
| 4793 9 4* Blue, LightBlue | |
| 4794 10 2* Green, LightGreen | |
| 4795 11 6* Cyan, LightCyan | |
| 4796 12 1* Red, LightRed | |
| 4797 13 5* Magenta, LightMagenta | |
| 4798 14 3* Yellow, LightYellow | |
| 4799 15 7* White | |
| 4800 | |
| 4801 The number under "NR-16" is used for 16-color terminals ('t_Co' | |
| 4802 greater than or equal to 16). The number under "NR-8" is used for | |
| 4803 8-color terminals ('t_Co' less than 16). The '*' indicates that the | |
| 4804 bold attribute is set for ctermfg. In many 8-color terminals (e.g., | |
| 4805 "linux"), this causes the bright colors to appear. This doesn't work | |
| 4806 for background colors! Without the '*' the bold attribute is removed. | |
| 4807 If you want to set the bold attribute in a different way, put a | |
| 4808 "cterm=" argument AFTER the "ctermfg=" or "ctermbg=" argument. Or use | |
| 4809 a number instead of a color name. | |
| 4810 | |
| 4811 The case of the color names is ignored. | |
| 4812 Note that for 16 color ansi style terminals (including xterms), the | |
| 237 | 4813 numbers in the NR-8 column is used. Here '*' means 'add 8' so that Blue |
| 7 | 4814 is 12, DarkGray is 8 etc. |
| 4815 | |
| 4816 Note that for some color terminals these names may result in the wrong | |
| 4817 colors! | |
| 4818 | |
| 6697 | 4819 You can also use "NONE" to remove the color. |
| 4820 | |
| 7 | 4821 *:hi-normal-cterm* |
| 4822 When setting the "ctermfg" or "ctermbg" colors for the Normal group, | |
| 4823 these will become the colors used for the non-highlighted text. | |
| 4824 Example: > | |
| 4825 :highlight Normal ctermfg=grey ctermbg=darkblue | |
| 4826 < When setting the "ctermbg" color for the Normal group, the | |
| 11473 | 4827 'background' option will be adjusted automatically, under the |
| 4828 condition that the color is recognized and 'background' was not set | |
| 4829 explicitly. This causes the highlight groups that depend on | |
| 4830 'background' to change! This means you should set the colors for | |
| 4831 Normal first, before setting other colors. | |
| 7 | 4832 When a colorscheme is being used, changing 'background' causes it to |
| 4833 be reloaded, which may reset all colors (including Normal). First | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
4834 delete the "g:colors_name" variable when you don't want this. |
| 7 | 4835 |
| 4836 When you have set "ctermfg" or "ctermbg" for the Normal group, Vim | |
| 4837 needs to reset the color when exiting. This is done with the "op" | |
| 4838 termcap entry |t_op|. If this doesn't work correctly, try setting the | |
| 4839 't_op' option in your .vimrc. | |
| 4840 *E419* *E420* | |
| 4841 When Vim knows the normal foreground and background colors, "fg" and | |
| 4842 "bg" can be used as color names. This only works after setting the | |
| 4843 colors for the Normal group and for the MS-DOS console. Example, for | |
| 4844 reverse video: > | |
| 4845 :highlight Visual ctermfg=bg ctermbg=fg | |
| 4846 < Note that the colors are used that are valid at the moment this | |
| 4847 command are given. If the Normal group colors are changed later, the | |
| 4848 "fg" and "bg" colors will not be adjusted. | |
| 4849 | |
| 4850 | |
| 4851 3. highlight arguments for the GUI | |
| 4852 | |
| 4853 gui={attr-list} *highlight-gui* | |
| 4854 These give the attributes to use in the GUI mode. | |
| 4855 See |attr-list| for a description. | |
| 4856 Note that "bold" can be used here and by using a bold font. They | |
| 4857 have the same effect. | |
| 4858 Note that the attributes are ignored for the "Normal" group. | |
| 4859 | |
| 4860 font={font-name} *highlight-font* | |
| 4861 font-name is the name of a font, as it is used on the system Vim | |
| 4862 runs on. For X11 this is a complicated name, for example: > | |
| 4863 font=-misc-fixed-bold-r-normal--14-130-75-75-c-70-iso8859-1 | |
| 4864 < | |
| 4865 The font-name "NONE" can be used to revert to the default font. | |
| 4866 When setting the font for the "Normal" group, this becomes the default | |
| 4867 font (until the 'guifont' option is changed; the last one set is | |
| 4868 used). | |
| 4869 The following only works with Motif and Athena, not with other GUIs: | |
| 4870 When setting the font for the "Menu" group, the menus will be changed. | |
| 4871 When setting the font for the "Tooltip" group, the tooltips will be | |
| 4872 changed. | |
| 4873 All fonts used, except for Menu and Tooltip, should be of the same | |
| 4874 character size as the default font! Otherwise redrawing problems will | |
| 4875 occur. | |
|
9227
ecb621205ed1
commit https://github.com/vim/vim/commit/82af8710bf8d1caeeceafb1370a052cb7d92f076
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4876 To use a font name with an embedded space or other special character, |
|
ecb621205ed1
commit https://github.com/vim/vim/commit/82af8710bf8d1caeeceafb1370a052cb7d92f076
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4877 put it in single quotes. The single quote cannot be used then. |
|
ecb621205ed1
commit https://github.com/vim/vim/commit/82af8710bf8d1caeeceafb1370a052cb7d92f076
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4878 Example: > |
|
ecb621205ed1
commit https://github.com/vim/vim/commit/82af8710bf8d1caeeceafb1370a052cb7d92f076
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4879 :hi comment font='Monospace 10' |
| 7 | 4880 |
| 4881 guifg={color-name} *highlight-guifg* | |
| 4882 guibg={color-name} *highlight-guibg* | |
| 217 | 4883 guisp={color-name} *highlight-guisp* |
| 4884 These give the foreground (guifg), background (guibg) and special | |
|
12317
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4885 (guisp) color to use in the GUI. "guisp" is used for undercurl and |
|
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
4886 strikethrough. |
| 642 | 4887 There are a few special names: |
| 7 | 4888 NONE no color (transparent) |
| 4889 bg use normal background color | |
| 4890 background use normal background color | |
| 4891 fg use normal foreground color | |
| 4892 foreground use normal foreground color | |
| 4893 To use a color name with an embedded space or other special character, | |
| 4894 put it in single quotes. The single quote cannot be used then. | |
| 4895 Example: > | |
| 4896 :hi comment guifg='salmon pink' | |
| 4897 < | |
| 4898 *gui-colors* | |
| 4899 Suggested color names (these are available on most systems): | |
| 4900 Red LightRed DarkRed | |
| 4901 Green LightGreen DarkGreen SeaGreen | |
| 4902 Blue LightBlue DarkBlue SlateBlue | |
| 4903 Cyan LightCyan DarkCyan | |
| 4904 Magenta LightMagenta DarkMagenta | |
| 4905 Yellow LightYellow Brown DarkYellow | |
| 4906 Gray LightGray DarkGray | |
| 4907 Black White | |
| 4908 Orange Purple Violet | |
| 4909 | |
| 4910 In the Win32 GUI version, additional system colors are available. See | |
| 4911 |win32-colors|. | |
| 4912 | |
| 4913 You can also specify a color by its Red, Green and Blue values. | |
| 4914 The format is "#rrggbb", where | |
| 4915 "rr" is the Red value | |
| 217 | 4916 "gg" is the Green value |
| 7 | 4917 "bb" is the Blue value |
| 4918 All values are hexadecimal, range from "00" to "ff". Examples: > | |
| 4919 :highlight Comment guifg=#11f0c3 guibg=#ff00ff | |
| 4920 < | |
| 4921 *highlight-groups* *highlight-default* | |
| 4922 These are the default highlighting groups. These groups are used by the | |
| 4923 'highlight' option default. Note that the highlighting depends on the value | |
| 4924 of 'background'. You can see the current settings with the ":highlight" | |
| 4925 command. | |
|
2314
233eb4412f5d
Added 'colorcolumn' option. Partly by Gregor Uhlenheuer.
Bram Moolenaar <bram@vim.org>
parents:
2304
diff
changeset
|
4926 *hl-ColorColumn* |
|
233eb4412f5d
Added 'colorcolumn' option. Partly by Gregor Uhlenheuer.
Bram Moolenaar <bram@vim.org>
parents:
2304
diff
changeset
|
4927 ColorColumn used for the columns set with 'colorcolumn' |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
4928 *hl-Conceal* |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
4929 Conceal placeholder characters substituted for concealed |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
4930 text (see 'conceallevel') |
| 7 | 4931 *hl-Cursor* |
| 4932 Cursor the character under the cursor | |
| 4933 *hl-CursorIM* | |
| 4934 CursorIM like Cursor, but used when in IME mode |CursorIM| | |
| 746 | 4935 *hl-CursorColumn* |
| 4936 CursorColumn the screen column that the cursor is in when 'cursorcolumn' is | |
| 4937 set | |
| 4938 *hl-CursorLine* | |
| 4939 CursorLine the screen line that the cursor is in when 'cursorline' is | |
| 4940 set | |
| 7 | 4941 *hl-Directory* |
| 4942 Directory directory names (and other special names in listings) | |
| 4943 *hl-DiffAdd* | |
| 4944 DiffAdd diff mode: Added line |diff.txt| | |
| 4945 *hl-DiffChange* | |
| 4946 DiffChange diff mode: Changed line |diff.txt| | |
| 4947 *hl-DiffDelete* | |
| 4948 DiffDelete diff mode: Deleted line |diff.txt| | |
| 4949 *hl-DiffText* | |
| 4950 DiffText diff mode: Changed text within a changed line |diff.txt| | |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
4951 *hl-EndOfBuffer* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4952 EndOfBuffer filler lines (~) after the last line in the buffer. |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4953 By default, this is highlighted like |hl-NonText|. |
| 7 | 4954 *hl-ErrorMsg* |
| 4955 ErrorMsg error messages on the command line | |
| 4956 *hl-VertSplit* | |
| 4957 VertSplit the column separating vertically split windows | |
| 4958 *hl-Folded* | |
| 4959 Folded line used for closed folds | |
| 4960 *hl-FoldColumn* | |
| 4961 FoldColumn 'foldcolumn' | |
| 4962 *hl-SignColumn* | |
| 4963 SignColumn column where |signs| are displayed | |
| 4964 *hl-IncSearch* | |
| 4965 IncSearch 'incsearch' highlighting; also used for the text replaced with | |
| 4966 ":s///c" | |
| 4967 *hl-LineNr* | |
| 699 | 4968 LineNr Line number for ":number" and ":#" commands, and when 'number' |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4969 or 'relativenumber' option is set. |
| 3445 | 4970 *hl-CursorLineNr* |
| 4073 | 4971 CursorLineNr Like LineNr when 'cursorline' or 'relativenumber' is set for |
| 4972 the cursor line. | |
| 699 | 4973 *hl-MatchParen* |
| 4974 MatchParen The character under the cursor or just before it, if it | |
| 4975 is a paired bracket, and its match. |pi_paren.txt| | |
| 4976 | |
| 7 | 4977 *hl-ModeMsg* |
| 4978 ModeMsg 'showmode' message (e.g., "-- INSERT --") | |
| 4979 *hl-MoreMsg* | |
| 4980 MoreMsg |more-prompt| | |
| 4981 *hl-NonText* | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4982 NonText '@' at the end of the window, characters from 'showbreak' |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4983 and other characters that do not really exist in the text |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4984 (e.g., ">" displayed when a double-wide character doesn't |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
4985 fit at the end of the line). |
| 7 | 4986 *hl-Normal* |
| 4987 Normal normal text | |
| 540 | 4988 *hl-Pmenu* |
| 4989 Pmenu Popup menu: normal item. | |
| 4990 *hl-PmenuSel* | |
| 4991 PmenuSel Popup menu: selected item. | |
| 4992 *hl-PmenuSbar* | |
| 4993 PmenuSbar Popup menu: scrollbar. | |
| 4994 *hl-PmenuThumb* | |
| 4995 PmenuThumb Popup menu: Thumb of the scrollbar. | |
| 7 | 4996 *hl-Question* |
| 4997 Question |hit-enter| prompt and yes/no questions | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
4998 *hl-QuickFixLine* |
|
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
4999 QuickFixLine Current |quickfix| item in the quickfix window. |
| 7 | 5000 *hl-Search* |
| 5001 Search Last search pattern highlighting (see 'hlsearch'). | |
|
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
5002 Also used for similar items that need to stand out. |
| 7 | 5003 *hl-SpecialKey* |
| 5004 SpecialKey Meta and special keys listed with ":map", also for text used | |
| 5005 to show unprintable characters in the text, 'listchars'. | |
| 5006 Generally: text that is displayed differently from what it | |
| 5007 really is. | |
| 221 | 5008 *hl-SpellBad* |
| 5009 SpellBad Word that is not recognized by the spellchecker. |spell| | |
| 5010 This will be combined with the highlighting used otherwise. | |
| 391 | 5011 *hl-SpellCap* |
| 5012 SpellCap Word that should start with a capital. |spell| | |
| 5013 This will be combined with the highlighting used otherwise. | |
| 221 | 5014 *hl-SpellLocal* |
| 5015 SpellLocal Word that is recognized by the spellchecker as one that is | |
| 5016 used in another region. |spell| | |
| 5017 This will be combined with the highlighting used otherwise. | |
| 5018 *hl-SpellRare* | |
| 5019 SpellRare Word that is recognized by the spellchecker as one that is | |
| 5020 hardly ever used. |spell| | |
| 5021 This will be combined with the highlighting used otherwise. | |
| 7 | 5022 *hl-StatusLine* |
| 5023 StatusLine status line of current window | |
| 5024 *hl-StatusLineNC* | |
| 5025 StatusLineNC status lines of not-current windows | |
| 5026 Note: if this is equal to "StatusLine" Vim will use "^^^" in | |
| 5027 the status line of the current window. | |
| 677 | 5028 *hl-TabLine* |
| 5029 TabLine tab pages line, not active tab page label | |
| 5030 *hl-TabLineFill* | |
| 5031 TabLineFill tab pages line, where there are no labels | |
| 5032 *hl-TabLineSel* | |
| 5033 TabLineSel tab pages line, active tab page label | |
|
13100
656ab57d1ddc
update a few runtime files
Christian Brabandt <cb@256bit.org>
parents:
12756
diff
changeset
|
5034 *hl-Terminal* |
|
656ab57d1ddc
update a few runtime files
Christian Brabandt <cb@256bit.org>
parents:
12756
diff
changeset
|
5035 Terminal |terminal| window (see |terminal-size-color|) |
| 7 | 5036 *hl-Title* |
| 5037 Title titles for output from ":set all", ":autocmd" etc. | |
| 5038 *hl-Visual* | |
| 5039 Visual Visual mode selection | |
| 5040 *hl-VisualNOS* | |
| 5041 VisualNOS Visual mode selection when vim is "Not Owning the Selection". | |
| 5042 Only X11 Gui's |gui-x11| and |xterm-clipboard| supports this. | |
| 5043 *hl-WarningMsg* | |
| 5044 WarningMsg warning messages | |
| 5045 *hl-WildMenu* | |
| 5046 WildMenu current match in 'wildmenu' completion | |
| 5047 | |
| 523 | 5048 *hl-User1* *hl-User1..9* *hl-User9* |
| 7 | 5049 The 'statusline' syntax allows the use of 9 different highlights in the |
| 237 | 5050 statusline and ruler (via 'rulerformat'). The names are User1 to User9. |
| 7 | 5051 |
| 1624 | 5052 For the GUI you can use the following groups to set the colors for the menu, |
| 7 | 5053 scrollbars and tooltips. They don't have defaults. This doesn't work for the |
| 5054 Win32 GUI. Only three highlight arguments have any effect here: font, guibg, | |
| 5055 and guifg. | |
| 5056 | |
| 5057 *hl-Menu* | |
| 5058 Menu Current font, background and foreground colors of the menus. | |
| 5059 Also used for the toolbar. | |
| 5060 Applicable highlight arguments: font, guibg, guifg. | |
| 5061 | |
| 5062 NOTE: For Motif and Athena the font argument actually | |
| 5063 specifies a fontset at all times, no matter if 'guifontset' is | |
| 5064 empty, and as such it is tied to the current |:language| when | |
| 5065 set. | |
| 5066 | |
| 5067 *hl-Scrollbar* | |
| 5068 Scrollbar Current background and foreground of the main window's | |
| 5069 scrollbars. | |
| 5070 Applicable highlight arguments: guibg, guifg. | |
| 5071 | |
| 5072 *hl-Tooltip* | |
| 5073 Tooltip Current font, background and foreground of the tooltips. | |
| 5074 Applicable highlight arguments: font, guibg, guifg. | |
| 5075 | |
| 5076 NOTE: For Motif and Athena the font argument actually | |
| 5077 specifies a fontset at all times, no matter if 'guifontset' is | |
| 5078 empty, and as such it is tied to the current |:language| when | |
| 5079 set. | |
| 5080 | |
| 5081 ============================================================================== | |
| 5082 13. Linking groups *:hi-link* *:highlight-link* *E412* *E413* | |
| 5083 | |
| 5084 When you want to use the same highlighting for several syntax groups, you | |
| 5085 can do this more easily by linking the groups into one common highlight | |
| 5086 group, and give the color attributes only for that group. | |
| 5087 | |
| 5088 To set a link: | |
| 5089 | |
| 5090 :hi[ghlight][!] [default] link {from-group} {to-group} | |
| 5091 | |
| 5092 To remove a link: | |
| 5093 | |
| 5094 :hi[ghlight][!] [default] link {from-group} NONE | |
| 5095 | |
| 5096 Notes: *E414* | |
| 5097 - If the {from-group} and/or {to-group} doesn't exist, it is created. You | |
| 5098 don't get an error message for a non-existing group. | |
| 5099 - As soon as you use a ":highlight" command for a linked group, the link is | |
| 5100 removed. | |
| 5101 - If there are already highlight settings for the {from-group}, the link is | |
| 5102 not made, unless the '!' is given. For a ":highlight link" command in a | |
| 5103 sourced file, you don't get an error message. This can be used to skip | |
| 5104 links for groups that already have settings. | |
| 5105 | |
| 5106 *:hi-default* *:highlight-default* | |
| 5107 The [default] argument is used for setting the default highlighting for a | |
| 5108 group. If highlighting has already been specified for the group the command | |
| 5109 will be ignored. Also when there is an existing link. | |
| 5110 | |
| 5111 Using [default] is especially useful to overrule the highlighting of a | |
| 5112 specific syntax file. For example, the C syntax file contains: > | |
| 5113 :highlight default link cComment Comment | |
| 5114 If you like Question highlighting for C comments, put this in your vimrc file: > | |
| 5115 :highlight link cComment Question | |
| 5116 Without the "default" in the C syntax file, the highlighting would be | |
| 5117 overruled when the syntax file is loaded. | |
| 5118 | |
| 5119 ============================================================================== | |
| 5120 14. Cleaning up *:syn-clear* *E391* | |
| 5121 | |
| 5122 If you want to clear the syntax stuff for the current buffer, you can use this | |
| 5123 command: > | |
| 5124 :syntax clear | |
| 5125 | |
| 5126 This command should be used when you want to switch off syntax highlighting, | |
| 5127 or when you want to switch to using another syntax. It's normally not needed | |
| 5128 in a syntax file itself, because syntax is cleared by the autocommands that | |
| 5129 load the syntax file. | |
| 5130 The command also deletes the "b:current_syntax" variable, since no syntax is | |
| 5131 loaded after this command. | |
| 5132 | |
| 5133 If you want to disable syntax highlighting for all buffers, you need to remove | |
| 5134 the autocommands that load the syntax files: > | |
| 5135 :syntax off | |
| 5136 | |
| 5137 What this command actually does, is executing the command > | |
| 5138 :source $VIMRUNTIME/syntax/nosyntax.vim | |
| 5139 See the "nosyntax.vim" file for details. Note that for this to work | |
| 5140 $VIMRUNTIME must be valid. See |$VIMRUNTIME|. | |
| 5141 | |
| 5142 To clean up specific syntax groups for the current buffer: > | |
| 5143 :syntax clear {group-name} .. | |
| 5144 This removes all patterns and keywords for {group-name}. | |
| 5145 | |
| 5146 To clean up specific syntax group lists for the current buffer: > | |
| 5147 :syntax clear @{grouplist-name} .. | |
| 5148 This sets {grouplist-name}'s contents to an empty list. | |
| 5149 | |
| 5150 *:syntax-reset* *:syn-reset* | |
| 5151 If you have changed the colors and messed them up, use this command to get the | |
| 5152 defaults back: > | |
| 5153 | |
| 5154 :syntax reset | |
| 5155 | |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
5156 It is a bit of a wrong name, since it does not reset any syntax items, it only |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
5157 affects the highlighting. |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
5158 |
| 7 | 5159 This doesn't change the colors for the 'highlight' option. |
| 5160 | |
| 5161 Note that the syntax colors that you set in your vimrc file will also be reset | |
| 5162 back to their Vim default. | |
| 5163 Note that if you are using a color scheme, the colors defined by the color | |
| 5164 scheme for syntax highlighting will be lost. | |
| 5165 | |
| 5166 What this actually does is: > | |
| 5167 | |
| 5168 let g:syntax_cmd = "reset" | |
| 5169 runtime! syntax/syncolor.vim | |
| 5170 | |
| 5171 Note that this uses the 'runtimepath' option. | |
| 5172 | |
| 5173 *syncolor* | |
| 5174 If you want to use different colors for syntax highlighting, you can add a Vim | |
| 5175 script file to set these colors. Put this file in a directory in | |
| 5176 'runtimepath' which comes after $VIMRUNTIME, so that your settings overrule | |
| 5177 the default colors. This way these colors will be used after the ":syntax | |
| 5178 reset" command. | |
| 5179 | |
| 5180 For Unix you can use the file ~/.vim/after/syntax/syncolor.vim. Example: > | |
| 5181 | |
| 5182 if &background == "light" | |
| 5183 highlight comment ctermfg=darkgreen guifg=darkgreen | |
| 5184 else | |
| 5185 highlight comment ctermfg=green guifg=green | |
| 5186 endif | |
| 5187 | |
| 24 | 5188 *E679* |
| 5189 Do make sure this syncolor.vim script does not use a "syntax on", set the | |
| 5190 'background' option or uses a "colorscheme" command, because it results in an | |
| 5191 endless loop. | |
| 5192 | |
| 7 | 5193 Note that when a color scheme is used, there might be some confusion whether |
| 5194 your defined colors are to be used or the colors from the scheme. This | |
| 5195 depends on the color scheme file. See |:colorscheme|. | |
| 5196 | |
| 5197 *syntax_cmd* | |
| 5198 The "syntax_cmd" variable is set to one of these values when the | |
| 5199 syntax/syncolor.vim files are loaded: | |
| 5200 "on" ":syntax on" command. Highlight colors are overruled but | |
| 5201 links are kept | |
| 5202 "enable" ":syntax enable" command. Only define colors for groups that | |
| 5203 don't have highlighting yet. Use ":syntax default". | |
| 5204 "reset" ":syntax reset" command or loading a color scheme. Define all | |
| 5205 the colors. | |
| 5206 "skip" Don't define colors. Used to skip the default settings when a | |
| 5207 syncolor.vim file earlier in 'runtimepath' has already set | |
| 5208 them. | |
| 5209 | |
| 5210 ============================================================================== | |
| 5211 15. Highlighting tags *tag-highlight* | |
| 5212 | |
| 5213 If you want to highlight all the tags in your file, you can use the following | |
| 5214 mappings. | |
| 5215 | |
| 5216 <F11> -- Generate tags.vim file, and highlight tags. | |
| 5217 <F12> -- Just highlight tags based on existing tags.vim file. | |
| 5218 > | |
| 5219 :map <F11> :sp tags<CR>:%s/^\([^ :]*:\)\=\([^ ]*\).*/syntax keyword Tag \2/<CR>:wq! tags.vim<CR>/^<CR><F12> | |
| 5220 :map <F12> :so tags.vim<CR> | |
| 5221 | |
| 5222 WARNING: The longer the tags file, the slower this will be, and the more | |
| 5223 memory Vim will consume. | |
| 5224 | |
| 5225 Only highlighting typedefs, unions and structs can be done too. For this you | |
| 5226 must use Exuberant ctags (found at http://ctags.sf.net). | |
| 5227 | |
| 5228 Put these lines in your Makefile: | |
| 5229 | |
| 5230 # Make a highlight file for types. Requires Exuberant ctags and awk | |
| 5231 types: types.vim | |
| 5232 types.vim: *.[ch] | |
| 1125 | 5233 ctags --c-kinds=gstu -o- *.[ch] |\ |
| 7 | 5234 awk 'BEGIN{printf("syntax keyword Type\t")}\ |
| 5235 {printf("%s ", $$1)}END{print ""}' > $@ | |
| 5236 | |
| 5237 And put these lines in your .vimrc: > | |
| 5238 | |
| 5239 " load the types.vim highlighting file, if it exists | |
| 5240 autocmd BufRead,BufNewFile *.[ch] let fname = expand('<afile>:p:h') . '/types.vim' | |
| 5241 autocmd BufRead,BufNewFile *.[ch] if filereadable(fname) | |
| 5242 autocmd BufRead,BufNewFile *.[ch] exe 'so ' . fname | |
| 5243 autocmd BufRead,BufNewFile *.[ch] endif | |
| 5244 | |
| 5245 ============================================================================== | |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5246 16. Window-local syntax *:ownsyntax* |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5247 |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5248 Normally all windows on a buffer share the same syntax settings. It is |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5249 possible, however, to set a particular window on a file to have its own |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5250 private syntax setting. A possible example would be to edit LaTeX source |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5251 with conventional highlighting in one window, while seeing the same source |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5252 highlighted differently (so as to hide control sequences and indicate bold, |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5253 italic etc regions) in another. The 'scrollbind' option is useful here. |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5254 |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5255 To set the current window to have the syntax "foo", separately from all other |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5256 windows on the buffer: > |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5257 :ownsyntax foo |
|
2254
4620acaf4814
One more fix for conceal patch.
Bram Moolenaar <bram@vim.org>
parents:
2250
diff
changeset
|
5258 < *w:current_syntax* |
|
4620acaf4814
One more fix for conceal patch.
Bram Moolenaar <bram@vim.org>
parents:
2250
diff
changeset
|
5259 This will set the "w:current_syntax" variable to "foo". The value of |
|
4620acaf4814
One more fix for conceal patch.
Bram Moolenaar <bram@vim.org>
parents:
2250
diff
changeset
|
5260 "b:current_syntax" does not change. This is implemented by saving and |
|
4620acaf4814
One more fix for conceal patch.
Bram Moolenaar <bram@vim.org>
parents:
2250
diff
changeset
|
5261 restoring "b:current_syntax", since the syntax files do set |
|
4620acaf4814
One more fix for conceal patch.
Bram Moolenaar <bram@vim.org>
parents:
2250
diff
changeset
|
5262 "b:current_syntax". The value set by the syntax file is assigned to |
|
4620acaf4814
One more fix for conceal patch.
Bram Moolenaar <bram@vim.org>
parents:
2250
diff
changeset
|
5263 "w:current_syntax". |
| 6421 | 5264 Note: This resets the 'spell', 'spellcapcheck' and 'spellfile' options. |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5265 |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5266 Once a window has its own syntax, syntax commands executed from other windows |
| 4992 | 5267 on the same buffer (including :syntax clear) have no effect. Conversely, |
| 4264 | 5268 syntax commands executed from that window do not affect other windows on the |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5269 same buffer. |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5270 |
|
2254
4620acaf4814
One more fix for conceal patch.
Bram Moolenaar <bram@vim.org>
parents:
2250
diff
changeset
|
5271 A window with its own syntax reverts to normal behavior when another buffer |
|
4620acaf4814
One more fix for conceal patch.
Bram Moolenaar <bram@vim.org>
parents:
2250
diff
changeset
|
5272 is loaded into that window or the file is reloaded. |
|
4620acaf4814
One more fix for conceal patch.
Bram Moolenaar <bram@vim.org>
parents:
2250
diff
changeset
|
5273 When splitting the window, the new window will use the original syntax. |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5274 |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5275 ============================================================================== |
| 2581 | 5276 17. Color xterms *xterm-color* *color-xterm* |
| 7 | 5277 |
| 5278 Most color xterms have only eight colors. If you don't get colors with the | |
| 5279 default setup, it should work with these lines in your .vimrc: > | |
| 5280 :if &term =~ "xterm" | |
| 5281 : if has("terminfo") | |
| 5282 : set t_Co=8 | |
| 5283 : set t_Sf=<Esc>[3%p1%dm | |
| 5284 : set t_Sb=<Esc>[4%p1%dm | |
| 5285 : else | |
| 5286 : set t_Co=8 | |
| 5287 : set t_Sf=<Esc>[3%dm | |
| 5288 : set t_Sb=<Esc>[4%dm | |
| 5289 : endif | |
| 5290 :endif | |
| 5291 < [<Esc> is a real escape, type CTRL-V <Esc>] | |
| 5292 | |
| 5293 You might want to change the first "if" to match the name of your terminal, | |
| 5294 e.g. "dtterm" instead of "xterm". | |
| 5295 | |
| 5296 Note: Do these settings BEFORE doing ":syntax on". Otherwise the colors may | |
| 5297 be wrong. | |
| 5298 *xiterm* *rxvt* | |
| 5299 The above settings have been mentioned to work for xiterm and rxvt too. | |
| 5300 But for using 16 colors in an rxvt these should work with terminfo: > | |
| 5301 :set t_AB=<Esc>[%?%p1%{8}%<%t25;%p1%{40}%+%e5;%p1%{32}%+%;%dm | |
| 5302 :set t_AF=<Esc>[%?%p1%{8}%<%t22;%p1%{30}%+%e1;%p1%{22}%+%;%dm | |
| 5303 < | |
| 5304 *colortest.vim* | |
| 5305 To test your color setup, a file has been included in the Vim distribution. | |
| 671 | 5306 To use it, execute this command: > |
| 5307 :runtime syntax/colortest.vim | |
| 7 | 5308 |
| 237 | 5309 Some versions of xterm (and other terminals, like the Linux console) can |
| 7 | 5310 output lighter foreground colors, even though the number of colors is defined |
| 5311 at 8. Therefore Vim sets the "cterm=bold" attribute for light foreground | |
| 5312 colors, when 't_Co' is 8. | |
| 5313 | |
| 5314 *xfree-xterm* | |
| 5315 To get 16 colors or more, get the newest xterm version (which should be | |
| 237 | 5316 included with XFree86 3.3 and later). You can also find the latest version |
| 7 | 5317 at: > |
| 5318 http://invisible-island.net/xterm/xterm.html | |
| 5319 Here is a good way to configure it. This uses 88 colors and enables the | |
| 5320 termcap-query feature, which allows Vim to ask the xterm how many colors it | |
| 5321 supports. > | |
| 5322 ./configure --disable-bold-color --enable-88-color --enable-tcap-query | |
| 5323 If you only get 8 colors, check the xterm compilation settings. | |
| 5324 (Also see |UTF8-xterm| for using this xterm with UTF-8 character encoding). | |
| 5325 | |
| 5326 This xterm should work with these lines in your .vimrc (for 16 colors): > | |
| 5327 :if has("terminfo") | |
| 5328 : set t_Co=16 | |
| 5329 : set t_AB=<Esc>[%?%p1%{8}%<%t%p1%{40}%+%e%p1%{92}%+%;%dm | |
| 5330 : set t_AF=<Esc>[%?%p1%{8}%<%t%p1%{30}%+%e%p1%{82}%+%;%dm | |
| 5331 :else | |
| 5332 : set t_Co=16 | |
| 5333 : set t_Sf=<Esc>[3%dm | |
| 5334 : set t_Sb=<Esc>[4%dm | |
| 5335 :endif | |
| 5336 < [<Esc> is a real escape, type CTRL-V <Esc>] | |
| 5337 | |
| 5338 Without |+terminfo|, Vim will recognize these settings, and automatically | |
| 5339 translate cterm colors of 8 and above to "<Esc>[9%dm" and "<Esc>[10%dm". | |
| 5340 Colors above 16 are also translated automatically. | |
| 5341 | |
| 5342 For 256 colors this has been reported to work: > | |
| 5343 | |
| 5344 :set t_AB=<Esc>[48;5;%dm | |
| 5345 :set t_AF=<Esc>[38;5;%dm | |
| 5346 | |
| 5347 Or just set the TERM environment variable to "xterm-color" or "xterm-16color" | |
| 5348 and try if that works. | |
| 5349 | |
| 5350 You probably want to use these X resources (in your ~/.Xdefaults file): | |
| 5351 XTerm*color0: #000000 | |
| 5352 XTerm*color1: #c00000 | |
| 5353 XTerm*color2: #008000 | |
| 5354 XTerm*color3: #808000 | |
| 5355 XTerm*color4: #0000c0 | |
| 5356 XTerm*color5: #c000c0 | |
| 5357 XTerm*color6: #008080 | |
| 5358 XTerm*color7: #c0c0c0 | |
| 5359 XTerm*color8: #808080 | |
| 5360 XTerm*color9: #ff6060 | |
| 5361 XTerm*color10: #00ff00 | |
| 5362 XTerm*color11: #ffff00 | |
| 5363 XTerm*color12: #8080ff | |
| 5364 XTerm*color13: #ff40ff | |
| 5365 XTerm*color14: #00ffff | |
| 5366 XTerm*color15: #ffffff | |
| 5367 Xterm*cursorColor: Black | |
| 5368 | |
| 5369 [Note: The cursorColor is required to work around a bug, which changes the | |
| 5370 cursor color to the color of the last drawn text. This has been fixed by a | |
| 1125 | 5371 newer version of xterm, but not everybody is using it yet.] |
| 7 | 5372 |
| 5373 To get these right away, reload the .Xdefaults file to the X Option database | |
| 5374 Manager (you only need to do this when you just changed the .Xdefaults file): > | |
| 5375 xrdb -merge ~/.Xdefaults | |
| 5376 < | |
| 5377 *xterm-blink* *xterm-blinking-cursor* | |
| 5378 To make the cursor blink in an xterm, see tools/blink.c. Or use Thomas | |
| 5379 Dickey's xterm above patchlevel 107 (see above for where to get it), with | |
| 5380 these resources: | |
| 5381 XTerm*cursorBlink: on | |
| 5382 XTerm*cursorOnTime: 400 | |
| 5383 XTerm*cursorOffTime: 250 | |
| 5384 XTerm*cursorColor: White | |
| 5385 | |
| 5386 *hpterm-color* | |
| 1125 | 5387 These settings work (more or less) for an hpterm, which only supports 8 |
| 7 | 5388 foreground colors: > |
| 5389 :if has("terminfo") | |
| 5390 : set t_Co=8 | |
| 5391 : set t_Sf=<Esc>[&v%p1%dS | |
| 5392 : set t_Sb=<Esc>[&v7S | |
| 5393 :else | |
| 5394 : set t_Co=8 | |
| 5395 : set t_Sf=<Esc>[&v%dS | |
| 5396 : set t_Sb=<Esc>[&v7S | |
| 5397 :endif | |
| 5398 < [<Esc> is a real escape, type CTRL-V <Esc>] | |
| 5399 | |
| 5400 *Eterm* *enlightened-terminal* | |
| 5401 These settings have been reported to work for the Enlightened terminal | |
| 5402 emulator, or Eterm. They might work for all xterm-like terminals that use the | |
| 5403 bold attribute to get bright colors. Add an ":if" like above when needed. > | |
| 5404 :set t_Co=16 | |
| 5405 :set t_AF=^[[%?%p1%{8}%<%t3%p1%d%e%p1%{22}%+%d;1%;m | |
| 5406 :set t_AB=^[[%?%p1%{8}%<%t4%p1%d%e%p1%{32}%+%d;1%;m | |
| 5407 < | |
| 5408 *TTpro-telnet* | |
| 5409 These settings should work for TTpro telnet. Tera Term Pro is a freeware / | |
| 5410 open-source program for MS-Windows. > | |
| 5411 set t_Co=16 | |
| 5412 set t_AB=^[[%?%p1%{8}%<%t%p1%{40}%+%e%p1%{32}%+5;%;%dm | |
| 5413 set t_AF=^[[%?%p1%{8}%<%t%p1%{30}%+%e%p1%{22}%+1;%;%dm | |
| 5414 Also make sure TTpro's Setup / Window / Full Color is enabled, and make sure | |
| 5415 that Setup / Font / Enable Bold is NOT enabled. | |
| 5416 (info provided by John Love-Jensen <eljay@Adobe.COM>) | |
| 5417 | |
|
4764
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5418 |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5419 ============================================================================== |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5420 18. When syntax is slow *:syntime* |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5421 |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5422 This is aimed at authors of a syntax file. |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5423 |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5424 If your syntax causes redrawing to be slow, here are a few hints on making it |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5425 faster. To see slowness switch on some features that usually interfere, such |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5426 as 'relativenumber' and |folding|. |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5427 |
| 4780 | 5428 Note: this is only available when compiled with the |+profile| feature. |
| 5429 You many need to build Vim with "huge" features. | |
| 5430 | |
|
4764
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5431 To find out what patterns are consuming most time, get an overview with this |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5432 sequence: > |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5433 :syntime on |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5434 [ redraw the text at least once with CTRL-L ] |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5435 :syntime report |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5436 |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5437 This will display a list of syntax patterns that were used, sorted by the time |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5438 it took to match them against the text. |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5439 |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5440 :syntime on Start measuring syntax times. This will add some |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5441 overhead to compute the time spent on syntax pattern |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5442 matching. |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5443 |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5444 :syntime off Stop measuring syntax times. |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5445 |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5446 :syntime clear Set all the counters to zero, restart measuring. |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5447 |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5448 :syntime report Show the syntax items used since ":syntime on" in the |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5449 current window. Use a wider display to see more of |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5450 the output. |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5451 |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5452 The list is sorted by total time. The columns are: |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5453 TOTAL Total time in seconds spent on |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5454 matching this pattern. |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5455 COUNT Number of times the pattern was used. |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5456 MATCH Number of times the pattern actually |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5457 matched |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5458 SLOWEST The longest time for one try. |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5459 AVERAGE The average time for one try. |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5460 NAME Name of the syntax item. Note that |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5461 this is not unique. |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5462 PATTERN The pattern being used. |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5463 |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5464 Pattern matching gets slow when it has to try many alternatives. Try to |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5465 include as much literal text as possible to reduce the number of ways a |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5466 pattern does NOT match. |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5467 |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5468 When using the "\@<=" and "\@<!" items, add a maximum size to avoid trying at |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5469 all positions in the current and previous line. For example, if the item is |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5470 literal text specify the size of that text (in bytes): |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5471 |
| 4992 | 5472 "<\@<=span" Matches "span" in "<span". This tries matching with "<" in |
|
4764
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5473 many places. |
| 4992 | 5474 "<\@1<=span" Matches the same, but only tries one byte before "span". |
|
4764
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5475 |
|
f824cb97eb92
updated for version 7.3.1129
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
5476 |
| 7 | 5477 vim:tw=78:sw=4:ts=8:ft=help:norl: |