Guida di riferimento per creare, formattare e strutturare file nativi di documentazione della guida di Vim (doc/*.txt).
Scrivere file di aiuto
Creazione file e filetype
:edit doc/myplugin.txt
:set filetype=help " Anteprima di rendering e risalto dei tag
:set filetype=text " Modalità di modifica pratica
Usa ft=help per vedere l'anteprima e ft=text durante la stesura iniziale.
Struttura di esempio
*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:
Vedi :help help-writing in Vim per le linee guida ufficiali complete.
Sintassi ed elementi
Riferimento markup
| Sintassi | Descrizione | Esempio |
|---|---|---|
*tag* |
Tag di destinazione del salto definitivo | *myplugin-intro* |
|tag| |
Collegamento ipertestuale che salta al tag | |:command| |
'option' |
Opzione di configurazione di Vim | 'textwidth' |
{placeholder} |
Argomento obbligatorio o facoltativo | {Visual}gf |
<key> |
Tasto speciale della tastiera | <PageDown>, <CR> |
`command` |
Comando o codice inline | `set fo=want` |
CTRL-X |
Combinazione di tasti con Control | CTRL-] |
HEADING *tag* |
Intestazione di sezione in maiuscolo con tag | INSTALLATION *my-install* |
Heading~ |
Sottointestazione con tilde | Options~ |
===== |
Separatore di sezione principale (78 caratteri) | ====================== |
----- |
Separatore di sottosezione (78 caratteri) | ---------------------- |
Tag e navigazione
- Racchiudi i nomi di ancoraggio tra asterischi: plugin-tag
- Collega alle destinazioni con caratteri pipe: |plugin-tag|
- Premi Ctrl-] su un collegamento delimitato da pipe per saltare al tag; premi Ctrl-T o Ctrl-O per tornare indietro.
Blocchi di codice
Indica i blocchi di codice terminando il paragrafo precedente con > e terminando il blocco con < a inizio riga:
Example: >
let g:loaded_myplugin = 1
call myplugin#setup()
<
Intestazione del documento
*myplugin.txt* Extended utility toolkit for Vim
Posiziona sempre un tag primario contenente il nome del file sulla prima riga, seguito da una breve descrizione.
Modeline di aiuto
Aggiungi una modeline sull'ultima riga del file:
vim:tw=78:ts=8:ft=help:norl:
Convenzioni
Indice dei contenuti
CONTENTS *myplugin-contents*
1. Introduction .............................. |myplugin-intro|
2. Commands .................................. |myplugin-commands|
3. Configuration Options ..................... |myplugin-options|
Blocco autore e licenza
Author: Jack Hackness <[email protected]> *myplugin-author*
License: Same terms as Vim itself (see |license|)