From 426b55da1a6e2757f33dae4473a616b0582cc396 Mon Sep 17 00:00:00 2001 From: h-east Date: Fri, 17 Oct 2025 23:37:22 +0900 Subject: [PATCH] Update syntax.{txt,jax} --- doc/syntax.jax | 84 +++++----- en/syntax.txt | 407 +++++++++++++++++++++++++------------------------ 2 files changed, 254 insertions(+), 237 deletions(-) diff --git a/doc/syntax.jax b/doc/syntax.jax index 5996733e3..14025b3be 100644 --- a/doc/syntax.jax +++ b/doc/syntax.jax @@ -1,4 +1,4 @@ -*syntax.txt* For Vim バージョン 9.1. Last change: 2025 Oct 07 +*syntax.txt* For Vim バージョン 9.1. Last change: 2025 Oct 14 VIMリファレンスマニュアル by Bram Moolenaar @@ -1932,7 +1932,7 @@ HTMLファイルのタグ用の構文ファイルは以下のように動作す :let html_my_rendering=1 この例については以下からmysyntax.vimをダウンロードすること。 -https://www.fleiner.com/vim/download.html +https://web.archive.org/web/20241129015117/https://www.fleiner.com/vim/download.html 次の行をvimrcに加えればこの描画を無効にできる: > :let html_no_rendering=1 @@ -2157,13 +2157,16 @@ Note これら 3 つの変数は HTML 構文ファイルで維持されること 数字と文字列は、以下で Javadoc 以外のコメントでも認識される > :let g:java_comment_strings = 1 -'foldmethod' が "syntax" に設定されている場合、コードブロックと複数行コメント -は折り畳まれる。複数行コメントの最初の行には通常テキストが書かれていないため、 +'foldmethod' が "syntax" に設定されている場合、複数行のコードブロック ("b")、 +プレーンコメント ("c")、Javadoc コメント ("d")、および隣接する "import" 宣言 +("i") はデフォルトで折り畳まれる。サポートされている種類の構文項目は、その省略 +名が以下の方法でリストから削除された場合、折り畳まれない: > + :let g:java_ignore_folding = "bcdi" +複数行コメントの最初の行には通常テキストが書かれていないため、 デフォルトの 'foldtext' 値では、Javadoc コメントの折り畳まれた内容は情報が少な くなる。この方法で書かれたコメントの場合は 2 行目の内容を表示し、それ以外の場 合は 1 行目の内容を表示するように以下で選択できる > :let g:java_foldtext_show_first_or_second_line = 1 - Javadoc コメント内の HTML タグは、|html-folding| に記載されている指示に従い、 以下に明示的に同意することでさらに折り畳むことができる > :let g:java_consent_to_html_syntax_folding = 1 @@ -3285,6 +3288,9 @@ RESTRUCTURED TEXT *rst.vim* *ft-rst-syntax* Note 一部のプラットフォームでは、折りたたみによってパフォーマンスの問題が発生 する可能性がある。 +最小の行構文同期は 50 に設定されている。この数値を変更するには: > + let rst_minlines = 100 + REXX *rexx.vim* *ft-rexx-syntax* @@ -4168,8 +4174,8 @@ ZSH *zsh.vim* *ft-zsh-syntax* "skip" を使うとパターン "end" にマッチするのを避けることができる。 複数の構文アイテムを1つの構文グループに入れることができる。構文グループにはハ -イライト属性を与えることができる。例えば、"/* .. */" のコメントを定義する要素 -と "// .." のコメントを定義する要素を作り、両方を "Comment" グループに入れる。 +イライト属性を与えることができる。例えば、"/* ... */" のコメントを定義する要素 +と "// ..." のコメントを定義する要素を作り、両方を "Comment" グループに入れる。 そして "Comment" を青のボールドフォントで表示するように指定すると、両方のタイ プのコメントに対して同じハイライトがされるようになる。1つの構文要素に対し1つの 構文グループを作ってもよいし、すべての要素を1つのグループに入れてもよい。これ @@ -4363,9 +4369,9 @@ ZSH *zsh.vim* *ft-zsh-syntax* [keepend] [extend] [excludenl] - start={start-pattern} .. + start={start-pattern} ... [skip={skip-pattern}] - end={end-pattern} .. + end={end-pattern} ... [{options}] リージョンを定義する。複数行にわたってもよい。 @@ -4680,7 +4686,7 @@ fold *:syn-fold* *:syn-contains* *E405* *E406* *E407* *E408* *E409* -contains={group-name},.. +contains={group-name},... 引数 "contains" の後には構文グループ名のリストを続ける。"contains" で指定され たグループは、そのアイテムの内側で始まることを許可される(内包されるグループに @@ -4693,7 +4699,7 @@ contains=ALL containsリストが "ALL" だけのとき、全てのグループがこのアイテ ムの内側で許可される。 -contains=ALLBUT,{group-name},.. +contains=ALLBUT,{group-name},... containsリストの最初の要素が "ALLBUT" のとき、{group-name}で列 挙したグループを除く全てのグループがこのアイテムの内側で許可さ @@ -4703,13 +4709,13 @@ contains=ALLBUT,{group-name},.. contains=TOP containsリストの最初の要素が "TOP" のとき、引数 "contained" を 持たないグループ全てが許可される。 -contains=TOP,{group-name},.. +contains=TOP,{group-name},... "TOP" と同様だが、{group-name}に列挙したグループは除かれる。 contains=CONTAINED containsリストの最初の要素が "CONTAINED" のとき、引数 "contained" を持つグループ全てが許可される。 -contains=CONTAINED,{group-name},.. +contains=CONTAINED,{group-name},... "CONTAINED" と同様だが、{group-name}に列挙したグループは除かれ る。 @@ -4731,7 +4737,7 @@ contains=CONTAINED,{group-name},.. る。これはハイライトされる範囲も制限することに注意。 -containedin={group-name}... *:syn-containedin* +containedin={group-name}.... *:syn-containedin* 引数 "containedin" の後には構文グループ名のリストを続ける。するとこのアイテム がそれらのグループの内側で始まることが許可される。これは外側のアイテムが引数 @@ -4744,7 +4750,7 @@ containedin={group-name}... *:syn-containedin* Note |:syn-transparent| 領域は、独自の |:syn-contains| リストを強制することに 注意。 -{group-name}...の指定の仕方は前述の "contains" と同様である。 +{group-name},... の指定の仕方は前述の "contains" と同様である。 これは構文アイテムを後から追加するときに便利である。既に定義されているアイテム の定義を変更することなく、その内側にアイテムを含めることができる。例えば、Cの @@ -4758,7 +4764,7 @@ Note |:syn-transparent| 領域は、独自の |:syn-contains| リストを強制 |:syn-contains|、|:syn-transparent| も参照。 -nextgroup={group-name},.. *:syn-nextgroup* +nextgroup={group-name},... *:syn-nextgroup* 引数 "nextgroup" の後には構文グループ名のリストをコンマ区切りで続ける ("contains" と同様。パターンを使うこともできる)。 @@ -5002,23 +5008,23 @@ skipパターンも "\n" を含んでよい。ただし次の行の最初の文 ============================================================================== 9. クラスタ *:syn-cluster* *E400* -:sy[ntax] cluster {cluster-name} [contains={group-name}..] - [add={group-name}..] - [remove={group-name}..] +:sy[ntax] cluster {cluster-name} [contains={group-name},...] + [add={group-name},...] + [remove={group-name},...] このコマンドを使うと、複数の構文グループを1つの名前のもとにまとめることができ る。このまとまりのことをクラスタと呼ぶ。 - contains={group-name}.. + contains={group-name},... クラスタに含まれるグループを指定する。 - add={group-name}.. + add={group-name},... 指定したグループをクラスタに加える。 - remove={group-name}.. + remove={group-name},... 指定したグループをクラスタからとり除く。 -定義したクラスタはcontains=..やcontainedin=..、nextgroup=..、add=..、remove=.. -などの文脈で使うことができる。そのとき、クラスタ名の頭に "@" をつける。クラス -タを定義する前にそのクラスタ名を使用してもよい。 +定義したクラスタは contains=...、containedin=...、nextgroup=...、add=...、 +remove=... などの文脈で使うことができる。そのとき、クラスタ名の頭に "@" をつけ +る。クラスタを定義する前にそのクラスタ名を使用してもよい。 例: > :syntax match Thing "# [^#]\+ #" contains=@ThingMembers @@ -5216,7 +5222,7 @@ Note: "*/" を含む文字列で行をまたぐものがあると、Cコメン ターンの数が減るとそれだけ速くなる。] *syn-sync-grouphere* *E393* *E394* - :syntax sync match {sync-group-name} grouphere {group-name} "pattern" .. + :syntax sync match {sync-group-name} grouphere {group-name} "pattern" ... シンクロナイズ用に使うマッチを定義する。{group-name}はマッチのすぐ後に 続く構文グループの名前である。ハイライトのためのテキストのパースはマッ @@ -5225,7 +5231,7 @@ Note: "*/" を含む文字列で行をまたぐものがあると、Cコメン プが続かない場合は "NONE" を使う。 *syn-sync-groupthere* - :syntax sync match {sync-group-name} groupthere {group-name} "pattern" .. + :syntax sync match {sync-group-name} groupthere {group-name} "pattern" ... "grouphere" と同様。ただし{group-name}はシンクロナイズポイントの検索が 始まる行の行頭で使われる構文グループの名前である。マッチとシンクロナイ @@ -5237,8 +5243,8 @@ Note: "*/" を含む文字列で行をまたぐものがあると、Cコメン 文字列の中に "/*" と "*/" があるかもしれないので、もう少し込み入ってい る。これは読者の練習問題としておく...)。 - :syntax sync match .. - :syntax sync region .. + :syntax sync match ... + :syntax sync region ... 引数 "groupthere" なしの場合。シンクロナイズポイントの検索の際にスキッ プされるリージョンやマッチを定義する。 @@ -5258,7 +5264,7 @@ Note: "*/" を含む文字列で行をまたぐものがあると、Cコメン :syntax sync clear あるシンクロナイズパターンをクリアするには: > - :syntax sync clear {sync-group-name} .. + :syntax sync clear {sync-group-name} ... ============================================================================== 12. 構文アイテムのリストを表示する *:syntax* *:sy* *:syn* *:syn-list* @@ -5392,7 +5398,7 @@ https://github.com/vim/colorschemes/blob/master/legacy_colors/ 1つのハイライトグループに対するハイライトを無効にする。 デフォルトの色に戻すわけではない。 -:hi[ghlight] [default] {group-name} {key}={arg} .. +:hi[ghlight] [default] {group-name} {key}={arg} ... ハイライトグループを追加する、または既存のグループに対 する強調を変更する。指定された色の名前が認識されない場 合、'runtimepath' 上で見付かる各 @@ -5713,7 +5719,7 @@ guisp={color-name} *highlight-guisp* 他人に信頼されるカラーリストを開発したい場合は、カラー名にプリフィック スを付けるとよい。慣例により、これらのカラーリストは colors/lists ディ レクトリに配置される。その例を - '$VIMRUNTIME/colors/lists/csscolors.vim' で見ることができる。このリス + "$VIMRUNTIME/colors/lists/csscolors.vim" で見ることができる。このリス トは、以下を使用したカラースキームによって読み込まれる: > :runtime colors/lists/csscolors.vim @@ -6010,11 +6016,11 @@ C 構文ファイルは次の行を含んでいる: > はすべての構文がなくなるからである。 カレントバッファに対する特定の構文グループを消去するには: > - :syntax clear {group-name} .. + :syntax clear {group-name} ... これは{group-name}に対する全てのパターンとキーワードを消去する。 カレントバッファに対する特定の構文グループリストを消去するには: > - :syntax clear @{grouplist-name} .. + :syntax clear @{grouplist-name} ... これは{grouplist-name}の中身を空リストにセットする。 *:syntax-off* *:syn-off* @@ -6291,7 +6297,7 @@ Setup→Font→Enable Boldが無効になっていることを確認すること ============================================================================== -20. シンタックスが遅い時には *:syntime* +20. シンタックスが遅い時には *:synti* *:syntime* この章はシンタックスファイルを作る人向けである。 @@ -6312,15 +6318,15 @@ Note: |+profile| 機能付きでコンパイルされた時のみ利用可能で これにより利用されたシンタックスパターンが、マッチにかかった時間の多い順にソー トして表示される。 -:syntime on シンタックスにかかる時間の測定を開始する。測定をするに +:synti[me] on シンタックスにかかる時間の測定を開始する。測定をするに はシンタックスパターンのマッチに多少のオーバーヘッドが 発生する。 -:syntime off シンタックスの計測を終了する。 +:synti[me] off シンタックスの計測を終了する。 -:syntime clear 全部のカウンタを 0 にし、計測をやり直す。 +:synti[me] clear 全部のカウンタを 0 にし、計測をやり直す。 -:syntime report 現在のウィンドウで ":syntime on" してから使用されたシ +:synti[me] report 現在のウィンドウで ":syntime on" してから使用されたシ ンタックス要素を表示する。出力される内容をちゃんと読む には幅の広いディスプレイを使ったほうが良い。 diff --git a/en/syntax.txt b/en/syntax.txt index 0545093bb..236340dae 100644 --- a/en/syntax.txt +++ b/en/syntax.txt @@ -1,4 +1,4 @@ -*syntax.txt* For Vim version 9.1. Last change: 2025 Oct 07 +*syntax.txt* For Vim version 9.1. Last change: 2025 Oct 14 VIM REFERENCE MANUAL by Bram Moolenaar @@ -380,12 +380,12 @@ Upon loading a file, Vim finds the relevant syntax file as follows: 4. Conversion to HTML *2html.vim* *convert-to-HTML* 2html is not a syntax file itself, but a script that converts the current -window into HTML. Vim opens a new window in which it builds the HTML file. +window into HTML. Vim opens a new window in which it builds the HTML file. -After you save the resulting file, you can view it with any browser. The +After you save the resulting file, you can view it with any browser. The colors should be exactly the same as you see them in Vim. With |g:html_line_ids| you can jump to specific lines by adding (for example) #L123 -or #123 to the end of the URL in your browser's address bar. And with +or #123 to the end of the URL in your browser's address bar. And with |g:html_dynamic_folds| enabled, you can show or hide the text that is folded in Vim. @@ -394,7 +394,7 @@ Source the script to convert the current file: > :runtime! syntax/2html.vim < -Many variables affect the output of 2html.vim; see below. Any of the on/off +Many variables affect the output of 2html.vim; see below. Any of the on/off options listed below can be enabled or disabled by setting them explicitly to the desired value, or restored to their default by removing the variable using |:unlet|. @@ -421,17 +421,17 @@ and last line to be converted. Example, using the last set Visual area: > < *:TOhtml* :[range]TOhtml The ":TOhtml" command is defined in a standard plugin. - This command will source |2html.vim| for you. When a + This command will source |2html.vim| for you. When a range is given, this command sets |g:html_start_line| and |g:html_end_line| to the start and end of the - range, respectively. Default range is the entire + range, respectively. Default range is the entire buffer. If the current window is part of a |diff|, unless |g:html_diff_one_file| is set, :TOhtml will convert all windows which are part of the diff in the current tab and place them side-by-side in a element - in the generated HTML. With |g:html_line_ids| you can + in the generated HTML. With |g:html_line_ids| you can jump to lines in specific windows with (for example) #W1L42 for line 42 in the first diffed window, or #W3L87 for line 87 in the third. @@ -445,7 +445,7 @@ and last line to be converted. Example, using the last set Visual area: > *g:html_diff_one_file* Default: 0. When 0, and using |:TOhtml| all windows involved in a |diff| in the current tab -page are converted to HTML and placed side-by-side in a
element. When +page are converted to HTML and placed side-by-side in a
element. When 1, only the current buffer is converted. Example: > @@ -465,9 +465,9 @@ not set. Default: 0. When 0, display a progress bar in the statusline for each major step in the 2html.vim conversion process. -When 1, do not display the progress bar. This offers a minor speed improvement -but you won't have any idea how much longer the conversion might take; for big -files it can take a long time! +When 1, do not display the progress bar. This offers a minor speed +improvement but you won't have any idea how much longer the conversion might +take; for big files it can take a long time! Example: > let g:html_no_progress = 1 @@ -480,17 +480,17 @@ moves through the buffer, switches windows, and the like: > < Note that the -s flag prevents loading your .vimrc and any plugins, so you need to explicitly source/enable anything that will affect the HTML -conversion. See |-E| and |-s-ex| for details. It is probably best to create a +conversion. See |-E| and |-s-ex| for details. It is probably best to create a script to replace all the -c commands and use it with the -u flag instead of specifying each command separately. *hl-TOhtmlProgress* *TOhtml-progress-color* When displayed, the progress bar will show colored boxes along the statusline -as the HTML conversion proceeds. By default, the background color as the -current "DiffDelete" highlight group is used. If "DiffDelete" and "StatusLine" +as the HTML conversion proceeds. By default, the background color as the +current "DiffDelete" highlight group is used. If "DiffDelete" and "StatusLine" have the same background color, TOhtml will automatically adjust the color to -differ. If you do not like the automatically selected colors, you can define -your own highlight colors for the progress bar. Example: > +differ. If you do not like the automatically selected colors, you can define +your own highlight colors for the progress bar. Example: > hi TOhtmlProgress guifg=#c0ffee ctermbg=7 < @@ -509,11 +509,11 @@ Go back to the default to use 'number' by deleting the variable: > *g:html_line_ids* Default: 1 if |g:html_number_lines| is set, 0 otherwise. When 1, adds an HTML id attribute to each line number, or to an empty -inserted for that purpose if no line numbers are shown. This ID attribute +inserted for that purpose if no line numbers are shown. This ID attribute takes the form of L123 for single-buffer HTML pages, or W2L123 for diff-view pages, and is used to jump to a specific line (in a specific window of a diff -view). Javascript is inserted to open any closed dynamic folds -(|g:html_dynamic_folds|) containing the specified line before jumping. The +view). Javascript is inserted to open any closed dynamic folds +(|g:html_dynamic_folds|) containing the specified line before jumping. The javascript also allows omitting the window ID in the url, and the leading L. For example: > @@ -527,7 +527,7 @@ For example: > Default: 1. When 1, generate valid HTML 5 markup with CSS styling, supported in all modern browsers and many old browsers. -When 0, generate tags and similar outdated markup. This is not +When 0, generate tags and similar outdated markup. This is not recommended but it may work better in really old browsers, email clients, forum posts, and similar situations where basic CSS support is unavailable. Example: > @@ -549,10 +549,10 @@ included in the generated HTML (unless it is folded): > *g:html_ignore_folding* Default: 0. When 0, text in a closed fold is replaced by the text shown for the fold in -Vim (|fold-foldtext|). See |g:html_dynamic_folds| if you also want to allow +Vim (|fold-foldtext|). See |g:html_dynamic_folds| if you also want to allow the user to expand the fold as in Vim to see the text inside. When 1, include all text from the buffer in the generated HTML; whether the -text is in a fold has no impact at all. |g:html_dynamic_folds| has no effect. +text is in a fold has no impact at all. |g:html_dynamic_folds| has no effect. Either of these commands will ensure that all text in the buffer is included in the generated HTML (unless it is concealed): > @@ -576,7 +576,7 @@ This variable is ignored when |g:html_ignore_folding| is set. Default: 0. When 0, if |g:html_dynamic_folds| is 1, generate a column of text similar to Vim's foldcolumn (|fold-foldcolumn|) the user can click on to toggle folds -open or closed. The minimum width of the generated text column is the current +open or closed. The minimum width of the generated text column is the current 'foldcolumn' setting. When 1, do not generate this column; instead, hovering the mouse cursor over folded text will open the fold as if |g:html_hover_unfold| were set. @@ -586,10 +586,10 @@ folded text will open the fold as if |g:html_hover_unfold| were set. *TOhtml-uncopyable-text* *g:html_prevent_copy* Default: Empty string. This option prevents certain regions of the generated HTML from being copied, -when you select all text in document rendered in a browser and copy it. Useful -for allowing users to copy-paste only the source text even if a fold column or -line numbers are shown in the generated content. Specify regions to be -affected in this way as follows: +when you select all text in document rendered in a browser and copy it. +Useful for allowing users to copy-paste only the source text even if a fold +column or line numbers are shown in the generated content. Specify regions to +be affected in this way as follows: f: fold column n: line numbers (also within fold text) t: fold text @@ -606,9 +606,9 @@ Default: "none" If |g:html_prevent_copy| is non-empty, then: When "all", read-only elements are used in place of normal text for -uncopyable regions. In some browsers, especially older browsers, after +uncopyable regions. In some browsers, especially older browsers, after selecting an entire page and copying the selection, the tags are not -pasted with the page text. If |g:html_no_invalid| is 0, the tags have +pasted with the page text. If |g:html_no_invalid| is 0, the tags have invalid type; this works in more browsers, but the page will not validate. Note: This method does NOT work in recent versions of Chrome and equivalent browsers; the tags get pasted with the text. @@ -616,23 +616,23 @@ browsers; the tags get pasted with the text. When "fallback" (default value), the same elements are generated for older browsers, but newer browsers (detected by CSS feature query) hide the elements and instead use generated content in an ::before pseudoelement -to display the uncopyable text. This method should work with the largest +to display the uncopyable text. This method should work with the largest number of browsers, both old and new. -When "none", the elements are not generated at all. Only the -generated-content method is used. This means that old browsers, notably +When "none", the elements are not generated at all. Only the +generated-content method is used. This means that old browsers, notably Internet Explorer, will either copy the text intended not to be copyable, or -the non-copyable text may not appear at all. However, this is the most +the non-copyable text may not appear at all. However, this is the most standards-based method, and there will be much less markup. *g:html_no_invalid* Default: 0. When 0, if |g:html_prevent_copy| is non-empty and |g:html_use_input_for_pc| is not "none", an invalid attribute is intentionally inserted into the -element for the uncopyable areas. This prevents pasting the elements -in some applications. Specifically, some versions of Microsoft Word will not -paste the elements if they contain this invalid attribute. When 1, no -invalid markup is inserted, and the generated page should validate. However, +element for the uncopyable areas. This prevents pasting the elements +in some applications. Specifically, some versions of Microsoft Word will not +paste the elements if they contain this invalid attribute. When 1, no +invalid markup is inserted, and the generated page should validate. However, elements may be pasted into some applications and can be difficult to remove afterward. @@ -641,7 +641,7 @@ Default: 0. When 0, the only way to open a fold generated by 2html.vim with |g:html_dynamic_folds| set, is to click on the generated fold column. When 1, use CSS 2.0 to allow the user to open a fold by moving the mouse -cursor over the displayed fold text. This is useful to allow users with +cursor over the displayed fold text. This is useful to allow users with disabled javascript to view the folded text. Note that old browsers (notably Internet Explorer 6) will not support this @@ -654,11 +654,11 @@ they will not be openable without a foldcolumn. *g:html_id_expr* Default: "" Dynamic folding and jumping to line IDs rely on unique IDs within the document -to work. If generated HTML is copied into a larger document, these IDs are no -longer guaranteed to be unique. Set g:html_id_expr to an expression Vim can +to work. If generated HTML is copied into a larger document, these IDs are no +longer guaranteed to be unique. Set g:html_id_expr to an expression Vim can evaluate to get a unique string to append to each ID used in a given document, so that the full IDs will be unique even when combined with other content in a -larger HTML document. Example, to append _ and the buffer number to each ID: > +larger HTML document. Example, to append _ and the buffer number to each ID: > :let g:html_id_expr = '"_" .. bufnr("%")' < @@ -687,11 +687,11 @@ Go back to default, determine wrapping from 'wrap' setting: > *g:html_no_pre* Default: 0. When 0, buffer text in the generated HTML is surrounded by
...
-tags. Series of whitespace is shown as in Vim without special markup, and tab +tags. Series of whitespace is shown as in Vim without special markup, and tab characters can be included literally (see |g:html_expand_tabs|). When 1 (not recommended), the
 tags are omitted, and a plain 
