Расширение:CodeMirror
- Not to be confused with CodeEditor .
CodeMirror Статус релиза: стабильно |
|
---|---|
Реализация | Пользовательский интерфейс |
Описание | Обеспечивает подсветку синтаксиса в редакторе викитекста |
Автор(ы) | Pavel Astakhov (pastakhovобсуждение) |
Последняя версия | 6.0.0 |
Политика совместимости | Снэпшоты выходят вместе с MediaWiki. Мастер не имеет обратной совместимости. |
MediaWiki | >= 1.43 |
Изменения в БД | Нет |
Лицензия | GNU General Public License 2.0 или позднее |
Скачать | |
|
|
Ежеквартальные загрузки | 284 (Ranked 16th) |
Использование общедоступными вики | 6,549 (Ranked 62nd) |
Переведите расширение CodeMirror, если оно доступно на translatewiki.net | |
Роль Vagrant | codemirror |
Проблемы | Открытые задачи · Сообщить об ошибке |
Расширение CodeMirror обеспечивает подсветку синтаксиса в редакторе вики-текста MediaWiki. Оно добавляет кнопку со значком на панель инструментов редактирования, которая позволяет включать и выключать подсветку синтаксиса. Оно поддерживает панель инструментов WikiEditor 2010, а также панель инструментов VisualEditor.
По умолчанию оно выключено. При включении оно заменит стандартную текстовую область редактором, предоставляемым библиотекой CodeMirror. При выключении оно снова переключится на стандартное текстовое поле.
Цвета, используемые в этом расширении, были оптимизированы для повышения контрастности, доступности и лучшей читаемости и теперь соответствуют Руководству по обеспечению доступности веб-контента (WCAG 1.4.3 AA). Цвета обеспечивают лучший доступ для людей с ограниченным зрением, а также для пользователей, работающих в условиях яркого дневного света. (больше информации)
Возможности
Соответствие скобок
Эта функция выделяет самую внутреннюю пару скобок, когда курсор находится между любой парой скобок, а когда курсор находится непосредственно рядом с скобкой, эта функция выделяет соответствующую соответствующую скобку. Сопоставление скобок активно в обоих редакторах, когда подсветка синтаксиса включена в любом пространстве имен, использующем эти редакторы.
-
Соответствие скобок
Нумерация строк
В режиме редактирования викитекста номера строк автоматически отображаются в обоих редакторах.
-
Нумерация строк в редакторе викитекста 2010
-
Нумерация строк в редакторе викитекста 2017
Режим дальтонизма
Для пользователей, которым трудно различать цвета, CodeMirror предлагает режим, удобный для дальтоников. Эту функцию можно активировать в вики с включенным CodeMirror, перейдя на страницу Special:Preferences.
При активной схеме для дальтоников цвета следующих элементов страницы изменяются:
Заголовки, символы, подписи, названия разделов, волшебные слова | #E4A400 |
Шаблоны | #9C3A00 |
HTML-теги, ссылки, математические выражения | #56B4E9 |
Переменные | #009E73 |
Кроме того, удаляются фоновые выделения и цвета из всего текста и объектов. Поведение выделения жирным шрифтом и подчеркивания остается неизменным.
Поддержка браузеров
Поддерживаются все браузеры, которые поддерживает MediaWiki.
Установка
- Установите либо расширение WikiEditor , либо расширение VisualEditor , как указано на их страницах; для работы этого расширения требуется хотя бы одно из них.
- Скачайте и распакуйте файл(ы) в папку с названием
CodeMirror
в вашей папкеextensions/
.
Вместо этого разработчикам и соавторам кода следует установить расширение из Git, используя:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror - Добавьте следующий код в конце вашего файла LocalSettings.php :
wfLoadExtension( 'CodeMirror' );
- Настройте, как вам требуется.
- Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.
Установка Vagrant:
- Если вы используете Vagrant , установите с помощью
vagrant roles enable codemirror --provision
Конфигурация
Для настройки цвета и стиля см. страницу справки Meta. Вы можете использовать свои собственные стили для выделения викитекста. Используемые стили доступны здесь. Вам следует разместить свои собственные стили в common.css .
Добавьте следующий код внизу вашего LocalSettings.php .
# Включение использования CodeMirror по умолчанию, но позволяет пользователям отключать его.
$wgDefaultUserOptions['usecodemirror'] = true;
Чтобы включить дополнительные функции:
- $wgCodeMirrorLineNumberingNamespaces
- Ограничьте нумерацию строк определенными пространствами имен. По умолчанию используется значение null, что позволяет использовать его для всех пространств имен. Установите значение [], чтобы отключить везде.
- $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.
Интеграция расширения
Если ваше расширение MediaWiki добавляет новый тег и вы хотите, чтобы CodeMirror правильно выделял содержимое внутри него, вы можете добавить поддержку CodeMirror в свое расширение. Вот два примера: Расширение Cite и Расширение PhpTags.
Интеграция JavaScript
В этом расширении используются следующие [$url front-end хуки]:
Хук | Параметры | |
---|---|---|
Тип | Описание | |
ext.CodeMirror.switch
|
логическое значение | Отображается ли сейчас редактор CodeMirror |
объект jQuery | Текущий "редактор", который представляет собой обычный <textarea /> или элемент .CodeMirror .
|
If you need to interact with the contents of a CodeMirror instance, use jQuery.plugin.textSelection.
Что сделать
- К сожалению, содержимое с письмом справа налево не поддерживается. (задача T170001)
- автозаполнение (задача T95100)
- код складывания (задача T166098)
- выделение внутри тега галереи (<gallery> foo | bar </gallery>)
См. также
- Обзор отсутствующих функций и ошибок: MediaWiki-extensions-CodeMirror
- User:Помните о точке/Подсветке синтаксиса
- Extension:VisualEditor
- Расширение:WikiEditor
- Расширение:CodeEditor
- Сообщество технологий/Подсветка синтаксиса редактора викитекста - включает информацию о настройке цветов
- c:Category:MediaWiki extension CodeMirror
Это расширение используется в одном или нескольких проектах Викимедиа. Вероятно, это означает, что расширение стабильно и работает достаточно хорошо, чтобы использоваться такими сайтами с высоким трафиком. Найдите название этого расширения в файлах конфигурации Викимедиа CommonSettings.php и InitialiseSettings.php, чтобы узнать, где оно установлено. Полный список расширений, установленных на конкретной вики, можно увидеть на странице Special:Version wiki. |
Это расширение включено в следующие вики-фермы/хостинги и/или пакеты: Это не исчерпывающий список. Некоторые вики-фермы/хостинги и/или пакеты могут содержать это расширение, даже если они не перечислены здесь. Всегда сверяйтесь со своими вики-фермами/хостингами или комплектами/бандлами для подтверждения. |