Extension:CodeMirror

From mediawiki.org
This page is a translated version of the page Extension:CodeMirror and the translation is 28% complete.
Základní informace k tomuto rozšíření MediaWiki
OOjs UI icon advanced-invert.svg
CodeMirror
Stav rozšíření: stabilní
Pride and codemirror.png
Zavádění Uživatelské rozhraní
Popis Poskytuje zvýraznění syntaxe v editoru wikitext
Napsal(i) Pavel Astakhov (pastakhovdiskuse)
Nejnovější verze 4.0.0
Zásady kompatibility Vydání snímků následuje MediaWiki. Hlavní vývojová větev není zpětně kompatibilní.
MediaWiki 1.32+
PHP 5.3+
Změny v databázi nedělá
Licence GNU General Public License 2.0 nebo pozdější
Zdrojový kód
  • $wgCodeMirrorColorblindColors
  • $wgCodeMirrorEnableBracketMatching
  • $wgCodeMirrorAccessibilityColors
  • $wgCodeMirrorLineNumberingNamespaces
Přeložte rozšíření CodeMirror, používá-li lokalizaci z translatewiki.net

Podívejte se kdo a v jaké verzi toto rozšíření používá.

Vagrant role codemirror
Problémy Otevřené úkoly · Nahlásit chybu

Rozšíření CodeMirror poskytuje zvýraznění syntaxe v wikitextovém editoru MediaWiki. It adds a button with the icon Codemirror-icon.png to the editing toolbar that allows for switching syntax highlighting on and off. It supports the 2010 WikiEditor toolbar as well as the VisualEditor toolbar.

Ve výchozím nastavení je vypnuto. When switched on, it will replace the standard textarea with the editor provided by CodeMirror library. When switched off, it will switch back to the standard textarea.

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


Podpora prohlížeče

Podporovány jsou všechny prohlížeče podporované MediaWiki.

Instalace

  • Pokud používáte Vagrant , instalujte s těmito parametry vagrant roles enable codemirror --provision
Manuální instalace
  • 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.
  • Stáhněte soubor/y a vložte je do adresáře pojmenovaného CodeMirror ve vaší složce extensions/.
  • Na konec vašeho souboru LocalSettings.php přidejte řádek s následujícím kódem:
    wfLoadExtension( 'CodeMirror' );
    
  • Configure as required.
  • Yes Hotovo – Přejděte na stránku Special:Version vaší wiki, a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.

Konfigurace

Informace o přizpůsobení barev a stylu naleznete na stránce nápovědy Meta. Pro zvýraznění wikitextu můžete použít své vlastní styly. Used styles available here. You should place your own styles to common.css .

Přidejte následující kód na konec svého LocalSettings.php .

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

Integrace rozšíření

Pokud vaše rozšíření MediaWiki přidá novou značku a chcete se ujistit, že CodeMirror správně zvýrazňuje jeho obsah, můžete do svého rozšíření přidat podporu CodeMirror. Zde jsou dva příklady: Cite extension a 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.

Úkol

  • zvýraznění seznamů definic ( ;foo :bar ) (task T170042)
  • automatické dokončení (phab:T95100)
  • skládání kódu (task T166098)
  • zvýraznění uvnitř značky galerie (<gallery> foo | bar </gallery>)

Související stránky