Guia Rápido de Arquivos de Ajuda do Vim

Um guia de referência para redigir, estilizar e formatar arquivos de documentação de ajuda nativos do Vim (doc/*.txt).

Escrevendo Arquivos de Ajuda

Criação de Arquivos e Filetypes

:edit doc/myplugin.txt
:set filetype=help   " Visualizar renderização e realce de tags
:set filetype=text   " Modo conveniente de edição

Use ft=help para visualizar a renderização e ft=text durante a edição inicial.

Estrutura de Exemplo

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

Consulte :help help-writing dentro do Vim para as diretrizes oficiais completas.

Sintaxe e Elementos

Referência de Marcação

Sintaxe	Descrição	Exemplo
`tag`	Tag definitiva de destino de salto	`myplugin-intro`
`\|tag\|`	Hiperlink para a tag	`\|:command\|`
`'option'`	Opção de configuração do Vim	`'textwidth'`
`{placeholder}`	Argumento obrigatório ou opcional	`{Visual}gf`
`<key>`	Tecla especial do teclado	`<PageDown>`, `<CR>`
`command`	Comando ou código inline	`set fo=want`
`CTRL-X`	Combinação de teclas com Control	`CTRL-]`
`HEADING tag`	Cabeçalho de seção em maiúsculas com tag	`INSTALLATION my-install`
`Heading~`	Subcabeçalho com til	`Options~`
`=====`	Separador de seção principal (78 caracteres)	`======================`
`-----`	Separador de subseção (78 caracteres)	`----------------------`

Tags e Navegação

Envolva os nomes das âncoras de destino com asteriscos: plugin-tag
Vincule aos destinos com barras verticais: |plugin-tag|
Pressione Ctrl-] sobre o link para pular para a tag; pressione Ctrl-T ou Ctrl-O para retornar.

Blocos de Código

Indique blocos de código terminando o parágrafo anterior com > e encerrando o bloco com < no início da linha:

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

Cabeçalho do Documento

*myplugin.txt*  Extended utility toolkit for Vim

Sempre coloque uma tag primária com o nome do arquivo na primeira linha, seguida por uma breve descrição.

Modeline de Ajuda

Adicione uma modeline na última linha do arquivo:

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

Convenções

Índice (Table of Contents)

CONTENTS                                                     *myplugin-contents*

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

Bloco de Autor e Licença

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