# VIMWIKI: Un wiki personnel pour Vim

{{INLINETOC}}

## Introduction

Vimwiki est un plugin riche en fonctionnalités pour Vim qui permet de créer un wiki en texte clair avec tout le formatage Markdown habituel, des listes de tâches, des blocs de code surlignés par la syntaxe et même un journal pour la rédaction de notes quotidiennes.

Avec Vimwiki, on peut :

  * organiser des notes et des idées
  * gérer les listes de tâches
  * écrire de la documentation
  * tenir un journal
  * tout exporter en HTML

## Caractéristiques

  * trois syntaxes de balisage prises en charge: la syntaxe propre de Vimwiki, Markdown, MediaWiki
  * tout peu être exporter en HTML
  * lien vers d'autres pages wiki et fichiers externes
  * rechercher dans toutes les pages wiki
  * esquisser des notes et des tâches dans des listes en retrait
  * manipuler rapidement des listes numérotées et à puces
  * identifier les pages wiki ou des lieux arbitraires et passez rapidement aux balises
  * tableaux formatés automatiquement

## Installation

### Prérequis

S'assurer d’avoir ces paramètres dans le fichier vimrc (~/.vimrc ou /etc/vimrc) :

```
set nocompatible
filetype plugin on
syntaxe sur
```

Sans eux, Vimwiki ne fonctionnera pas correctement.

### Installation à l'aide de packages Vim (depuis Vim 7.4.1528)

```
git clone https://github.com/vimwiki/vimwiki.git ~/.vim/pack/plugins/start/vimwiki
```


## Démarrage rapide

Vimwiki est simple et intuitif. Dans Vim, on peut à tout moment ouvrir la page d'index du wiki avec <leader>ww . À partir de là, pour créer des pages supplémentaires, il suffit d'écrire un nom de page composé d'un seul mot et d'appuyer sur Enter dessus. Pour accéder à la page précédente, appuyer sur Backspace (en mode normal, bien sûr).

Pour démarrer rapidement, appuyer sur `<Leader>ww` (il s’agit généralement de `\ww`) pour accéder au fichier wiki d’index. Par défaut, il se trouve dans ~/vimwiki/index.wiki.

Insérer l'exemple suivant:

```
= Ma base de connaissances =
    * Tâches - choses à faire _ hier _ !!!
    * Projet Gutenberg - les bons livres, c'est le pouvoir.
    * Scratchpad - diverses choses temporaires.
```

Placer le curseur sur Tâches et appuyer sur Entrée pour créer un lien. Une fois appuyé, les tâches deviendront `[[Tasks]]` - un lien Vimwiki. Appuyer à nouveau sur Entrée pour l'ouvrir. Modifier le fichier, enregistrer, puis appuyer sur la touche Retour arrière pour revenir à l'index.

Un lien Vimwiki peut être construit à partir de plusieurs mots. Il suffit de sélectionner visuellement les mots à lier et d'appuyer sur Entrée. 

### Balisage de base

```
= En-tête1 =
== En-tête2 ==
=== En-tête3 ===


* gras * - texte gras
_italic_ - texte en italique

[[lien wiki]] - lien wiki
[[lien wiki | description]] - lien wiki avec description
```

### Listes:

```
* bullet item 1 de la liste
    - puce numéro de liste 2
    - puce numéro de liste 3
        * bullet item de la liste 4
        * bullet item de liste 5
* bullet item 6 de la liste
* bullet item de liste 7
    - puce numéro de liste 8
    - puce numéro de liste 9

1. élément de liste numéroté 1
2. élément de liste numéroté 2
    a) élément de liste numéroté 3
    b) élément de liste numéroté 4
```

### Raccourcis clavier

modèle normal:

  * `<Leader>ww` - Ouvre le fichier d'index wiki par défaut.
  * `<Leader>wt` - Ouvre le fichier d'index wiki par défaut dans un nouvel onglet.
  * `<Leader>ws` - Sélectionnez et ouvrez le fichier d'index du wiki.
  * `<Leader>wd` - Supprimer le fichier wiki dans lequel vous vous trouvez.
  * `<Leader>wr` - Renomme le fichier wiki dans lequel vous vous trouvez.
  * `<Enter>` - Suivre / Créer un lien wiki
  *  `<Shift-Enter>` - Divise et suit / crée un lien wiki
  * `<Ctrl-Enter>` - Division verticale et suivre / créer un lien wiki
  * `<Backspace>` - Retourne au lien wiki précédent (précédent)
  * `<Tab>` - Trouver le lien wiki suivant
  * `<Shift-Tab>` - Trouver le lien wiki précédent

### Les commandes

  * `:Vimwiki2HTML` - Converti le lien wiki actuel en HTML
  * `:VimwikiAll2HTML` - Converti tous les liens de wiki en HTML
  * `:help vimwiki-orders` - liste toutes les commandes