Manuel:Extensions

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:Extensions and the translation is 100% complete.

Other languages:
Bahasa Indonesia • ‎Bahasa Melayu • ‎Deutsch • ‎English • ‎Mirandés • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎italiano • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎čeština • ‎Ελληνικά • ‎български • ‎русский • ‎العربية • ‎سنڌي • ‎پښتو • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어
Gnome-preferences-other.svg Extensions: Développement Extension "Tag" Manuel:Fonctions d'analyse Points d’accroche Pages spéciales Manuel:Habillage Manuel:Mots magiques API Content models

Qu'est-ce qu'une extension ?

Extensions MediaWiki

Les extensions vous permettent de personnaliser l'apparence et la façon de travailler de MediaWiki.

Les utilisateurs wiki peuvent rechercher parmi les extensions existantes ou bien demander une nouvelle extension. Les administrateurs système peuvent installer (ou désinstaller) des extensions sur les systèmes MediaWiki qu'ils gèrent. Les développeurs peuvent créer de nouvelles extensions ou bien améliorer/maintenir des extensions existantes.

Recherchez les extensions par mot(s)-clé(s) :

En fonction de vos objectifs, vous pouvez utiliser des extensions pour :

Tandis que certaines extensions sont maintenues par les développeurs MediaWiki, d'autres ont été écrites par des développeurs tiers. De ce fait, beaucoup d'entre-elles contiennent des bogues et la compatibilité entre extensions n'est pas garantie. Certaines ne sont pas maintenues : toutes les extensions ne fonctionnent pas sur toutes les versions de MediaWiki. L'utilisation de toute extension, notamment celles qui sont marquées comme dangereuses, se fera à vos propres risques. Lorsque l'utilisation d'une extension réclame d'ajouter des patches dans le noyau MediaWiki ou des entrées supplémentaires dans votre(vos) base(s) de données, assurez-vous d'effectuer une sauvegarde de votre base de données et/ou du code noyau MediaWiki de façon à éviter de planter de façon permanente votre wiki.

Navigation dans les extensions

Vous pouvez naviguer dans la catégorie Catégorie:Extensions par catégories pour voir l'éventail des extensions qui ont déjà été écrites. Pour les informations sur la manière d'installer ces extensions ou bien d'écrire la vôtre, voyez plus bas.

Vérification des extensions installées

Seule une personne disposant d'un accès administration au système de fichiers (et souvent aussi à la base de données) sur un serveur peut installer des extensions pour MediaWiki, et tous les utilisateurs peuvent vérifier quelles extensions sont activées sur une version de MediaWiki en accédant à la page spéciale Special:Version . Par exemple, voici la liste des extensions actives sur la Wikipédia francophone.

Installation d'une extension

