Extension:CodeMirror

This page is a translated version of the page Extension:CodeMirror and the translation is 70% complete.
Manuel des extensions MediaWiki
OOjs UI icon advanced-invert.svg
CodeMirror
État de la version : stable
Pride and codemirror.png
Implémentation Interface utilisateur
Description Fournit la coloration syntaxique dans l'éditeur de texte wiki.
Auteur(s) Pavel Astakhov (pastakhovdiscussion)
Dernière version 4.0.0
Politique de compatibilité Versions ponctuelles alignées avec MediaWiki. Le master n'est pas compatible arrière.
MediaWiki 1.32+
PHP 5.3+
Modifie la base
de données
Non
Licence Licence publique générale GNU v2.0 ou supérieur
Téléchargement
  • $wgCodeMirrorEnableBracketMatching
  • $wgCodeMirrorAccessibilityColors
  • $wgCodeMirrorLineNumberingNamespaces
Traduire l’extension CodeMirror sur translatewiki.net si elle y est disponible

Vérifier la matrice des utilisations et des versions.

Rôle Vagrant codemirror
Problèmes Tâches ouvertes · Signaler un bogue

L'extension CodeMirror fournit la coloration syntaxique dans l'éditeur wikitexte de MediaWiki. Elle ajoute un bouton avec une l'icône Codemirror-icon.png dans la barre d'outil d'édition qui permet d'activer ou non la coloration. La barre d'outil du WikiEditor 2010 ainsi que la barre d'outil de l'éditeur visuel sont gérées.

Par défaut cette fonctionnalité est désactivée. Lors de la mise en fonction, il remplacera la zone de texte standard par l'éditeur fourni par CodeMirror library. Lors de la désactivation, ce sera l'effet inverse.

Les couleurs utilisées dans cette extension ont été optimisées pour offrir un contraste plus élevé, une meilleure accessibilité et lisibilité.

Please note though, that the updated color scheme is currently only enabled by default for some wikis (see roadmap and configuration).

Caractéristiques

Bracket matching

This feature allows highlighting of the closest matching pair of surrounding brackets while navigating through wikitext code using the cursor. Bracket matching will be active in both editors when syntax highlighting is turned on, in any namespace using these editors.

Please note that bracket matching is only enabled by default in some wikis (see roadmap and configuration).

Numérotation des lignes

In the wikitext edit mode line numbers are automatically displayed in both editors.

Please note that this feature is only enabled for the template namespace on most wikis (see roadmap and configuration).

Navigateurs supportés

Tous les navigateurs supportés par MediaWiki sont supportés.

Installation

  • Si vous utilisez Vagrant , installez avec vagrant roles enable codemirror --provision
Installation manuelle
  • Installez l'extension WikiEditor ou l'extension VisualEditor , comme indiqué sur leurs pages ; au moins un de ces éléments est nécessaire pour que cette extension fonctionne.
  • Téléchargez et placez le(s) fichiers (s) dans un répertoire appelé CodeMirror dans votre dossier extensions/.
  • Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
    wfLoadExtension( 'CodeMirror' );
    
  • Configuration requise
  •   Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

Paramètres de configuration

Pour la personnalisation des couleurs et des styles, consultez Meta page d'aide. Vous pouvez utiliser vos propre styles pour la coloration du wikitexte. Styles d'occasion disponibles ici. Vous pouvez placer vos propres styles dans common.css.

Ajouter le code ci-dessus en bas de votre LocalSettings.php .

# Enables use of CodeMirror by default but still allow users to disable it
$wgDefaultUserOptions['usecodemirror'] = 1;

Pour essayer les nouvelles fonctionnalités mentionnées ci-dessus dans votre installation locale, ajoutez également les lignes suivantes. Veuillez noter cependant que ces fonctionnalités sont destinées à devenir des fonctionnalités par défaut. Les paramètres pourraient alors ne plus avoir d'effet.

# Enable bracket matching in CodeMirror
$wgCodeMirrorEnableBracketMatching = true;

# Enable accessible colors in CodeMirror
$wgCodeMirrorAccessibilityColors = true;

# Enable line numbering in CodeMirror
# defaults to the template namespace `[ NS_TEMPLATE ]`
# `null` enables it for all namespace
# [] for disabling everywhere
$wgCodeMirrorLineNumberingNamespaces = null;

Intégration des extensions

Si votre extension MediaWiki ajoute une nouvelle balise et que vous voulez vous assurer que CodeMirror met correctement en évidence le contenu qu'elle contient, vous pouvez ajouter la prise en charge de CodeMirror à votre extension. Voici deux exemples : Cite extension et PhpTags extension.

JavaScript integration

The following front-end hooks are used in this extension:

Hook Parameters
Type Description
ext.CodeMirror.switch boolean Whether the CodeMirror editor is now shown
jQuery object The current "editor", which is either the normal ‎<textarea /> or the .CodeMirror element.

A faire

  • mise en surbrillance des listes de définitions ( ; foo : bar ) (phab:T170042)
  • Ajout Automatique (phab:T95100)
  • repli du code T166098
  • mise en évidence à l'intérieur de la balise de la galerie <nowiki> (<gallery> foo | bar </gallery>) </nowiki>

Voir aussi