Erweiterung:CodeMirror

MediaWiki-Erweiterungen

CodeMirror Freigabestatus: stabil
Einbindung	Benutzer-Schnittstelle
Beschreibung	Provides syntax highlighting in wikitext editor
Autor(en)	Pavel Astakhov (pastakhovDiskussion)
Letzte Version	4.0.0
Kompatibilitätspolitik	Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki	1.32+
PHP	5.3+
Datenbankänderungen	Nein
Lizenz	GNU General Public License 2.0 oder neuer
Herunterladen	Erweiterung herunterladen Git [?]: Git master herunterladen Repository durchsuchen (GitHub) Ergänzungen und Änderungen Repository-Mitwirkende (GitHub) Code-Review
Parameter $wgCodeMirrorEnableBracketMatching $wgCodeMirrorAccessibilityColors $wgCodeMirrorLineNumberingNamespaces
Verwendete Hooks BeforePageDisplay GetPreferences ResourceLoaderGetConfigVars
Übersetze die CodeMirror-Erweiterung, wenn sie auf translatewiki.net verfügbar ist
Prüfe die Benutzungs- und Versionsmatrix.
Vagrant-Rolle	codemirror
Probleme	Offene Aufgaben · Einen Fehler melden

The CodeMirror extension provides syntax highlighting in MediaWiki's wikitext editor. It adds a button with the icon to the editing toolbar that allows for switching syntax highlighting on and off. It supports the 2010 WikiEditor toolbar as well as the VisualEditor toolbar.

By default it is switched off. When switching on, it will replace the standard textarea with the editor provided by CodeMirror library. When switching off, it will be the opposite effect.

The colors used in this extension have been optimised to provide higher contrast, accessibility and better readability.

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

Features

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).

• 

  Bracket matching

Line numbering

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).

• 

  Line numbering in 2010 wikitext editor

• 

  Line numbering in 2017 wikitext editor

Browser Unterstützung

All browsers supported by MediaWiki are supported.

Installation

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

Manuelle Installation

• Install either the WikiEditor extension or the VisualEditor extension , as instructed on their pages; at least one of these is required for this extension to work.
• Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens CodeMirror im Ordner extensions/ ablegen.
• Folgenden Code am Ende der LocalSettings.php hinzufügen:

  wfLoadExtension( 'CodeMirror' );
  

• Configure as required.
•  Erledigt – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Konfiguration

For color and style customization, see Meta help page. You can use your own styles for wikitext highlighting. Used styles available here. You should place your own styles to common.css.

Add the following code at the bottom of your LocalSettings.php .

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

To try out the new features mentioned above in your local installation, add the following lines as well. Please note though, that these features are meant to become default features. The settings might not have an effect any more then.

# 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;

Extension integration

If your MediaWiki extension adds a new tag and you want to make sure CodeMirror properly highlights the content within it, you can add CodeMirror support to your extension. Here are two examples: Cite extension and 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.

zu erledigen

• highlighting definition lists ( ;foo :bar ) (phab:T170042)
• auto-completion (phab:T95100)
• code folding T166098
• highlighting inside gallery tag (<gallery> foo | bar </gallery>)

Siehe auch

• Overview of missing features and bugs: MediaWiki-extensions-CodeMirror
• User:Remember the dot/Syntax highlighter

• Extension:VisualEditor
• Erweiterung:WikiEditor
• Extension:CodeEditor
• Community Tech/Wikitext editor syntax highlighting (includes information on customizing the colors)
• c:Category:MediaWiki extension CodeMirror