Introduction à Mediawiki

Ce guide a pour objectif de vous présenter le fonctionnement, la configuration et l'utilisation du service MediaWiki intégré à Tuleap. Nous nous concentrerons sur les fonctionnalités offertes par Tuleap pour gérer votre documentation.

Dans Tuleap, le service MediaWiki s’intègre nativement aux outils de suivi de projet. Cette intégration permet de centraliser la connaissance et la documentation de vos projets au sein d’un outil directement lié à votre environnement de travail.

Attention : pour utiliser ce service, il vous faut activer le service “MediaWiki Standalone” dans l’administration de votre instance Tuleap et dans l’administration de votre projet.

Présentation du service

Qu’est ce que Mediawiki ?

MediaWiki est un moteur de wiki open-source, mondialement connu pour être la technologie qui propulse Wikipédia et des milliers d'autres sites à travers le monde. Son principe fondamental est de permettre à plusieurs utilisateurs de créer, modifier et organiser du contenu de manière simple et collaborative.

Conçu pour la gestion de la connaissance, MediaWiki se distingue par plusieurs caractéristiques clés :

Édition ouverte et facile : grâce à une syntaxe simple (le wikitexte) et souvent un éditeur visuel, n'importe quel membre autorisé du projet peut corriger une erreur, ajouter une information ou créer une nouvelle page sans compétences techniques avancées.
Historique complet des modifications : chaque page conserve un historique détaillé de toutes ses versions. Il est ainsi possible de voir qui a changé quoi, de comparer les versions entre elles et de revenir à une version antérieure en cas d'erreur.
Maillage interne : il est extrêmement simple de créer des liens entre les pages, ce qui permet de construire une base de connaissances structurée et interconnectée où l'information est facile à trouver.
Organisation du Contenu : les pages peuvent être organisées à l'aide de catégories, créant ainsi une arborescence thématique pour naviguer dans la documentation.

Dans le contexte de Tuleap, MediaWiki sert de base de connaissances centralisée pour votre projet. C'est l'outil idéal pour rédiger et maintenir collectivement de la documentation technique, des comptes-rendus de réunion, des guides utilisateurs, des spécifications fonctionnelles, et toute autre forme de savoir partagé par l'équipe.

Comment MediaWiki s'intègre à Tuleap ?

Le service MediaWiki dans Tuleap est fourni sous forme standalone. Cela signifie qu’il s’agit d’une instance de MediaWiki distincte, mais intégrée de manière transparente à Tuleap. Voici les points clés de cette intégration :

Authentification unique (SSO) : les utilisateurs connectés à Tuleap sont automatiquement connectés à MediaWiki. Il n'est pas nécessaire de gérer des comptes séparés.
Gestion des droits centralisée : les permissions (lecture/écriture) sont héritées des paramètres du projet Tuleap. Les administrateurs de projet peuvent définir des droits spécifiques pour certains groupes d'utilisateurs.
Interface unifiée : une interface Tuleap est appliquée à MediaWiki pour une expérience utilisateur cohérente. Le wiki est accessible directement depuis l’onglet “MediaWiki” dans l’interface du projet, et la navigation principale ainsi que les liens vers les autres services du projet restent accessibles.
Gestion simplifiée : la maintenance de l'instance MediaWiki (mises à jour, etc.) est gérée au niveau de la plateforme Tuleap.

Explorer l'interface MediaWiki

L'interface du service MediaWiki est organisée en plusieurs zones distinctes pour faciliter la navigation et l'édition.

Menu MediaWiki

Le menu MediaWiki vous permet d'accéder à des éléments de navigation clés :

