Een referentiegids voor het schrijven, opmaken en structureren van native Vim-hulpdocumenten (doc/*.txt).
Hulpbestanden schrijven
Bestand aanmaken & Bestandstypen
:edit doc/myplugin.txt
:set filetype=help " Voorbeeld van weergave en tag-markering
:set filetype=text " Handige bewerkingsmodus
Gebruik ft=help om de opmaak te bekijken en ft=text tijdens het eerste schrijfproces.
Voorbeeldstructuur
*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:
Zie :help help-writing in Vim voor de volledige officiële richtlijnen.
Syntaxis & Elementen
Markup-referentie
| Syntaxis | Beschrijving | Voorbeeld |
|---|---|---|
*tag* |
Definitieve doeltag voor sprongen | *myplugin-intro* |
|tag| |
Hyperlink die naar tag springt | |:command| |
'option' |
Vim-configuratieoptie | 'textwidth' |
{placeholder} |
Vereist / optioneel argument | {Visual}gf |
<key> |
Speciale toetsenbordtoets | <PageDown>, <CR> |
`command` |
Inline-opdracht of codestring | `set fo=want` |
CTRL-X |
Toetscombinatie met Control | CTRL-] |
HEADING *tag* |
Sectiekop in hoofdletters met tag | INSTALLATION *my-install* |
Heading~ |
Subkop of kolomkop met tilde | Options~ |
===== |
Hoofdsectiescheider (78 tekens) | ====================== |
----- |
Subsectiescheider (78 tekens) | ---------------------- |
Tags & Navigatie
- Omring doelankernamen met sterretjes: plugin-tag
- Link naar doelen met sluistekens: |plugin-tag|
- Druk op Ctrl-] op een link om naar de tag te springen; druk op Ctrl-T of Ctrl-O om terug te keren.
Codeblokken
Geef codeblokken aan door de voorgaande alinea af te sluiten met > en het blok te sluiten met < aan het begin van een regel:
Example: >
let g:loaded_myplugin = 1
call myplugin#setup()
<
Documentkop
*myplugin.txt* Extended utility toolkit for Vim
Plaats altijd een primaire tag met de bestandsnaam op de allereerste regel, gevolgd door een korte beschrijving.
Hulp-modeline
Voeg een modeline toe aan de allerlaatste regel van het bestand:
vim:tw=78:ts=8:ft=help:norl:
Conventies
Inhoudsopgave
CONTENTS *myplugin-contents*
1. Introduction .............................. |myplugin-intro|
2. Commands .................................. |myplugin-commands|
3. Configuration Options ..................... |myplugin-options|
Auteur- & Licentieblok
Author: Jack Hackness <[email protected]> *myplugin-author*
License: Same terms as Vim itself (see |license|)