Cheat Sheet Fișiere de Ajutor Vim

Ghid de referință pentru redactarea, stilizarea și formatarea fișierelor de documentație de ajutor din Vim (doc/*.txt).

Redactarea fișierelor de ajutor

Crearea fișierelor și Filetypes

:edit doc/myplugin.txt
:set filetype=help   " Previzualizare randare și evidențiere taguri
:set filetype=text   " Mod comod de editare

Folosiți ft=help pentru previzualizare și ft=text în timpul redactării inițiale.

Structură model

*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:

Consultați :help help-writing în Vim pentru ghidul oficial complet.

Sintaxă și Elemente

Referință de marcare

Sintaxă	Descriere	Exemplu
`tag`	Tag definitiv de destinație	`myplugin-intro`
`\|tag\|`	Hyperlink care sare la tag	`\|:command\|`
`'option'`	Opțiune de configurare Vim	`'textwidth'`
`{placeholder}`	Argument obligatoriu sau opțional	`{Visual}gf`
`<key>`	Tastă specială de tastatură	`<PageDown>`, `<CR>`
`command`	Comandă sau cod inline	`set fo=want`
`CTRL-X`	Combinație de taste cu Control	`CTRL-]`
`HEADING tag`	Titlu de secțiune cu majuscule și tag	`INSTALLATION my-install`
`Heading~`	Subtitlu cu tildă	`Options~`
`=====`	Separator principal de secțiune (78 caractere)	`======================`
`-----`	Separator secundar de secțiune (78 caractere)	`----------------------`

Taguri și Navigare

Încadrați numele de ancore cu asteriscuri: plugin-tag
Creați linkuri către ținte cu caractere pipe: |plugin-tag|
Apăsați Ctrl-] pe un link pentru a sări la tag; apăsați Ctrl-T sau Ctrl-O pentru revenire.

Blocuri de cod

Indicați blocurile de cod încheind paragraful anterior cu > și finalizând blocul cu < la începutul liniei:

Example: >
    let g:loaded_myplugin = 1
    call myplugin#setup()
<

Antetul documentului

*myplugin.txt*  Extended utility toolkit for Vim

Plasați întotdeauna pe prima linie un tag primar cu numele fișierului, urmat de o scurtă descriere.

Modeline de ajutor

Adăugați o linie modeline chiar pe ultima linie a fișierului:

vim:tw=78:ts=8:ft=help:norl:

Convenții

Cuprins (Table of Contents)

CONTENTS                                                     *myplugin-contents*

    1. Introduction .............................. |myplugin-intro|
    2. Commands .................................. |myplugin-commands|
    3. Configuration Options ..................... |myplugin-options|

Secțiunea autor și licență

Author:  Jack Hackness <[email protected]>         *myplugin-author*
License: Same terms as Vim itself (see |license|)