Skip to content

Update helphelp.{txt,jax} #2045

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.

Sign up for GitHub

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
Apr 26, 2025
Merged

Update helphelp.{txt,jax} #2045

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion doc/helphelp.jax
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*helphelp.txt* For Vim バージョン 9.1. Last change: 2025 Apr 08
*helphelp.txt* For Vim バージョン 9.1. Last change: 2025 Apr 21


VIMリファレンスマニュアル by Bram Moolenaar
Expand Down Expand Up @@ -378,6 +378,10 @@ Tip: `/` コマンドで検索するパターンを挿入した後、<CR> では
書式で書かれていると便利です。あなたが新しいヘルプファイルを書くときは、既存の
ファイルをコピーしてそれをテンプレートとして使用するといいでしょう。

Vim のヘルプファイルでは通常、文の後に 2 つのスペースを使用します (等幅フォン
トを使用して記述されており、これが 70 年代 / 80 年代に好まれたスタイルであった
ため)。こちらで説明されています: https://english.stackexchange.com/a/2602

ヘルプファイルの 1 行目は次のように書きます:

*plugin_name.txt* {プラグインの短い説明}
Expand Down
6 changes: 5 additions & 1 deletion en/helphelp.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*helphelp.txt* For Vim version 9.1. Last change: 2025 Apr 08
*helphelp.txt* For Vim version 9.1. Last change: 2025 Apr 21


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -383,6 +383,10 @@ standard Vim help files, except for the first line. If you are writing a new
help file it's best to copy one of the existing files and use it as a
template.

Vim help files generally use 2 spaces after a sentence (since they are written
using a fixed-width font and that was the prefered style in the 70s/80s), like
what is described here: https://english.stackexchange.com/a/2602

The first line in a help file should have the following format:

*plugin_name.txt* {short description of the plugin}
Expand Down