확장 기능:CodeMirror

This page is a translated version of the page Extension:CodeMirror and the translation is 10% complete.
Not to be confused with CodeEditor .
미디어위키 확장 기능 설명서
CodeMirror
출시 상태: 안정
구현 사용자 인터페이스
설명 위키텍스트 편집기에서 구문 강조 기능 제공
만든 이 Pavel Astakhov (pastakhov토론)
최신 버전 5.0.0
호환성 정책 스냅샷은 미디어위키와 함께 릴리스됩니다. Master is not backward compatible.
MediaWiki 1.32+
PHP 5.3+
데이터베이스 변경 아니오
라이선스 GNU General Public License 2.0 or later
다운로드
  • $wgCodeMirrorConflictingGadgets
  • $wgCodeMirrorV6
  • $wgCodeMirrorTemplateFoldingNamespaces
  • $wgCodeMirrorLineNumberingNamespaces
Quarterly downloads 308 (Ranked 13th)
Public wikis using 6,549 (Ranked 62nd)
CodeMirror 확장 기능 번역 (translatewiki.net에서 가능한 경우)
Vagrant 역할 codemirror
이슈 미해결 작업 · 버그 보고
CodeMirror is currently being upgraded to a new major version. See Extension:CodeMirror/6 for the new documentation.

The CodeMirror extension provides syntax highlighting in MediaWiki's wikitext editor. It adds a button with the icon to the editing toolbar that allows for switching syntax highlighting on and off. It supports the 2010 WikiEditor toolbar as well as the VisualEditor toolbar.

By default it is switched off. When switched on, it will replace the standard textarea with the editor provided by CodeMirror library. When switched off, it will switch back to the standard textarea.

The colors used in this extension have been optimised for higher contrast, accessibility and better readability and now conform to the Web Content Accessibility Guidelines (WCAG 1.4.3 AA). The colors provide better access for people with limited vision as well as for users working in bright daylight conditions. (more information)


Bracket matching

This feature highlights the innermost pair of brackets when the cursor lies between any bracket pair, and when the cursor lies directly next to a bracket, the feature highlights the corresponding matching bracket. Bracket matching is active in both editors when syntax highlighting is turned on in any namespace using these editors.

Line numbering

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

This feature is enabled only for the template namespace on most wikis, and on all namespaces on some wikis (see the roadmap and the configuration).

Colorblind mode

For users who have difficulty distinguishing between colors, CodeMirror offers a colorblind-friendly mode. This feature can be activated on wikis with CodeMirror enabled by navigating to the Special:Preferences page.

With the colorblind-friendly scheme active, the colors of the following page elements change:

Headings, symbols, signatures, section names, magic words #E4A400
Templates #9C3A00
HTML tags, references, mathematical expressions #56B4E9
Variables #009E73

In addition, background highlights and colors are removed from all text and objects. Bolding and underlining behavior remains unaffected.


브라우저 지원

All browsers supported by MediaWiki are supported.

설치

  • Install either the 확장기능:WikiEditor extension or the VisualEditor extension, as instructed on their pages; at least one of these is required for this extension to work.
  • 파일을 다운로드하고 CodeMirror 폴더를 extensions/ 디렉토리에 넣어 주세요.
    개발자와 코딩 기여자는 Git을 이용해 확장기능을 다운받는 것이 좋습니다.cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
  • 아래의 코드를 LocalSettings.php 코드의 마지막에 추가합니다.
    wfLoadExtension( 'CodeMirror' );
    
  • Configure as required.
  •   완료 – 위키의 ‘Special:Version’에 이동해서, 확장기능이 올바르게 설치된 것을 확인합니다.


Vagrant 설치:

  • Vagrant 를 사용하고 있는 경우에는, vagrant roles enable codemirror --provision로 설치해주세요

설정하기

For color and style customization, see Meta help page. You can use your own styles for wikitext highlighting. Used styles available here. You should place your own styles to common.css .

Add the following code at the bottom of your LocalSettings.php .

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

Additional configuration:

$wgCodeMirrorLineNumberingNamespaces
Restrict line numbering to specific namespaces. Defaults to null, which enables it for all namespaces. Set to [] to disable everywhere.
$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.

확장 기능 통합

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

If your MediaWiki extension adds a new tag and you want to make sure CodeMirror properly highlights the content within it, you can add CodeMirror support to your extension. Here are two examples: Cite extension and PhpTags extension.

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.

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

To do

  • Unfortunately, right-to-left content is not supported. (task T170001)
  • highlighting definition lists ( ;foo :bar ) (task T170042)
  • auto-completion (task T95100)
  • code folding (task T166098)
  • highlighting inside gallery tag (<gallery> foo | bar </gallery>)


같이 보기