Extension:CodeMirror
- Not to be confused with CodeEditor .
CodeMirror Stav rozšíření: stabilní |
|
---|---|
Implementace | Uživatelské rozhraní |
Popis | Poskytuje zvýraznění syntaxe v editoru wikitext |
Autoři | Pavel Astakhov (pastakhovdiskuse) |
Nejnovější verze | 6.0.0 |
Zásady kompatibility | Vydání snímků současně s MediaWiki. Hlavní vývojová větev není zpětně kompatibilní. |
MediaWiki | 1.32+ |
PHP | 5.3+ |
Změny v databázi | Ne |
Licence | GNU General Public License 2.0 nebo novější |
Stáhnout | |
|
|
Čtvrtletní stahování | 279 (Ranked 17th) |
Veřejné wiki používající rozšíření | 6,549 (Ranked 62nd) |
Přeložte rozšíření CodeMirror, používá-li lokalizaci z translatewiki.net | |
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 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)
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.
-
Bracket matching
Line numbering
In the wikitext edit mode line numbers are automatically displayed in both editors.
-
Line numbering in 2010 wikitext editor
-
Line numbering in 2017 wikitext editor
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.
Podpora prohlížeče
Podporovány jsou všechny prohlížeče podporované MediaWiki.
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žceextensions/
.
Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror - Na konec vašeho souboru LocalSettings.php přidejte následující kód:
wfLoadExtension( 'CodeMirror' );
- Configure as required.
- Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
Instalace Vagrant:
- Pokud používáte Vagrant , instalujte s těmito parametry
vagrant roles enable codemirror --provision
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'] = 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.
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.
|
If you need to interact with the contents of a CodeMirror instance, use jQuery.plugin.textSelection.
Úkol
- Unfortunately, right-to-left content is not supported. (úkol T170001)
- zvýraznění seznamů definic ( ;foo :bar ) (úkol T170042)
- automatické dokončení (úkol T95100)
- skládání kódu (úkol T166098)
- zvýraznění uvnitř značky galerie (<gallery> foo | bar </gallery>)
Související stránky
- Přehled chybějících funkcí a chyb: MediaWiki-extensions-CodeMirror
- Uživatel:Pamatujte na zvýrazňovač teček nebo syntaxe
- Extension:VisualEditor
- Rozšíření:WikiEditor
- Rozšíření:CodeEditor
- Community Tech/Wikitext editor syntax highlighting - includes information on customizing the colors
- c:Category:MediaWiki extension CodeMirror
Toto rozšíření se používá na jednom nebo více projektech Wikimedia. Pravděpodobně to znamená, že rozšíření je stabilní a funguje dostatečně dobře, aby jej mohly používat weby s tak vysokou návštěvností. Vyhledejte tento název rozšíření v konfiguračních souborech CommonSettings.php a InitialiseSettings.php Wikimedie, abyste viděli, kde je nainstalováno. Úplný seznam rozšíření nainstalovaných na konkrétní wiki lze vidět na stránce wiki Special:Version. |
Toto rozšíření je zahrnuto v následujících wiki farmách/hostitelích a/nebo balíčcích: Toto není autoritativní seznam. Některé wiki farmy/hostitelé a/nebo balíčky mohou toto rozšíření obsahovat, i když zde nejsou uvedeny. Pro potvrzení se vždy obraťte na své wiki farmy/hostitele nebo balíček. |