はてな記法プラグイン

Download:	hatena-formatter-0.9.zip
Version:	0.1
Updated:	2009/07/28
Size:	40.13 KB

概要

投稿やコメントに「はてな記法」を導入します。

「はてな記法」のフォーマット処理は、author が id:jkondo である Text::Hatenaをそのまま使用しています。

システム要件

WordPress 2.1以上
PHP 4以降
Perl 5以降
Text::Hatena Perlモジュール 0.16/0.20

[備考]

「はてな記法」の導入は簡単ではありません。(特にWindows環境下では)
Text::Hatena 0.20は「はてな記法」の機能縮小＆パフォーマンス改善版です。
多機能版が必要でしたら、Text::Hatena 0.16の導入を検討してください。
なお、Text::Hatena 0.16をWindows環境にインストールするのは非常に敷居が高いのでおすすめしません。
Text::Hatena 0.20にスーパーpre記法（シンタックス・ハイライト）を対応させるためのパッチを同梱しています。
このパッチはmasakiのはてなダイアリー – とりあえず Text-Hatena-0.20 をスーパーpre記法（＋シンタックス・ハイライト）に対応させるを改変したものです。

インストール概要

サーバにPerlをインストールします。(ない場合)
Perl に Text::Hatenaモジュールをインストールします。
はてな記法プラグインの.zipアーカイブをダウンロードし、展開します。
WordPressのプラグインフォルダ(wp-content-plugins)に、展開されたファイルをディレクトリごとアップロードします。
管理者画面ではてな記法プラグインを有効にします。
管理者画面ではてな記法設定画面を開き、Perlのパスや環境変数など必要事項を設定します。

インストール手順(linux)

さくらインターネットのスタンダードプラン共用サーバの例

これまでにさくらインターネットの共用サーバにCPANでモジュールをインストールしたことがない、もしくはCPANとはそもそも何？という人は、Perlモジュールを共用サーバにインストールための前準備が必要です。

参考サイト：CPANで自分のホームディレクトリ内にモジュールをインストールやGoogleで見つかるリンクなどを参考に、設定してください。
Text::Hatena 0.16 のインストール、もしくは Text::Hatena 0.20に「スーパーpre記法パッチ」を当てる場合は、vimエディタとそのPerlモジュールのインストールが必要です。

さくらインターネットのスタンダードプランには vim はインストールされていませんので、独自に導入します。

本家からソースをダウンロードしてインストールします。
```
~ $ cd local/src
~/local/src $ wget ftp://ftp.vim.org/pub/vim/unix/vim-7.1.tar.bz2
~/local/src $ tar jfx vim-7.1.tar.bz2
~/local/src $ cd vim71
~/local/src/vim71 $ ./configure --prefix=/home/jack/local --enable-multibyte
~/local/src/vim71 $ make && make install
```
次に、Text::VimColor Perl モジュールをインストールします。
```
~ $ cpan install Text::VimColor
```
Perl に Text::Hatena モジュールをインストールします。
Text::Hatena 0.20 なら
```
~ $ cpan install JKONDO/Text-Hatena-0.20.tar.gz
```
Text::Hatena 0.16 なら
```
~ $ cpan install JKONDO/Text-Hatena-0.16.tar.gz
```
です。

おそらくインストール中に他のモジュールをインストールするか聞いてきます。すべてインストールしてください。

なお、私の環境では Text::Hatena 0.16のインストールで最後の test が失敗してインストールされずに終わりました。テスト失敗の内容をざっと見ると、アマゾンの商品情報取得内容がモジュールの書かれた当時の内容と異なるためのようだったので、テスト結果を無視してインストールするようにしました。

