Erweiterung:CodeMirror
- Not to be confused with CodeEditor .
![]() Freigabestatus: stabil |
|
---|---|
![]() |
|
Einbindung | Benutzer-Schnittstelle |
Beschreibung | Provides syntax highlighting in wikitext editor |
Autor(en) | Pavel Astakhov (pastakhovDiskussion) |
Letzte Version | 6.0.0 |
Kompatibilitätspolitik | Snapshots werden zusammen mit MediaWiki veröffentlicht. Der Master ist nicht abwärtskompatibel. |
MediaWiki | 1.32+ |
PHP | 5.3+ |
Datenbankänderungen | Nein |
Lizenz | GNU General Public License 2.0 oder neuer |
Herunterladen | |
|
|
Quarterly downloads | 303 (Ranked 14th) |
Public wikis using | 6,549 (Ranked 62nd) |
Übersetze die CodeMirror-Erweiterung, wenn sie auf translatewiki.net verfügbar ist | |
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 switched on, it will replace the standard textarea with the editor provided by CodeMirror library. When switched off, it will switch back to the standard textarea.
The colors used in this extension have been optimised for higher contrast, accessibility and better readability and now conform to the Web Content Accessibility Guidelines (WCAG 1.4.3 AA). The colors provide better access for people with limited vision as well as for users working in bright daylight conditions. (Weitere Informationen)
Funktionen
Bracket matching
This feature highlights the innermost pair of brackets when the cursor lies between any bracket pair, and when the cursor lies directly next to a bracket, the feature highlights the corresponding matching bracket. Bracket matching is active in both editors when syntax highlighting is turned on in any namespace using these editors.
-
Bracket matching
Zeilennummerierung
In the wikitext edit mode line numbers are automatically displayed in both editors.
-
Zeilennummerierung im 2010-Wikitext-Editor
-
Zeilennummerierung im 2017-Wikitext-Editor
Farbenblind-Modus
For users who have difficulty distinguishing between colors, CodeMirror offers a colorblind-friendly mode. This feature can be activated on wikis with CodeMirror enabled by navigating to the Special:Preferences page.
With the colorblind-friendly scheme active, the colors of the following page elements change:
Headings, symbols, signatures, section names, magic words | #E4A400 |
Vorlagen | #9C3A00 |
HTML tags, references, mathematical expressions | #56B4E9 |
Variablen | #009E73 |
In addition, background highlights and colors are removed from all text and objects. Bolding and underlining behavior remains unaffected.
Browserunterstützung
All browsers supported by MediaWiki are supported.
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 Ordnerextensions/
ablegen.
Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror - Folgenden Code am Ende deiner LocalSettings.php -Datei einfügen:
wfLoadExtension( 'CodeMirror' );
- 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 codemirror --provision
zu installieren
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'] = true;
Additional configuration:
- $wgCodeMirrorLineNumberingNamespaces
- Restrict line numbering to specific namespaces. Defaults to null, which enables it for all namespaces. Set to [] to disable everywhere.
- $wgCodeMirrorV6
- Temporary feature flag to control the migration to CodeMirror 6 (phab:T259059).
- $wgCodeMirrorConflictingGadgets
- An array of gadget names that, if enabled, will prevent CodeMirror from loading. Defaults to wikEd.
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 | Parameter | |
---|---|---|
Typ | Beschreibung | |
ext.CodeMirror.switch
|
boolean | Whether the CodeMirror editor is now shown |
jQuery-Objekt | The current "editor", which is either the normal <textarea /> or the .CodeMirror element.
|
If you need to interact with the contents of a CodeMirror instance, use jQuery.plugin.textSelection.
Zu erledigen
- Unfortunately, right-to-left content is not supported. (task T170001)
- highlighting definition lists ( ;foo :bar ) (task T170042)
- auto-completion (task T95100)
- code folding (task 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
- Erweiterung:CodeEditor
- Community Tech/Wikitext editor syntax highlighting - includes information on customizing the colors
- c:Category:MediaWiki extension CodeMirror
Diese Erweiterung wird in einem oder mehreren Wikis von Wikimedia verwendet. Das bedeutet mit hoher Wahrscheinlichkeit, dass die Erweiterung stabil ist und gut genug funktioniert, um auf solch häufig besuchten Webseiten benutzt zu werden. Suche nach dem Erweiterungs-Namen in den Wikimedia CommonSettings.php und den InitialiseSettings.php-Konfigurations-Dateien, um nachzusehen, wo es installiert ist. Eine vollständige Liste der installierten Erweiterungen in einem bestimmten Wiki wird auf Special:Version im Wiki generiert und angezeigt. |
Diese Erweiterung ist in den folgenden Softwarepaketen enthalten und/oder wird von den folgenden Wiki-Farmen, bzw. Wiki-Hostern verwendet: Dies ist keine maßgebliche Liste. Softwarepakete und/oder Wiki-Farmen, bzw. Wiki-Hoster nutzen diese Erweiterung ggf., obwohl sie nicht in dieser Liste enthalten sind. Prüfe daher stets die Nutzung im verwendeten Softwarepaket und/oder bei der Wiki-Farm, bzw. dem Wiki-Hoster. |