Referenzleitfaden für das Verfassen, Formatieren und Strukturieren nativer Vim-Hilfedokumentationen (doc/*.txt).
Hilfedateien schreiben
Dateierstellung & Dateitypen
:edit doc/myplugin.txt
:set filetype=help " Vorschau des Renderings und Tag-Hervorhebung
:set filetype=text " Praktischer Bearbeitungsmodus
Verwenden Sie ft=help für die Vorschau und ft=text während der anfänglichen Bearbeitung.
Beispielhafte Struktur
*ack.txt* Plugin that integrates ack with Vim
==============================================================================
USAGE INSTRUCTIONS *ack-usage*
:Ack[!] {pattern} *:Ack*
Search recursively for {pattern}. See |:AckAdd|.
Also see http://beyondgrep.com for more information.
vim:tw=78:ts=8:ft=help:norl:
Siehe :help help-writing in Vim für die vollständigen offiziellen Richtlinien.
Syntax & Elemente
Markup-Referenz
| Syntax | Beschreibung | Beispiel |
|---|---|---|
*tag* |
Definitives Sprungziel-Tag | *myplugin-intro* |
|tag| |
Hyperlink zum Tag | |:command| |
'option' |
Vim-Konfigurationsoption | 'textwidth' |
{placeholder} |
Erforderliches / optionales Argument | {Visual}gf |
<key> |
Spezielle Tastaturtaste | <PageDown>, <CR> |
`command` |
Inline-Befehl oder Code-String | `set fo=want` |
CTRL-X |
Tastenkombination mit Control (Strg) | CTRL-] |
HEADING *tag* |
Abschnittsüberschrift in Großbuchstaben mit Tag | INSTALLATION *my-install* |
Heading~ |
Unterüberschrift oder Spaltenkopf mit Tilde | Options~ |
===== |
Haupttrennlinie (78 Zeichen) | ====================== |
----- |
Unterabschnittstrennlinie (78 Zeichen) | ---------------------- |
Tags & Navigation
- Zielanker mit Sternchen umschließen: plugin-tag
- Auf Ziele mit Pipe-Zeichen verlinken: |plugin-tag|
- Drücken Sie Ctrl-] auf einem Pipe-Link, um direkt zum Tag zu springen; Ctrl-T oder Ctrl-O zum Zurückkehren.
Codeblöcke
Leiten Sie Codeblöcke mit einem > am Ende des vorherigen Absatzes ein und schließen Sie mit < am Zeilenanfang ab:
Example: >
let g:loaded_myplugin = 1
call myplugin#setup()
<
Dokument-Header
*myplugin.txt* Extended utility toolkit for Vim
Setzen Sie immer ein primäres Tag mit dem Dateinamen auf die allererste Zeile, gefolgt von einer kurzen Beschreibung.
Hilfe-Modeline
Fügen Sie eine Modeline in die allerletzte Zeile der Datei ein:
vim:tw=78:ts=8:ft=help:norl:
Konventionen
Inhaltsverzeichnis
CONTENTS *myplugin-contents*
1. Introduction .............................. |myplugin-intro|
2. Commands .................................. |myplugin-commands|
3. Configuration Options ..................... |myplugin-options|
Autor- & Lizenzblock
Author: Jack Hackness <[email protected]> *myplugin-author*
License: Same terms as Vim itself (see |license|)