Расширение:CodeEditor

From mediawiki.org
This page is a translated version of the page Extension:CodeEditor and the translation is 76% complete.
Outdated translations are marked like this.
Это расширение поставляется с MediaWiki 1.31 и выше. Таким образом, вам не нужно загружать его снова. Тем не менее, вы всё равно должны следовать другим инструкциям.
Not to be confused with CodeMirror .
Справка по расширениям MediaWiki
CodeEditor
Статус релиза: стабильно
Описание Предоставляет редактор кода с подсветкой синтаксиса для сайта и пользовательских страниц JS, CSS и Lua, интегрированный с расширенной панелью инструментов редактирования
Автор(ы)
  • Brooke Vibber
  • Derk-Jan Hartman
  • authors of Ace (ace.c9.io)
Политика совместимости Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki >= 1.42.0
Изменения в БД Нет
Лицензия GPL-2.0-or-later AND BSD-3-Clause
Скачать
  • $wgCodeEditorEnableCore
Ежеквартальные загрузки 181 (Ranked 40th)
Использование общедоступными вики 8,385 (Ranked 17th)
Переведите расширение CodeEditor, если оно доступно на translatewiki.net
Проблемы Открытые задачи · Сообщить об ошибке

Расширение CodeEditor расширяет панель инструментов расширенного редактирования WikiEditor встроенным виджетом редактора Ace, предоставляя некоторые удобные функции для страниц JavaScript пользователя/сайта, страниц CSS, страниц JSON, а также, если установлено расширение Scribunto, для страниц Lua, т.е. страниц в пространстве имен Модуль. Редактор кода не отображается на обычных вики-страницах, т.е. вики-страницах с моделью содержимого "вики-текст". (См. Расширение:CodeMirror для подсветки синтаксиса вики-текста при использовании редактора исходного текста.)

Оно предоставляет следующие возможности:

  • подсветка синтаксиса для JavaScript, CSS и Lua
  • автоматический отступ
  • клавиша табуляции создает отступы табуляции (с версии 1.22), до этого были мягкие отступы.
  • выделение отступа/неотступа с помощью клавиш Tab/Shift-Tab
  • проверка достоверности синтаксиса для JavaScript
  • Попарное сопоставление для круглых и квадратных скобок

Установка

Для работы этого расширения необходимо установить расширение WikiEditor. Установка расширения Scribunto необязательна.
  • Скачайте и распакуйте файл(ы) в папку с названием CodeEditor в вашей папке extensions/.
    Вместо этого разработчикам и соавторам кода следует установить расширение из Git, используя:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeEditor
  • Добавьте следующий код в конце вашего файла LocalSettings.php :
    wfLoadExtension( 'CodeEditor' );
    $wgDefaultUserOptions['usebetatoolbar'] = 1; // user option provided by WikiEditor extension
    
  • Настройте по необходимости.
  • Yes Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.


Установка Vagrant:

  • Если вы используете Vagrant , установите с помощью vagrant roles enable codeeditor --provision

Настройка

$wgCodeEditorEnableCore
Чтобы отключить редактор на страницах JavaScript и CSS в пространствах имен MediaWiki, User и других основных, установите $wgCodeEditorEnableCore = false; (по умолчанию "true").
$wgScribuntoUseCodeEditor
Чтобы отключить это расширение для Scribunto, то есть в пространстве имен модулей, установите $wgScribuntoUseCodeEditor = false; (по умолчанию "true").
Этот параметр конфигурации предоставляется расширением Scribunto и поэтому должен быть добавлен после вызова CodeEditor, а также расширения Scribunto, которое также должно быть установлено для работы.

JavaScript

Можно изменить конфигурацию редактора ACE, подключившись к MediaWiki JS hook (например mw.hook( 'codeEditor.configure' ).add( ... )). Аргументом, передаваемым вашему хуку, будет ACE EditSession объект.

Если вам нужно взаимодействовать с содержимым экземпляра CodeEditor, используйте jQuery.plugin.textSelection.

Лицензия

Хотя это расширение лицензировано GNU General Public License v2.0 или более поздней версии (GPL-2.0+), оно использует программное обеспечение редактора Ace, которое лицензировано BSD 3-clause "New" или "Revised" License (BSD-3-Clause).

See also