Skip to content

Commit 472699e

Browse files
committed
Update by original
1 parent 7b96a45 commit 472699e

File tree

2 files changed

+26
-40
lines changed

2 files changed

+26
-40
lines changed

doc/helphelp.jax

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*helphelp.txt* For Vim バージョン 9.1. Last change: 2024 Dec 25
1+
*helphelp.txt* For Vim バージョン 9.1. Last change: 2024 Dec 26
22

33

44
VIMリファレンスマニュアル by Bram Moolenaar
@@ -430,28 +430,21 @@ Ex コマンドのブロックを例示するときは、大なり記号 (>) を
430430
echo "Example"
431431
endfunction
432432
<
433-
434-
ブロックに注釈を追加するには、大なり記号 (>) の後に注釈 (例: "lua") を配置しま
435-
す。例: >lua
436-
print("hello")
437-
<
438-
Note: |g:help_example_languages| に "lua" キーがある場合は、lua 構文のハイライ
439-
トを使用します。
440-
441-
コード例に Vim 構文ハイライトのサポートを追加することができます。
442-
例: >vim
433+
コードブロックの構文ハイライトを有効にするには、大なり記号 (>) の後に言語名の
434+
注釈 (例: "vim") を配置します。例: >vim
443435
function Example_Func()
444436
echo "Example"
445437
endfunction
446438
<
447439
*g:help_example_languages*
448-
ブロック内の構文ハイライトを変更する場合は、以下のように変更できます: >
449-
:let g:help_example_languages = #{ vim: 'vim', sh: 'bash' }
450-
キーは注釈マーカー名を表し、値は 'syntax' 名です。デフォルトでは、ヘルプファイ
451-
ルは Vim script のハイライトのみをサポートします。
452-
Note: "g:help_example_languages" を設定するときに "vim" キーを含めないと、Vim
453-
構文ハイライトは有効になりません。空の値に設定すると、埋め込み言語の構文のハイ
454-
ライトは無効になります。
440+
デフォルトでは、ヘルプファイルは Vim script のハイライトのみをサポートします。
441+
他の言語の構文ハイライトが必要な場合は、|vimrc| に以下を追加してください: >
442+
:let g:help_example_languages = { "vim": "vim", "sh": "bash" }
443+
キーは注釈マーカー名を表し、値は 'syntax' 名です。
444+
445+
Note: "g:help_example_languages" に "vim" を含めない場合、"vim" の構文ハイライ
446+
トは有効になりません。"g:help_example_languages" を空の値に設定すると、埋め込
447+
み言語の構文ハイライトは無効になります。
455448

456449
さらに note: 含まれている 'syntax' スクリプトがそのような趣旨を考慮していない
457450
場合、ヘルプファイルに任意の構文言語を含めることは必ずしも完璧に機能するとは限

en/helphelp.txt

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*helphelp.txt* For Vim version 9.1. Last change: 2024 Dec 25
1+
*helphelp.txt* For Vim version 9.1. Last change: 2024 Dec 26
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -437,31 +437,24 @@ also implicitly stops the block of ex-commands before it. E.g. >
437437
echo "Example"
438438
endfunction
439439
<
440-
441-
To add annotation in the block, place the annotation (ex: "lua") after a
442-
greater than (>) character. E.g: >lua
443-
print("hello")
444-
<
445-
Note: uses lua syntax highlighting, if "lua" key is in
446-
|g:help_example_languages|.
447-
448-
It's possible to add Vim syntax highlighting support to code examples.
449-
E.g: >vim
440+
To enable syntax highlighting for a block of code, place a language name
441+
annotation (e.g. "vim") after a greater than (>) character. E.g. >vim
450442
function Example_Func()
451443
echo "Example"
452444
endfunction
453445
<
454446
*g:help_example_languages*
455-
If you want to change the syntax highlighting in the block, you can
456-
change it like this: >
457-
:let g:help_example_languages = #{ vim: 'vim', sh: 'bash' }
447+
By default, help files only support Vim script highlighting. If you need
448+
syntax highlighting for other languages, add to your |vimrc|: >
449+
:let g:help_example_languages = { "vim": "vim", "sh": "bash" }
458450
The key represents the annotation marker name, and the value is the 'syntax'
459-
name. By default, help files support only Vim script highlighting.
460-
Note: When setting "g:help_example_languages", if you do not include "vim"
461-
key, the Vim syntax highlighting will not be enabled. If you set it to an
451+
name.
452+
453+
Note: If you do not include "vim" in "g:help_example_languages", its syntax
454+
highlighting will not be enabled. If you set "g:help_example_languages" to an
462455
empty value, syntax highlighting for embedded languages will be disabled.
463456

464-
Further note: including arbitrary syntax languages into help files may not
457+
Further note: Including arbitrary syntax languages into help files may not
465458
always work perfectly, if the included 'syntax' script does not account for
466459
such an import.
467460
*help-notation*
@@ -481,15 +474,15 @@ You can find the details in $VIMRUNTIME/syntax/help.vim
481474
GENDER NEUTRAL LANGUAGE
482475

483476
*gender-neutral* *inclusion*
484-
Vim is for everybody, no matter race, gender or anything. For new or updated
485-
help text, gender neutral language is recommended. Some of the help text is
486-
many years old and there is no need to change it. We do not make any
477+
Vim is for everybody, no matter race, gender or anything. For new or updated
478+
help text, gender neutral language is recommended. Some of the help text is
479+
many years old and there is no need to change it. We do not make any
487480
assumptions about the gender of the user, no matter how the text is phrased.
488481
The goal is that the reader understands how Vim works, the exact wording is
489482
secondary.
490483

491484
Many online technical style guides include sections about gender neutral
492-
language. Here are a few: >
485+
language. Here are a few: >
493486
494487
https://developers.google.com/style/pronouns
495488
https://techwhirl.com/gender-neutral-technical-writing/

0 commit comments

Comments
 (0)