Tillägg:CodeMirror

From mediawiki.org
This page is a translated version of the page Extension:CodeMirror and the translation is 74% complete.
Ej att förväxlas med CodeEditor .
Manual för MediaWikitillägg
CodeMirror
Utgivningsstatus: stabil
Genomförande Användargränssnitt
Beskrivning Erbjuder syntaxmarkering vid wikitextredigering
Författare Pavel Astakhov (pastakhovdiskussion)
Senaste versionen 5.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
  • $wgCodeMirrorConflictingGadgets
  • $wgCodeMirrorV6
  • $wgCodeMirrorLineNumberingNamespaces
Quarterly downloads 356 (Ranked 15th)
Public wikis using 6,549 (Ranked 62nd)
Översätt tillägget CodeMirror om det finns tillgängligt på translatewiki.net
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 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. Färgerna ger bättre tillgång för folk med synskador samt för användare som arbetar i starkt dagsljus. (mer information)


Funktioner

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.

Line numbering

In the wikitext edit mode line numbers are automatically displayed in both editors.

This feature is enabled only for the template namespace on most wikis, and on all namespaces on some wikis (see the roadmap and the configuration).

Colorblind mode

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
Templates #9C3A00
HTML tags, references, mathematical expressions #56B4E9
Variables #009E73

In addition, background highlights and colors are removed from all text and objects. Bolding and underlining behavior remains unaffected.


Webbläsarstöd

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

Installation

  • Installera antingen tillägget Tillägg:WikiEditor eller tillägget VisualEditor , som det står beskrivet på deras sidor; åtminstone en av dessa krävs för att det här tillägget ska fungera.
  • Ladda ner och placera filen/filerna i en katalog som heter CodeMirror i din extensions/-mapp.
    Utvecklare och personer som bidrar med kod borde istället installera tillägget från Git, med:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
  • Lägg till följande kod längst ner i din LocalSettings.php -fil:
    wfLoadExtension( 'CodeMirror' );
    
  • Konfigurera efter behov.
  • Yes Klart – Ta dig till Special:Version på din wiki för att bekräfta att tillägget har installerats ordentligt.


Vagrant-installering:

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

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 .

# Aktiverar användning av CodeMirror som standard men tillåter fortfarande att användare inaktiverar det
$wgDefaultUserOptions['usecodemirror'] = true;

För att aktivera ytterligare funktioner:

$wgCodeMirrorLineNumberingNamespaces
Begränsar radnumrering till vissa namnrymder. Återgår till null, vilket aktiverar det för alla namnrymder. Sätt till [] för att inaktivera överallt.
$wgCodeMirrorV6
Temporary feature flag to control the migration to CodeMirror 6 (phab:T259059).
$wgCodeMirrorConflictingGadgets
En array av finessnamn som, om aktiverad, kommer förhindra CodeMirror från att laddas in. Standardvärde wikEd.

Tilläggsintegrering

This functionality is subject to change following the CodeMirror 6 upgrade.

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.

Använd jQuery.plugin.textSelection om du behöver interagera med innehållet i en CodeMirror-instans.

Att göra


Se även