From 9d753d7c793cbd88ff1c5611ce459a7e0c9f23a4 Mon Sep 17 00:00:00 2001 From: h-east Date: Mon, 21 Apr 2025 22:10:19 +0900 Subject: [PATCH] Update helphelp.{txt,jax} --- doc/helphelp.jax | 6 +++++- en/helphelp.txt | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/doc/helphelp.jax b/doc/helphelp.jax index fec3d828e..e76a8f845 100644 --- a/doc/helphelp.jax +++ b/doc/helphelp.jax @@ -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 @@ -378,6 +378,10 @@ Tip: `/` コマンドで検索するパターンを挿入した後、 では 書式で書かれていると便利です。あなたが新しいヘルプファイルを書くときは、既存の ファイルをコピーしてそれをテンプレートとして使用するといいでしょう。 +Vim のヘルプファイルでは通常、文の後に 2 つのスペースを使用します (等幅フォン +トを使用して記述されており、これが 70 年代 / 80 年代に好まれたスタイルであった +ため)。こちらで説明されています: https://english.stackexchange.com/a/2602 + ヘルプファイルの 1 行目は次のように書きます: *plugin_name.txt* {プラグインの短い説明} diff --git a/en/helphelp.txt b/en/helphelp.txt index 26804d546..647c35ad2 100644 --- a/en/helphelp.txt +++ b/en/helphelp.txt @@ -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 @@ -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}