Kiterjesztés:CodeMirror

From mediawiki.org
This page is a translated version of the page Extension:CodeMirror and the translation is 29% complete.
MediaWiki-kiterjesztések kézikönyve
OOjs UI icon advanced-invert.svg
CodeMirror
Kiadási állapot: stabil
Pride and codemirror.png
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ó 4.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
  • $wgCodeMirrorLineNumberingNamespaces
Fordítsd le a(z) CodeMirror kiterjesztést, ha elérhető a translatewiki.net oldalon

Használati és verziómátrix

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 (Codemirror-icon.png) 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)

Features

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 for the template namespace on most wiki, 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.

New preference colorblind syntax highlighting.png


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.
  • Add hozzá az alábbi sort a $LocalSettings fájl aljához:
    wfLoadExtension( 'CodeMirror' );
    
  • Állítsd be a szükséges módon.
  • Yes 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'] = 1;

To try out the new features mentioned above in your local installation, add the following lines as well. Note: these features are intended to become default features. Once made default, these settings may no longer have an effect.

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

Összekapcsolás más kiterjesztésekkel

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.

Teendők

  • highlighting definition lists ( ;foo :bar ) (task T170042)
  • auto-completion (phab:T95100)
  • code folding (task T166098)
  • highlighting inside gallery tag (<gallery> foo | bar </gallery>)

Lásd még