ふりがなエンジン (rubyEngine)

ふりがなエンジンとは…

「ふりがなエンジン」は、ルビつきの文字を画像として出力するPHPのライブラリです。

ルビを施したい部分には、ふりがなタグを用いて {ruby(漢字|ふりがな)} のように記述します。
また、簡単な禁則処理に対応しています。

レンダリングには、GDとFreeType2を使っています。したがって、GDとFreeType2が必要です。かつ、PHPからGDとFreeType2を実行できなければなりません。

開発記録

ソースのダウンロード

使い方

フォントディレクトリの指定

rubyEngine20.phpの以下の部分をお使いの環境に合わせて変更してください。

//フォントディレクトリを指定
DEFINE("FONT_DIR","/usr/share/fonts/ja/TrueType/");

PHPソースの例

<?php 
 //ふりがなエンジン読み込み
 require_once("./rubyEngine20.php");  

 //文字列
 $string="「ふりがなエンジン」は、ルビつきの{ruby(文字|もじ)}を{ruby(画像|がぞう)}として{ruby(出力|しゅつりょく)}するPHPのライブラリです。"; 

 $ruby=new rubyEngine; 
 $ruby->setSize(500,100); //幅、高さを指定(px)
 $ruby->setFont("A-OTF-KyokaICAPro-Light.otf"); //フォントを指定
 $ruby->setFontsize(14); //フォントのサイズを指定(px)
 $ruby->setRubysize(7); //ルビの大きさを指定(px)
 $ruby->setLinespacing(7); //行間を指定(px)
 $ruby->setOffset(3); //オフセットを指定(px)
 $ruby->setFontcolor(0,0,0); //フォントの色を指定 (R,G,B) 0～255の値
 $ruby->setBgcolor(255,255,255); //背景の色を指定 (R,G,B) 0～255の値
 $ruby->setCharset("UTF-8"); //文字コードを指定（今のところUTF-8のみの対応です）
 $ruby->setFiletype("PNG"); //ファイルタイプを指定
 $ruby->setString($string); //出力文字列
 $ruby->displayFt(); //表示
  
?>

システム要件

テスト環境のLinux, Apache2.x, PHP5.x, GD2.x, FreeType2.xでは正常に動作。
GD, FreeType2はバージョンが高いほど、きれいにレンダリングされるようです。
古いFreeTypeではOpenTypeが使えないかもしれません。

ふりがなタグの使い方

{ruby(漢字|よみがな)}
タグで括った部分がふりがなつきの文字になります。
例: {ruby(林檎|りんご)}
{sup(上付き)}
上付きの文字になります。
例: 彼は…と述べた{sup(注1）)}。 → 彼は…と述べた注1）。
{sub(下付き)}
下付きの文字になります。小さいフォントとしても使えます。
例: H{sub(2)}O → H2O

試してみる

* サンプル文字列はふりがなタグが挿入されていません。「一括変換」ボタンを押してから「作成する」を押してください。

px
px
px
px
px
px
ファイルタイプ
ルビ挿入 一括変換 クリア 下付き 上付き

(C) Takekatsu HIRAMURA.