Rozszerzenie:CodeEditor

To rozszerzenie jest dodawane do pakietu MediaWiki od wersji 1.31 i wyższych. W związku z tym nie musi być ponownie pobierane. Niemniej jednak wciąż musisz wykonać inne podane instrukcje.

Podręcznik rozszerzeń MediaWiki

CodeEditor Status wydania: stabilne
Opis	Dostarcza podświetlający składnię zintegrowany z zaawansowanym edytorem wikitekstu edytor kodu dla stron JS, CSS oraz modułów Lua.
Autor(zy)	Brion Vibber Derk-Jan Hartman authors of Ace (ace.c9.io)
Polityka zgodności	gałęzie wydań
MediaWiki	1.32+
Zmiany w bazie danych	Nie
Licencja	GPL-2.0-or-later AND BSD-3-Clause
Pobieranie	Download extension Git [?]: Pobierz Git master przeglądaj repozytorium (GitHub) historia wprowadzeń repository contributors (GitHub) ocena kodu
Parametry $wgCodeEditorEnableCore
Użyte haki EditPage::showEditForm:initial EditPage::showReadOnlyForm:initial GetPreferences
Dostarczane haki CodeEditorGetPageLanguage
Przetłumacz rozszerzenie CodeEditor jeżeli jest dostępne na translatewiki.net
Sprawdź wykorzystywanie i matrycę wersji.
Problemy	Otwarte zadania · Zgłoś błąd

Rozszerzenie CodeEditor poszerza zakres możliwości WikiEditora poprzez osadzenie widżetu edytora Ace, dostarczającego pewne funkcje przydatne na stronach JS oraz CSS, a gdy zainstalowane jest także Scribunto , to również w przestrzeni nazw Moduł:

It provides the following features:

• podświetlanie składni JavaScriptu, CSS oraz Lua
• automatyczne dodawanie wcięć
• klawisz tab tworzy wcięcia przy użyciu tabulacji (od 1.22), wcześniej miękkie wcięcia
• dodanie/usunięcie wcięcia z sekcji przy użyciu klawiszy tab/shift-tab

sprawdzanie poprawności składni dla JavaScriptu

• parowanie nawiasów, nawiasów klamrowych oraz kwadratowych

Instalacja

Aby uruchomić to rozszerzenie, konieczna jest także instalacja rozszerzenia WikiEditor. Instalacja rozszerzenia Scribunto nie jest wymagana.

• Jeżeli korzystasz z Vagrant , zainstaluj poprzez vagrant roles enable codeeditor --provision

Ręczna instalacja

• Pobierz i umieść plik(i) w katalogu o nazwie CodeEditor w swoim katalogu extensions/.
• Dodaj poniższy kod na dole swojego pliku LocalSettings.php:

  wfLoadExtension( 'CodeEditor' );
  $wgDefaultUserOptions['usebetatoolbar'] = 1; // user option provided by WikiEditor extension
  

• Skonfiguruj zgodnie z wymaganiami.
•  Zrobione – Przejdź do Special:Version na swojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Konfiguracja

$wgCodeEditorEnableCore

Aby wyłączyć edytor na stronach JavaScript i CSS w przestrzeniach nazw takich jak MediaWiki, użytkownik i inne, ustaw $wgCodeEditorEnableCore = false; (domyślna wartość to „true”)

$wgScribuntoUseCodeEditor

Aby wyłączyć rozszerzenie dla Scribunto, tj. na stronach w przestrzeni Moduł, ustaw $wgScribuntoUseCodeEditor = false; (domyślna wartość to „true”)

Ta zmienna konfiguracyjna pochodzi z rozszerzenia Scribunto, co oznacza, że musi zostać dodana po przywołaniu zarówno rozszerzenia CodeEditor jak i Scribunto, które także jest wymagane do jej obsługi.

JavaScript

Możliwa jest zmiana konfiguracji edytora ACE poprzez użycie haka MediaWiki (i.e. mw.hook( 'codeEditor.configure' ).add( ... )). Argumentem podanym do twojego haka będzie sesja edytora ACE.

Integracja z WikiEditorem

I've been integrating CodeEditor into the pluggable portions of Extension:WikiEditor as prep for Future editor work, since we'll want to be able to extend it to edit things that aren't plain wikitext, which'll need some changes to the toolbar setup and whatnot. JS/CSS here still return plain text in the end, making it an easier intermediate project. --brion 00:26, 14 June 2011 (UTC)

Good:

• special char insertions work, including quote pairs to surround text

• basic formatting insertions work, including link dialogs

• search/replace dialog works

• • ace's built-in search/replace UI also triggers from keyboard commands, still need to disable them! (onCommandKey)

Bad:

• multi-line formatting doesn't apply correctly (but really should that apply here? :)

Todo:

• remove toolbar buttons that don't apply (formatting, syntax help?)

• add toolbar buttons that are more directly useful

• • indent/outdent

• • insertion helpers for common keywords or code bits

• • help reference to MW JS API reference, JS & CSS specs/documentation

Problemy

• przystępność: klawisze tab/tab-shift są nadpisane. Czy istnieje spójna alternatywa dla użytkowników korzystających tylko z klawiatury?

• accessibility: accesskey on the original textarea needs to be moved over or otherwise handled

• scrollbar initializes too wide; need to trigger resize check after that's filled (maybe fixed?)

• cursor/scroll position not maintained over previews/show changes

Licencja

Choć rozszerzenie dostępne na zasadach licencji GNU General Public License v2.0 or later (GPL-2.0+), to wykorzystuje ono Ace oprogramowanie edytora Ace, które dostępne jest na licencji BSD 3-clause "New" or "Revised" License (BSD-3-Clause).