Mediawiki – Syntaxe de base

L’un des aspects les moins agréables dans un wiki, est la syntaxe nécessaire pour mettre en forme le contenu.

Beaucoup préfèreraient donc utiliser un éditeur « visuel », façon traitement de texte.

Moyennant quelques efforts de mémorisation pourtant, utiliser directement la syntaxe wiki fait gagner énormément de temps: pas de souris à aller chercher pour cliquer sur un bouton donc les deux mains restent sur le clavier. Cqfd 😉

Voici un petit résumé informel de la syntaxe que j’utilise le plus souvent sous MediaWiki. Rien de transcendant.

Mise en forme des caractères

'''Gras'''
''Italique''
'''''Gras Italique'''''
<small>Petit</small>
<big>Grand</big>
<u>Souligné</u>
<s>Barré</s>

Former des paragraphes
Un paragraphe est constitué d’une succession de lignes de texte. Deux paragraphes sont séparés par une ligne vide.
par exemple :

un seul
paragraphe

un 
autre 
paragraphe

Si l’on veut forcer un passage à la ligne, il suffit d’insérer une ligne vide.
Pas besoin de balise br (br is evil)

En augmentant le nombre de lignes vides entre deux paragraphes on augmente l’espace vide entre ces deux paragraphes.

Centrer du texte

<center>texte centré</center>

Afficher du texte non formaté
Pour afficher du texte non formaté, il suffit

• de débuter chaque ligne par un espace,
• ou d’encadrer le paragraphe concerné par les balises <pre> et </pre>

Exemples:

 texte non formaté

<pre>
Autre texte non formaté
</pre>

Listes à puces, listes numérotées

• Une ligne par item
• Les items non numérotés commencent par ‘* ‘
• Les items numérotés commencent par ‘# ‘
• Il est possible de mixer les types de listes

* item a
* item b
*# item b1
*# item b2
*# item b3
* item c

# item 1
# item 2
#* item 2x
#* item 2y
# item 3

Chapîtres, sections, sous-sections, etc

= Titre 1 =
== Titre 2 ==
=== Titre 3 ===
etc

Forcer ou empêcher l’affichage du sommaire d’une page
Le TOC d’une page est affiché automatiquement s’il y a plus de trois sections.

Ce TOC sera omis dans le cas contraire, sauf à insérer le tag __TOC__ à l’endroit où l’on souhaite faire appaître le TOC

A l’inverse, le tag __NOTOC__ empêche l’affichage du TOC de la page courante

Créer des liens entre pages et sections de pages
On peut insérer un lien

