Jump to content

Rozšíření:CodeEditor

From mediawiki.org
This page is a translated version of the page Extension:CodeEditor and the translation is 7% complete.
This extension comes with MediaWiki 1.31 and above. To znamená, že jej nemusíte stahovat samostatně. Musíte se nicméně stále řídit pokyny k jeho použití.
Not to be confused with CodeMirror .
Příručka k rozšířením MediaWiki
CodeEditor
Stav rozšíření: stabilní
Popis Poskytuje editor kódu se zvýrazněním syntaxe pro stránky JS, CSS a Lua webu a uživatele, integruje se s panelem nástrojů pro pokročilé úpravy
Autoři
  • Brooke Vibber
  • Derk-Jan Hartman
  • authors of Ace (ace.c9.io)
Zásady kompatibility Vydání snímků současně s MediaWiki. Hlavní vývojová větev není zpětně kompatibilní.
MediaWiki >= 1.43
Změny v databázi Ne
Licence GPL-2.0-or-later AND BSD-3-Clause
Stáhnout
  • $wgCodeEditorEnableCore
Čtvrtletní stahování 120 (Ranked 49th)
Veřejné wiki používající rozšíření 8,385 (Ranked 17th)
Přeložte rozšíření CodeEditor, používá-li lokalizaci z translatewiki.net
Problémy Otevřené úkoly · Nahlásit chybu

The CodeEditor extension extends the WikiEditor advanced editing toolbar with an embedded Ace editor widget, providing some handy features for user/site JavaScript pages, CSS pages, JSON pages, and when extension Scribunto is also installed, for Lua pages, i.e. pages in the Module namespace. The code editor does not show on regular wiki pages, i.e. wiki pages with the "wikitext" content model. (See Extension:CodeMirror for syntax highlighting of wikitext when using the source editor.)

It provides the following features:

  • syntax highlighting for JavaScript, CSS and Lua
  • auto-indent
  • tab key produces tab indents (since 1.22), soft indents before.
  • indent/unindent selection with Tab ↹/⇧ Shift+Tab ↹ keys
  • syntax validity check for JavaScript
  • Pair-matching for parenthesis, braces and square brackets

Installation

The WikiEditor extension needs to be installed for this extension to work. Installing the Scribunto extension is optional.
  • Stáhněte soubor/y a vložte je do adresáře pojmenovaného CodeEditor ve vaší složce extensions/.
    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/CodeEditor
  • Na konec vašeho souboru LocalSettings.php přidejte následující kód:
    wfLoadExtension( 'CodeEditor' );
    $wgDefaultUserOptions['usebetatoolbar'] = 1; // user option provided by WikiEditor extension
    
  • Configure as required.
  • Yes 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 codeeditor --provision

Configuration

$wgCodeEditorEnableCore
To disable the editor on JavaScript and CSS pages in the MediaWiki, User and other core namespaces, set $wgCodeEditorEnableCore = false; (default is "true")
$wgScribuntoUseCodeEditor
To disable this extension for Scribunto, i.e. in the module namespace set $wgScribuntoUseCodeEditor = false; (default is "true")
This configuration parameter is provided by the Scribunto extension and must therefore be added after invoking the CodeEditor as well as the Scribunto extension which also needs to be installed for this to work.

JavaScript

It is possible to change the configuration of the ACE editor, by hooking into the MediaWiki JS hook (i.e. mw.hook( 'codeEditor.configure' ).add( ... )). The argument passed to your hook will be an ACE EditSession object.

If you need to interact with the contents of a CodeEditor instance, use module-jquery.textSelection.$.fn.textSelection().

License

See also