Wiki

OpenProject propose deux méthodes différentes pour gérer la documentation des projets :

  • Wiki du projet : le wiki OpenProject intégré décrit sur cette page.
  • Fournisseurs de wiki externes : intégrations avec des plateformes de documentation externes, notamment XWiki.

Cette page explique comment utiliser le wiki d’OpenProject.

Si vous souhaitez connecter une plateforme de documentation externe telle que XWiki à vos projets, veuillez consulter la documentation relative à la configuration des fournisseurs de wiki externes.

Wiki est le module intégré à OpenProject permettant de créer et de modifier de manière collaborative la documentation relative aux projets. Il utilise le format CommonMark de GitHub (GFM) et doit être activé dans les paramètres du projet avant de pouvoir être utilisé.

Pour les organisations qui préfèrent gérer leur documentation en dehors d’OpenProject, il est possible de connecter des fournisseurs de wiki externes, tels que XWiki, grâce à une intégration.

Sujet Contenu
Créer et modifier des pages wiki Créer, modifier, organiser et gérer des pages wiki.
Navigation sur le wiki Naviguer et organiser les pages wiki au sein d’un projet.
FAQ du wiki Foire aux questions sur le wiki.

Activer le wiki du projet

Le wiki du projet peut être activé individuellement pour chaque projet.

Pour utiliser le wiki interne, il faut d’abord l’activer sur votre instance OpenProject, puis l’activer pour le projet dans les paramètres du projet.

Modification des pages wiki

Les pages Wiki utilisent l’éditeur WYSIWYG d’OpenProject, basé sur CKEditor 5. L’éditeur prend en charge le format CommonMark de type GitHub (GFM), ce qui vous permet de créer une documentation enrichie comprenant de la mise en forme, des images, des tableaux, des liens et des macros.

La plupart des fonctionnalités d’édition sont disponibles dans l’ensemble d’OpenProject. Pour obtenir des informations détaillées sur :

  • mise en forme du texte
  • images
  • tableaux
  • liens
  • macros
  • raccourcis clavier
  • fonctionnalités de l’éditeur prises en charge

Consultez le guide Éditeur WYSIWYG.

Fonctionnalités propres au wiki

Le wiki propose des fonctionnalités supplémentaires qui ne sont disponibles que lors de la modification des pages du wiki.

Éléments spécifiques au wiki

Cliquez sur + Insérer dans la barre d’outils pour accéder aux macros spécifiques au wiki suivantes :

  • Liste des sous-pages : insère une liste hiérarchique de toutes les sous-pages. Cette macro n’est disponible que lors de la modification de pages wiki.
  • Page wiki existante : insère un lien vers une page wiki existante.
  • Nouvelle page wiki : permet de créer une nouvelle page wiki et d’insérer un lien vers celle-ci.

Les macros Page wiki existante et Nouvelle page wiki sont également disponibles dans d’autres éditeurs de texte enrichi d’OpenProject, notamment dans les descriptions et les résultats de réunion, les commentaires et les champs personnalisés de type Texte.

Macros spécifiques au wiki dans un éditeur CKEditor sur une page wiki d’OpenProject

Conseil

Pour plus d’informations sur l’utilisation des macros, consultez notre article de blog intitulé Comment utiliser les macros.

Liens vers des pages wiki

Vous pouvez également créer des liens vers des pages wiki en utilisant la syntaxe suivante :

[[Page wiki]]
[[Page wiki|Texte du lien]]
[[Identifiant du projet:Page wiki]]