Skip to content

Commit 443e18d

Browse files
authored
Merge pull request #2143 from h-east/update-helphelp
Update helphelp.{txt,jax}
2 parents 9d35fd5 + 5f7755f commit 443e18d

File tree

2 files changed

+38
-2
lines changed

2 files changed

+38
-2
lines changed

doc/helphelp.jax

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*helphelp.txt* For Vim バージョン 9.1. Last change: 2025 Jun 03
1+
*helphelp.txt* For Vim バージョン 9.1. Last change: 2025 Jul 07
22

33

44
VIMリファレンスマニュアル by Bram Moolenaar
@@ -404,6 +404,24 @@ Vim のヘルプファイルでは通常、文の後に 2 つのスペースを
404404
ます。
405405

406406

407+
☆スタイル
408+
409+
Vim で 'modeline' が有効になっている場合、組み込みのヘルプファイルを編集する際
410+
に Vim は自動的に推奨スタイルに従います。
411+
412+
Vim ヘルプファイルは 78 文字の 'textwidth' でフォーマットする必要があります。
413+
これにより、一般的な 80 x 24 ターミナルウィンドウで適切に表示されます。
414+
415+
文末のピリオドと次の文の最初の文字の間には 2 つのスペースを使います。このよう
416+
に。{訳注: 日本語訳では関係ないです。日本語訳には日本語訳のルールがあります}
417+
418+
コンテンツの整列にはタブ文字を使用し、'tabstop' 設定は 8 にします。
419+
これによりファイルサイズの削減にも役立ちます。
420+
421+
編集が終わったら必ず |:retab| を使用してください。 |:retab!| を盲目的に使用せ
422+
ず、常に変更内容を確認して意図しない変更を避けてください。
423+
424+
407425
☆タグ
408426

409427
ヘルプタグを定義するには、名前をアスタリスクで挟みます ("*tag-name*")。

en/helphelp.txt

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*helphelp.txt* For Vim version 9.1. Last change: 2025 Jun 03
1+
*helphelp.txt* For Vim version 9.1. Last change: 2025 Jul 07
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -410,6 +410,24 @@ and 'tabstop' options and the 'filetype' to "help". Never set a global option
410410
in such a modeline, that can have undesired consequences.
411411

412412

413+
STYLE
414+
415+
If your Vim has 'modeline' enabled, Vim should follow the preferred style
416+
automatically when editing built-in help files.
417+
418+
Vim help files should be formatted for a 'textwidth' of 78 characters, so they
419+
look good in a typical 80 x 24 terminal window.
420+
421+
Use two spaces between the final dot of a sentence of the first letter of the
422+
next sentence. Like this.
423+
424+
Use tab characters for aligning content, with a 'tabstop' setting of 8.
425+
This also helps reduce the file size.
426+
427+
Always use |:retab| after you have finished editing. Don't blindly use
428+
|:retab!|, always review what will be changed to avoid unwanted changes.
429+
430+
413431
TAGS
414432

415433
To define a help tag, place the name between asterisks ("*tag-name*"). The

0 commit comments

Comments
 (0)