Skip to content

Update helphelp.{txt,jax} #2143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion doc/helphelp.jax
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*helphelp.txt* For Vim バージョン 9.1. Last change: 2025 Jun 03
*helphelp.txt* For Vim バージョン 9.1. Last change: 2025 Jul 07


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


☆スタイル

Vim で 'modeline' が有効になっている場合、組み込みのヘルプファイルを編集する際
に Vim は自動的に推奨スタイルに従います。

Vim ヘルプファイルは 78 文字の 'textwidth' でフォーマットする必要があります。
これにより、一般的な 80 x 24 ターミナルウィンドウで適切に表示されます。

文末のピリオドと次の文の最初の文字の間には 2 つのスペースを使います。このよう
に。{訳注: 日本語訳では関係ないです。日本語訳には日本語訳のルールがあります}

コンテンツの整列にはタブ文字を使用し、'tabstop' 設定は 8 にします。
これによりファイルサイズの削減にも役立ちます。

編集が終わったら必ず |:retab| を使用してください。 |:retab!| を盲目的に使用せ
ず、常に変更内容を確認して意図しない変更を避けてください。


☆タグ

ヘルプタグを定義するには、名前をアスタリスクで挟みます ("*tag-name*")。
Expand Down
20 changes: 19 additions & 1 deletion en/helphelp.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*helphelp.txt* For Vim version 9.1. Last change: 2025 Jun 03
*helphelp.txt* For Vim version 9.1. Last change: 2025 Jul 07


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


STYLE

If your Vim has 'modeline' enabled, Vim should follow the preferred style
automatically when editing built-in help files.

Vim help files should be formatted for a 'textwidth' of 78 characters, so they
look good in a typical 80 x 24 terminal window.

Use two spaces between the final dot of a sentence of the first letter of the
next sentence. Like this.

Use tab characters for aligning content, with a 'tabstop' setting of 8.
This also helps reduce the file size.

Always use |:retab| after you have finished editing. Don't blindly use
|:retab!|, always review what will be changed to avoid unwanted changes.


TAGS

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