Erweiterung:CodeEditor

Not to be confused with CodeMirror .

MediaWiki-Erweiterungen

CodeEditor Freigabestatus: stabil
Beschreibung	Provides a syntax-highlighting code editor for site & user JS, CSS and Lua pages, integrating with advanced edit toolbar
Autor(en)	Brooke Vibber Derk-Jan Hartman authors of Ace (ace.c9.io)
Kompatibilitätspolitik	Snapshots werden zusammen mit MediaWiki veröffentlicht. Der Master ist nicht abwärtskompatibel.
Datenbankänderungen	Nein
Parameter $wgCodeEditorEnableCore
Verwendete Hooks EditPage::showEditForm:initial EditPage::showReadOnlyForm:initial GetPreferences
Bereitgestellte Hooks CodeEditorGetPageLanguage
Lizenz GNU General Public License 2.0 oder neuer BSD-3-clause-"Modified"-Lizenz
Herunterladen	Erweiterung herunterladen Git [?]: Repository durchsuchen (Phabricator · GitHub) Code-Review Ergänzungen und Änderungen Download source tarball
Übersetze die CodeEditor-Erweiterung, wenn sie auf translatewiki.net verfügbar ist
Probleme	Offene Aufgaben · Einen Fehler melden

In MediaWiki 1.46, Erweiterung:CodeMirror became the default syntax aware editor of MediaWiki for all content types, replacing CodeEditor.

The CodeEditor extension extends the WikiEditor advanced editing toolbar with an embedded Ace editor widget, providing some handy features for user/site JavaScript pages, CSS pages, JSON pages, and when extension Scribunto is also installed, for Lua pages, i.e. pages in the Module namespace. The code editor does not show on regular wiki pages, i.e. wiki pages with the "wikitext" content model. (See Erweiterung:CodeMirror for syntax highlighting of wikitext when using the source editor.)

It provides the following features:

• syntax highlighting for JavaScript, CSS and Lua

• auto-indent

• tab key produces tab indents (since 1.22), soft indents before.

• indent/unindent selection with Tab ↹/⇧ Shift+Tab ↹ keys

• syntax validity check for JavaScript

• Pair-matching for parenthesis, braces and square brackets

Installation

Diese Erweiterung ist in MediaWiki 1.31 und darüber enthalten. The remaining configuration instructions must still be followed.

Die WikiEditor-Erweiterung muss installiert sein, damit diese Erweiterung funktioniert. Installing the Scribunto extension is optional.

• Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens CodeEditor im Ordner extensions/ ablegen.
  Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:

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

• Folgenden Code am Ende deiner LocalSettings.php -Datei einfügen:

  wfLoadExtension( 'CodeEditor' );
  $wgDefaultUserOptions['usebetatoolbar'] = 1; // user option provided by WikiEditor extension
  

• Konfiguriere nach Bedarf.
• Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.

Vagrant-Installation:

• Wird Vagrant benutzt, ist mit vagrant roles enable codeeditor --provision zu installieren

Konfiguration

$wgCodeEditorEnabledModes

Temporary feature flag to control conflicts with Erweiterung:CodeMirror .

$wgScribuntoUseCodeEditor

To disable this extension for Scribunto, i.e. in the module namespace set $wgScribuntoUseCodeEditor = false; (default is true)

This configuration parameter is provided by the Scribunto extension and must therefore be added after invoking the CodeEditor as well as the Scribunto extension which also needs to be installed for this to work.

JavaScript

It is possible to change the configuration of the ACE editor, by hooking into the MediaWiki JS hook (i.e. mw.hook( 'codeEditor.configure' ).add( ... )). The argument passed to your hook will be an ACE EditSession object.

If you need to interact with the contents of a CodeEditor instance, use module-jquery.textSelection.$.fn.textSelection().

Lizenz

While this extension is licensed GNU General Public License v2.0 or later (GPL-2.0+) it makes use of the Ace editor software which is licensed BSD 3-clause "New" or "Revised" License (BSD-3-Clause).

See also

• Kategorie:CodeEditorGetPageLanguage-Erweiterungen – extensions that make use of CodeEditor through the CodeEditorGetPageLanguage hook.
• en:User:Nardog/CodeEditorAssist – a user script to save user preferences across page loads