Documentation personnalisée

De Vim-fr

A quoi ça sert?

C'est une petite astuce qui vous permetteras de créer vos propres aides/documentation directement lisible dans vim grace à la commande :help

Créer le fichier contenant votre documentation

Pour commencer, il vous faut créer un fichier dans lequel vous mettrez le contenu de votre documentation. Pour celà, créer un fichier nommé, par exemple, mon_aide.txt (il semblerait que le fichier fichier ait obligatoirement l'extension .txt) et placer le dans le répertoire ~/.vim/doc:

cd ~/.vim/doc
touch mon_aide.txt
echo "*mon_aide.txt*" >> mon_aide.txt

Concernant la dernière commande, elle permet à vim de savoir que ce sera une aide. Il faut que cette ligne se trouve au tout début de votre fichier.

Maintenant il ne vous reste plus qu'a éditer votre fichier pour y mettre votre documentation.

Editer votre fichier

Bon, alors là, je vous laisse le choix de l'éditeur, mais si vous traînez sur ce wiki, j'imagine que vous allez prendre vim ;)

En suite, il vous suffit simplement de remplir votre fichier:

*mon_aide.txt*
 
Une ligne...
Une deuxième ligne...

Voici une petite astuces supplémentaire. Vous pouvez rajouter des "ancres". Celà vous permetteras d'inclure des "mots-clés" dans votre fichier d'aide, par exemple:

*mon_aide.txt*
 
Une ligne...
Une deuxième ligne...
 
Comment fait-on les bébés? *bébé*
Demande à ton père!

Ensuite vous pourrez accéder à ces mots-clés très simplement:

:h bébé

Une dernière chose

En dernier lieu, il faut penser à générer un fichier tag pour que votre aide soit prise en compte par vim:

:helptags ~/.vim/doc

Vous pouvez dorénavant utilisez votre aide perso ;)

ps: pensez à regénérez les tags après chaque ajout d'ancres.

Liens externes