Extensión:CodeMirror

From mediawiki.org
This page is a translated version of the page Extension:CodeMirror and the translation is 95% complete.
Not to be confused with CodeEditor .
Manual de extensiones de MediaWiki
CodeMirror
Estado de lanzamiento: estable
Implementación Interfaz de usuario
Descripción Proporciona resaltado de sintaxis en el editor de wikitexto
Autor(es) Pavel Astakhov (pastakhovdiscusión)
Última versión 5.0.0
Política de compatibilidad Lanzamientos de screenshots junto con MediaWiki. Master no es compatible con versiones anteriores.
MediaWiki 1.32+
PHP 5.3+
Cambios de la base de datos No
Licencia GNU Licencia Pública general 2.0 o posterior
Descarga
  • $wgCodeMirrorConflictingGadgets
  • $wgCodeMirrorV6
  • $wgCodeMirrorLineNumberingNamespaces
Descargas trimestrales 354 (Ranked 17th)
Wikis públicos que lo utilizan 6,549 (Ranked 62nd)
Traduce la extensión CodeMirror si está disponible en translatewiki.net
Función de vagabundo codemirror
Asuntos Tareas abiertas · Reportar un bug

La extensión de CodeMirror proporciona resaltado de sintaxis en el editor de wikitexto de MediaWiki. Añade un botón con el icono a la barra de herramientas de edición que permite activar y desactivar el resaltado de sintaxis. Es compatible con la barra de herramientas de WikiEditor 2010, así como con la barra de herramientas de VisualEditor.

Por defecto está apagado. Cuando está encendido, reemplazará el área de texto estándar con el editor proporcionado por la librería CodeMirror. Cuando se apague, volverá al área de texto estándar.

Los colores utilizados en esta extensión se han optimizado para un mayor contraste, accesibilidad y mejor legibilidad y ahora cumplen con las Pautas de accesibilidad al contenido web (WCAG 1.4.3 AA). Los colores brindan un mejor acceso a las personas con visión limitada, así como a los usuarios que trabajan en condiciones de luz diurna brillante. (más información)


Características

Coincidencia de corchetes

Esta función resalta el par de corchetes más interno cuando el cursor se encuentra entre cualquier par de corchetes, y cuando el cursor se encuentra directamente al lado de un corchete, la función resalta el corchete correspondiente. La coincidencia de corchetes está activa en ambos editores cuando el resaltado de sintaxis está activado en cualquier espacio de nombres que use estos editores.

Numeración de línea

En el modo de edición de wikitexto, los números de línea se muestran automáticamente en ambos editores.

Esta característica está habilitada solo para el espacio de nombres de la plantilla en la mayoría de los wikis y en todos los espacios de nombres en algunos wikis (consulte el mapa vial y la configuración).

Modo daltónico

Para los usuarios que tienen dificultades para distinguir entre colores, CodeMirror ofrece un modo para daltónicos. Esta característica se puede activar en wikis con CodeMirror habilitado navegando a la página de Special:Preferences.

Con el esquema para daltónicos activo, los colores de los siguientes elementos de la página cambian:

Encabezados, símbolos, firmas, nombres de secciones, palabras mágicas #E4A400
Plantillas #9C3A00
Etiquetas HTML, referencias, expresiones matemáticas #56B4E9
Variables #009E73

Además, los resaltados y colores de fondo se eliminan de todo el texto y los objetos. El comportamiento de negrita y subrayado no se ve afectado.


Compatibilidad con navegadores

Todos los navegadores compatibles con MediaWiki son compatibles.

Instalación

  • Instale la extensión de Extensión:WikiEditor o la extensión de VisualEditor , como se indica en sus páginas; se requiere al menos uno de estos para que esta extensión funcione.
  • Descarga y extrae los archivos en un directorio denominado «CodeMirror» dentro de la carpeta 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
  • Añade el siguiente código en la parte final de tu archivo LocalSettings.php :
    wfLoadExtension( 'CodeMirror' );
    
  • Configure según sea necesario.
  • Yes Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.


Instalación Vagrant:

  • Si se utiliza Vagrant , instala con vagrant roles enable codemirror --provision

Parámetros de configuración

Para personalizar el color y el estilo, consulte la página de metaayuda. Puede usar sus propios estilos para resaltar wikitexto. Estilos usados disponibles aquí. Debes colocar tus propios estilos en common.css .

Agrega el código de arriba al final de tu LocalSettings.php .

# Habilita el uso de CodeMirror de forma predeterminada, pero aún permite que los usuarios lo deshabiliten
$wgDefaultUserOptions['usecodemirror'] = true;

Para habilitar funciones adicionales:

$wgCodeMirrorLineNumberingNamespaces
Restrinja la numeración de líneas a espacios de nombres específicos. El valor predeterminado es null, lo que lo habilita para todos los espacios de nombres. Establézcalo en [] para deshabilitar en todas partes.
$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.

Integración de la extensión

This functionality is subject to change following the CodeMirror 6 upgrade.

Si su extensión MediaWiki agrega una nueva etiqueta y desea asegurarse de que CodeMirror resalte correctamente el contenido dentro de ella, puede agregar compatibilidad con CodeMirror a su extensión. He aquí dos ejemplos: extension Cite y extensión PhpTags.

Integración JavaScript

Los siguientes ganchos frontales son usados en esta extensión:

Gancho Parámetros
Tipo Descripción
ext.CodeMirror.switch booleano Si ahora se muestra el editor de CodeMirror
objeto jQuery El "editor" actual, que es el elemento normal ‎<textarea /> o .CodeMirror.

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

Pendientes

  • Desafortunadamente, el contenido de derecha a izquierda no es compatible. (task T170001)
  • Resaltando listas de definición ( ;foo :bar ) (task T170042)
  • compleción automática (task T95100)
  • plegado de código (task T166098)
  • resaltando dentro de la etiqueta de la galería (<gallery> foo | bar </gallery>)


Véase también