Extension:VEForAll

Manuel des extensions MediaWiki

VEForAll État de la version : stable
Description	Définit la fonctionnalité JavaScript pour permettre aux autres extensions d'intégrer VisualEditor dans leurs zones de texte de formulaire
Auteur(s)	Pierre Boutet, Clément Flipo, Ike Hecht, Yaron Koren et Cindy Cicalese
Dernière version	0.5.2 (février 2024)
Politique de compatibilité	Le master conserve la compatibilité arrière.
MediaWiki	1.35+
Modifie la base de données	Non
Licence	Licence publique générale GNU v2.0 ou supérieur
Téléchargement	Télécharger l'extension Git [?]: Télécharger la branche master de Git parcourir le dépôt (Phabricator · GitHub) historique des validations (commits) contributeurs du dépôt (GitHub) relecture du code
Accroches utilisées BeforePageDisplay MakeGlobalVariablesScript
Accroches fournies VEForAllToolbarConfigNormal
Téléchargements trimestriels	5 (Ranked 135th)
Traduire l’extension VEForAll sur translatewiki.net si elle y est disponible
Problèmes	Tâches ouvertes · Signaler un bogue

L'extension VEForAll (VisualEditor For All) permet à d'autres extensions d'intégrer l'interface de VisualEditor dans les zones de texte pour l'édition par l'utilisateur.

Cette extension n'a pas d'impact direct sur l'interface utilisateur. Elle définit plutôt la fonction JavaScript applyVisualEditor() qui peut être appelée par d'autres extensions sur leurs zones de texte. Pour le moment, les extebsions suivantes peuvent utiliser VEForAll.

• CommentStreams
• Page Forms
• FlexForm
• VisualData

Comme on pouvait s'y attendre, l'extension VisualEditor doit être installée pour que cette extension fonctionne.

Téléchargement

Vous pouvez télécharger le code VEForAll, au format .zip, de Github.

Vous pouvez aussi télécharger le code directement via Git depuis le répertoire de code source MediaWiki. À partir d'une ligne de commande, vous pouvez appeler ceci :

git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/VEForAll

Vous pouvez également afficher le code en ligne ici.

Installation

Pour installer cette extension, créez un répertoire VEForAll (soit en extrayant le fichier compressé ou en le téléchargeant via Git), et placez ce répertoire dans le répertoire principal extensions de MediaWiki. Ensuite, dans le fichier LocalSettings.php ajoutez la ligne suivante :

wfLoadExtension( 'VEForAll' );
$wgDefaultUserOptions['visualeditor-enable'] = 1;

Utiliser VEForAll avec d'autres extensions

VEForAll peut être utilisé actuellement avec les extensions suivantes : CommentStreams , Page Forms , FlexForm , VisualData

• Pour CommentStreams, vous devez simplement avoir installé VEForAll (et VisualEditor), et les zones de texte pour entrer des commentaires obtiendront automatiquement l'interface VisualEditor.
• Pour Page Forms, dans la définition du formulaire, ajoutez |editor=visualeditor à la balise pour toute entrée de zone de texte (y compris l'entrée free text), et l'interface VisualEditor doit alors apparaître à l'affichage de ce formulaire.
• Pour FlexForm, utilisez editor="ve" pour définir une zone de texte, par exemple <_input type="textarea" editor="ve"></_input>. Vous pouvez avoir autant d'éditeurs VE sur une page que nécessaire et vous pouvez même ajouter un menu/bouton à l'éditeur VE qui ouvrira un autre éditeur VE.
• For VisualData, VEForAll is enabled by default in the form for creating a new article, and can be enabled through the Schema Builder in any input with type string and format textarea.

Configuration

Par défaut, la barre d'outils est affichée en bas de la zone de texte. Dans Page Forms, vous pouvez plutôt l'afficher en haut en ajoutant |class=toolbarOnTop à la balise de la zone de texte dans la définition du formulaire.

Vous pouvez utiliser les accroches VEForAllToolbarConfigNormal et VEForAllToolbarConfigWide pour personnaliser l'affichage de la barre d'outils VisualEditor. L'une ou l'autre des accroches est appelée, selon que toolbarOnTop est initialisé : Normal est appelé s'il n'est pas initialisé, et Wide s'il l'est.

Par exemple, pour ajouter des boutons « Insérer → formule mathématique » , « Insérer → Images et médias » , et « Citer » dans le cas normal (barre d'outils en bas), ajoutez ce qui suit à LocalSettings.php, en dessous de l'inclusion de VEForAll :

$wgHooks['VEForAllToolbarConfigNormal'][] = function( &$defaultConfigNormal ) {
        $defaultConfigNormal[4]['include'][] = 'math';
        $defaultConfigNormal[4]['include'][] = 'media';
        $defaultConfigNormal[] = [ 'name' => 'reference' ];
};

Pour que la première et la troisième lignes aient un effet, les extensions Math et Cite doivent être installées, respectivement.

Problèmes connus

Avec certains habillages, les listes déroulantes peuvent sembler plutôt compressées. Vous pouvez appliquer un petit ajustement CSS pour corriger cela :

table.formtable,
table.multipleTemplateInstanceTable {
  border-collapse: inherit;
}

Auteurs et crédits

VEForAll est fortement basé sur l'extension (maintenant obsolète) VEForPageForm par Pierre Boutet et Clément Flipo. Un certain travail pour rendre le code plus générique a été effectué par Ike Hecht, Yaron Koren et Cindy Cicalese. D'autres personnes ont contribué au code tel Anysite et Mark Hershberger. VEForAll inclut également le code de l'extension StructuredDiscussions.

Historique des versions

• 0.1 - 3 mai 2018 - version initiale
• 0.2 - 7 février 2020 - Rendre configurable la barre d'outils; suppression des dépendances avec l'extension Math; correction des valeurs soumises pour les zones de texte qui ont le focus; définir correctement la direction VE (RTL/LTR); ajout de l'accroche veForAll.targetCreated; et plusieurs autres corrections
• 0.3 - 5 mai 2021 - Amélioration de la prise en charge de MW 1.35+; suppression de la prise in charge des versions MW < 1.29; prise en charge ajoutée du paramètre max height de Page Forms; échappement ajouté des barres verticales '|' dans le wikicode du tableau, dans les champs de modèle Page Forms; corrections des bogues
• 0.4 - 3 novembre 2021 - Amélioration du support pour MW 1.34+; suppression du support pour MW < 1.32; correction de l'échappement des caractères '|'
• 0.4.1 - 15 novembre 2022 - support corrigé pour MW 1.39+; autres corrections
• 0.5 - 22 mars 2023 - Correction supplémentaire de l'aide pour MW 1.39+; suppression du support pour MW < v 1.35
• 0.5.1 - 2 août 2023 - Correction de la gestion de Parsoid pour MW 1.40 MW+; correction de la gestion des attributs rowspan et colspan; mise à jour de la gestion des accroches
• 0.5.2 - 20 février 2024 - Improved support for MW 1.41+; fix for rapid conversion between wikitext and HTML