• vers une page cible en insérant le tag [[nom de la page cible]]
• vers une section d’une autre page en insérant le tag [[nom de l'article#nom de la section]]
• vers une autre section de la page courante en insérant le tag [[#nom de la section]]

Si la page ciblée n’existe pas alors le lien apparaîtra en rouge et il suffira de cliquer sur le lien pour créer la page.

Le « nom de la page cible » peut être remplacé dans le libellé du lien par un alias en utilisant la syntaxe [[nom de la page cible|texte de l'alias]].

Lier une page vers une autre site (Lien externe)
Un lien externe pointe vers une url hors du wiki. A l’affichage, il est accompagné d’une icône distinctive.

• [http://www.wikimedia.fr Association Wikimédia France] apparaîtra comme Association Wikimédia France
• http://www.wikimedia.fr apparaîtra comme http://www.wikimedia.fr
• [http://www.wikimedia.fr] apparaîtra comme [1]

Inclure une page dans une autre
Il suffit d’insérer la balise {{:nom de la page à inclure}}

Insérer une définition

; terme à définir : définition du terme
; autre terme
: définition plus complète
: sur une ou plusieurs lignes

Charger un fichier (image ou autre) dans le wiki
Mediawiki permet d’inclure des images aux formats courants (jpeg, jpg, png, etc)
La procédure est simple:

1. Cliquer sur le lien « Téléverser un fichier »
2. Sélectionnner un fichier (format jpeg, jpg, png, etc)
3. Donner une catégorie et un commentaire à l’image
4. Valider

Inclure une image dans une page wiki
Il suffit d’utiliser le tag [[Image:nom de l'image]] à l’endroit où l’on souhaite faire apparaître l’image

Tableau

• Center un tableau: encadrer le tableau entre les balises <center> et </center>
• Début de tableau : {|
• Nouvelle ligne : |-
• Titre/Entête de colonne : ! Texte_du_titre
• Cellule : | texte_de_la_cellule
• Fin de tableau : |}

Exemple:

{| 

|-
! Titre 1
! Titre 2
! Titre 3

|-
| Texte 1
| Texte 2
| Texte 3

|}

Mediawiki – Maintenance de base

Même une fois les pratiques de base appliquées, il peut arriver qu’un wiki dérive quelque-peu.

Il faut donc mettre en place de manière régulière quelques routines de maintenance de base.  Il ne s’agit pas d’accéder à la base de données, mais simplement de détecter les problèmes les plus courants à l’aide des pages spéciales du fournies par MediaWiki et d’y remédier de la manière la plus simple et directe.

Quelques axes à envisager :

• Clarifier et utiliser les catégories
• Eliminer les redirections
• Détecter les fichiers et pages manquants
• Rendre accessible les pages orphelines

Catégories inutilisées

• Cause: Une catégorie a été créée mais (plus) aucune page ou fichier n’y sont rattachés.
• Moyen de détection: page [[Spécial:Catégories]]
• Action: Ces catégories doivent être supprimées.

Catégories les plus demandées

• Cause: Des pages utilisent une catégorie, mais celle-ci n’existe pas.
• Moyen de détection: page [[Spécial:Catégories_demandées]]
• Action: Vérifier si des catégories existantes correspondraient mieux et les utiliser, ou créer au coup par coup les catégories manquantes.

Catégories peu utilisées (comportant 1 ou deux pages)

• Cause: Une catégorie a été créée, mais peu de pages s’y réfèrent.
• Moyen de détection: page [[Spécial:Catégories]]. Chaque catégorie y figure, suivie du nombre de pages qu’elle regroupe.
• Actions: Vérifier si il est possible de la remplacer par une autre catégorie plus usitée. En général, si une seule page est rattachée à une catégorie, celle-ci doit être supprimée et remplacée par  la page en question.

Eliminer les redirections

• Cause: Il s’agit en général de pages qui ont été renommées. Dans ce cas, pour éviter d’avoir des liens vers des pages n’existant pas, MediaWiki crée une redirection.
• Moyen de détection: page [[Spécial:Liste_des_redirections]]
• Action: corriger les liens vers la page cible de la redirection et supprimer la page de redirection.

Doubles redirections

• Cause: Il s’agit d’une page qui est redirigée vers une autre, qui à son tour redirige vers une troisième, en général après renommages successifs d’une page.
• Moyen de détection: page [[Spécial:Doubles_redirections]]
• Action: Ces doubles redirections doivent être supprimées, et les liens corrigés pour pointer vers les pages existantes.

Redirections cassées

• Cause: Une page de redirection pointe vers une page inexistante.
• Moyen de détection: page [[Spécial:Redirections_cassées]]
• Action: Remplacer la page de redirection par une page de contenu. Cette page doit être utilisée lors de la suppression des redirections et des doubles redirections.
• Autre action possible: Supprimer la page de redirection et corriger les liens qui y pointent.

Fichiers les plus demandés

• Cause: Une page inclut une image, ou un média mais celui-ci n’a pas été « Téléversé » dans le wiki.
• Moyen de détection: page [[Spécial:Fichiers_demandés]]
• Action: Supprimer le lien vers le fichier ou téléverser le fichier dans le wiki.

Pages les plus demandées

• Cause: Un lien a été créé vers une page qui n’existe pas.
• Moyen de détection: page [[Spécial:Pages_demandées]]
• Action: Créer la page manquante ou remplacer les liens qui y pointent par du texte simple.

Pages non catégorisées

• Cause: Une page n’est pas rattachée à au moins une catégorie.
• Moyen de détection: page [[Spécial:Pages_non_catégorisées]]
• Action: Ajouter au moins une catégorie à chaque page non catégorisée.

Fichiers non catégorisés

• Cause: Un fichier n’a pas été rattaché à au moins une catégorie.
• Moyen de détection: page [[Spécial:Fichiers_non_catégorisés]]
• Action: Ajouter au moins une catégorie à chaque fichier non catégorisé.

Fichiers orphelins

• Cause: Il s’agit de fichiers téléversés dans le wiki, mais non utilisés.
• Moyen de détection: page [[Spécial:Fichiers_inutilisés]]
• Actions: Supprimer ou utiliser les fichiers orphelins.

Pages orphelines

• Cause: Il s’agit de pages auxquelles on ne peut accéder depuis aucune autre page.
• Moyen de détection: page [[Spécial:Spécial:Pages_orphelines]]
• Actions: Ajouter des liens vers ces pages, corriger d’éventuels liens cassés.

Pages inaccessibles (Walled garden)

• Cause: Des liens existent au sein d’un groupe de pages, mais aucune d’entre elles n’est accessible depuis le reste du wiki, à l’image d’un jardin fermé, ou « walled garden » en anglais.
• Moyen de détection: pas de moyen direct. Ce type d’anomalie est souvent détecté par chance.
• Action: Créer un lien depuis la page d’accueil, ou depuis une page accessible depuis la page d’accueil, vers une des pages du walled garden.

Mediawiki – Mes pratiques de base

Je mets en place et utilise des Wikis depuis de nombreuses années maintenant, tant pour le privé que pour le travail.

Au fil du temps j’ai déduit quelques principes et mis en place quelques règles quant-à-l’utilisation et l’alimentation du contenu d’un wiki.

Généralités: Le Tao du Wiki

• Rester dans l’optique KISS (Keep It Stupidly Simple)
• Utiliser la syntaxe wiki plutôt que des balises html pour conserver un texte (source) clair.
• Spécifier ce qui sera affiché, et non comment l’afficher. Titre, paragraphe, cellule, code, lien, etc ont chacun une syntaxe wiki appropriée
• Donner impérativement au moins une catégorie à chaque page et chaque fichier.
• Ne pas laisser de pages ni de fichiers orphelins (ie. sans lien y pointant)
• Ne pas laisser de page vide
• Donner une description à chaque catégorie et à chaque fichier téléversé
• Ne pas numéroter explicitement les titres de chapitres, sections, etc. Si les titres doivent apparaitre numérotés, aller dans les préférences et cocher la case « Numéroter automatiquement les titres de section » de l’onglet « apparence »

Choisir avec soin le nom des nouvelles pages

Une page mal nommée pourra bien sûr être renommée plus tard, mais chaque renommage crée une page de redirection de l’ancien nom vers le nouveau, ce qui peut amener à des redirections multiples.

L’accumulation des redirections complique l’organisation des pages, donc autant faire un petit effort dès le création d’une nouvelle page.

Création d’une nouvelle page

La création de nouvelles pages est une des pratiques de base dans un wiki.

Plusieurs méthodes de création d’une nouvelle page:

• Créer un lien vers la nouvelle page dans une page existante. Après enregistrement de la page « source », le lien apparait en rouge car la page n’existe pas encore. Cliquer sur le lien affiche un formulaire permettant de saisir le contenu de la page.
• Effectuer une rechercher sur la page que l’on souhaite créer. La page de résulta de recherche proposera de créer la nouvelle page

Créer et utiliser des Catégories

Pour faciliter les recherches, chaque page et chaque fichier/image inclus dans mediawiki doit avoir une ou plusieurs catégories.

Il suffit d’ajouter en tête de la page le tag [[Category:nom_de_la_categorie]] pour chaque catégorie souhaitée

Les catégories existant sont listées dans la page [[Special:Categories]]

Si une des catégories choisies n’existe pas, son libellé apparait normalement en rouge (suivant les préférences du contributeur), et il suffit de cliquer sur le lien pour la créer (même méthode qu’une page classique).

Il est fortement conseillé donner une description, même brève, à chaque catégorie.

Eviter les pages trop longues

S’il devient difficile de se repérer dans une page, ou de la modifier, c’est que la page est peut-être trop longue.

Il faut alors en s’appuyant sur son sommaire commencer par éliminer les redondances (il y en a sûrement) et regrouper les informations dans des sections, sous-sections, etc.

Si la page reste peu pratique à utiliser et à modifier, alors il faudra en déplacer certaines parties vers de nouvelles pages, le texte déplacé étant remplacé par un lien vers la nouvelle page. Ne pas oublier d’assigner les catégories nécessaires (cf un peu plus haut).

Cette pratique permet également d’éviter certains conflits d’édition (situation où plusieurs contributeurs modifient en même temps une même page). Mediawiki gère très bien ces conflits d’édition, mais autant s’éviter des complications souvent inutiles.

Il y a bien entendu certaines situations où une page restera imposante, quoi qu’on fasse.

Utiliser la syntaxe wiki plutôt que des balises html

Préférer la syntaxe wiki aux balises html pour obtenir un texte (source) propre et compréhensible.

La syntaxe wiki permet de spécifier ce qui sera affiché; Titre, paragraphe, liste, code, lien, etc ont chacun une syntaxe simple et appropriée, sauf peut-être les tableaux dont la syntaxe est (juste) un peu plus compliquée.

Dit simplement, le rédacteur s’occupe de quoi afficher tandis que le logiciel s’occupe de comment l’afficher. Ce doit être du WYSIWYM (What You See Is What You Mean).

Penser en outre qu’il faudra surement revenir modifier la page demain, dans trois semaines ou dans six mois, et que quelqu’un d’autre aura éventuellement s’y coller… il sera difficile de s’y retrouver si le texte est confus (ex: tableaux complexes, listes trop imbriquées, etc).

Quelques options utiles dans les préférences

Chaque contributeur peut choisir des règles d’affichage et de fonctionnement qui lui sont propres, en cliquant sur le lien « Préférences ». Ce lien est en général en haut et à droite des pages du wiki. Apparait alors un formulaire avec plusieurs onglet.

J’ai adopté les réglages suivants:

Onglet « Apparence »:

• Format maximal des images : 800x600px
• Afficher en rouge les liens vers les pages inexistantes : activé
• Afficher la table des matières (pour les pages ayant plus de 3 sections) : activé
• Numéroter automatiquement les titres de section : activé

Onglet « Modifications récentes »:

• Utiliser les modifications récentes améliorées (nécessite JavaScript) : activé

Pour conclure

Il ne s’agit pas de techniques avancées, mais juste de quelques principes de base concernant l’alimentation d’un wiki.

Même si MediaWiki a été plusieurs fois cité, tout ceci reste applicable avec d’autres logiciels de Wiki.