Page d'accueil : le point d'entrée de votre wiki.
Modifications récentes : consultez les dernières contributions sur l'ensemble du wiki.
Page au hasard : affiche une page aléatoire, utile pour la relecture ou la découverte.
Aide concernant MediaWiki : ouvre un lien vers la documentation officielle de MediaWiki pour obtenir de l'aide sur l'utilisation du logiciel.
Administration : offre un accès aux outils de gestion du wiki, tels que la gestion des permissions des utilisateurs (cet onglet n'est visible que par les administrateurs).

La barre de navigation est un moteur de recherche puissant qui vous permettra de retrouver facilement des informations dans toutes les pages du wiki.

Menu du compte utilisateur

Situé dans le coin supérieur droit de la fenêtre, le menu “Compte MediaWiki” pour permet de gérer vos paramètres personnels :

Préférences : permet de personnaliser certains aspects de l'interface MediaWiki (apparence, format de date, etc.).
Contributions : affiche la liste de toutes les modifications que vous avez effectuées sur le wiki.
Se déconnecter : termine votre session MediaWiki (vous resterez connecté à Tuleap).

Actions contextuelles

En haut de chaque page, à droite du titre, se trouve une barre d'actions contextuelles qui vous permet d'interagir avec le contenu.

Le bouton principal "Modifier" et son menu déroulant regroupent les actions les plus courantes :

Modifier : ouvre l'éditeur pour modifier le contenu de la page actuelle.
Discussion : accède à une page de discussion dédiée pour échanger sur le contenu de l'article sans altérer l'article lui-même.
Voir l'historique : affiche la liste de toutes les versions précédentes de la page, avec la possibilité de les comparer ou de les restaurer.

Le reste du menu déroulant "Modifier" offre des options de gestion avancées :

Informations sur la page : fournit des détails sur la page, tels que sa date de création, son nombre de modifications, etc.
Lien permanent : fournit une URL unique vers la version actuelle de la page, qui ne changera pas même si la page est modifiée plus tard.
Pages liées : liste toutes les autres pages du wiki qui pointent vers la page actuelle.
Protéger : permet de restreindre les modifications sur la page à certains groupes d'utilisateurs.
Renommer : change le titre de la page tout en conservant son historique et en créant une redirection depuis l'ancien nom.
Supprimer : efface la page de manière permanente.
Exporter en PDF / Version imprimable : génère des versions adaptées pour l'export en PDF ou l'impression.

Enfin, le bouton "Outils" donne accès à des fonctionnalités complémentaires :

Téléverser un fichier : permet d'importer des images, des documents et d'autres fichiers pour les utiliser dans vos pages de wiki.
Suivi des pages liées : affiche les modifications récentes des pages qui sont liées depuis la page actuelle.

Contribuer et naviguer

Créer une nouvelle page

La méthode la plus courante et la plus efficace pour créer une nouvelle page dans MediaWiki est de créer un lien vers celle-ci depuis une page existante. Cette approche garantit que votre nouvelle documentation est immédiatement intégrée au reste de la base de connaissances.

Il existe deux manières principales de procéder :

1. Via un "lien rouge"

Créez un lien interne : sur une page existante, cliquez sur "Modifier". Dans l'éditeur, identifiez un mot ou une phrase qui devrait pointer vers votre nouvelle page. Entourez ce texte de doubles crochets. Par exemple, pour créer une page nommée "Spécifications du module de paiement", vous écririez : [[Spécifications du module de paiement]].
Enregistrez la page : après avoir ajouté le lien, enregistrez vos modifications. Le lien que vous venez de créer (appelé “red link”) apparaîtra en rouge, signalant que la page de destination n'existe pas encore.
Cliquez sur le lien rouge : en cliquant sur ce lien rouge, vous serez redirigé vers l'éditeur de la nouvelle page, pré-remplie avec le titre que vous avez défini. Il ne vous reste plus qu'à rédiger le contenu et à l'enregistrer.

2. Via la barre de recherche

Tapez le titre exact de la page que vous souhaitez créer dans la barre de recherche et lancez la recherche.
Si la page n'existe pas, MediaWiki affichera un message vous informant qu'elle n'a pas été trouvée et vous proposera de la créer via un “red link” dans les résultats.

Voir l’ensemble des pages

Pour avoir une vue d'ensemble de toute la documentation de votre projet, vous pouvez accéder à la liste complète des pages du wiki.

La méthode la plus directe est d'utiliser la barre de recherche :

Repérez la barre “Rechercher sur...” en haut à droite de la page.
Tapez “Special:AllPages” dans le champ de recherche et validez.

Cette page affiche une liste alphabétique de toutes les pages créées dans le wiki, vous permettant de naviguer et de vérifier facilement le contenu existant.

Info pratique
En complément de cette documentation, nous vous encourageons à consulter la documentation officielle de MediaWiki, une référence incontournable pour toute question complémentaire sur la syntaxe et les fonctionnalités avancées.