summaryrefslogtreecommitdiffstats
path: root/runtime/doc/helphelp.txt
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2021-11-16 19:18:26 +0000
committerBram Moolenaar <Bram@vim.org>2021-11-16 19:18:26 +0000
commit519cc559b08b800edc429688aece7ad6a00d41eb (patch)
tree483c495c0c3f86c496937f256ec9defcce5e46f0 /runtime/doc/helphelp.txt
parent728104da6cd561b8cb2c7142769f7526d725958e (diff)
Update runtime files
Diffstat (limited to 'runtime/doc/helphelp.txt')
-rw-r--r--runtime/doc/helphelp.txt22
1 files changed, 13 insertions, 9 deletions
diff --git a/runtime/doc/helphelp.txt b/runtime/doc/helphelp.txt
index 3a06baf66b..d1a5b2be87 100644
--- a/runtime/doc/helphelp.txt
+++ b/runtime/doc/helphelp.txt
@@ -1,4 +1,4 @@
-*helphelp.txt* For Vim version 8.2. Last change: 2020 Dec 29
+*helphelp.txt* For Vim version 8.2. Last change: 2021 Nov 13
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -323,21 +323,25 @@ Hints for translators:
3. Writing help files *help-writing*
For ease of use, a Vim help file for a plugin should follow the format of the
-standard Vim help files. If you are writing a new help file it's best to copy
-one of the existing files and use it as a template.
+standard Vim help files, except fot the fist 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.
The first line in a help file should have the following format:
-*helpfile_name.txt* For Vim version 7.3 Last change: 2010 June 4
+*plugin_name.txt* {short description of the plugin}
-The first field is a link to the help file name. The second field describes
-the applicable Vim version. The last field specifies the last modification
-date of the file. Each field is separated by a tab.
+The first field is a help tag where ":help plugin_name" will jump to. The
+remainder of the line, after a Tab, describes the plugin purpose in a short
+way. This will show up in the "LOCAL ADDITIONS" section of the main help
+file. Check there that it shows up properly: |local-additions|.
+
+If you want to add a version number of last modification date, put it in the
+second line, right aligned.
At the bottom of the help file, place a Vim modeline to set the 'textwidth'
and 'tabstop' options and the 'filetype' to "help". Never set a global option
-in such a modeline, that can have consequences undesired by whoever reads that
-help.
+in such a modeline, that can have undesired consequences.
TAGS