Text::Hatena 0.20に「スーパーpre記法パッチ」を当てる場合、
```
~ $ patch ~/perl/lib/Text/Hatena.pm < ~/www/wordpress/wp-content/plugins/hatena-formatter/superpre/Hatena.pm.20.superpre-syntax.patch
```
とします(パスはお使いの環境に合わせてください)。
```
~ $ cpan
cpan[1]> force install JKONDO/Text-Hatena-0.16.tar.gz
```
はてな記法プラグインの.zipアーカイブをダウンロードし、展開します。
WordPressのプラグインフォルダ(wp-content-plugins)に、展開されたファイルをディレクトリごとアップロードします。
管理者画面ではてな記法プラグインを有効にします。
はてな記法プラグインの設定画面を開き、Perl設定を適切に設定します。

Perlへのパス：

/usr/local/bin/perl

引数：

「Text::Hatena 0.16用デフォルト引数」または
「Text::Hatena 0.20用デフォルト引数」

Perl用環境変数：

PERL5LIB=/home/jack/perl/lib
PATH=/home/jack/local/bin:/usr/bin:/bin
(PERL5LIBの値は各自のCPAN設定によります。
PATHはText::Hatena 0.16もしくはText::Hatena 0.20にスーパーpre シンタックスハイライトパッチを当てた場合は必須になります。値は vim/text-vimcolor と sh コマンドがおかれているディレクトリをコロン(:)区切りで指定します。)

Windows XP & xampp の場合

xamppサイトから、「xampp Windows版」と、「XAMPP Windows版アドオン」「Perl 5.x.x」をダウンロードし、インストールします。
Text::Hatena 0.20 をインストールします。
xampp環境のPerlにText::Hatenaをインストールを参考にしてください。
はてな記法プラグインの.zipアーカイブをダウンロードし、展開します。
WordPressのプラグインフォルダ(wp-content-plugins)に、展開されたファイルをディレクトリごとアップロードします。
管理者画面ではてな記法プラグインを有効にします。
はてな記法プラグインの設定画面を開き、Perl設定を適切に設定します。

Perlへのパス：

C:\xampp\perl\bin\perl.exe

引数：

「Text::Hatena 0.20用デフォルト引数」

Perl用環境変数：

PERL5LIB=C:\xampp\perl\site\lib
(値は各自のCPAN設定によります。)

コンテンツ表示高速化設定

はてな記法プラグインはWordPress組み込みのキャッシュ機能をサポートしています。キャッシュ機能を利用すると、投稿やコメントの表示処理が早くなる場合があります。

具体的な動作は次の通りです。

投稿の作成および修正後、初めて表示する時のみ「はてな記法処理」を行い、処理結果をキャッシュに保存
同じ投稿を次回以降表示する時は、「はてな記法処理」を省いてキャッシュに保存した内容を取り出して表示

なお、WordPress組み込みキャッシュ機能はデフォルトで無効になっています。

有効にするには、wp-config.phpでENABLE_CACHE定数を有効にします。

<?php
...
define('ENABLE_CACHE', true);              // キャッシュを有効にする

define('ABSPATH', dirname(__FILE__).'/');
require_once(ABSPATH.'wp-settings.php');

また、キャッシュの有効期限はデフォルトで900秒です。短すぎると思われる場合は、CACHE_EXPIRATION_TIME定数を定義することで変更できます。

<?php
...
define('ENABLE_CACHE', true);              // キャッシュを有効にする
define('CACHE_EXPIRATION_TIME', 31536000); // １年

define('ABSPATH', dirname(__FILE__).'/');
require_once(ABSPATH.'wp-settings.php');

なお、一般に公開されているプラグインの中にはキャッシュを考慮していないものがあります。一緒に動作させるには、該当のプラグインに手を加えるか、キャッシュを無効にしてください。

制限事項

はてな記法で投稿やページを作成する場合、リッチエディタ機能は自動的に無効になります。
“本家はてな日記”で使用できる記法の中には「はてな記法プラグイン」では機能しないものもあります。おおよそText::Hatenaモジュール自体がサポートしていないためであり、それらについて「はてな記法プラグイン」としてはよほど切実な理由でもない限りそのまま放っておきます。

不具合報告や改善要望など

メールか、もしくは「はてな記法プラグイン」サポートサイトにてお知らせください。なおサポートサイトは近日中に公開します。

During The Prime Hacking Hours

概要