MediaWiki est prêt à accepter des extensions dès la fin de l'installation. Pour ajouter une extension, suivez ces étapes :

  1. Avant de commencer
    De nombreuses extensions fournissent des instructions conçues pour l'installation à l'aide de commandes unix. Vous aurez besoin d'un accès shell (SSH) pour entrer ces commandes énumérées dans les pages d'aide de l'extension.
  2. Téléchargez votre extension.
    La page de téléchargement d'extensions vous permet de sélectionner et de télécharger la plupart des extensions populaires.
    Les extensions sont généralement distribuées sous forme de packages modulaires. Elles vont généralement dans leur propre sous-répertoire du dossier $IP /extensions/. Une liste des extensions stockées dans Wikimedia Dépôt Git se trouve dans git:mediawiki/extensions. Certaines extensions n'utilisent pas de contrôle de version et ne sont pas recommandées.
    Quelques extensions aussi sont disponibles sous forme de colis, de composer ou de dépôt de packages.
  3. Installez votre extension..
    Généralement à la fin du fichier LocalSettings.php , (mais au-dessus du délimiteur de fin de code PHP "?>" s'il est présent), la ligne suivante doit être ajoutée :
    // mw.v 1.24.x or less
    require_once "$IP/extensions/extension_name/extension_name.php";
    // mw.v 1.25.x or above
    wfLoadExtension( '<extension-name>' );
    
    Cette ligne oblige l'interpréteur PHP à lire le fichier principal de l'extension et donc la rendre accessible à MediaWiki.
    Certaines extensions peuvent être en conflit avec les scripts de maintenance, par exemple si elles accèdent directement à $_SERVER (non recommandé).
    Dans ce cas, elles peuvent être incluses dans une condition afin que les scripts de maintenance puissent toujours s'exécuter.
//for mw.v 1.24.x or less
if ( !$wgCommandLineMode ) {
   require_once "$IP/extensions/extension_name/extension_name.php";
}
//for mw.v 1.25.x or above
if ( !$wgCommandLineMode ) {
   wfLoadExtension ( '<extension-name>' );
}
Le script de maintenance importDump.php ne fonctionnera pas pour toute extension qui nécessite des espaces de noms personnalisés et qui est incluse dans la condition ci-dessus comme Extension:Semantic MediaWiki , Extension:Semantic Forms .
Assurez-vous de disposer des permissions adéquates pour les extensions !
Bien que la procédure d'installation soit suffisante pour la majorité des extensions, certaines peuvent demander une installation différente. Voyez la documentation de l'extension pour plus d'informations.
Si vous souhaitez modifier les variables de configuration dans LocalSettings.php, vous devez impérativement le faire après avoir inclus l'extension. Autrement les valeurs par défaut de l'extension écraseront votre configuration.
Attention! Attention : Bien que les déclarations d'extensions puissent être ajoutées n'importe où dans le fichier LocalSettings.php file, il ne faut jamais mettre les extensions avant la ligne require_once "includes/DefaultSettings.php"; pour les versions MediaWiki antérieures à la 1.17. Si vous faites ainsi, cela effacera les tableaux de la fonction d'initialisation de l'extension, empêchant l'installation des extensions et rendant probablement impossible l'accès à votre wiki jusqu'à ce que vous fassiez la correction !


Mise à jour d'une extension

Certaines extensions nécessitent une mise à jour lorsque vous mettez à jour MediaWiki tandis que d'autres fonctionnent sur plusieurs versions. Pour mettre à jour une extension avec une nouvelle version :

  1. Téléchargez la nouvelle version de l'extension
  2. Remplacez tous les fichiers de l'extension dans le répertoire extension/NomDeLExtension par les nouveaux fichiers. Ne retirez pas la configuration de l'extension présente dans LocalSettings.php.
  3. En fonction de l'extension, il se peut que vous ayez à lancer le script de maintenance Update.php . La majeure partie des extensions mentionneront si le script a besoin ou non d'être exécuté. (Faites une sauvegarde de vos données avant d'exécuter le script). Si vous ne disposez pas d'accès aux lignes de commande, vous pouvez aussi utiliser l'utilitaire de mise à jour web.
  4. C'est tout ce que vous avez à faire. Dans la plupart des cas, tout configuration d'extension que vous avez faite dans LocalSettings.php fonctionnera aussi avec la nouvelle version de l'extension.
Ces instructions couvrent 99% des extensions. Si l'extension spécifique que vous mettez à jour possède des instructions qui diffère de celles-ci, vous devez dans ce cas suivre les instructions spécifiques à cette extension.

Suppression d'une extension

Les extensions sont ajoutées en insérant une ligne dans LocalSettings.php, qui grosso-modo ressemble à ceci :

// mw.v 1.24.x or less
require_once "$IP/extensions/extension_name/extension_name.php";
// mw.v 1.25.x or above
wfLoadExtension( '<extension-name>' );
En fonction de l'extension que vous souhaitez désinstaller, celle-ci peut avoir nécessité quelques manipulations supplémentaires lors de son installation, que vous ne voudriez pas retirer maintenant. Pour plus de détails, voir la section sur l'installation d'une extension.
  1. Supprimez cette ligne et l'extension sera désinstallée. Si vous le souhaitez, vous pouvez (et vous devriez si vous ne souhaitez plus utiliser cette extension à l'avenir) supprimer les fichiers de cette extension dans le répertoire « extensions/ ».
  2. Peut-être avez-vous d'autres lignes en rapport avec l'extension que vous souhaitez supprimer dans LocalSettings.php. Très certainement, il s'agira de lignes qui permettent à certains utilisateurs d'accéder à des pages générées par l'extension. Ces lignes contiennent la variable « $wgGroupPermissions » et mettent en place quelques paramètres ici. Du moment qu'elles concernent des droits qui proviennent de l'extension supprimée, vous pouvez aussi supprimer ces lignes.
  3. Il se peut aussi que l'extension ait ajouté des colonnes dans votre base de données. Le fichier de mise à jour maintenance/update.php les retire quand vous le lancez après avoir désinstallé l'extension.

Développement d'extensions

Ce sujet complexe est développé dans la page du manuel Développement d'extensions.

Voir aussi

Extensions : Catégorie tout RequêtesManuel:Extensions de balises FAQ des extensions Variantes d'extensionsEspaces de noms par défaut de l'extension