En referensguide för att författa, formatera och strukturera Vim-hjälpdokumentation (doc/*.txt).
Skriva hjälpfiler
Skapa filer & Filtyper
:edit doc/myplugin.txt
:set filetype=help " Förhandsgranska rendering och taggmarkering
:set filetype=text " Bekvämt redigeringsläge
Använd ft=help för att förhandsgranska och ft=text under den inledande redigeringen.
Exempelstruktur
*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:
Se :help help-writing i Vim för fullständiga officiella riktlinjer.
Syntax & Element
Markup-referens
| Syntax | Beskrivning | Exempel |
|---|---|---|
*tag* |
Definitiv måltagg för hopp | *myplugin-intro* |
|tag| |
Hyperlänk som hoppar till tagg | |:command| |
'option' |
Vim-konfigurationsalternativ | 'textwidth' |
{placeholder} |
Obligatoriskt / valfritt argument | {Visual}gf |
<key> |
Särskild tangentbordstangent | <PageDown>, <CR> |
`command` |
Inline-kommando eller kodsträng | `set fo=want` |
CTRL-X |
Tangentkombination med Control | CTRL-] |
HEADING *tag* |
Avsnittsrubrik med versaler och tagg | INSTALLATION *my-install* |
Heading~ |
Underrubrik med tilde | Options~ |
===== |
Huvudavsnittsskiljare (78 tecken) | ====================== |
----- |
Underavsnittsskiljare (78 tecken) | ---------------------- |
Taggar och navigering
- Omge måltaggar med asterisker: plugin-tag
- Länka till mål med vertikala streck: |plugin-tag|
- Tryck på Ctrl-] på en länk för att hoppa till målet; tryck på Ctrl-T eller Ctrl-O för att återvända.
Kodblock
Avsluta föregående stycke med > och avsluta blocket med < i början av en rad:
Example: >
let g:loaded_myplugin = 1
call myplugin#setup()
<
Dokumentrubrik
*myplugin.txt* Extended utility toolkit for Vim
Placera alltid en primär tagg med filnamnet på den allra första raden, följt av en kort beskrivning.
Hjälp-modeline
Lägg till en modeline på den allra sista raden i filen:
vim:tw=78:ts=8:ft=help:norl:
Konventioner
Innehållsförteckning
CONTENTS *myplugin-contents*
1. Introduction .............................. |myplugin-intro|
2. Commands .................................. |myplugin-commands|
3. Configuration Options ..................... |myplugin-options|
Författare & Licensblock
Author: Jack Hackness <[email protected]> *myplugin-author*
License: Same terms as Vim itself (see |license|)