is -used instead. Whitespace is replaced by a series of   character -references, and
is used to end each line. This is another way to allow +used instead. Whitespace is replaced by a series of   character +references, and
is used to end each line. This is another way to allow text in the generated HTML is wrap (see |g:html_pre_wrap|) which also works in old browsers, but may cause noticeable differences between Vim's display and the rendered page generated by 2html.vim. @@ -701,8 +701,8 @@ the rendered page generated by 2html.vim. *g:html_no_doc* Default: 0. When 1 it doesn't generate a full HTML document with a DOCTYPE, , -, etc. If |g:html_use_css| is enabled (the default) you'll have to -define the CSS manually. The |g:html_dynamic_folds| and |g:html_line_ids| +, etc. If |g:html_use_css| is enabled (the default) you'll have to +define the CSS manually. The |g:html_dynamic_folds| and |g:html_line_ids| settings (off by default) also insert some JavaScript. @@ -721,9 +721,9 @@ Default: 0 if 'tabstop' is 8, 'expandtab' is 0, 'vartabstop' is not in use, When 1, characters in the buffer text are replaced with an appropriate number of space characters, or   references if |g:html_no_pre| is 1. When 0, if |g:html_no_pre| is 0 or unset, characters in the buffer text -are included as-is in the generated HTML. This is useful for when you want to +are included as-is in the generated HTML. This is useful for when you want to allow copy and paste from a browser without losing the actual whitespace in -the source document. Note that this can easily break text alignment and +the source document. Note that this can easily break text alignment and indentation in the HTML, unless set by default. Force |2html.vim| to keep characters: > @@ -738,14 +738,15 @@ It is highly recommended to set your desired encoding with If you do not specify an encoding, |2html.vim| uses the preferred IANA name for the current value of 'fileencoding' if set, or 'encoding' if not. -'encoding' is always used for certain 'buftype' values. 'fileencoding' will be -set to match the chosen document encoding. +'encoding' is always used for certain 'buftype' values. 'fileencoding' will +be set to match the chosen document encoding. Automatic detection works for the encodings mentioned specifically by name in |encoding-names|, but TOhtml will only automatically use those encodings with -wide browser support. However, you can override this to support specific +wide browser support. However, you can override this to support specific encodings that may not be automatically detected by default (see options -below). See http://www.iana.org/assignments/character-sets for the IANA names. +below). See http://www.iana.org/assignments/character-sets for the IANA +names. Note: By default all Unicode encodings are converted to UTF-8 with no BOM in the generated HTML, as recommended by W3C: @@ -756,7 +757,7 @@ the generated HTML, as recommended by W3C: *g:html_use_encoding* Default: none, uses IANA name for current 'fileencoding' as above. To overrule all automatic charset detection, set g:html_use_encoding to the -name of the charset to be used. It is recommended to set this variable to +name of the charset to be used. It is recommended to set this variable to something widely supported, like UTF-8, for anything you will be hosting on a webserver: > :let g:html_use_encoding = "UTF-8" @@ -785,10 +786,10 @@ Default: none, autoload/tohtml.vim contains default conversions for encodings mentioned by name at |encoding-names| and which have wide browser support. This option allows |2html.vim| to detect the HTML charset for any -'fileencoding' or 'encoding' which is not detected automatically. You can also -use it to override specific existing encoding-charset pairs. For example, -TOhtml will by default use UTF-8 for all Unicode/UCS encodings. To use UTF-16 -and UTF-32 instead, use: > +'fileencoding' or 'encoding' which is not detected automatically. You can +also use it to override specific existing encoding-charset pairs. For +example, TOhtml will by default use UTF-8 for all Unicode/UCS encodings. To +use UTF-16 and UTF-32 instead, use: > :let g:html_charset_override = {'ucs-4': 'UTF-32', 'utf-16': 'UTF-16'} Note that documents encoded in either UTF-32 or UTF-16 have known @@ -797,12 +798,12 @@ compatibility problems with some major browsers. *g:html_font* Default: "monospace" You can specify the font or fonts used in the converted document using -g:html_font. If this option is set to a string, then the value will be -surrounded with single quotes. If this option is set to a list then each list -item is surrounded by single quotes and the list is joined with commas. Either -way, "monospace" is added as the fallback generic family name and the entire -result used as the font family (using CSS) or font face (if not using CSS). -Examples: > +g:html_font. If this option is set to a string, then the value will be +surrounded with single quotes. If this option is set to a list then each list +item is surrounded by single quotes and the list is joined with commas. +Either way, "monospace" is added as the fallback generic family name and the +entire result used as the font family (using CSS) or font face (if not using +CSS). Examples: > " font-family: 'Consolas', monospace; :let g:html_font = "Consolas" @@ -876,9 +877,9 @@ version 2.2.3. ASSEMBLY *ft-asm-syntax* *ft-asmh8300-syntax* *ft-nasm-syntax* *ft-masm-syntax* *ft-asm68k-syntax* *fasm.vim* -Files matching "*.i" could be Progress or Assembly. If the automatic detection -doesn't work for you, or you don't edit Progress at all, use this in your -startup vimrc: > +Files matching "*.i" could be Progress or Assembly. If the automatic +detection doesn't work for you, or you don't edit Progress at all, use this in +your startup vimrc: > :let filetype_i = "asm" Replace "asm" with the type of assembly you use. @@ -893,7 +894,7 @@ files are included: ia64 Intel Itanium 64 fasm Flat assembly (http://flatassembler.net) masm Microsoft assembly (.masm files are compiled with - Microsoft's Macro Assembler. This is only supported + Microsoft's Macro Assembler. This is only supported for x86, x86_64, ARM and AARCH64 CPU families) nasm Netwide assembly tasm Turbo Assembly (with opcodes 80x86 up to Pentium, and @@ -965,7 +966,7 @@ For Visual Basic use: > ASYMPTOTE *asy.vim* *ft-asy-syntax* -By default, only basic Asymptote keywords are highlighted. To highlight +By default, only basic Asymptote keywords are highlighted. To highlight extended geometry keywords: > :let g:asy_syn_plain = 1 @@ -974,7 +975,7 @@ and for highlighting keywords related to 3D constructions: > :let g:asy_syn_three = 1 -By default, Asymptote-defined colors (e.g: lightblue) are highlighted. To +By default, Asymptote-defined colors (e.g: lightblue) are highlighted. To highlight TeX-defined colors (e.g: BlueViolet) use: > :let g:asy_syn_texcolors = 1 @@ -986,8 +987,8 @@ or for Xorg colors (e.g: AliceBlue): > BAAN *baan.vim* *baan-syntax* The baan.vim gives syntax support for BaanC of release BaanIV up to SSA ERP LN -for both 3 GL and 4 GL programming. Large number of standard defines/constants -are supported. +for both 3 GL and 4 GL programming. Large number of standard +defines/constants are supported. Some special violation of coding standards will be signalled when one specify in ones |.vimrc|: > @@ -996,7 +997,7 @@ in ones |.vimrc|: > *baan-folding* Syntax folding can be enabled at various levels through the variables -mentioned below (Set those in your |.vimrc|). The more complex folding on +mentioned below (Set those in your |.vimrc|). The more complex folding on source blocks and SQL can be CPU intensive. To allow any folding and enable folding at function level use: > @@ -1009,9 +1010,9 @@ Folding can be enabled for embedded SQL blocks as SELECT, SELECTDO, SELECTEMPTY, ... The indentation preceding the begin/end keywords has to match (spaces are not considered equal to a tab). > let baan_fold_sql=1 -Note: Block folding can result in many small folds. It is suggested to |:set| +Note: Block folding can result in many small folds. It is suggested to |:set| the options 'foldminlines' and 'foldnestmax' in |.vimrc| or use |:setlocal| in -.../after/syntax/baan.vim (see |after-directory|). Eg: > +.../after/syntax/baan.vim (see |after-directory|). Eg: > set foldminlines=5 set foldnestmax=6 @@ -1062,7 +1063,7 @@ Variable Highlight ~ *c_syntax_for_h* use C syntax for *.h files instead of C++/ObjC/ObjC++ (NOTE: This variable is deprecated and no longer necessary, as *.h files now default to C, unless the - file contains C++ or Objective-C syntax. If the + file contains C++ or Objective-C syntax. If the automated detection fails, the default filetype can be adjusted using `g:filetype_h`.) *c_no_if0* don't highlight "#if 0" blocks as comments @@ -1273,7 +1274,7 @@ variable. CSV *ft-csv-syntax* If you change the delimiter of a CSV file, its syntax highlighting will no -longer match the changed file content. You will need to unlet the following +longer match the changed file content. You will need to unlet the following variable: > :unlet b:csv_delimiter @@ -1289,10 +1290,10 @@ Now the syntax engine should determine the newly changed CSV delimiter. CYNLIB *cynlib.vim* *ft-cynlib-syntax* Cynlib files are C++ files that use the Cynlib class library to enable -hardware modelling and simulation using C++. Typically Cynlib files have a .cc -or a .cpp extension, which makes it very difficult to distinguish them from a -normal C++ file. Thus, to enable Cynlib highlighting for .cc files, add this -line to your .vimrc file: > +hardware modelling and simulation using C++. Typically Cynlib files have a +.cc or a .cpp extension, which makes it very difficult to distinguish them +from a normal C++ file. Thus, to enable Cynlib highlighting for .cc files, +add this line to your .vimrc file: > :let cynlib_cyntax_for_cc=1 @@ -1332,9 +1333,9 @@ following variables: DART *dart.vim* *ft-dart-syntax* Dart is an object-oriented, typed, class defined, garbage collected language -used for developing mobile, desktop, web, and back-end applications. Dart uses -a C-like syntax derived from C, Java, and JavaScript, with features adopted -from Smalltalk, Python, Ruby, and others. +used for developing mobile, desktop, web, and back-end applications. Dart +uses a C-like syntax derived from C, Java, and JavaScript, with features +adopted from Smalltalk, Python, Ruby, and others. More information about the language and its development environment at the official Dart language website at https://dart.dev @@ -1450,7 +1451,7 @@ Doxygen generates code documentation using a special documentation format (similar to Javadoc). This syntax script adds doxygen highlighting to c, cpp, idl and php files, and should also work with java. -There are a few of ways to turn on doxygen formatting. It can be done +There are a few of ways to turn on doxygen formatting. It can be done explicitly or in a modeline by appending '.doxygen' to the syntax of the file. Example: > :set syntax=c.doxygen @@ -1558,7 +1559,7 @@ to your startup file. EUPHORIA *euphoria3.vim* *euphoria4.vim* *ft-euphoria-syntax* -Two syntax highlighting files exist for Euphoria. One for Euphoria +Two syntax highlighting files exist for Euphoria. One for Euphoria version 3.1.1, which is the default syntax highlighting file, and one for Euphoria version 4.0.5 or later. @@ -1584,7 +1585,7 @@ add the following line to your startup file: > Elixir and Euphoria share the *.ex file extension. If the filetype is specifically set as Euphoria with the g:filetype_euphoria variable, or the file is determined to be Euphoria based on keywords in the file, then the -filetype will be set as Euphoria. Otherwise, the filetype will default to +filetype will be set as Euphoria. Otherwise, the filetype will default to Elixir. @@ -1644,10 +1645,10 @@ The following file extensions are auto-detected as Elixir file types: *.ex, *.exs, *.eex, *.leex, *.lock -Elixir and Euphoria share the *.ex file extension. If the filetype is +Elixir and Euphoria share the *.ex file extension. If the filetype is specifically set as Euphoria with the g:filetype_euphoria variable, or the file is determined to be Euphoria based on keywords in the file, then the -filetype will be set as Euphoria. Otherwise, the filetype will default to +filetype will be set as Euphoria. Otherwise, the filetype will default to Elixir. @@ -1659,12 +1660,12 @@ NOTE: This site currently doesn't work, on Wikipedia is mentioned that development stopped in 2009. Syntax highlighting is available for the most common elements of FlexWiki -syntax. The associated ftplugin script sets some buffer-local options to make -editing FlexWiki pages more convenient. FlexWiki considers a newline as the +syntax. The associated ftplugin script sets some buffer-local options to make +editing FlexWiki pages more convenient. FlexWiki considers a newline as the start of a new paragraph, so the ftplugin sets 'tw'=0 (unlimited line length), 'wrap' (wrap long lines instead of using horizontal scrolling), 'linebreak' (to wrap at a character in 'breakat' instead of at the last char on screen), -and so on. It also includes some keymaps that are disabled by default. +and so on. It also includes some keymaps that are disabled by default. If you want to enable the keymaps that make "j" and "k" and the cursor keys move up and down by display lines, add this to your .vimrc: > @@ -1725,7 +1726,7 @@ edit F# or Fortran at all, use this in your startup vimrc: > FORTRAN *fortran.vim* *ft-fortran-syntax* Default highlighting and dialect ~ -Vim highlights according to Fortran 2023 (the most recent standard). This +Vim highlights according to Fortran 2023 (the most recent standard). This choice should be appropriate for most users most of the time because Fortran 2023 is almost a superset of previous versions (Fortran 2018, 2008, 2003, 95, 90, 77, and 66). A few legacy constructs deleted or declared obsolescent, @@ -1750,21 +1751,21 @@ in your .vimrc prior to the :syntax on command. If the form of the source code depends, in a non-standard way, upon the file extension, then it is most convenient to set fortran_free_source in a ftplugin -file. For more information on ftplugin files, see |ftplugin|. Note that this +file. For more information on ftplugin files, see |ftplugin|. Note that this will work only if the "filetype plugin indent on" command precedes the "syntax on" command in your .vimrc file. When you edit an existing Fortran file, the syntax script will assume free source form if the fortran_free_source variable has been set, and assumes fixed source form if the fortran_fixed_source variable has been set. Suppose -neither of these variables have been set. In that case, the syntax script +neither of these variables have been set. In that case, the syntax script attempts to determine which source form has been used by examining the file extension using conventions common to the ifort, gfortran, Cray, NAG, and PathScale compilers (.f, .for, .f77 for fixed-source, .f90, .f95, .f03, .f08 for free-source). No default is used for the .fpp and .ftn file extensions -because different compilers treat them differently. If none of this works, +because different compilers treat them differently. If none of this works, then the script examines the first five columns of the first 500 lines of your -file. If no signs of free source form are detected, then the file is assumed +file. If no signs of free source form are detected, then the file is assumed to be in fixed source form. The algorithm should work in the vast majority of cases. In some cases, such as a file that begins with 500 or more full-line comments, the script may incorrectly decide that the code is in fixed form. @@ -1809,8 +1810,8 @@ fortran_fold in your .vimrc with a command such as > to instruct the syntax script to define fold regions for program units, that is main programs starting with a program statement, subroutines, function subprograms, modules, submodules, blocks of comment lines, and block data -units. Block, interface, associate, critical, type definition, and change team -constructs will also be folded. If you also set the variable +units. Block, interface, associate, critical, type definition, and change +team constructs will also be folded. If you also set the variable fortran_fold_conditionals with a command such as > :let fortran_fold_conditionals=1 then fold regions will also be defined for do loops, if blocks, select case, @@ -1979,7 +1980,7 @@ are read during initialization) > :let html_my_rendering=1 If you'd like to see an example download mysyntax.vim at -https://www.fleiner.com/vim/download.html +https://web.archive.org/web/20241129015117/https://www.fleiner.com/vim/download.html You can also disable this rendering by adding the following line to your vimrc file: > @@ -2214,14 +2215,17 @@ Note that these three variables are maintained in the HTML syntax file. Numbers and strings can be recognized in non-Javadoc comments with > :let g:java_comment_strings = 1 -When 'foldmethod' is set to "syntax", blocks of code and multi-line comments -will be folded. No text is usually written in the first line of a multi-line -comment, making folded contents of Javadoc comments less informative with the -default 'foldtext' value; you may opt for showing the contents of a second -line for any comments written in this way, and showing the contents of a first -line otherwise, with > +When 'foldmethod' is set to "syntax", multi-line blocks of code ("b"), plain +comments ("c"), Javadoc comments ("d"), and adjacent "import" declarations +("i") will be folded by default. Syntax items of any supported kind will +remain NOT foldable when its abbreviated name is delisted with > + :let g:java_ignore_folding = "bcdi" +No text is usually written in the first line of a multi-line comment, making +folded contents of Javadoc comments less informative with the default +'foldtext' value; you may opt for showing the contents of a second line for +any comments written in this way, and showing the contents of a first line +otherwise, with > :let g:java_foldtext_show_first_or_second_line = 1 - HTML tags in Javadoc comments can additionally be folded by following the instructions listed under |html-folding| and giving explicit consent with > :let g:java_consent_to_html_syntax_folding = 1 @@ -2288,7 +2292,7 @@ JSON *json.vim* *ft-json-syntax* *g:vim_json_conceal* *g:vim_json_warnings* The json syntax file provides syntax highlighting with conceal support by -default. To disable concealment: > +default. To disable concealment: > let g:vim_json_conceal = 0 To disable syntax highlighting of errors: > @@ -2444,7 +2448,7 @@ instead, and the name of your source file should be *.pike LUA *lua.vim* *ft-lua-syntax* -The Lua syntax file can be used for versions 4.0, 5.0+. You can select one of +The Lua syntax file can be used for versions 4.0, 5.0+. You can select one of these versions using the global variables |g:lua_version| and |g:lua_subversion|. @@ -2452,9 +2456,9 @@ these versions using the global variables |g:lua_version| and MAIL *mail.vim* *ft-mail.vim* Vim highlights all the standard elements of an email (headers, signatures, -quoted text and URLs / email addresses). In keeping with standard conventions, -signatures begin in a line containing only "--" followed optionally by -whitespaces and end with a newline. +quoted text and URLs / email addresses). In keeping with standard +conventions, signatures begin in a line containing only "--" followed +optionally by whitespaces and end with a newline. Vim treats lines beginning with ']', '}', '|', '>' or a word followed by '>' as quoted text. However Vim highlights headers and signatures in quoted text @@ -2495,8 +2499,9 @@ MAPLE *maple.vim* *ft-maple-syntax* Maple V, by Waterloo Maple Inc, supports symbolic algebra. The language supports many packages of functions which are selectively loaded by the user. -The standard set of packages' functions as supplied in Maple V release 4 may be -highlighted at the user's discretion. Users may place in their .vimrc file: > +The standard set of packages' functions as supplied in Maple V release 4 may +be highlighted at the user's discretion. Users may place in their .vimrc +file: > :let mvpkg_all= 1 @@ -2550,13 +2555,13 @@ have the following in your .vimrc: > MBSYNC *mbsync.vim* *ft-mbsync-syntax* The mbsync application uses a configuration file to setup mailboxes names, -user and password. All files ending with `.mbsyncrc` or with the name +user and password. All files ending with `.mbsyncrc` or with the name `isyncrc` will be recognized as mbsync configuration files. MEDIAWIKI *ft-mediawiki-syntax* By default, syntax highlighting includes basic HTML tags like style and -headers |html.vim|. For strict Mediawiki syntax highlighting: > +headers |html.vim|. For strict Mediawiki syntax highlighting: > let g:html_no_rendering = 1 @@ -2584,7 +2589,7 @@ The syntax for a dialect tag comment is: > m2pim = 'm2pim', m2iso = 'm2iso', m2r10 = 'm2r10' A dialect tag comment is recognised by Vim if it occurs within the first 200 -lines of the source file. Only the very first such comment is recognised, any +lines of the source file. Only the very first such comment is recognised, any additional dialect tag comments are ignored. Example: > @@ -2789,7 +2794,7 @@ To do so, set the *g:filetype_md* var: > :let g:filetype_md = 'pandoc' -The pandoc syntax plugin uses |conceal| for pretty highlighting. Default is 1 > +The pandoc syntax plugin uses |conceal| for pretty highlighting. Default is 1 > :let g:pandoc#syntax#conceal#use = 1 @@ -2818,8 +2823,8 @@ This is a list of the rules which can be used here: - inlinecode - inlinemath -You can customize the way concealing works. For example, if you prefer to mark -footnotes with the `*` symbol: > +You can customize the way concealing works. For example, if you prefer to +mark footnotes with the `*` symbol: > :let g:pandoc#syntax#conceal#cchar_overrides = {"footnote" : "*"} @@ -2839,8 +2844,8 @@ specified. Default = 1 > :let g:pandoc#syntax#codeblocks#embeds#use = 1 For specify what languages and using what syntax files to highlight embeds. -This is a list of language names. When the language pandoc and vim use don't -match, you can use the "PANDOC=VIM" syntax. For example: > +This is a list of language names. When the language pandoc and vim use don't +match, you can use the "PANDOC=VIM" syntax. For example: > :let g:pandoc#syntax#codeblocks#embeds#langs = ["ruby", "bash=sh"] @@ -2855,8 +2860,8 @@ To add underline subscript, superscript and strikeout text styles. Default = 1 > :let g:pandoc#syntax#style#underline_special = 1 -Detect and highlight definition lists. Disabling this can improve performance. -Default = 1 (i.e., enabled by default) > +Detect and highlight definition lists. Disabling this can improve +performance. Default = 1 (i.e., enabled by default) > :let g:pandoc#syntax#style#use_definition_lists = 1 @@ -2864,7 +2869,7 @@ The pandoc syntax script also comes with the following commands: > :PandocHighlight LANG -Enables embedded highlighting for language LANG in codeblocks. Uses the +Enables embedded highlighting for language LANG in codeblocks. Uses the syntax for items in g:pandoc#syntax#codeblocks#embeds#langs. > :PandocUnhighlight LANG @@ -3277,7 +3282,7 @@ commands than are actually available to you by the game. R *r.vim* *ft-r-syntax* The parsing of R code for syntax highlight starts 40 lines backwards, but you -can set a different value in your |vimrc|. Example: > +can set a different value in your |vimrc|. Example: > let r_syntax_minlines = 60 You can also turn off syntax highlighting of ROxygen: > @@ -3303,9 +3308,9 @@ To highlight R code in knitr chunk headers: > let rmd_syn_hl_chunk = 1 By default, chunks of R code will be highlighted following the rules of R -language. Moreover, whenever the buffer is saved, Vim scans the buffer and -highlights other languages if they are present in new chunks. LaTeX code also -is automatically recognized and highlighted when the buffer is saved. This +language. Moreover, whenever the buffer is saved, Vim scans the buffer and +highlights other languages if they are present in new chunks. LaTeX code also +is automatically recognized and highlighted when the buffer is saved. This behavior can be controlled with the variables `rmd_dynamic_fenced_languages`, and `rmd_include_latex` whose valid values are: > let rmd_dynamic_fenced_languages = 0 " No autodetection of languages @@ -3328,10 +3333,10 @@ To highlight R code in knitr chunk headers, add to your |vimrc|: > RASI *rasi.vim* *ft-rasi-syntax* -Rasi stands for Rofi Advanced Style Information. It is used by the program -rofi to style the rendering of the search window. The language is heavily -inspired by CSS stylesheet. Files with the following extensions are recognized -as rasi files: .rasi. +Rasi stands for Rofi Advanced Style Information. It is used by the program +rofi to style the rendering of the search window. The language is heavily +inspired by CSS stylesheet. Files with the following extensions are +recognized as rasi files: .rasi. READLINE *readline.vim* *ft-readline-syntax* @@ -3377,6 +3382,9 @@ To enable folding of sections: > Note that folding can cause performance issues on some platforms. +The minimum line syntax sync is set to 50. To modify this number: > + let rst_minlines = 100 + REXX *rexx.vim* *ft-rexx-syntax* @@ -3683,7 +3691,7 @@ the following line in your .vimrc: > Sh: EMBEDDING LANGUAGES~ You may wish to embed languages into sh. I'll give an example courtesy of -Lorance Stinson on how to do this with awk as an example. Put the following +Lorance Stinson on how to do this with awk as an example. Put the following file into $HOME/.vim/after/syntax/sh/awkembed.vim: > " AWK Embedding: @@ -3780,7 +3788,7 @@ to a larger number: > This will make the syntax synchronization start 1000 lines before the first displayed line. If you set "tcsh_minlines" to "fromstart", then -synchronization is done from the start of the file. The default value for +synchronization is done from the start of the file. The default value for tcsh_minlines is 100. The disadvantage of using a larger number is that redrawing can become slow. @@ -3989,7 +3997,7 @@ substitution will not be made. *g:tex_isk* *g:tex_stylish* Tex: Controlling iskeyword~ -Normally, LaTeX keywords support 0-9, a-z, A-z, and 192-255 only. Latex +Normally, LaTeX keywords support 0-9, a-z, A-z, and 192-255 only. Latex keywords don't support the underscore - except when in *.sty files. The syntax highlighting script handles this with the following logic: @@ -4042,7 +4050,8 @@ syntax highlighting script handles this with the following logic: < If you don't want matching to occur inside bold and italicized regions, > let g:tex_excludematcher= 1 -< will prevent the texMatcher group from being included in those regions. +< will prevent the texMatcher group from being included in those + regions. TF *tf.vim* *ft-tf-syntax* @@ -4060,7 +4069,7 @@ There is one option to control the TypeScript syntax highlighting. *g:typescript_host_keyword* When this variable is set to 1, host-specific APIs such as `addEventListener` -are highlighted. To disable set it to zero in your .vimrc: > +are highlighted. To disable set it to zero in your .vimrc: > let g:typescript_host_keyword = 0 < @@ -4070,8 +4079,8 @@ TYPST *ft-typst-syntax* *g:typst_embedded_languages* Typst files can embed syntax highlighting for other languages by setting the -|g:typst_embedded_languages| variable. This variable is a list of language -names whose syntax definitions will be included in Typst files. Example: > +|g:typst_embedded_languages| variable. This variable is a list of language +names whose syntax definitions will be included in Typst files. Example: > let g:typst_embedded_languages = ['python', 'r'] @@ -4164,8 +4173,8 @@ using Neovim), set > WDL *wdl.vim* *wdl-syntax* -The Workflow Description Language is a way to specify data processing workflows -with a human-readable and writeable syntax. This is used a lot in +The Workflow Description Language is a way to specify data processing +workflows with a human-readable and writeable syntax. This is used a lot in bioinformatics. More info on the spec can be found here: https://github.com/openwdl/wdl @@ -4233,11 +4242,11 @@ YAML *yaml.vim* *ft-yaml-syntax* *g:yaml_schema* *b:yaml_schema* A YAML schema is a combination of a set of tags and a mechanism for resolving -non-specific tags. For user this means that YAML parser may, depending on +non-specific tags. For user this means that YAML parser may, depending on plain scalar contents, treat plain scalar (which can actually be only string and nothing else) as a value of the other type: null, boolean, floating-point, -integer. `g:yaml_schema` option determines according to which schema values -will be highlighted specially. Supported schemas are +integer. `g:yaml_schema` option determines according to which schema values +will be highlighted specially. Supported schemas are Schema Description ~ failsafe No additional highlighting. @@ -4284,9 +4293,9 @@ Vim understands three types of syntax items: Several syntax ITEMs can be put into one syntax GROUP. For a syntax group you can give highlighting attributes. For example, you could have an item -to define a "/* .. */" comment and another one that defines a "// .." comment, -and put them both in the "Comment" group. You can then specify that a -"Comment" will be in bold font and have a blue color. You are free to make +to define a "/* ... */" comment and another one that defines a "// ..." +comment, and put them both in the "Comment" group. You can then specify that +a "Comment" will be in bold font and have a blue color. You are free to make one highlight group for one syntax item, or put all items into one group. This depends on how you want to specify your highlighting attributes. Putting each item in its own group results in having to specify the highlighting @@ -4486,9 +4495,9 @@ DEFINING REGIONS *:syn-region* *:syn-start* *:syn-skip* *:syn-end* [keepend] [extend] [excludenl] - start={start-pattern} .. + start={start-pattern} ... [skip={skip-pattern}] - end={end-pattern} .. + end={end-pattern} ... [{options}] This defines one region. It may span several lines. @@ -4687,7 +4696,7 @@ concealends *:syn-concealends* When the "concealends" argument is given, the start and end matches of the region, but not the contents of the region, are marked as concealable. Whether or not they are actually concealed depends on the setting on the -'conceallevel' option. The ends of a region can only be concealed separately +'conceallevel' option. The ends of a region can only be concealed separately in this way when they have their own highlighting via "matchgroup". The |synconcealed()| function can be used to retrieve information about conealed items. @@ -4822,7 +4831,7 @@ from its syntax items. *:syn-contains* *E405* *E406* *E407* *E408* *E409* -contains={group-name},.. +contains={group-name},... The "contains" argument is followed by a list of syntax group names. These groups will be allowed to begin inside the item (they may extend past the @@ -4835,7 +4844,7 @@ contains=ALL If the only item in the contains list is "ALL", then all groups will be accepted inside the item. -contains=ALLBUT,{group-name},.. +contains=ALLBUT,{group-name},... If the first item in the contains list is "ALLBUT", then all groups will be accepted inside the item, except the ones that are listed. Example: > @@ -4845,14 +4854,14 @@ contains=TOP If the first item in the contains list is "TOP", then all groups will be accepted that don't have the "contained" argument. -contains=TOP,{group-name},.. +contains=TOP,{group-name},... Like "TOP", but excluding the groups that are listed. contains=CONTAINED If the first item in the contains list is "CONTAINED", then all groups will be accepted that have the "contained" argument. -contains=CONTAINED,{group-name},.. +contains=CONTAINED,{group-name},... Like "CONTAINED", but excluding the groups that are listed. @@ -4875,7 +4884,7 @@ region where contained items do match. Note that this may also limit the area that is highlighted -containedin={group-name}... *:syn-containedin* +containedin={group-name},... *:syn-containedin* The "containedin" argument is followed by a list of syntax group names. The item will be allowed to begin inside these groups. This works as if the @@ -4888,7 +4897,7 @@ neither contains this item via |:syn-contains| nor is named in this item's Note that a |:syn-transparent| region still enforces its own |:syn-contains| list. -The {group-name}... can be used just like for "contains", as explained above. +The {group-name},... can be used just like for "contains", as explained above. This is useful when adding a syntax item afterwards. An item can be told to be included inside an already existing item, without changing the definition @@ -4905,7 +4914,7 @@ work. See also: |:syn-contains|, |:syn-transparent|. -nextgroup={group-name},.. *:syn-nextgroup* +nextgroup={group-name},... *:syn-nextgroup* The "nextgroup" argument is followed by a list of syntax group names, separated by commas (just like with "contains", so you can also use patterns). @@ -4971,7 +4980,7 @@ IMPLICIT CONCEAL *:syn-conceal-implicit* :sy[ntax] conceal [on|off] This defines if the following ":syntax" commands will define keywords, - matches or regions with the "conceal" flag set. After ":syn conceal + matches or regions with the "conceal" flag set. After ":syn conceal on", all subsequent ":syn keyword", ":syn match" or ":syn region" defined will have the "conceal" flag set implicitly. ":syn conceal off" returns to the normal state where the "conceal" flag must be @@ -5161,22 +5170,22 @@ cannot be referred to. ============================================================================== 9. Syntax clusters *:syn-cluster* *E400* -:sy[ntax] cluster {cluster-name} [contains={group-name}..] - [add={group-name}..] - [remove={group-name}..] +:sy[ntax] cluster {cluster-name} [contains={group-name},...] + [add={group-name},...] + [remove={group-name},...] This command allows you to cluster a list of syntax groups together under a single name. - contains={group-name}.. + contains={group-name},... The cluster is set to the specified list of groups. - add={group-name}.. + add={group-name},... The specified groups are added to the cluster. - remove={group-name}.. + remove={group-name},... The specified groups are removed from the cluster. -A cluster so defined may be referred to in a contains=.., containedin=.., -nextgroup=.., add=.. or remove=.. list with a "@" prefix. You can also use +A cluster so defined may be referred to in a contains=..., containedin=..., +nextgroup=..., add=... or remove=... list with a "@" prefix. You can also use this notation to implicitly declare a cluster before specifying its contents. Example: > @@ -5391,7 +5400,7 @@ highlighting. The reduced number of patterns means it will go (much) faster.] *syn-sync-grouphere* *E393* *E394* - :syntax sync match {sync-group-name} grouphere {group-name} "pattern" .. + :syntax sync match {sync-group-name} grouphere {group-name} "pattern" ... Define a match that is used for syncing. {group-name} is the name of a syntax group that follows just after the match. Parsing @@ -5400,7 +5409,7 @@ faster.] "NONE" can be used for when there is no syntax group after the match. *syn-sync-groupthere* - :syntax sync match {sync-group-name} groupthere {group-name} "pattern" .. + :syntax sync match {sync-group-name} groupthere {group-name} "pattern" ... Like "grouphere", but {group-name} is the name of a syntax group that is to be used at the start of the line where searching for the sync @@ -5413,8 +5422,8 @@ faster.] it's a bit more complicated, because the "/*" and "*/" could appear inside a string. That's left as an exercise to the reader...). - :syntax sync match .. - :syntax sync region .. + :syntax sync match ... + :syntax sync region ... Without a "groupthere" argument. Define a region or match that is skipped while searching for a sync point. @@ -5435,7 +5444,7 @@ You can clear all sync settings with: > :syntax sync clear You can clear specific sync patterns with: > - :syntax sync clear {sync-group-name} .. + :syntax sync clear {sync-group-name} ... ============================================================================== 12. Listing syntax items *:syntax* *:sy* *:syn* *:syn-list* @@ -5473,8 +5482,9 @@ of colors by using the `:colorscheme` command, for example: > < In case g:colors_name has not been defined :colo will output "default". Its palette is defined in the file "$VIMRUNTIME/syntax/syncolor.vim" and is based on - legacy versions of peachpuff and desert. When compiled - without the |+eval| feature it will output "unknown". + legacy versions of peachpuff and desert. When + compiled without the |+eval| feature it will output + "unknown". :colo[rscheme] {name} Load color scheme {name}. This searches 'runtimepath' for the file "colors/{name}.vim". The first one that @@ -5570,9 +5580,9 @@ in their own color. Disable the highlighting for one highlight group. It is _not_ set back to the default colors. -:hi[ghlight] [default] {group-name} {key}={arg} .. +:hi[ghlight] [default] {group-name} {key}={arg} ... Add a highlight group, or change the highlighting for - an existing group. If a given color name is not + an existing group. If a given color name is not recognized, each `colors/lists/default.vim` found on 'runtimepath' will be loaded. See |highlight-args| for the {key}={arg} arguments. @@ -5607,7 +5617,7 @@ also tell where it was last set. Example: > Last set from /home/mool/vim/vim7/runtime/syntax/syncolor.vim ~ When ":hi clear" is used then the script where this command is used will be -mentioned for the default values. See |:verbose-cmd| for more information. +mentioned for the default values. See |:verbose-cmd| for more information. *highlight-args* *E416* *E417* *E423* There are three types of terminals for highlighting: @@ -5808,9 +5818,9 @@ ctermul={color-nr} *highlight-ctermul* "fg" and "bg" colors will not be adjusted. ctermfont={font-nr} *highlight-ctermfont* - This gives the alternative font number to use in the terminal. The + This gives the alternative font number to use in the terminal. The available fonts depend on the terminal, and if the terminal is not set - up for alternative fonts this simply won't do anything. The range of + up for alternative fonts this simply won't do anything. The range of {font-nr} is 0-10 where 0 resets the font to the default font, 1-9 selects one of the 9 alternate fonts, and 10 selects the Fraktur font. For more information see your terminal's handling of SGR parameters @@ -5904,10 +5914,10 @@ guisp={color-name} *highlight-guisp* colorscheme alt < If you want to develop a color list that can be relied on by others, - it is best to prefix your color names. By convention these color lists - are placed in the colors/lists directory. You can see an example in - '$VIMRUNTIME/colors/lists/csscolors.vim'. This list would be sourced - by a color scheme using: > + it is best to prefix your color names. By convention these color + lists are placed in the colors/lists directory. You can see an + example in "$VIMRUNTIME/colors/lists/csscolors.vim". This list would + be sourced by a color scheme using: > :runtime colors/lists/csscolors.vim :highlight Comment guifg=css_turquoise @@ -5933,7 +5943,8 @@ lCursor Character under the cursor when |language-mapping| *hl-CursorIM* CursorIM Like Cursor, but used when in IME mode. |CursorIM| *hl-CursorColumn* -CursorColumn Screen column that the cursor is in when 'cursorcolumn' is set. +CursorColumn Screen column that the cursor is in when 'cursorcolumn' is + set. *hl-CursorLine* CursorLine Screen line that the cursor is in when 'cursorline' is set. *hl-Directory* @@ -6019,10 +6030,10 @@ PmenuSbar Popup menu: Scrollbar. *hl-PmenuThumb* PmenuThumb Popup menu: Thumb of the scrollbar. *hl-PmenuMatch* -PmenuMatch Popup menu: Matched text in normal item. Applied in +PmenuMatch Popup menu: Matched text in normal item. Applied in combination with |hl-Pmenu|. *hl-PmenuMatchSel* -PmenuMatchSel Popup menu: Matched text in selected item. Applied in +PmenuMatchSel Popup menu: Matched text in selected item. Applied in combination with |hl-PmenuSel|. *hl-PmenuBorder* PmenuBorder Popup menu: Border characters. @@ -6209,11 +6220,11 @@ The command also deletes the "b:current_syntax" variable, since no syntax is loaded after this command. To clean up specific syntax groups for the current buffer: > - :syntax clear {group-name} .. + :syntax clear {group-name} ... This removes all patterns and keywords for {group-name}. To clean up specific syntax group lists for the current buffer: > - :syntax clear @{grouplist-name} .. + :syntax clear @{grouplist-name} ... This sets {grouplist-name}'s contents to an empty list. *:syntax-off* *:syn-off* @@ -6325,12 +6336,12 @@ And put these lines in your .vimrc: > ============================================================================== 18. Window-local syntax *:ownsyntax* -Normally all windows on a buffer share the same syntax settings. It is +Normally all windows on a buffer share the same syntax settings. It is possible, however, to set a particular window on a file to have its own -private syntax setting. A possible example would be to edit LaTeX source +private syntax setting. A possible example would be to edit LaTeX source with conventional highlighting in one window, while seeing the same source highlighted differently (so as to hide control sequences and indicate bold, -italic etc regions) in another. The 'scrollbind' option is useful here. +italic etc regions) in another. The 'scrollbind' option is useful here. To set the current window to have the syntax "foo", separately from all other windows on the buffer: > @@ -6345,7 +6356,7 @@ Note: This resets the 'spell', 'spellcapcheck', 'spellfile' and 'spelloptions' options. Once a window has its own syntax, syntax commands executed from other windows -on the same buffer (including :syntax clear) have no effect. Conversely, +on the same buffer (including :syntax clear) have no effect. Conversely, syntax commands executed from that window do not affect other windows on the same buffer. @@ -6498,7 +6509,7 @@ that Setup / Font / Enable Bold is NOT enabled. ============================================================================== -20. When syntax is slow *:syntime* +20. When syntax is slow *:synti* *:syntime* This is aimed at authors of a syntax file. @@ -6518,19 +6529,19 @@ this sequence: > This will display a list of syntax patterns that were used, sorted by the time it took to match them against the text. -:syntime on Start measuring syntax times. This will add some +:synti[me] on Start measuring syntax times. This will add some overhead to compute the time spent on syntax pattern matching. -:syntime off Stop measuring syntax times. +:synti[me] off Stop measuring syntax times. -:syntime clear Set all the counters to zero, restart measuring. +:synti[me] clear Set all the counters to zero, restart measuring. -:syntime report Show the syntax items used since ":syntime on" in the +:synti[me] report Show the syntax items used since ":syntime on" in the current window. Use a wider display to see more of the output. - The list is sorted by total time. The columns are: + The list is sorted by total time. The columns are: TOTAL Total time in seconds spent on matching this pattern. COUNT Number of times the pattern was used.