Extensão:CodeEditor

Manual de extensões do MediaWikiManual:Extensions

CodeEditor Estado da versão:Extension status estável
DescriçãoTemplate:Extension#description	Fornece um editor de código com realce de sintaxe para páginas JS, CSS e Lua de sites e usuários, integrado com barra de ferramentas de edição avançada
Autor(es)Template:Extension#username	Brion Vibber Derk-Jan Hartman authors of Ace (ace.c9.io)
MediaWikiTemplate:Extension#mediawiki	1.27+
Modifica o banco de dadosTemplate:Extension#needs-updatephp	Não
LicençaTemplate:Extension#license	GNU General Public License 2.0 or later
Download	Download snapshot (Git master) Git [?]: repo summary browse file tree (GitHub) commit history code review
ParâmetrosTemplate:Extension#parameters $wgCodeEditorEnableCore
Hooks usadosTemplate:Extension#hook EditPage::showEditForm:initialManual:Hooks/EditPage::showEditForm:initial EditPage::showReadOnlyForm:initialManual:Hooks/EditPage::showReadOnlyForm:initial GetPreferencesManual:Hooks/GetPreferences
Traduza a extensão CodeEditor, se estiver disponível no translatewiki.net
Verifique a matriz de uso e versão
ProblemasPhabricator	Tarefas em aberto · Relatar um bug

A extensão CodeEditor estende a barra de edição avançada do WikiEditor com um widget Ace editor, oferecendo algumas funcionalidades úteis para javascripts de usuário ou site, páginas CSS e, quando Extension:Scribunto estiver também instalado, para páginas no namespace Module:

• 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
• syntax validity check for JavaScript
• Pair-matching for parenthesis, braces and square brackets

No momento, a extensão está em desenvolvimento ativo, e detalhes de sua ativação e funcionalidades estão sujeitos a mudanças.

License

While this extension is licensed GNU General Public License v2.0 or later (GPL-2.0+) it makes use of the Ace editor software which is licensed BSD 3-clause "New" or "Revised" License (BSD-3-Clause).

Instalação

• Se estiver usando o VagrantMediaWiki-Vagrant, instale com vagrant roles enable codeeditor --provision

Instalação manual

• Baixe e coloque o(s) arquivo(s) em um diretório chamado CodeEditor em sua pasta extensions/.

• Adicione o seguinte código no arquivo LocalSettings.php:

  wfLoadExtension( 'CodeEditor' );
  

• Y Concluído - Navegue na página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.

Configuração

$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 use this extension for Scribunto, i.e. in the module namespace set $wgScribuntoUseCodeEditor = true; (default is "false")

This configuration parameter is provided by the Scributo 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.

$wgScribuntoUseGeSHi

To use this extension for ScribuntoExtension:Scribunto as well as Extension:SyntaxHighlightExtension:SyntaxHighlight, to allow syntax highlighting in the module namespace set $wgScribuntoUseGeSHi = true; (default is "false")

This configuration parameter is provided by the Scributo extension and must therefore be added after invoking the CodeEditor as well as the Scribunto extension. Both the Scribunto and SyntaxHighlight extension also need 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 codeEditor.configure. The argument passed to your hook will be an ACE editor session.

Integração do WikiEditor

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

Problemas

Known issues:

• probably explodes with classic toolbar now; use with Extension:WikiEditor toolbar. See also bugzilla:55419
• accessibility: tab/shift-tab are overridden. is there a consistent alternative for keyboard-reliant users?
• 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
• upstream ctrl+R, ctrl+L, ctrl+T are taken over by the editor, which is SUPER annoying