From 79860cda0fe7f9c6a7919821c71b194a77f99378 Mon Sep 17 00:00:00 2001 From: h-east Date: Thu, 26 Dec 2024 01:26:11 +0900 Subject: [PATCH 1/3] Update helphelp.{txt,jax} --- doc/helphelp.jax | 38 +++++++++++++++++++++++++++++--------- en/helphelp.txt | 39 ++++++++++++++++++++++++++++++--------- 2 files changed, 59 insertions(+), 18 deletions(-) diff --git a/doc/helphelp.jax b/doc/helphelp.jax index 17ebbe19b..0ff89ad62 100644 --- a/doc/helphelp.jax +++ b/doc/helphelp.jax @@ -1,4 +1,4 @@ -*helphelp.txt* For Vim バージョン 9.1. Last change: 2024 Dec 15 +*helphelp.txt* For Vim バージョン 9.1. Last change: 2024 Dec 25 VIMリファレンスマニュアル by Bram Moolenaar @@ -426,17 +426,37 @@ Ex コマンドのブロックを例示するときは、大なり記号 (>) を 末に書き、小なり記号 (<) をその後ろのブロックの前の最初の非空白文字として書き ます。テキストが 1 列目から始まっている行があると、Ex コマンドのブロックはその 直前で暗黙的に終了となります。例: > - function Example_Func() - echo "Example" - endfunction + function Example_Func() + echo "Example" + endfunction < -コード例に Vim 構文ハイライトサポートを追加することができます。これは、大なり -記号 (>) の後に "vim" を追加することで可能です (">vim")。 + +ブロックに注釈を追加するには、大なり記号 (>) の後に注釈 (例: "lua") を配置しま +す。例: >lua + print("hello") +< +Note: |g:help_example_languages| に "lua" キーがある場合は、lua 構文のハイライ +トを使用します。 + +コード例に Vim 構文ハイライトのサポートを追加することができます。 例: >vim - function Example_Func() - echo "Example" - endfunction + function Example_Func() + echo "Example" + endfunction < + *g:help_example_languages* +ブロック内の構文ハイライトを変更する場合は、以下のように変更できます: > + :let g:help_example_languages = #{ vim: 'vim', sh: 'bash' } +キーは注釈マーカー名を表し、値は 'syntax' 名です。デフォルトでは、ヘルプファイ +ルは Vim script のハイライトのみをサポートします。 +Note: "g:help_example_languages" を設定するときに "vim" キーを含めないと、Vim +構文ハイライトは有効になりません。空の値に設定すると、埋め込み言語の構文のハイ +ライトは無効になります。 + +さらに note: 含まれている 'syntax' スクリプトがそのような趣旨を考慮していない +場合、ヘルプファイルに追加の構文言語を含めることは必ずしも完全に機能するとは限 +りません。 + *help-notation* Vim ヘルプファイルでは以下のものがそれぞれハイライトされます: - 特殊キーの名前。 のような <> 表記で書かれたものと、CTRL-X のよう に書かれた制御文字。 diff --git a/en/helphelp.txt b/en/helphelp.txt index 948ef7248..5ab112d60 100644 --- a/en/helphelp.txt +++ b/en/helphelp.txt @@ -1,4 +1,4 @@ -*helphelp.txt* For Vim version 9.1. Last change: 2024 Dec 15 +*helphelp.txt* For Vim version 9.1. Last change: 2024 Dec 25 VIM REFERENCE MANUAL by Bram Moolenaar @@ -433,17 +433,38 @@ To quote a block of ex-commands verbatim, place a greater than (>) character at the end of the line before the block and a less than (<) character as the first non-blank on a line following the block. Any line starting in column 1 also implicitly stops the block of ex-commands before it. E.g. > - function Example_Func() - echo "Example" - endfunction + function Example_Func() + echo "Example" + endfunction < -It's possible to add Vim syntax highlighting support to code examples. This -can be done by adding "vim" after the greater than (>) character (">vim"). + +To add annotation in the block, place the annotation (ex: "lua") after a +greater than (>) character. E.g: >lua + print("hello") +< +Note: uses lua syntax highlighting, if "lua" key is in +|g:help_example_languages|. + +It's possible to add Vim syntax highlighting support to code examples. E.g: >vim - function Example_Func() - echo "Example" - endfunction + function Example_Func() + echo "Example" + endfunction < + *g:help_example_languages* +If you want to change the syntax highlighting in the block, you can +change it like this: > + :let g:help_example_languages = #{ vim: 'vim', sh: 'bash' } +The key represents the annotation marker name, and the value is the 'syntax' +name. By default, help files support only Vim script highlighting. +Note: When setting "g:help_example_languages", if you do not include "vim" +key, the Vim syntax highlighting will not be enabled. If you set it to an +empty value, syntax highlighting for embedded languages will be disabled. + +Further note: including additional syntax languages into help files may not +always work perfectly, if the included 'syntax' script does not account for +such an import. + *help-notation* The following are highlighted differently in a Vim help file: - a special key name expressed either in <> notation as in , or as a Ctrl character as in CTRL-X From 7b96a45c9d826020247bc4f92b1d3e4bd89d16be Mon Sep 17 00:00:00 2001 From: h-east Date: Thu, 26 Dec 2024 02:13:14 +0900 Subject: [PATCH 2/3] Update original --- doc/helphelp.jax | 2 +- en/helphelp.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/helphelp.jax b/doc/helphelp.jax index 0ff89ad62..f127c5bf6 100644 --- a/doc/helphelp.jax +++ b/doc/helphelp.jax @@ -454,7 +454,7 @@ Note: "g:help_example_languages" を設定するときに "vim" キーを含め ライトは無効になります。 さらに note: 含まれている 'syntax' スクリプトがそのような趣旨を考慮していない -場合、ヘルプファイルに追加の構文言語を含めることは必ずしも完全に機能するとは限 +場合、ヘルプファイルに任意の構文言語を含めることは必ずしも完璧に機能するとは限 りません。 *help-notation* Vim ヘルプファイルでは以下のものがそれぞれハイライトされます: diff --git a/en/helphelp.txt b/en/helphelp.txt index 5ab112d60..9e3e7488c 100644 --- a/en/helphelp.txt +++ b/en/helphelp.txt @@ -461,7 +461,7 @@ Note: When setting "g:help_example_languages", if you do not include "vim" key, the Vim syntax highlighting will not be enabled. If you set it to an empty value, syntax highlighting for embedded languages will be disabled. -Further note: including additional syntax languages into help files may not +Further note: including arbitrary syntax languages into help files may not always work perfectly, if the included 'syntax' script does not account for such an import. *help-notation* From 472699e3f838f922ca7e4b7457b9cfe83b4a3b66 Mon Sep 17 00:00:00 2001 From: h-east Date: Thu, 26 Dec 2024 19:03:14 +0900 Subject: [PATCH 3/3] Update by original --- doc/helphelp.jax | 29 +++++++++++------------------ en/helphelp.txt | 37 +++++++++++++++---------------------- 2 files changed, 26 insertions(+), 40 deletions(-) diff --git a/doc/helphelp.jax b/doc/helphelp.jax index f127c5bf6..f9af8f0b2 100644 --- a/doc/helphelp.jax +++ b/doc/helphelp.jax @@ -1,4 +1,4 @@ -*helphelp.txt* For Vim バージョン 9.1. Last change: 2024 Dec 25 +*helphelp.txt* For Vim バージョン 9.1. Last change: 2024 Dec 26 VIMリファレンスマニュアル by Bram Moolenaar @@ -430,28 +430,21 @@ Ex コマンドのブロックを例示するときは、大なり記号 (>) を echo "Example" endfunction < - -ブロックに注釈を追加するには、大なり記号 (>) の後に注釈 (例: "lua") を配置しま -す。例: >lua - print("hello") -< -Note: |g:help_example_languages| に "lua" キーがある場合は、lua 構文のハイライ -トを使用します。 - -コード例に Vim 構文ハイライトのサポートを追加することができます。 -例: >vim +コードブロックの構文ハイライトを有効にするには、大なり記号 (>) の後に言語名の +注釈 (例: "vim") を配置します。例: >vim function Example_Func() echo "Example" endfunction < *g:help_example_languages* -ブロック内の構文ハイライトを変更する場合は、以下のように変更できます: > - :let g:help_example_languages = #{ vim: 'vim', sh: 'bash' } -キーは注釈マーカー名を表し、値は 'syntax' 名です。デフォルトでは、ヘルプファイ -ルは Vim script のハイライトのみをサポートします。 -Note: "g:help_example_languages" を設定するときに "vim" キーを含めないと、Vim -構文ハイライトは有効になりません。空の値に設定すると、埋め込み言語の構文のハイ -ライトは無効になります。 +デフォルトでは、ヘルプファイルは Vim script のハイライトのみをサポートします。 +他の言語の構文ハイライトが必要な場合は、|vimrc| に以下を追加してください: > + :let g:help_example_languages = { "vim": "vim", "sh": "bash" } +キーは注釈マーカー名を表し、値は 'syntax' 名です。 + +Note: "g:help_example_languages" に "vim" を含めない場合、"vim" の構文ハイライ +トは有効になりません。"g:help_example_languages" を空の値に設定すると、埋め込 +み言語の構文ハイライトは無効になります。 さらに note: 含まれている 'syntax' スクリプトがそのような趣旨を考慮していない 場合、ヘルプファイルに任意の構文言語を含めることは必ずしも完璧に機能するとは限 diff --git a/en/helphelp.txt b/en/helphelp.txt index 9e3e7488c..3ba092062 100644 --- a/en/helphelp.txt +++ b/en/helphelp.txt @@ -1,4 +1,4 @@ -*helphelp.txt* For Vim version 9.1. Last change: 2024 Dec 25 +*helphelp.txt* For Vim version 9.1. Last change: 2024 Dec 26 VIM REFERENCE MANUAL by Bram Moolenaar @@ -437,31 +437,24 @@ also implicitly stops the block of ex-commands before it. E.g. > echo "Example" endfunction < - -To add annotation in the block, place the annotation (ex: "lua") after a -greater than (>) character. E.g: >lua - print("hello") -< -Note: uses lua syntax highlighting, if "lua" key is in -|g:help_example_languages|. - -It's possible to add Vim syntax highlighting support to code examples. -E.g: >vim +To enable syntax highlighting for a block of code, place a language name +annotation (e.g. "vim") after a greater than (>) character. E.g. >vim function Example_Func() echo "Example" endfunction < *g:help_example_languages* -If you want to change the syntax highlighting in the block, you can -change it like this: > - :let g:help_example_languages = #{ vim: 'vim', sh: 'bash' } +By default, help files only support Vim script highlighting. If you need +syntax highlighting for other languages, add to your |vimrc|: > + :let g:help_example_languages = { "vim": "vim", "sh": "bash" } The key represents the annotation marker name, and the value is the 'syntax' -name. By default, help files support only Vim script highlighting. -Note: When setting "g:help_example_languages", if you do not include "vim" -key, the Vim syntax highlighting will not be enabled. If you set it to an +name. + +Note: If you do not include "vim" in "g:help_example_languages", its syntax +highlighting will not be enabled. If you set "g:help_example_languages" to an empty value, syntax highlighting for embedded languages will be disabled. -Further note: including arbitrary syntax languages into help files may not +Further note: Including arbitrary syntax languages into help files may not always work perfectly, if the included 'syntax' script does not account for such an import. *help-notation* @@ -481,15 +474,15 @@ You can find the details in $VIMRUNTIME/syntax/help.vim GENDER NEUTRAL LANGUAGE *gender-neutral* *inclusion* -Vim is for everybody, no matter race, gender or anything. For new or updated -help text, gender neutral language is recommended. Some of the help text is -many years old and there is no need to change it. We do not make any +Vim is for everybody, no matter race, gender or anything. For new or updated +help text, gender neutral language is recommended. Some of the help text is +many years old and there is no need to change it. We do not make any assumptions about the gender of the user, no matter how the text is phrased. The goal is that the reader understands how Vim works, the exact wording is secondary. Many online technical style guides include sections about gender neutral -language. Here are a few: > +language. Here are a few: > https://developers.google.com/style/pronouns https://techwhirl.com/gender-neutral-technical-writing/