Template:ExtensionInstall
- Téléchargez et placez le(s) fichier(s) dans un répertoire appelé
ExtensionInstall
dans votre dossierextensions/
.
Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionInstall - Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
- Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Ce modèle utilise le module Lua suivant : |
Utilisation
Installation instructions.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Extension name | 1 | Set the extension name manually.
| String | optional |
Git submodule | git-submodule | Add --recurse-submodules to the git clone command | Boolean | optional |
Vagrant role name | vagrant | If given, shows how to install extension with the Vagrant's enable-role command | String | optional |
Download link | download-link | Overwrite the download link.
| URL | optional |
LocalSettings early | localsettingsearly | Pass custom php code that the user should include in [[LocalSettings.php]] before the extension is loaded.
| Unknown | optional |
LocalSettings | localsettings | Pass custom PHP code that the user should include in [[LocalSettings.php]].
| Unknown | optional |
Database update | db-update | If the extension has one or more database tables that need to be created through [[update.php]], set this parameter to any value.
| Boolean | optional |
Composer | composer | If the extension uses [[Composer]] to manage dependencies, set this parameter to any value.
| Boolean | optional |
Custom steps 0 | custom-steps0 | Additional steps before download, e.g. other required extensions (as an unordered "* list") | Content | optional |
Custom steps | custom-steps | Additional steps (as an unordered "* list") | Content | optional |
Supports registration | registration | Changes the template to use <code>wfLoadExtension()</code> if it supports registration. Set to any value if the extension supports registration, or to <code>required</code> if it <em>only</em> supports registration and doesn't support the old-style of loading. | String | optional |
No registration version | no-registration-version | The MediaWiki version for which extension registration should not be used
| Unknown | optional |
Exemples
Ci-dessous quelques exemples sur la manière d'utiliser ce modèle :
Simple
{{ExtensionInstall}}
- Téléchargez et placez le(s) fichier(s) dans un répertoire appelé
MyExtension
dans votre dossierextensions/
.
Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
require_once "$IP/extensions/MyExtension/MyExtension.php";- Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Avec un nom
{{ExtensionInstall|CategoryTree}}
- Téléchargez et placez le(s) fichier(s) dans un répertoire appelé
CategoryTree
dans votre dossierextensions/
.
Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CategoryTree- Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
require_once "$IP/extensions/CategoryTree/CategoryTree.php";- Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Avec un lien de téléchargement
{{ExtensionInstall |download-link=[http://bits.wikimedia.org/example.zip Download] }}
- Download et placez le(s) fichier(s) dans un répertoire appelé
MyExtension
dans votre dossierextensions/
.- Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
require_once "$IP/extensions/MyExtension/MyExtension.php";- Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
LocalSettings
{{ExtensionInstall |localsettings= $wgUseAjax = true; }}
- Téléchargez et placez le(s) fichier(s) dans un répertoire appelé
MyExtension
dans votre dossierextensions/
.
Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
require_once "$IP/extensions/MyExtension/MyExtension.php"; $wgUseAjax = true;- Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Ancien LocalSettings
{{ExtensionInstall |localsettingsearly= $wgUseAjax = true; // inclure ceci avant de charger l'extension }}
- Téléchargez et placez le(s) fichier(s) dans un répertoire appelé
MyExtension
dans votre dossierextensions/
.
Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
$wgUseAjax = true; // inclure ceci avant de charger l'extension require_once "$IP/extensions/MyExtension/MyExtension.php";- Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Avec une mise à jour de la base de données
{{ExtensionInstall |db-update=Yes }}
- Téléchargez et placez le(s) fichier(s) dans un répertoire appelé
MyExtension
dans votre dossierextensions/
.
Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
require_once "$IP/extensions/MyExtension/MyExtension.php";- Exécutez le script de mise à jour qui va créer automatiquement les tables de base de données dont cette extension a besoin.
- Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Avec Composer
{{ExtensionInstall |composer=Yes }}
- Téléchargez et placez le(s) fichier(s) dans un répertoire appelé
MyExtension
dans votre dossierextensions/
.
Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Seulement lorsque vous installez à partir de Git, exécutez Composer pour installer les dépendances PHP, en entrant
composer install --no-dev
après vous être positionné dans le répertoire de l'extension. (Voir tâche T173141 pour des complications potentielles.)- Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
require_once "$IP/extensions/MyExtension/MyExtension.php";- Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Avec des étapes personnalisées
{{ExtensionInstall |custom-steps= * Lorem ipsum dolor sit amet * Foo bar baz quux [[sandbox]] }}
- Téléchargez et placez le(s) fichier(s) dans un répertoire appelé
MyExtension
dans votre dossierextensions/
.
Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
require_once "$IP/extensions/MyExtension/MyExtension.php";- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
- Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Prend en charge l'enregistrement d'extension
{{ExtensionInstall |registration=1 }}
- Téléchargez et placez le(s) fichier(s) dans un répertoire appelé
MyExtension
dans votre dossierextensions/
.
Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
wfLoadExtension( 'MyExtension' );- Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Supporter l'enregistrement avec la version minimale
{{ExtensionInstall |registration=1 |no-registration-version=1.39 }}
- Téléchargez et placez le(s) fichier(s) dans un répertoire appelé
MyExtension
dans votre dossierextensions/
.
Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
wfLoadExtension( 'MyExtension' );- Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Pour les utilisateurs de MediaWiki 1.39 ou précédents :
Les instructions ci-dessus décrivent la nouvelle procédure pour installer cette extension en utilisant
wfLoadExtension()
. Si vous avez besoin d'installer cette extension sur les précédentes versions de MediaWiki (1.39 ou antérieur), à la place dewfLoadExtension( 'MyExtension' );
, vous devez utiliser :require_once "$IP/extensions/MyExtension/MyExtension.php";
Cela ne fonctionne que si la version spécifiée est 1.35 ou plus récente, sinon le modèle suppose que personne ne s'occupe des anciennes versions et se replie sur l'Enregistrement nécessaire.
Nécessite l'enregistrement
{{ExtensionInstall |registration=required }}
- Téléchargez et placez le(s) fichier(s) dans un répertoire appelé
MyExtension
dans votre dossierextensions/
.
Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
wfLoadExtension( 'MyExtension' );- Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Tout en même temps
{{ExtensionInstall|Example |download-link=[http://bits.wikimedia.org/example.zip Download] |vagrant=example |localsettings= $wgUseAjax = true; |db-update=Yes |composer=Yes |custom-steps= * Lorem ipsum dolor sit amet * Foo bar baz quux [[sandbox]] |registration=yes }}
- Download et placez le(s) fichier(s) dans un répertoire appelé
Example
dans votre dossierextensions/
.- Seulement lorsque vous installez à partir de Git, exécutez Composer pour installer les dépendances PHP, en entrant
composer install --no-dev
après vous être positionné dans le répertoire de l'extension. (Voir tâche T173141 pour des complications potentielles.)- Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
wfLoadExtension( 'Example' ); $wgUseAjax = true;- Exécutez le script de mise à jour qui va créer automatiquement les tables de base de données dont cette extension a besoin.
- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
- Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Pour les utilisateurs de MediaWiki 1.39 ou précédents :
Les instructions ci-dessus décrivent la nouvelle procédure pour installer cette extension en utilisant
wfLoadExtension()
. Si vous avez besoin d'installer cette extension sur les précédentes versions de MediaWiki (1.39 ou antérieur), à la place dewfLoadExtension( 'Example' );
, vous devez utiliser :require_once "$IP/extensions/Example/Example.php";
Installation Vagrant :
- Si vous utilisez Vagrant , installez avec
vagrant roles enable example --provision