Guide de référence pour rédiger, styliser et formater les fichiers de documentation d'aide natifs de Vim (doc/*.txt).
Rédiger des fichiers d'aide
Création de fichiers & Types de fichiers
:edit doc/myplugin.txt
:set filetype=help " Aperçu du rendu et surbrillance des tags
:set filetype=text " Mode d'édition pratique
Utilisez ft=help pour prévisualiser le document et ft=text pendant l'édition initiale.
Structure type
*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:
Consultez :help help-writing dans Vim pour les directives officielles complètes.
Syntaxe & Éléments
Référence du balisage
| Syntaxe | Description | Exemple |
|---|---|---|
*tag* |
Balise de cible de saut définitive | *myplugin-intro* |
|tag| |
Lien hypertexte sautant vers la balise | |:command| |
'option' |
Option de configuration Vim | 'textwidth' |
{placeholder} |
Argument obligatoire ou optionnel | {Visual}gf |
<key> |
Touche spéciale du clavier | <PageDown>, <CR> |
`command` |
Commande ou code en ligne | `set fo=want` |
CTRL-X |
Combinaison avec la touche Control | CTRL-] |
HEADING *tag* |
Titre de section en majuscules avec tag | INSTALLATION *my-install* |
Heading~ |
Sous-titre ou en-tête de colonne avec tilde | Options~ |
===== |
Séparateur de section principale (78 caractères) | ====================== |
----- |
Séparateur de sous-section (78 caractères) | ---------------------- |
Balises et navigation
- Entourez les cibles d'ancrage d'astérisques : plugin-tag
- Liez vers les cibles avec des barres verticales : |plugin-tag|
- Appuyez sur Ctrl-] sur un lien pour sauter vers la balise cible ; appuyez sur Ctrl-T ou Ctrl-O pour revenir.
Blocs de code
Indiquez les blocs de code en terminant le paragraphe précédent par > et en fermant le bloc par < en début de ligne :
Example: >
let g:loaded_myplugin = 1
call myplugin#setup()
<
En-tête de document
*myplugin.txt* Extended utility toolkit for Vim
Placez toujours une balise principale contenant le nom du fichier sur la toute première ligne, suivie d'une brève description.
Modeline d'aide
Ajoutez une modeline sur la toute dernière ligne du fichier :
vim:tw=78:ts=8:ft=help:norl:
Conventions
Table des matières
CONTENTS *myplugin-contents*
1. Introduction .............................. |myplugin-intro|
2. Commands .................................. |myplugin-commands|
3. Configuration Options ..................... |myplugin-options|
Bloc auteur & Licence
Author: Jack Hackness <[email protected]> *myplugin-author*
License: Same terms as Vim itself (see |license|)