확장 기능:SyntaxHighlight

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:SyntaxHighlight and the translation is 22% complete.

Other languages:
Deutsch • ‎English • ‎Türkçe • ‎dansk • ‎беларуская (тарашкевіца)‎ • ‎русский • ‎中文 • ‎日本語 • ‎한국어
이 extension 확장기능은 미디어위키 1.21 이상에서 포함됩니다. 따라서 다시 다운로드하지 않아도 됩니다. 하지만 여전히 제공되는 별개의 지침을 따라야 합니다.
원본 편집기를 이용할 때 구문 강조가 필요하다면 CodeMirror 확장기능이나 Remember the dot, Cacycle 사용자 스크립트를 사용하십시오.
미디어위키 확장 기능 매뉴얼
OOjs UI icon advanced.svg
SyntaxHighlight
출시 상태: 안정
SyntaxHighlighting with Pygments.png
구현 Tag
설명 위키 문서에서 소스 코드의 구문이 강조되도록 합니다.
만든이
  • Brion Vibber,
  • Tim Starling,
  • Rob Church,
  • Ori Livneh
최신 버전 continuous updates
MediaWiki 1.25+
데이터베이스 변경 아니오
라이선스 GNU General Public License 2.0 or later
다운로드
README
변수

  • $wgPygmentizePath
  • $wgSyntaxHighlightModels
태그
<syntaxhighlight>
사용된 훅
ContentGetParserOutput
ParserFirstCallInit
ApiFormatHighlight
ResourceLoaderRegisterModules
SyntaxHighlight 확장 기능 번역 (translatewiki.net에서 가능한 경우)
사용법과 버전 매트릭스를 확인합니다.
이슈 미해결 작업 · 버그 보고

SyntaxHighlight 확장 기능은 이전에는 SyntaxHighlight_GeSHi라는 이름을 가졌으며 <syntaxhighlight> 태그를 사용했을 때 소스 코드를 충분히 꾸며줍니다. It is powered by the Pygments library and supports hundreds of different programming languages and file formats.

Like the <pre> and <poem > tags, the text is rendered exactly as it was typed, preserving any white space.

사용법

Once installed, you can use "syntaxhighlight" tags on wiki pages. For example,

1 def quickSort(arr):
2 	less = []
3 	pivotList = []
4 	more = []
5 	if len(arr) <= 1:
6 		return arr
7 	else:
8 		pass

is the result of the following wikitext markup:

<syntaxhighlight lang="Python" line='line'>
def quickSort(arr):
	less = []
	pivotList = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass
</syntaxhighlight>

In older versions (before MediaWiki 1.16), the extension used the tag <source>. This is still supported, but <syntaxhighlight> may help avoid conflicts if your source code itself contains <source> tags (for example XML).

서식

If the displayed code is too big, you can adjust it by putting the following into the MediaWiki:Common.css page in your wiki (create it if it does not exist):

/* CSS placed here will be applied to all skins */
.mw-highlight pre {
	font-size: 90%;
}

Encasing code blocks in borders can be done by inserting a line like border: 1px dashed blue; in the section above. Control over font family used can also be exercised by inserting a line like font-family: "Courier New", monospace; into the section above.

구문 강조에 오류가 있는 문서

<source> 또는 <syntaxhighlight> 태그에 잘못된 lang 속성값을 가지는 문서들을 추적하는 카테고리에 추가합니다. The message key MediaWiki:syntaxhighlight-error-category determines the category name; on this wiki it is Category:Pages with syntax highlighting errors.

The most common error that leads to pages being tagged with this category is a <syntaxhighlight> or <source> tag with no lang attribute at all, because older versions of this extension supported the definition of "$wgSyntaxHighlightDefaultLang". These can typically either be replaced with <pre>, or lang="bash" or lang="text" can be added to the tag.

The category may also be added, and the content will not be highlighted, if there are more than 1000 lines or more than 100 kB text.[1]

