Extensão:CodeEditor

From mediawiki.org
This page is a translated version of the page Extension:CodeEditor and the translation is 100% complete.
Esta extensão acompanha o MediaWiki 1.31 ou superior. Logo, não é necessário baixá-la novamente. No entanto, ainda é necessário seguir as outras instruções fornecidas.
Not to be confused with CodeMirror.
Manual de extensões do MediaWiki
CodeEditor
Estado da versão: estável
Descrição Fornece um editor de código de realce de sintaxe para páginas em JavaScript (JS), folhas de estilos em cascatas (F.E.C., C.S.S.) e Lua do site e do usuário, integrando-se com barra de ferramentas de edição avançada
Autor(es)
  • Brion Vibber
  • Derk-Jan Hartman
  • authors of Ace (ace.c9.io)
Política de
compatibilidade
Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.32+
Modifica o banco
de dados
Não
Licença GPL-2.0-or-later AND BSD-3-Clause
Download
  • $wgCodeEditorEnableCore
Quarterly downloads 192 (Ranked 43rd)
Public wikis using 8,385 (Ranked 17th)
Para traduzir a extensão CodeEditor, verifique sua disponibilidade no translatewiki.net
Problemas Tarefas em aberto · Relatar um bug

A extensão CodeEditor estende a barra de ferramentas de edição avançada do WikiEditor com uma ferramenta (widget) do editor Ace incorporada, fornecendo alguns recursos úteis para páginas em JavaScript, páginas folhas de estilos em cascatas (F.E.C., C.S.S.), páginas em Notação de objeto JavaScript (N.O.J.S., J.S.O.N.) e, quando a extensão Scribunto também está instalada, para páginas em Lua do usuário/site, ou seja, páginas no espaço nomeado (namespace) Módulo. O editor de código não aparece em páginas wiki regulares, ou seja, páginas wiki com o modelo de conteúdo de "texto wiki" ("wikitext"). (Consulte Extensão:CodeMirror para realce de sintaxe de texto wiki ao usar o editor de código-fonte.)

Ela fornece as seguintes funcionalidades:

  • realce de sintaxe para JavaScript (JS), folhas de estilos em cascatas (F.E.C., C.S.S.) e Lua
  • indentação automática
  • * tecla de tabulação (tab) produz identação de tabulação (desde 1.22), identações suaves antes.
  • seleção de indentação/desindentação com as teclas de tabulação/tabulação-mudança (Tab/Shift-Tab)
  • verificação de validade de sintaxe para JavaScript
  • Correspondência de pares para parênteses, chaves e colchetes

Instalação

A extensão WikiEditor precisa ser instalada para que esta extensão funcione. A instalação da extensão Scribunto é opcional.
  • Baixe e coloque o(s) arquivo(s) num diretório chamado CodeEditor na sua pasta extensions/.
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php :
    wfLoadExtension( 'CodeEditor' );
    $wgDefaultUserOptions['usebetatoolbar'] = 1; // user option provided by WikiEditor extension
    
  • Configure conforme necessário.
  • Yes Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.


Instalação com Vagrant:

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

Configuração

$wgCodeEditorEnableCore
Para desabilitar o editor em páginas em JavaScript e em folhas de estilos em cascatas (F.E.C., C.S.S.) nos espaços nomeados (namespaces) MediaWiki, Usuários e outros espaços nomeados (namespaces) principais, defina $wgCodeEditorEnableCore = false; (o padrão é "true")
$wgScribuntoUseCodeEditor
Para desabilitar esta extensão para a Scribunto, ou seja, no espaço nomeado (namespace) dos módulos, defina $wgScribuntoUseCodeEditor = false; (o padrão é "true")
Este parâmetro de configuração é fornecido pela extensão Scribunto e, portanto, deve ser adicionado após invocar a CodeEditor, bem como a extensão Scribunto, que também precisa ser instalada para que funcione.

JavaScript

É possível alterar a configuração do editor Ace, conectando-se ao gancho do J.S. do MediaWiki (ou seja, mw.hook( 'codeEditor.configure' ).add( ... )). O argumento passado para o seu gancho será um objeto ACE EditSession.

Se você precisar interagir com o conteúdo de uma instância da CodeEditor, use jQuery.plugin.textSelection.

Licença

Embora esta extensão seja licenciada sob a Licença pública geral GNU versão 2.0 ou posterior (GPL-2.0+) ela faz uso do software editor Ace que é licenciado sob a Licença de 3 cláusulas "Nova" ou "Revisada" da Distribuição de software Berkeley (D.S.B., B.S.D.).

See also