Extension:CodeEditor

This page is a translated version of the page Extension:CodeEditor and the translation is 100% complete.
Cette extension est fournie avec MediaWiki 1.31 et supérieur. Ainsi vous n'avez pas besoin de la télécharger à nouveau. Néanmoins, vous devez encore suivre les autres instructions fournies.
A ne pas confondre avec CodeMirror .
Manuel des extensions MediaWiki
CodeEditor
État de la version : stable
Description Fournit un éditeur de code qui met en forme la syntaxe pour les pages JS, CSS et Lua du site, ainsi que celles de l'utilisateur, en intégrant la barre d'outils d'édition avancée
Auteur(s)
  • Brooke Vibber
  • Derk-Jan Hartman
  • authors of Ace (ace.c9.io)
Politique de compatibilité Versions ponctuelles alignées avec MediaWiki. Le master n'est pas compatible arrière.
MediaWiki >= 1.42.0
Modifie la base
de données
Non
Licence GPL-2.0-or-later AND BSD-3-Clause
Téléchargement
  • $wgCodeEditorEnableCore
Téléchargements trimestriels 157 (Ranked 36th)
Utilisé par les wikis publics 8,385 (Ranked 17th)
Traduire l’extension CodeEditor sur translatewiki.net si elle y est disponible
Problèmes Tâches ouvertes · Signaler un bogue

L'extension CodeEditor étend la barre d'outils d'édition avancée de WikiEditor avec un widget d'éditeur Ace intégré, fournissant des fonctionnalités pratiques pour les pages JavaScript des utilisateurs ou des sites, les pages CSS, les pages JSON, et lorsque l'extension Scribunto est aussi installée, pour les pages LUA c'est à dire les pages de l'espace de noms Module. L'éditeur de code ne s'affiche pas sur les pages wiki ordinaires, c'est-à-dire les pages wiki avec le modèle de contenu wikitext. (Voir Extension:CodeMirror pour la mise en surbrillance de la syntaxe du wikicode lors de l'utilisation de l'éditeur de source.)

Il fournit les fonctionnalités suivantes :

  • mise en valeur de la syntaxe pour le JavaScript, CSS et Lua
  • auto-indentation
  • la touche de tabulation génère des indentations tabulées (depuis 1.22) et avant, les indentations étaient logicielles.
  • indenter/désindenter la sélection avec les clés Tab ↹/⇧ Shift+Tab ↹
  • contrôle de validité syntaxique pour le JavaScript
  • association des paires de parenthèses, accolades et crochets

Installation

L'extension WikiEditor doit être installée pour que cette extension puisse fonctionner. L'installation de Scribunto est facultative.
  • Téléchargez et placez le(s) fichier(s) dans un répertoire appelé CodeEditor dans votre dossier extensions/.
    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/CodeEditor
  • Ajoutez le code suivant à la fin de votre fichier LocalSettings.php  :
    wfLoadExtension( 'CodeEditor' );
    $wgDefaultUserOptions['usebetatoolbar'] = 1; // user option provided by WikiEditor extension
    
  • Configurer si nécessaire.
  •   Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.


Installation Vagrant :

  • Si vous utilisez Vagrant , installez avec vagrant roles enable codeeditor --provision

Configuration

$wgCodeEditorEnableCore
Pour désactiver l'éditeur sur les pages JavaScript et CSS de MediaWiki, User et autres espaces de nom du noyau, initialisez $wgCodeEditorEnableCore = false; (par défaut true)
$wgScribuntoUseCodeEditor
Pour désactiver cette extension pour Scribunto, par exemple dans l'espace de noms Module, initialisez $wgScribuntoUseCodeEditor = false; (valeur par défaut true)
Ce paramètre de configuration est fourni par l'extension Scribunto et doit par conséquent être ajouté après avoir appelé CodeEditor et l'extension Scribunto; celle-ci doit également avoir été installée auparavent pour que cela fonctionne.

JavaScript

Il est possible de modifier la configuration de l'éditeur ACE, en utilisant l'accroche MediaWiki JS (par exemple mw.hook( 'codeEditor.configure' ).add( ... )). L'argument passé à votre accroche sera une session d'éditeur ACE.

Si vous devez interagir avec le contenu d'une instance CodeEditor, utilisez jQueryPlugins.textSelection().

Licence

Alors que cette extension est sous licence GNU General Public License v2.0 or later (GPL-2.0+) elle utilise le logiciel Ace editor qui est sous licence BSD 3-clause "Nouveau" ou "Révisé" License (BSD-3-Clause).

Voir aussi