MTSakuinPluginMTSakuinPluginはシックス・アパート株式会社が提供するブログ/CMSツールであるMovable Type用のプラグインです。
エントリーのキーワード欄に関連キーワードを登録することで、はてなダイアリーのようなキーワードリンクを自動で作成したり、本の索引のようなサイトマップページを作成することができます。
- 用語集サイトの短期構築
- 関連ページの自動表示
- 柔軟なキーワードリンクの自動作成
など、コンテンツ構築やサイトの利便性アップ、SEO対策といったビジネス効果を短期間で得られるプラグインです。
ライセンス体系およびリリース予定
MTSakuinPluginは現在開発中ですが、商用化を前提としています。
現在はβ版として評価目的または利益を伴わない個人的な目的でのみ利用できます。 正式リリース後にライセンスを購入するまで商用目的で利用できませんのでご注意ください。
正式リリース(バージョン1.00)は7月1日、価格はMovable Typeインストールあたり10,500円(税込)を予定しています。 リリース後もブログをはじめとする個人利用については無償で提供する予定です。
β版ダウンロード
現在β版をダウンロードできます。
ダウンロードおよびインストールをしてプラグインを利用する前に、利用規約を必ずお読みください。インストールして利用を開始した際は利用規約に同意したものとみなされます。
インストール
- ダウンロードしたファイルを解凍してください。
- Movable Typeをインストールしたディレクトリのpluginディレクトリに、Sakuinディレクトリを作成してください。
- sakuin.pl、libディレクトリを作成したplugins/Sakuinディレクトリにコピーしてください。
チュートリアル
キーワードの登録
- エントリーに関連するキーワードを登録するにはエントリーのキーワード欄を使用します。
- カンマ(,)区切りで複数のキーワードを登録できます。
索引用の読み仮名の登録
- 登録するキーワードにパイプ(|)を付けて、読み仮名を指定することができます。
- 読み仮名は索引を作成する場合に使用されます。キーワードリンクのみの使用では指定は不要です。
- 読み仮名を省略した場合はキーワードそのものが読み仮名として使われます。ひらがな、カタカナ、英数字のキーワードには不要です。
キーワードリンクの作成
- キーワードリンクを作成したいコンテンツを<MTSakuinKeywordLink>タグで括ってください。
- 次の例では、あるエントリーの本文でブログの全エントリーについての関連キーワードが使用されている場合、それを自動的にリンク付きキーワードに置き換えます。
キーワード一覧の作成
- キーワードとそのキーワードに関連するエントリーの一覧を作成する場合は、<MTSakuinKeywords>タグを使って次のようにテンプレートを記述します。
グループ化された索引の作成
- 本の索引のように頭文字によってキーワードをグループ化する場合は、<MTSakuinGroups>タグを使って次のようにテンプレートを記述します。
タグリファレンス
MTSakuinコンテナタグ
このプラグインを利用する範囲を<MTSakuin>～</MTSakuin>で括ってください。
- blog_id属性
- キーワードの索引を作成する対象ブログをIDで指定します。省略した場合は現在のブログのみが対象になります。同じMovable Typeインストール内であれば他のブログを指定することもできます。カンマ区切りで複数のブログを指定できます。
- group_file属性(0.7では未実装)
- 索引グループを変更する場合はサーバにグループファイルをアップロードし、この属性でそのパスを指定してください。絶対パスを指定するか、Movable Typeをインストールしたディレクトリを基点とする相対パスを指定してください。ファイルのフォーマットについてはファイルリファレンスを参照してください。
- phonetic_file属性(0.7では未実装)
- 読み仮名を一括で登録する場合はサーバに読み仮名ファイルをアップロードし、この属性でパスを指定してください。絶対パスを指定するか、Movable Typeをインストールしたディレクトリを基点とする相対パスを指定してください。ファイルのフォーマットについてはファイルリファレンスを参照してください。
MTSakuinKeywordLinkコンテナタグ
タグで括られた範囲にエントリーに関連づけられたキーワードが存在する場合、対応するエントリーへのリンクを張ります。キーワードに既にリンクが張られている場合はリンクを張りません。
- except_for_self属性(0.7では未実装)
- 現在のエントリーに関連するキーワードにはリンクを張らない場合は1を指定します。
- prefix_template属性(0.7では未実装)
- リンクを張るときに、キーワードの前方に付けられる文字列のパターンを指定します。$link(エントリーへのリンク)、$id(エントリーのID)、$title(エントリータイトル)が利用できます。<、>, "e;を使用する部分は[、]、'で代用してください。[、]、'を使用する場合は\[、\]、\'と記述してください(例: [a href='$link' target='_blank'])。
- surfix_template属性(0.7では未実装)
- リンクを張るときに、キーワードの後方に付けられる文字列のパターンを指定します。prefix_template属性と同様に扱うことができます。
- entry属性(0.7では未実装)
- firstまたはlastを指定します。キーワードに対して複数のエントリーが対応する場合、適用するエントリーを最初のものにするか最後のものにするかを指定できます。省略した場合はlastが適用されます。
- output属性(0.7では未実装)
- noを指定すると、タグで括った部分は表示されません。<MTSakuinGroups>や<MTSakuinKeywords>タグでrelatedを指定し、関連グループや関連キーワードのみを表示したい場合に併用します。通常は使用しません。
MTSakuinGroupsコンテナタグ
索引グループ(あ行、か行など)を列挙し、タグで括られた部分を繰り返します。
- groups属性
- used、all、relatedのいずれかを指定します。usedは全索引グループの中で実際にキーワードが使用している分のみを列挙します。allは未使用のグループも含めて全グループを列挙します。relatedを指定すると、直前に実行された<MTSakuinKeywordLink>タグでのキーワードリンクで使用されたキーワードのグループのみを列挙します。省略するとallが適用されます。
MTSakuinGroupsHeader条件タグ
索引グループを列挙して繰り返しを実行する際に、最初の1件についてのみ処理されます。
MTSakuinGroupsFooter条件タグ
索引グループを列挙して繰り返しを実行する際に、最後の1件についてのみ処理されます。
MTSakuinGroup値タグ
<MTSakuinGroups>タグによる繰り返しで現在対象となっている索引グループを表示します。
MTSakuinGroupCount値タグ
<MTSakuinGroups>タグによる繰り返しの回数を表示します。
MTSakuinGroupIndex値タグ
<MTSakuinGroups>タグによる繰り返しで現在処理している順番を表示します。
MTSakuinKeywordsコンテナタグ
キーワードを列挙し、タグで括られた部分を繰り返します。<MTSakuinGroups>タグの内部に記述された場合はそのグループに属するキーワードのみを列挙します。
- keywords属性
- used、relatedのいずれかを指定します。usedは使用されている全キーワードを列挙します。relatedを指定すると、直前に実行された<MTSakuinKeywordLink>タグでのキーワードリンクで使用されたキーワードのみを列挙します。省略するとusedが適用されます。
MTSakuinKeywordsHeader条件タグ
キーワードを列挙して繰り返しを実行する際に、最初の1件についてのみ処理されます。
MTSakuinKeywordsFooter条件タグ
キーワードを列挙して繰り返しを実行する際に、最後の1件についてのみ処理されます。
MTSakuinIfPhoneticIsDefferent条件タグ
現在処理しているキーワードとその読み仮名が違っている場合に処理されます。<MTElse>タグにより逆の場合の処理も記述できます。
MTSakuinKeyword値タグ
<MTSakuinKeywords>タグによる繰り返しで現在対象となっているキーワードを表示します。
MTSakuinPhonetic値タグ
<MTSakuinKeywords>タグによる繰り返しで現在対象となっているキーワードの読み仮名を表示します。
MTSakuinGroup値タグ
<MTSakuinKeywords>タグによる繰り返しで現在対象となっているキーワードの索引グループを表示します。
MTSakuinKeywordCount値タグ
<MTSakuinKeywords>タグによる繰り返しの回数を表示します。
MTSakuinKeywordIndex値タグ
<MTSakuinKeywords>タグによる繰り返しで現在処理している順番を表示します。
MTSakuinKeywordEntriesコンテナタグ
<MTSakuinKeywords>タグの内部で使用すると、現在のキーワードに関連するエントリーを列挙します。Movable Typeが標準で備えるMTEntriesとほぼ同様に利用することができ、<MTEntryTitle>や<MTEntryPermalink>といった値タグを利用できます。
- keywords属性
- used、relatedのいずれかを指定します。usedは使用されている全キーワードを列挙します。relatedを指定すると、直前に実行された<MTSakuinKeywordLink>タグでのキーワードリンクで使用されたキーワードのみを列挙します。省略するとusedが適用されます。
ファイルリファレンス
索引グループファイル(0.7で未実装)
索引グループを変更する場合は索引グループファイルを作成し、Movable Typeをインストールしたサーバにアップロードします。<MTSakuin>タグにおいてgroup_file属性でそのパスを指定します。ファイルの各行にはグループ名とその正規表現をパイプ(|)で区切って表記してください。
ファイルの文字コードはMovable Typeの内部文字コード(UTF-8)と統一してください。UTF-8での漢字同士の正規表現ができないため、下記の書き方に倣って文字コードによる記述をしてください。
キーワード読み仮名ファイル(0.7で未実装)
キーワードにパイプ(|)を使って読み仮名設定をする代わりに、テキストファイルによる一括指定も可能です。パイプを使った指定がない場合にはこちらが利用されます。
利用規約
現在はβ版につき、商用利用はできません。
ソフトウェアを利用する前にアイデアマンズ株式会社のソフトウェア利用規約をお読みください。利用規約に同意した上でご利用ください。