변수

lang

The lang="Name" attribute defines what lexer should be used. The language affects how the extension highlights the source code. The pygments parser is case sensitive and all languages have at least one capital letter (lower case language names are reserved for gtags). See the section Supported languages for details of supported languages.

def quickSort(arr):
    less = []
<syntaxhighlight lang="Python">
..
</syntaxhighlight>

Specifying an invalid or unknown name will tag the page with a tracking category. See the section Syntax highlighting error category in this page for details.

line

The line attribute enables line numbers.

1 def quickSort(arr):
2 	less = []
<syntaxhighlight lang="Python" line>
..
</syntaxhighlight>

start

The start attribute (in combination with line) defines the first line number of the code block. For example, line start="55" will make line numbering start at 55.

55 def quickSort(arr):
56     less = []
<syntaxhighlight lang="Python" line start="55">
..
</syntaxhighlight>

highlight

The highlight attribute specifies one or more lines that should be marked (by highlighting those lines with a different background color). You can specify multiple line numbers separated by commas (for example, highlight="1,4,8") or ranges using two line numbers and a hyphen (for example, highlight="5-7"). Note that the line number specification ignores any renumbering of the displayed line numbers with the start attribute.

3 def quickSort(arr):
4     less = []
5     pivotList = []
6     more = []
7     if len(arr) <= 1:
8         return arr

is the result of

<syntaxhighlight lang="Python" highlight="1,5-7" start='3' line>
..
</syntaxhighlight>

inline

미디어위키 버전: 1.26

The attribute indicates that the source code should be inline as part of a paragraph (as opposed to being its own block). This option is available starting with MediaWiki 1.26. For backwards-compatibility, an enclose="none" attribute results in the same behavior.

Note that line breaks can occur at any space between the opening and closing tags unless the source code is marked non-breakable with class="nowrap" (on those wikis that support it; see below) or style=white-space:nowrap.

For example:

lambda x: x * 2 is a lambda expression in Python.

Is the result of:

<syntaxhighlight lang="Python" inline>lambda x: x * 2</syntaxhighlight> is a [[w:Lambda (programming)|lambda expression]] in Python.

class

When inline is used, class="nowrap" (on those wikis that support it; not on MediaWiki itself) specifies that line breaks should not occur at spaces within the code block.

For example:

Without class="nowrap":

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxlambda x: x * 2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

With style="white-space:nowrap":

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxlambda x: x * 2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

style

The style attribute allows CSS attributes to be included directly. This is equivalent to enclosing the block in a <div> (not <span>) tag. The tab‑size attribute cannot be specified this way; it requires an enclosing <span> tag as described below under Advanced.

For example:

def quickSort(arr):
	less = []
	pivotList = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass

Is the result of:

<syntaxhighlight lang="Python" style="border:3px dashed blue">
def quickSort(arr):
	less = []
	pivotList = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass
</syntaxhighlight>

지원되는 언어들

The Pygments library provides support for hundreds of computer languages and file formats. full list is:

Programming languages

  • ActionScript
  • Ada
  • ANTLR
  • AppleScript
  • Assembly
  • Asymptote
  • Awk
  • Befunge
  • Boo
  • BrainFuck
  • C / C++
  • C#
  • Clojure
  • CoffeeScript
  • ColdFusion
  • Common Lisp
  • Coq
  • Cryptol
  • Crystal
  • Cython
  • D
  • Dart
  • Delphi
  • Dylan
  • Elm
  • Erlang
  • Ezhil
  • Factor
  • Fancy
  • Fortran
  • F#
  • GAP
  • Gherkin (Cucumber)
  • GL shaders
  • Groovy
  • Haskell
  • IDL
  • Io
  • Java
  • JavaScript
  • Lasso
  • LLVM
  • Logtalk
  • Lua
  • Matlab
  • MiniD
  • Modelica
  • Modula-2
  • MuPad
  • Nemerle
  • Nimrod
  • Objective-C
  • Objective-J
  • Octave
  • OCaml
  • PHP
  • Perl
  • PovRay
  • PostScript
  • PowerShell
  • Prolog
  • Python 2.x and 3.x
  • REBOL
  • Red
  • Redcode
  • Ruby
  • Rust
  • S, S-Plus and R
  • Scala
  • Scheme
  • Scilab
  • Smalltalk
  • SNOBOL
  • Tcl
  • Vala
  • Verilog
  • VHDL
  • Visual Basic.NET
  • Visual FoxPro
  • XQuery
  • Zephir

