Extension:BootstrapComponents

This page is a translated version of the page Extension:BootstrapComponents and the translation is 98% complete.
Outdated translations are marked like this.
Manuel des extensions MediaWiki
BootstrapComponents
État de la version : stable
Implémentation Extension de l'analyseur
Description Permet de fournir aux éditeurs un accès facile à certains composants introduits par Bootstrap 4
Auteur(s) Tobias Oetterer (Oettererdiscussion)
Dernière version 5.2.1 (2024-07-16)
MediaWiki 1.39+
PHP 8.0+
Modifie la base
de données
Non
Composer mediawiki/bootstrap-components
Licence Licence publique générale GNU v3.0 ou supérieur
Téléchargement
README
RELEASE-NOTES
Exemple

  • $wgBootstrapComponentsDisableSourceLinkOnImageModal
  • $wgBootstrapComponentsEnableCarouselGalleryMode
  • $wgBootstrapComponentsModalReplaceImageTag
  • $wgBootstrapComponentsWhitelist

L'extension BootstrapComponents permet aux éditeurs d'accéder facilement à certains composants introduits par Bootstrap 4.

Installation

Il y a deux manières d'installer cette extension : vous pouvez utiliser Composer pour l'installation, l'activation et la gestion de la dépendance ou vous pouvez tout faire manuellement.

Cette extension nécessite l'installation de l'extension Bootstrap dans la version 4.0+ . L'utilisation de Composer pour installer BootstrapComponents va s'occuper de cela.

Composer

C'est l'approche la plus facile et elle est recommandée.

Il suffit d'exécuter la commande suivante :

COMPOSER=composer.local.json composer require mediawiki/bootstrap-components "^5.0"

Qui ajoutera ceci dans composer.local.json :

{
	"require": {
		"mediawiki/bootstrap-components": "^5.0"
	}
}

Manuellement (non recommandé)

Vous devez télécharger et activer l'extension par vous-même. Vous devez aussi vous préoccuper des dépendances.

  • Tout d'abord, vous voyez les dépendances. Ce qui signifie installer l'extension Bootstrap. Voir ici pour les détails sur la façon de faire.
  • Télécharger ensuite cette extension en clonant son dépôt avec git. Allez dans le répertoire de vos extensions et exécutez :
git clone https://github.com/oetterer/BootstrapComponents

Vous pouvez également télécharger l'archive et l'extraire vous-même.

Activation

Depuis la version 4.0, vous devez activer l'extension manuellement dans votre configuration. Auparavant, cela aurait été fait automatiquement par Composer. Ajouter la ligne suivante dans votre LocalSettings.php :

wfLoadExtension( 'Bootstrap' );
wfLoadExtension( 'BootstrapComponents' );

Configuration

Vous pouvez modifier certains des comportements de cette extension avec les quatre paramètres suivants de la configuration de votre wiki. Ajouter simplement la ligne correspondante à votre fichier LocalSettings.php.

$wgBootstrapComponentsWhitelist

La valeur par défaut est true.

Cela vous permet d'activer tous, certains ou aucun des composants de votre code wiki.

Si vous voulez que tous les composants soient disponibles, initialisez ceci à true :

$wgBootstrapComponentsWhitelist = true;

Si vous voulez seulement une sélection de composants, initialisez-le avec un tableau contenant les composants en liste blanche. Pour la liste de tous les composants, voir la documentation.

$wgBootstrapComponentsWhitelist = [ 'card', 'tooltip', 'modal' ];

Lorsque vous utilisez des modal[1], vous pourriez souhaiter désactiver les popover[2]. Voir les problèmes connus pour plus d'informations.

Pour désactiver tous les composants, il suffit d'initialiser ceci à false.

$wgBootstrapComponentsModalReplaceImageTag

La valeur par défaut est false.

Vous pouvez faire en sorte que cette extension change la gestion normale des images dans votre wiki. Si vous initialisez ceci à true, toutes les balises de l'image qui ne contiennent pas de paramètre link= seront converties en modalité. Donc lorsque vous cliquez sur une image, au lieu d'aller sur la page correspondante de l'espace de noms du fichier, une fenêtre modale apparaît avec cette image et une légende possible (si vous avez fourni cette dernière) ainsi qu'un lien vers la page source du fichier.

Exemple :

$wgBootstrapComponentsModalReplaceImageTag = true;

La plupart des options régulières pouvant être utilisées avec les images sont reconnues et traitées en conséquence. Voir la page d'aide pour les images.

Même après avoir activé cette option, vous pouvez supprimer les fenêtres modales d'image sur une page donnée en ajoutant le mot magique __NOIMAGEMODAL__ quelque part sur la page. Si vous voulez supprimer la conversion modale pour une image particulière, attribuez-lui la classe css no-modal.

Exemple :

[[File:NormalImage.png|class=no-modal|alt=normal|This image is displayed normally]]

Voir les problèmes connus pour plus d'informations.

$wgBootstrapComponentsDisableSourceLinkOnImageModal

La valeur par défaut est false.

Lorsque vous utilisez des images modales (donc quand $wgBootstrapComponentsModalReplaceImageTag vaut true), en activant ce paramètre cela supprime le lien source dans la section du pied de page de la fenêtre modale.

$wgBootstrapComponentsEnableCarouselGalleryMode

La valeur par défaut est true.

Ceci ajoute le mode carousel à la balise ‎<gallery> qui lorsqu'elle est utilisée transforme votre galerie en carrousel. Pour les informations concernant l'utilisation des galeries, voir la documentation de la galerie.

Exemples

Voir aussi

Notes

  1. modal cible un élément qui est dans un état interdisant toute interaction avec les autres éléments situés en dehors jusqu'à ce que l'interaction soit terminée
  2. popover permet de désigner un élément qui sera affiché par-dessus le contenu actuel