HOME
> ----
> prism.inc.php コードハイライトPukiWikiプラグイン
prism.inc.php コードハイライトPukiWikiプラグイン
概要
Prism.jsを使用してソースコードを装飾するためのプラグインです。
- 行番号表示のオンオフ、開始行の指定、行番号指定のハイライトに対応しています。
- 開始・終了を分けて書く分割インライン版と、複数行引数を使ったブロック版を用意しています。
- ライセンスは LGPLv3です。
自作プラグイン - PukiWiki-officialへの投稿がうまくいかずに急遽HTMLで書きなおしたので少々説明が読みづらいです。
ダウンロード・導入方法
- pluginディレクトリにprism.inc.phpを追加してください。
- skinディレクトリ内にshディレクトリを作成し、prismjs.comでカスタマイズ・ダウンロードしたprism.jsとprism.cssを追加してください。
- 「<?php echo $head_tag ?>」がないスキンの場合は、<head></head>区間内にに、下記のようにそれらのファイルの読み込みを追加してください。
<link rel="stylesheet" type="text/css" media="screen" href="sh/prism.css" />
<script src="sh/prism.js"></script>
ブロック版の追加設定
ブロック版を使うには、複数行の引数を使えるようにpukiwiki.ini.phpの「PKWKEXP_DISABLE_MULTILINE_PLUGIN_HACK」を0にしておく必要があります。
記法
- 第1引数でハイライトしたい言語名を指定します。
- 第2引数で、行番号表示の開始行を指定します。0またはfalseだと行番号表示がオフになります。
- 第3引数以降では、数値単独または2-3のような範囲指定で強調する行を指定します。
分割インライン版の記法
- #endprism または &endprism; で終了します。
- 行頭スペースがある場合に終了をブロック書式で書かないとうまくいかないようです。
&prism(php,2,3-4,6);function example($hoge){ // ここから
if($hoge === "fuga"){
return true;
}
return false;
} // ここまで
#endprism
ブロック版の記法
- {{の次の行からコードを書き始め、終了行の次に}}で閉じる方式です。導入方法のとおり、複数行引数を有効化してある必要があります。
- ブロック版に限り、括弧()内の最終引数をw=400のように書くことで、幅を設定することができます((preの外のdivでないとコピーボタンなどが外にあるままになったのでブロック版のみ))。
- width:400 px;のようにcssな書き方にも一応対応しています。
prism(php,3,3-4,w=600){{
function example($hoge){ // ここから
if($hoge === "fuga"){
return true;
}
return false;
} // ここまで
}}
動作確認
- Pukiwiki 1.5.1で動作を確認しています。
- 1.4.7でも動きました。
参考資料とリンク
関連ページ