PukiWiki/自作プラグイン/Highlighter

highlighter.inc.php †

目次 †

• 概要
• サンプル
• インストール
• 使い方
• 設定
  • プラグインの設定
  • スタイルシートの設定
• 仕様
• ダウンロード
• 履歴
• 備考

概要 †

様々な言語のソースコードを、構文ハイライトして表示するプラグインです。

• 内部で PEAR::Text_Highlighter を利用しています
• スタイルシートによって表示色などを設定することができます
• 以下の17種類の言語に対応しています
  • ABAP
  • CPP
  • CSS
  • diff
  • DTD
  • HTML
  • Java
  • JavaScript
  • MySQL
  • Perl
  • PHP
  • Python
  • Ruby
  • SH
  • SQL
  • VBScript
  • XML

サンプル †

PHP のコードを構文ハイライトして表示した例を以下に示します。

<?php
 
/**
 * phphighlight.inc.php - Syntax highlighting using highlight_string() function
 *
 * @author      revulo
 * @licence     http://www.gnu.org/licenses/gpl.html  GPLv2
 * @link        http://www.revulo.com/PukiWiki/Plugin/PHPHighlight.html
 */
 
function plugin_phphighlight_convert()
{
    $args   = func_get_args();
    $source = rtrim(end($args));
    $html   = highlight_string($source, true);
 
    $before = array(
        ">\n<",
        '<font color="',
        'font>',
        'code>',
    );
    $after = array(
        '><',
        '<span style="color: ',
        'span>',
        'pre>',
    );
    return str_replace($before, $after, $html);
}
 
?>

インストール †

highlighter.inc.php プラグインのアーカイブファイルをダウンロードし、 PukiWiki をインストールしてあるディレクトリで展開します。

$ tar xvfz highlighter-1.2.tar.gz

cache/highlighter というディレクトリが作られるので、書き込み許可を与えて下さい。

$ chmod 777 cache/highlighter

PEAR::Text_Highlighter のページ からアーカイブをダウンロードし、PukiWiki の plugin ディレクトリで展開します。 ディレクトリ名は Text にリネームしておいて下さい。

$ cd plugin
$ tar xvfz Text_Highlighter-0.7.1.tgz
$ mv Text_Highlighter-0.7.1 Text

PEAR がインストールされていない場合は、 plugin/Text/Highlighter.php の以下の行をコメントアウトして下さい。

require_once 'PEAR.php';

あとは pukiwiki.ini.php の設定を以下のように変更して下さい。

define('PKWKEXP_DISABLE_MULTILINE_PLUGIN_HACK', 0);

なお、以前のバージョンからバージョンアップする場合は、以下の点に注意して下さい。

• バージョン 1.2 から、キャッシュの保存場所が cache/highlighter ディレクトリに変わりました。 cache ディレクトリに残っている 〜.highlighter というファイルは、使わないので削除して構いません。

• バージョン 1.2 から、スタイルシートを自動的に読み込むようになりました。 スキンのスタイルシートに @import "./highlighter.css"; のように書く必要はありません。

使い方 †

プラグインの書式は次のようになっています。

#highlighter(オプション){{
  ……
  ソースコード
  ……
}}

例えば、PHP 用の構文ハイライトをして行番号付きで表示するには、このように書きます。

#highlighter(php,number){{
<?php
echo 'test';
?>
}}

オプションは次のようなものが指定できます。 複数のオプションを指定する場合は 「，」(カンマ) で区切って書いて下さい。 デフォルト値は、highlighter.inc.php の PLUGIN_HIGHLIGHTER_DEFAULT_LANGUAGE などの値を設定することで変更できます。

• 言語名 (デフォルト: 構文ハイライトなし)
  • 言語名 もしくは language=言語名 ‥‥ 言語を指定します。言語名は大文字でも小文字でも構いません
  • 言語名を指定しなかった場合は、単なる整形済みテキストとして表示されます
    (ただし PLUGIN_HIGHLIGHTER_DEFAULT_LANGUAGE が設定されていたら、その言語とみなして処理します)

• number (デフォルト: off)
  • number もしくは number=on ‥‥ 行番号を表示します
  • number=off ‥‥ 行番号を非表示にします

• start (デフォルト: 1)
  • start=数字 ‥‥ 行番号を表示する際の開始番号を指定します

• cache (デフォルト: on) *1
  • cache もしくは cache=on ‥‥ キャッシュ機能を有効にします
  • cache=off ‥‥ キャッシュ機能を無効にします
  • cache=reset ‥‥ キャッシュを強制的に再作成します

設定 †

プラグインの設定 †

highlighter.inc.php の先頭部分で以下の値を設定することで、動作をカスタマイズできます。

PLUGIN_HIGHLIGHTER_LIB_DIR

PEAR::Text_Highlighter がインストールされているディレクトリ

PLUGIN_HIGHLIGHTER_CSS_URI

使用するスタイルシートの URL

PLUGIN_HIGHLIGHTER_CACHE

キャッシュを使用するかどうかのデフォルト値 (true, false のいずれか)

PLUGIN_HIGHLIGHTER_DEFAULT_LANGUAGE

言語名が指定されなかった時のデフォルトの言語名

PLUGIN_HIGHLIGHTER_LINE_NUMBERS

行番号を表示するかどうかのデフォルト値 (true, false のいずれか)

スタイルシートの設定 †

このサイトで用いているスタイルシートを revulo.css という名前で同梱してあります。 これを参考にスタイルシートを編集したり、 そのまま PLUGIN_HIGHLIGHTER_CSS_URI で指定して使ったりして下さい。

仕様 †

現在のところ、行番号を表示した場合に以下のような問題があります。

• ブラウザによっては、コピー＆ペーストが正常に行えません
• start オプションを用いると XHTML 1.1 準拠でなくなります
• Windows 版 Safari で見ると何も表示されない
  (Mac OS X 版 Safari でどうなのかは知りません。誰か確認して報告して下さい。)

どうやら Safari は、<object> タグで囲まれたテキストを表示してくれないようです。 とりあえずの対処法を挙げておきます。

• highlighter.inc.php の <object> タグを追加している箇所を、以下のように変更する
  (ただし、XHTML には準拠しなくなります。)

--- highlighter.inc.php.orig
+++ highlighter.inc.php
@@ -166,5 +166,5 @@

         $html = '<pre class="highlighter number ' . htmlspecialchars($options['language'])
-              . '"><code><object>' . $html . '</object></code></pre>';
+              . '">' . $html . '</pre>';
     } else {
         $html = $highlighter->highlight($source);

ダウンロード †

• highlighter-1.2.tar.gz
  • プラグイン本体
  • スタイルシート
    • PEAR::Text_Highlighter 標準のスタイルシート
    • このサイトで用いているスタイルシート

履歴 †

備考 †

同様の機能を持つプラグインが他にもあるのでまとめておきます。

プラグイン名	使用ライブラリ
geshi.inc.php	GeSHi (PHP)
highlighter.inc.php	PEAR::Text_Highlighter (PHP)
prettify.inc.php	google-code-prettify (JavaScript)
shjs.inc.php	SHJS (JavaScript)
codehighlight.inc.php	独自に実装 (PHP)
highlight.inc.php	SyntaxHighlighter (JavaScript)

最新の20件

Skin by YEAR OF THE CAT