Extension:CodeMirror

From MediaWiki.org
Jump to: navigation, search

Other languages:
العربية • ‎català • ‎Deutsch • ‎English • ‎español • ‎suomi • ‎français • ‎magyar • ‎italiano • ‎日本語 • ‎Nederlands • ‎polski • ‎português • ‎português do Brasil • ‎sicilianu • ‎中文
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
CodeMirror

Release status:Extension status beta

Pride and codemirror.png
ImplementationTemplate:Extension#type User interface
DescriptionTemplate:Extension#description Provides syntax highlighting in wikitext editor
Author(s)Template:Extension#username Pavel Astakhov (pastakhovtalk)
Latest versionTemplate:Extension#version 4.0.0 (2017-05-04)
MediaWikiTemplate:Extension#mediawiki 1.25+
PHPTemplate:Extension#php 5.3+
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download
ExampleTemplate:Extension#example test.foxway.org
Hooks usedTemplate:Extension#hook
EditPage::showEditForm:initialManual:Hooks/EditPage::showEditForm:initial
EditPage::showReadOnlyForm:initialManual:Hooks/EditPage::showReadOnlyForm:initial
MakeGlobalVariablesScriptManual:Hooks/MakeGlobalVariablesScript

Translate the CodeMirror extension if it is available at translatewiki.net

Check usage and version matrix.

IssuesPhabricator

Open tasks · Report a bug

The CodeMirror extension provides syntax highlighting in MediaWiki's wikitext editor. It adds the button with icon Codemirror-icon.png to toolbar that allows switch on/off syntax highlighting. It supports both Classic edit toolbar and WikiEditor 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.

You can use your own styles for wikitext highlighting. Used styles available here. You should place your own styles to common.css. If you have found better styles please let me known.

Browser support[edit]

It is not fully tested yet!

All browsers supported by MediaWiki are supported. Modern mobile browsers tend to partly work.

Screenshots[edit]

Live demo.

Installation[edit]

  • Download and place the file(s) in a directory called CodeMirror in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'CodeMirror' );
    
  • Configure as required.
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'CodeMirror' );, you need to use:

require_once "$IP/extensions/CodeMirror/CodeMirror.php";

Configuration[edit]

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

Add the above code at the bottom of your LocalSettings.phpManual:LocalSettings.php.

For color and style customization, see meta:Community Tech/Wikitext editor syntax highlighting#Color and style customization.

Extension integration[edit]

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.

To do[edit]

See also[edit]