Extensão:CodeMirror

This page is a translated version of the page Extension:CodeMirror and the translation is 92% complete.
Outdated translations are marked like this.
Not to be confused with CodeEditor .
Manual de extensões do MediaWiki
CodeMirror
Estado da versão: estável
Implementação Interface de usuário
Descrição Fornece destaque de sintaxe no editor wikitexto
Autor(es) Pavel Astakhov (pastakhovdiscussão)
Última versão 5.0.0
Política de
compatibilidade
Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.32+
PHP 5.3+
Modifica o banco
de dados
Não
Licença GNU GPL (Licença Pública Geral) 2.0 ou superior
Download
  • $wgCodeMirrorConflictingGadgets
  • $wgCodeMirrorV6
  • $wgCodeMirrorTemplateFoldingNamespaces
  • $wgCodeMirrorLineNumberingNamespaces
Quarterly downloads 332 (Ranked 12th)
Public wikis using 6,549 (Ranked 62nd)
Para traduzir a extensão CodeMirror, verifique sua disponibilidade no translatewiki.net
Função no Vagrant codemirror
Problemas Tarefas em aberto · Relatar um bug
CodeMirror is currently being upgraded to a new major version. See Extension:CodeMirror/6 for the new documentation.

A extensão CodeMirror providência o realce de sintaxe no editor de wikitexto da MediaWiki. Ela adiciona um botão com o ícone à barra de ferramentas de edição, que permite alternar o realce de sintaxe entre ativo e inativo. Ele suporta a Barra de Ferramentas do WikiEditor de 2010 e também a Barra de Ferramentas do VisualEditor.

Por padrão ela vem desativada. Quando ativada, ela alterará a área de texto padrão com o editor providenciado pela biblioteca do CodeMirror. Quando desativada, irá reativar a caixa de texto padrão.

As cores utilizadas nesta extensão foram otimizadas para maior contraste, acessibilidade e melhor legibilidade e agora estão de acordo com as Diretrizes de Acessibilidade para o Conteúdo da Web (WCAG 1.4.3 AA). As cores promovem melhor acesso para pessoas com visão limitada assim como para usuários em codições de luz do dia. (mais informações)


Recursos

Correspondência de colchetes

Esse recurso realça o par de colchetes mais interno quando o cursor está entre qualquer par de colchetes e, quando o cursor está diretamente ao lado de um colchete, o recurso realça o colchete correspondente. A correspondência de colchetes está ativa em ambos os editores de texto quando o realce de sintaxe está ativado em qualquer espaço nominal usando esses editores.

Numeração de linha

No modo de edição de wikitexto, os números das linhas são exibidos automaticamente em ambos os editores.

Este recurso é ativado apenas para o espaço nominal de predefinição na maioria das wikis e em todos os espaços nominais em algumas wikis (consulte o progresso e a configuração).

Modo daltônico

Para usuários que têm dificuldade em diferenciar cores, o CodeMirror oferece um modo compatível com daltônicos. Esse recurso pode ser ativado em wikis com o CodeMirror ativado navegando até a página Special:Preferences.

 

Com o esquema compatível com daltônicos ativo, as cores dos seguintes elementos da página mudam:

Cabeçalhos, símbolos, assinaturas, nomes de seção, palavras mágicas #E4A400
Predefinições #9C3A00
Tags HTML, referências, expressões matemáticas #56B4E9
Variáveis #009E73

Além disso, os realces e as cores de fundo são removidos de todos os textos e objetos. O comportamento de negrito e sublinhado permanece inalterado.


Suporte a navegadores

Todos os navegadores suportados pelo MediaWiki são suportados.

Instalação

  • Instale a extensão Extensão:WikiEditor ou a extensão VisualEditor , como instruído em suas páginas; pelo menos uma delas é necessária para que esta extensão funcione.
  • Baixe e coloque o(s) arquivo(s) num diretório chamado CodeMirror na sua pasta extensions/.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php :
    wfLoadExtension( 'CodeMirror' );
    
  • Configure conforme o necessário.
  •   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 codemirror --provision

Configuração

Para customização de cores e estilo, veja a página de ajuda no Meta. Você pode utilizar os seus próprios estilos para realçar o wikitexto. Estilos utilizados disponíveis aqui. Você deve colocar os seus estilos em common.css .

Adicione o seguinte código na parte inferior do seu LocalSettings.php .

# Ativa o uso de CodeMirror por padrão, mas ainda permite aos usuários desativá-la
$wgDefaultUserOptions['usecodemirror'] = true;

Para ativar recursos adicionais:

$wgCodeMirrorLineNumberingNamespaces
Restringe a numeração de linha para espaços nominais específicos. Possui null por padrão, o qual ativa para todos os espaços nominais. Defina como [] para desativar em todo lugar.
$wgCodeMirrorV6
Temporary feature flag to control the migration to CodeMirror 6 (phab:T259059).
$wgCodeMirrorConflictingGadgets
An array of gadget names that, if enabled, will prevent CodeMirror from loading. Defaults to wikEd.

Integração de extensão

This functionality is subject to change following the CodeMirror 6 upgrade. See Extension:CodeMirror/6#Integration for documentation on CodeMirror 6.

Se a sua extensão MediaWiki adiciona uma nova tag, e você quer que CodeMirror realce o conteúdo corretamente dentro dela, você pode adicionar o suporte do CodeMirror à sua extensão. Aqui estão dois exemplos: extensão Cite e extensão PhpTags.

Integração com JavaScript

Os seguintes [$url hooks front-end] são usados nesta extensão:

Hook Parâmetros
Tipo Descrição
ext.CodeMirror.switch booleano Se o editor do CodeMirror agora é mostrado
objeto jQuery O "editor" atual, que é ‎<textarea /> normal ou o elemento .CodeMirror.

If you need to interact with the contents of a CodeMirror instance, use jQuery.plugin.textSelection.

Pendências

  • Unfortunately, right-to-left content is not supported. (task T170001)
  • Realce de listas ( ;foo :bar ) (task T170042)
  • Preenchimento automático (task T95100)
  • dobragem/colapso de código (task T166098)
  • realce dentro da tag de galeria (<gallery> foo | bar </gallery>)


Ver também