Template languages

  • Cheetah templates
  • Django / Jinja templates
  • ERB
  • Genshi
  • JSP
  • Myghty
  • Mako
  • Smarty templates
  • Tea

Other markup

  • Apache config files
  • Bash shell scripts
  • BBCode
  • CMake
  • CSS
  • Debian control files
  • Diff files
  • DTD
  • Gettext catalogs
  • Gnuplot script
  • Groff markup
  • HTML
  • HTTP sessions
  • INI-style config files
  • IRC logs (irssi style)
  • Lighttpd config files
  • Makefiles
  • MoinMoin/Trac Wiki markup
  • MySQL
  • Nginx config files
  • POV-Ray scenes
  • Ragel
  • Redcode
  • ReST
  • Robot Framework
  • RPM spec files
  • SQL
  • Squid configuration
  • TeX
  • tcsh
  • Vim Script
  • Windows batch files
  • XML
  • XSLT
  • YAML

For accurate language codes, see complete details in the Pygments document and there are some mappings for some language names which were supported by GeSHi (full list).

Pygments does not yet provide a "wikitext" or "mediawiki" lexer (phab:T29828). Use "html", "xml", or "moin" instead.

Below is a partial list of languages that GeSHi could highlight, with strike-through for languages no longer supported after the switch to Pygments.


설치

이 확장기능은 shell 로 접근이 필요합니다.
The version of this extension bundled with MediaWiki 1.31 requires Python version 3 (python3) to be installed on the server. This is a change from the version bundled with MediaWiki 1.30, which used Python version 2 (python). Note that the python3 binary must be installed in the execution PATH of the PHP interpreter.
Despite its update to Pygments (and away from GeSHi) and despite its updated name, this extension internally still uses the former file names as stated below.
  • 파일을 다운로드해서, extensions/ 폴더 내의 SyntaxHighlight_GeSHi 이라는 이름의 디렉터리 내에 설치합니다.
  • 아래의 코드를 LocalSettings.php의 말미에 추가합니다:
    wfLoadExtension( 'SyntaxHighlight_GeSHi' );
    

리눅스에서, pygmentize 바이너리 실행 권한을 설정합니다:

chmod a+x /path/to/extensions/SyntaxHighlight_GeSHi/pygments/pygmentize
  • Yes 완료 – 위키의 ‘Special:Version’에 이동해서, 확장기능이 올바르게 설치된 것을 확인합니다.

미디어위키 1.24 이하를 실행 중인 사용자에게:

위의 지시사항은 wfLoadExtension()을 사용하여 이 확장기능을 설치하는 새로운 방법을 기술합니다 wfLoadExtension( 'SyntaxHighlight_GeSHi' ); 대신 이 초기 버전(미디어위키 1.24 이하)에 이 확장기능을 설치하려면 다음을 사용해야 합니다:

require_once "$IP/extensions/SyntaxHighlight_GeSHi/SyntaxHighlight_GeSHi.php";
When installing from Git, please note that starting from MediaWiki 1.26 this extension requires Composer.

So, after installation from Git change to the directory containing the extension e.g. "../extensions/SyntaxHighlight_GeSHi/" and run composer install --no-dev, or when updating: composer update --no-dev.

