Kiterjesztés:CodeMirror

This page is a translated version of the page Extension:CodeMirror and the translation is 29% complete.
Not to be confused with CodeEditor .
MediaWiki-kiterjesztések kézikönyve
CodeMirror
Kiadási állapot: stabil
Megvalósítás Felhasználói felület
Leírás Szintaxiskiemelést tesz lehetővé a forásszöveg-szerkesztőben
Szerző(k) Pavel Astakhov (pastakhovvitalap)
Legfrissebb verzió 5.0.0
Kompatibilitási irányelv Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.32+
PHP 5.3+
Adatbázis-változtatások Nem
Licenc GNU General Public License 2.0 or later
Letöltés
  • $wgCodeMirrorConflictingGadgets
  • $wgCodeMirrorV6
  • $wgCodeMirrorTemplateFoldingNamespaces
  • $wgCodeMirrorLineNumberingNamespaces
Quarterly downloads 338 (Ranked 16th)
Public wikis using 6,549 (Ranked 62nd)
Fordítsd le a(z) CodeMirror kiterjesztést, ha elérhető a translatewiki.net oldalon
Vagrant-szerep codemirror
Problémák Nyitott feladatok · Hibajelentés

A CodeMirror kiterjesztés szintaxiskiemelést tesz lehetővé a MediaWiki forrásszöveg-szerkesztőjében. Az eszközzel egy új ikon () jelenik meg az eszköztáron; a kiterjesztés mindkét változatot (klasszikus és 2017-es) támogatja.

Az eszköz alapértelmezetten ki van kapcsolva; engedélyezésével a szövegmezőt felváltja a CodeMirror-könyvtár szerkesztője, kikapcsolásával pedig az ablak a hagyományos módra vált vissza.

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. (more information)


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.


Böngészőtámogatás

A kiterjesztés az összes, a MediaWiki által is támogatott böngésző alatt működik.

Telepítés

  • 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.
  • Töltsd le a kiterjesztés fájljait, és mentsd el az extensions/ mappán belüli CodeMirror könyvtárba.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
  • Add hozzá az alábbi kódot a LocalSettings.php fájlod aljára:
    wfLoadExtension( 'CodeMirror' );
    
  • Állítsd be a szükséges módon.
  •   Kész – A Special:Version oldalon ellenőrizheted, hogy a kiterjesztés ténylegesen feltelepült-e.


Vagrant-telepítés:

  • Vagrant használata esetén telepítsd a vagrant roles enable codemirror --provision paranccsal

Beállítás

A színek és stílusok beállításához olvasd el ezt a lapot. A szerkesztőben saját stílusokat is használhatsz. A kiterjesztés által használt alapértelmezett stílusokat itt találod. sajátjaid pedig rögzítened kell a common.css -ben.

Adja hozzá a következő kódot a LocalSettings.php aljához.

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

Összekapcsolás más kiterjesztésekkel

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

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.

If you need to interact with the contents of a CodeMirror instance, use jQuery.plugin.textSelection.

Teendők

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


Lásd még