Tillägg:CodeMirror

This page is a translated version of the page Extension:CodeMirror and the translation is 89% complete.
Manual för MediaWikitillägg
OOjs UI icon advanced-invert.svg
CodeMirror
Utgivningsstatus: stabil
Pride and codemirror.png
Genomförande Användargränssnitt
Beskrivning Erbjuder syntaxmarkering vid wikitextredigering
Författare Pavel Astakhov (pastakhovdiskussion)
Senaste versionen 4.0.0
Kompatibilitetsregler Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.32+
PHP 5.3+
Förändringar i databasen Nej
Licenser GNU General Public License 2.0 eller senare
Ladda ner
  • $wgCodeMirrorEnableBracketMatching
  • $wgCodeMirrorAccessibilityColors
  • $wgCodeMirrorLineNumberingNamespaces
Översätt tillägget CodeMirror om det finns tillgängligt på translatewiki.net

Kontrollera användning och versionsmatris.

Vagrant-roll codemirror
Ärenden Öppna ärenden · Rapportera en bugg

Tillägget CodeMirror erbjuder syntaxmarkering i MediaWikis wikitextredigerare. Den lägger till en knapp med ikonen Codemirror-icon.png bland redigeringsverktygen som låter en sätta på och stänga av syntaxmarkering. Det stöds av 2010 års wikitextredigerare samt VisualEditor-verktyget.

Den är som standard avstängd. När det är påslaget kommer den byta ut den vanliga textrutan med redigeraren som erbjuds av CodeMirror-biblioteket. När den är avstängd kommer den ha motsatt effekt.

Färgerna som används i det här tillägget har optimerats för att erbjuda högre kontrast, tillgänglighet och bättre läsbarhet.

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

Funktioner

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

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

Webbläsarstöd

Alla webbläsare med stöd för MediaWiki stöds.

Installation

  • Om du använder Vagrant ska du installera med vagrant roles enable codemirror --provision
Manuell installering

Konfigurering

För färg och stilanpassning, läs hjälpsidan på Meta. Du kan använda dina egna stilar för syntaxmarkering. Använda stilar tillgängliga här. Du borde lägga dina egna stilar i common.css.

Lägg till följande kod längst ner i din LocalSettings.php .

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

För att testa nya funktioner som nämnts ovan i din lokala installation, lägg också till följande rad. Notera dock att dessa funktioner är tänkta att bli standardfunktioner. Inställningarna kanske inte längre har någon inverkan då.

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

Tilläggsintegrering

Om du har ett MediaWiki-tillägg som lägger till nya taggar och du vill säkerställa att CodeMirror markerar innehållet ordentligt inuti det, kan du lägga till CodeMirror-stöd till tillägget. Här följer två exempel: tillägget Cite och tillägget PhpTags.

JavaScript-integrering

Följande front-end-hakar används i det här tillägget:

Hake Parametrar
Typ Beskrivning
ext.CodeMirror.switch boolesk Om CodeMirrot-redigeraren visas eller inte
jQuery-objekt Den nuvarande "redigeraren", som antingen är det vanliga ‎<textarea /> eller .CodeMirror-elementet.

Att göra

  • markera definitionslistor ( ;foo :bar ) (phab:T170042)
  • automatisk fulländning (phab:T95100)
  • kodvikning T166098
  • markering inuti gallery-taggar (<gallery> foo | bar </gallery>)

Se även