PM Wiki —  Le wiki facile

Gazette Linux n°114 — Mai 2005

Raj Shekhar

Article paru dans le n°114 de la Gazette Linux de mai 2005.

Traduction française par Joëlle Cornavin .

Relecture de la traduction française par Encolpe Degoute .

Article publié sous Open Publication License. La Linux Gazette n'est ni produite, ni sponsorisée, ni avalisée par notre hébergeur principal, SSC, Inc.


Table des matières
1. Pourquoi utiliser un wiki
1.1. Base de connaissances
1.2. Liste des tâches à effectuer disponible n'importe où
1.3. Comptes-rendus de réunion mémorisés
2. Pourquoi Pmwiki
3. Installation
4. Personnalisation
5. Mesures anti-spam
6. Conclusion

1. Pourquoi utiliser un wiki

Dans le n°108 de la Gazette Linux®, Neil Youngman a écrit un article présentant JSPWiki. Dans celui-ci, j'aimerais vous décrire un wiki plus complexe mais aussi plus complet, appelé PmWiki. Avant de nous plonger dans les arcanes de Wiki, permettez-moi de vous exposer brièvement mon expérience avec les wikis et vous exprimer tout le bien que j'en pense.


1.1. Base de connaissances

Les wikis facilitent la création des pages HTML imbriquées. Vous pouvez vous concentrer sur votre tâche d'écriture de contenu proprement dite, sans vous préoccuper des balises HTML ou de la manière de créer des liens de navigation. Grâce au marquage aisé des wikis, il est très facile de copier du texte provenant de messages électroniques, de journaux de chat, de pages web aléatoires et de les ajouter à votre wiki. Le wikiengine (moteur de wiki) se charge quant à lui de transformer le texte simple en HTML propre.

Note

Vous devrez ajouter foi à l'auteur originel quand vous copiez du texte provenant d'un message électronique ou d'une page web.

La plupart des wikiengines comportent un moteur de recherche aussi, ce qui facilite les tâches de recherche à travers les pages du wiki.


1.2. Liste des tâches à effectuer disponible n'importe où

J'ai essayé beaucoup de programmes pour conserver une liste des choses que j'avais promis de faire. Il m'est arrivé un jour de tenter de la garder sur une page de wiki (sur l'Internet), puis j'ai réussi à y apporter des ajouts et des suppressions. (En ce moment, j'utilise l'excellent emacs planner.) Comme il est très facile de modifier une page de wiki, ce fut tout à fait efficace.


1.3. Comptes-rendus de réunion mémorisés

Dans une session de recherche d'idées (ou brainstorming), il est important de conserver des notes. Toutefois, dans le cas d'une petite structure, la charge revient aux participants de conserver une trace des discussions qui ont eu lieu. Dans ma précédente entreprise (qui était assez petite), chacun de nous conservait ses propres notes dans un simple fichier texte. Une fois la session terminée, nous avions l'habitude de créer une page de wiki et d'y placer chacun nos notes.


2. Pourquoi Pmwiki

Les principales fonctionnalités que je recherchais dans le Wiki étaient les suivantes :

En parcourant la liste des options de Wiki disponibles, j'ai trouvé PmWiki. J'ai également vu que ce projet a vraiment cru qu'il faut « manger son dogfood ». La documentation ainsi que la liste des bogues a été maintenue à l'aide de PmWiki lui-même. J'ai en outre jeté un coup d'œil à la syntaxe de marquage du wiki qui semble assez simple.


3. Installation

La page Installation comporte des instructions sur la manière de se procurer la toute dernière version de PmWiki et des instructions d'installation. Comme on le voit avec la plupart des applications PHP, le processus est très simple. Vous devez copier les fichiers dans un répertoire, dans la racine des documents de votre serveur web (par exemple dans /var/www/html/mywiki), puis changer les droits d'accès du répertoire en 2777. Utilisez un navigateur pour ouvrir la page pmwiki.php dans ce répertoire, c'est-à-dire www.yourdomain.com/mywiki/pmwiki.php. Si les droits d'accès ont été définis correctement, vous devriez voir la page d'accueil par défaut de PmWiki.


4. Personnalisation

Une fois le wiki installé, la prochaine étape consiste à le personnaliser. Les personnalisations sont habituellement contrôlées par le fichier config.php, qui se trouce dans le répertoire local. Quand vous installez PmWiki pour la première fois, le fichier config.php n'existe pas et vous devez donc en créer un si vous voulez procéder à une personnalisation locale. Vous pouvez copier le fichier sample-config.php (dans le même répertoire que pmwiki.php) dans le répertoire local et en faire votre point de départ.

La première chose que vous pouvez être amené à personnaliser est $WikiTitle. La variable $WikiTitle donne le nom de votre site tel qu'il apparaîtra dans la barre de titre de navigateur de l'utilisateur.

Le prochain élément à personnaliser est le « revêtement » ou skin. Si vous n'avez pas de compétences artistiques, comme moi, il vous reste un espoir. Heureusement, le PmWiki propose des revêtements esthétiques disponibles sur le site lui-même. Une fois le revêtement téléchargé, décompressez-le avec unzip et placez-le dans le dossier pub/skins/). Définissez ensuite la variable $Skin au nom du répertoire qui contient vos fichiers de revêtements. Par exemple, si vous aimez JHSkin, téléchargez le fichier zip et décompressez son contenu avec unzip. Vous obtenez un dossier appelé jhskin. Copiez ce dossier dans le dossier pub/skins dans le répertoire de votre wiki. Changez ensuite la variable Skin en $Skin = 'jhskin'. Quand vous rechargez le wiki dans votre navigateur, vous voyez qu'il a dorénavant une nouvelle apparence.

Le livre The PmWiki cookbook contient des astuces pour aller plus loin dans la personnalisation.


5. Mesures anti-spam

Du fait que n'importe qui peut modifier les pages wiki, les spammeurs s'en servent comme fermes de liens (par exemple, cette recherche google vous aidera à repérer quelques wikis utilisés à mauvais escient). Fort heureusement, PmWiki fournit quelques outils pour combattre cette menace. Vous pouvez faire appel à la Movable Type black list pour contrôler le spam au sein du wiki. Si le nombre d'utilisateurs qui doivent employer le wiki est restreint, vous pouvez même leur donner des mots de passe individuels. Il y a également un script UserAuth disponible, qui vous permet de gérer un plus grand nombre d'utilisateurs. Ce script vous permet aussi d'enregistrer les utilisateurs avant qu'ils puissent modifier des pages.

Si vous créez un Wiki qui réside sur votre réseau local (LAN), vous pouvez ignorer ces mesures anti-spam. Si ce Wiki est destiné à votre usage personnel, je vous conseille vivement d'avoir un mot de passe administrateur et de n'autoriser que l'administrateur à éditer les pages. Si vous créez un Wiki que tout le monde peut éditer, n'oubliez pas de consulter la PmWiki Security page.


6. Conclusion

Maintenant que vous êtes prêt à lancer votre propre Wiki, voici quelques liens utiles (en anglais) :

Je travaille pour Yahoo!® à Bangalore, en Inde (et je pense que c'est le meilleur endroit pour travailler) comme ingénieur d'exploitation.

Je suis un fervent partisan du Logiciel libre et de la campagne No Software Patents. Pendant mes loisirs, j'essaie de garder un blog relativement à jour.