Phabricator のプロジェクト名 #syntaxhighlight

Extension: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 20% complete.

Other languages:
Deutsch • ‎English • ‎日本語 • ‎русский • ‎Türkçe • ‎中文
この拡張機能は MediaWiki 1.21 以降に同梱されています。 そのため再度ダウンロードする必要はありません。 しかし、提供されているその他の手順に従う必要はあります。
この拡張は構文の強調表示にGeSHiを使用して以来、以前はSyntaxHighlight_GeSHiとして知られていました。 2015年6月以来、Pygmentsを使用しています。
ソースエディタを使用するときのウィキコードの構文強調表示については、CodeMirrorExtension:CodeMirror拡張機能またはRemember the dotCacycleのuserscriptsを参照してください。
MediaWiki 拡張機能マニュアルManual:Extensions
Crystal Clear action run.svg
SyntaxHighlight

リリースの状態:Extension status 安定

SyntaxHighlighting with Pygments.png
実装Template:Extension#type Tag
説明Template:Extension#description ウィキページ内でソースコードの構文を強調できるようにする
作者Template:Extension#username
  • Brion Vibber,
  • Tim Starling,
  • Rob Church,
  • Ori Livneh
最新バージョンTemplate:Extension#version continuous updates
MediaWikiTemplate:Extension#mediawiki 1.25+
データベースの変更Template:Extension#needs-updatephp いいえ
ライセンスTemplate:Extension#license GNU General Public License 2.0 or later
ダウンロード
README
パラメーターTemplate:Extension#parameters
  • $wgPygmentizePath
  • $wgSyntaxHighlightModels
タグTemplate:Extension#tags
<syntaxhighlight>
使用するフックTemplate:Extension#hook
ContentGetParserOutputManual:Hooks/ContentGetParserOutput
ParserFirstCallInitManual:Hooks/ParserFirstCallInit
ApiFormatHighlightManual:Hooks/ApiFormatHighlight
ResourceLoaderRegisterModulesManual:Hooks/ResourceLoaderRegisterModules

translatewiki.net で翻訳を利用できる場合は、SyntaxHighlight 拡張機能の翻訳にご協力ください

使用状況とバージョン マトリクスを確認してください。

問題点Phabricator

未解決のタスク · バグを報告

これまではSyntaxHighlight_GeSHiとして知られていたSyntaxHighlight拡張機能は、<syntaxhighlight>タグを使用してソースコードの豊富なフォーマットを提供しています。 Pygmentsライブラリを使用しており、数百の異なるプログラミング言語とファイル形式をサポートしています。

<pre>タグと<poemExtension:Poem>タグのように、テキストは入力されたとおりに正確にレンダリングされ、空白は保持されます。

使用法

インストールされると、wikiページで 「syntaxhighlight」タグを使用できます。 例えば、

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

は次のwikitextマークアップの結果です:

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

古いバージョン(MediaWiki 1.16より前)では、拡張機能は<source>というタグを使用していました。 これは引き続きサポートされていますが、ソースコード自体に<source>タグ(XMLなど)が含まれている場合、<syntaxhighlight>は競合を避けるのに役立ちます。

スタイル

表示されたコードが大きすぎる場合は、wikiのMediaWiki:Common.cssページに次のコードを入れて調整することができます(存在しない場合は作成してください):

/* ここに配置されたCSSはすべてのスキンに適用されます */
.mw-highlight pre {
	font-size: 90%;
}

コードブロックを境界線で囲むには、上のセクションでborder: 1px dashed blue;のような行を挿入します。 上記のセクションにfont-family: "Courier New", monospace;のような行を挿入することによって、使用される「フォントファミリ」の制御も行えます。

Syntax highlighting error category

この拡張機能は、<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 second most common error is the use of lang="sh" or lang="shell" which are unsupported. These can typically be replaced with lang="bash" or lang="shell-session".

Parameters

言語

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 int x = 0;
2 Console.WriteLine("结果是:"+ x);
<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

MediaWiki バージョン: 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:

#include <stdio.h>
int main()
{
	printf ("Hello world!");
	return 0;
}

Is the result of:

<syntaxhighlight lang=c style="border:3px dashed blue">
#include <stdio.h>
int main()
{
	printf ("Hello world!");
	return 0;
}
</syntaxhighlight>

Supported languages

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

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#, Gambas, GAP, Gherkin, 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 (incl. console sessions and tracebacks), R, REBOL, Red, Redcode, Ruby, Rust, S, S-Plus, Scala, Scheme, Scilab, Smalltalk, SNOBOL, Tcl, Vala, Verilog, VHDL, Visual Basic.NET, Visual FoxPro, XQuery, Zephir

(full list and 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.


インストール

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' );
    
  • In Linux, set execute permissions for the pygmentize binary:
chmod a+x /path/to/extensions/SyntaxHighlight_GeSHi/pygments/pygmentize
  • YesY 完了 - ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

MediaWiki 1.24 以前を稼働させている利用者へ:

上記の手順では、wfLoadExtension() を使用してこの拡張機能をインストールする新しい方法を記載しています。

この拡張機能をこれらの過去のバージョン (MediaWiki 1.24 以前) にインストールする必要がある場合は、wfLoadExtension( 'SyntaxHighlight_GeSHi' ); の代わりに以下を使用する必要があります:

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.

Configuration

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.

  • Try pointing $wgPygmentizePath in LocalSettings.php towards an external pygmentize binary.
  • See the phabricator task on this for further suggestions and information.

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

Advanced

Unlike the <pre> and <code> tags, HTML character entities such as   need not have the & character escaped as &. 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).[1] (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.

関連項目

Footnotes