Extensão:CodeMirror

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	4.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	Baixar extensão Git [?]: Baixar master do Git navegar pelo repositório (GitHub) histórico de commits contribuidores do repositório (GitHub) revisão de código
Parâmetros $wgCodeMirrorEnableBracketMatching $wgCodeMirrorAccessibilityColors $wgCodeMirrorLineNumberingNamespaces
Hooks usados BeforePageDisplay GetPreferences ResourceLoaderGetConfigVars
Para traduzir a extensão CodeMirror, verifique sua disponibilidade no translatewiki.net
Verificar uso e matriz de versões
Função no Vagrant	codemirror
Problemas	Tarefas em aberto · Relatar um bug

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 desativo. Ele suporta a Barra de Ferramentas do WikiEditor de 2010 e também a Barra de Ferramentas do VisualEditor.

Por padrão ele vem desativado. Quando ativado, ele alterará a área de texto padrão com o editor providênciado pela [do CodeMirror]. Quando desativado, o oposto ocorrerá.

The colors used in this extension have been optimised to provide higher contrast, accessibility and better readability.

Please note though, that the updated color scheme is currently only enabled by default for some wikis (see roadmap and configuration).

Features

Bracket matching

This feature allows highlighting of the closest matching pair of surrounding brackets while navigating through wikitext code using the cursor. Bracket matching will be active in both editors when syntax highlighting is turned on, in any namespace using these editors.

Please note that bracket matching is only enabled by default in some wikis (see roadmap and configuration).

• 

  Bracket matching

Line numbering

In the wikitext edit mode line numbers are automatically displayed in both editors.

Please note that this feature is only enabled for the template namespace on most wikis (see roadmap and configuration).

• 

  Line numbering in 2010 wikitext editor

• 

  Line numbering in 2017 wikitext editor

Suporte a navegadores

Todos os navegadores suportados pelo MediaWiki são suportados.

Instalação

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

Instalação manual

• Instale a extensão WikiEditor ou a extensão VisualEditor , como instruído nas suas páginas; pelo menos um deles é necessário para que esta extensão funcione.
• Baixe e coloque o(s) arquivo(s) num diretório chamado CodeMirror na sua pasta extensions/.
• 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.

Configuração

Para customização de cores e estilo, veja meta:Community Tech/Wikitext editor syntax highlighting#Color and style customization. Você pode utilizar os seus próprios estilos para realçar o wikitexto. Estilos utilizados disponíveis aqui. Você deve pôr os seus estilos em common.css.

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

# Enables use of CodeMirror by default but still allow users to disable it
$wgDefaultUserOptions['usecodemirror'] = 1;

To try out the new features mentioned above in your local installation, add the following lines as well. Please note though, that these features are meant to become default features. The settings might not have an effect any more then.

# Enable bracket matching in CodeMirror
$wgCodeMirrorEnableBracketMatching = true;

# Enable accessible colors in CodeMirror
$wgCodeMirrorAccessibilityColors = true;

# Enable line numbering in CodeMirror
# defaults to the template namespace `[ NS_TEMPLATE ]`
# `null` enables it for all namespace
# [] for disabling everywhere
$wgCodeMirrorLineNumberingNamespaces = null;

Integração de extensão

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

JavaScript integration

The following front-end hooks are used in this extension:

Hook	Parameters
	Type	Description
ext.CodeMirror.switch	boolean	Whether the CodeMirror editor is now shown
	jQuery object	The current "editor", which is either the normal ‎<textarea /> or the .CodeMirror element.

Pendências

• highlighting definition lists ( ;foo :bar ) (phab:T170042)
• auto-completion (phab:T95100)
• dobragem de código T166098
• highlighting inside gallery tag (<gallery> foo | bar </gallery>)

Ver também

• Overview of missing features and bugs: MediaWiki-extensions-CodeMirror
• User:Remember the dot/Syntax highlighter

• Extension:VisualEditor
• Extensão:WikiEditor
• Extensão:CodeEditor
• Community Tech/Wikitext editor syntax highlighting (includes information on customizing the colors)
• c:Category:MediaWiki extension CodeMirror