Alternatively as well as preferably add the line "extensions/SyntaxHighlight_GeSHi/composer.json" to the "composer.local.json" file in the root directory of your wiki like e.g.
{
	"extra": {
		"merge-plugin": {
			"include": [
				"extensions/SyntaxHighlight_GeSHi/composer.json"
			]
		}
	}
}
Now run composer update --no-dev. Voilà!
When uploading the extension via FTP be sure to upload the pygments/pygmentize file with the transfer type binary.

설정

Linux
  • $wgPygmentizePath (optional): Absolute path to pygmentize of the Pygments package. The extension bundles the Pygments package and $wgPygmentizePath points to the bundled version by default, but you can point to a different version, if you want to. For example: $wgPygmentizePath = "/usr/local/bin/pygmentize";.
  • $wgSyntaxHighlightModels: Configure the default lexer for some wiki pages. By default this will highlight javascript and css pages. Additional content models can be configured by extensions (e.g. Lua, JSON, ..).
Windows
  • If you are hosting your MediaWiki on a Windows machine, you have to set the path for the Pygmentize.exe $wgPygmentizePath = "c:\\Python27\\Scripts\\pygmentize.exe";
    • If there is no pygmentize.exe run easy_install Pygments from command line inside the Scripts folder to generate the file.

If you are using the bundled pygmentize binary (extensions/SyntaxHighlight_GeSHi/pygments/pygmentize), make sure your webserver is permitted to execute it. If your host does not allow you to add executables to your web directory, install python-pygments and add $wgPygmentizePath = pygmentize to LocalSettings.php.

Troubleshooting

After updating to MediaWiki v1.26 and above, some users started reporting problems with the extension. There could be cases, when some languages, such as Lua might not get highlighted and by turning on debugging, MediaWiki would throw out the error, Notice: Failed to invoke Pygments: /usr/bin/env: python3: No such file or directory.

  • Try pointing $wgPygmentizePath in LocalSettings.php towards an external pygmentize binary.
  • In shared hosting environments with cPanel, this can be done by setting up a new Python application through the "Setup Python App" menu, and activating the virtual environment for the app through SSH (source /virtualenv/python/3.5/bin/activate). After this, the Pygments module can be added to the Python app, for which navigate to the virtual environment path (cd virtualenv/python/3.5/bin/), download and install Pygments (./pip install Pygments) and then activate the module by adding "Pygments" under the "Existing applications" section of the "Setup Python App" menu. This will create the required file at path: virtualenv/python/3.5/bin/pygmentize


VisualEditor integration

The plugin enables direct editing with VisualEditor. A popup is opened when a user wants to edit source or syntaxhighlight sections. For this to work, VisualEditor must be installed and configured from the latest git version, same for Parsoid. The feature randomly does not work with older Parsoid versions. See Extension:SyntaxHighlight/VisualEditor for details

고급 사용

Unlike the <pre> and <code> tags, HTML character entities such as &nbsp; need not (and should not) have the & character escaped as &amp;. Like the <pre> tag but unlike the <code> tag, tags within the range (other than its own closing tag) need not have the < symbol escaped as &lt;, nor does wikitext need to be escaped with a <nowiki> tag.

Furthermore, while <pre> assumes tab stops every 8 characters and renders tabs using actual spaces when the rendered text is copied, <syntaxhighlight> uses 4-space tab stops (except Internet Explorer, which uses 8) and preserves the tab characters in the rendered text; the latter may be changed using an enclosing <span style="-moz-tab-size:nn; -o-tab-size:nn; tab-size:nn;"> tag (not <div>, and not using its own style attribute). The -moz- prefix is required for Firefox (from version 4.0), and the -o- prefix is required for Opera (from version 10.60 to version 15).[2] (Note that the wiki editing box assumes 8-space tabs.) This applies only to actual saved pages; previews generated through an edit box or Special:ExpandTemplates may differ.

같이 보기

각주