印刷用表示へ切り替え 通常表示へ切り替え 更新履歴を表示 更新履歴を隠す
Plugin テンプレートタグの解説ページへのリンク

MTOS 4/MT 4 では,テンプレートで使っているタグについては,解説しているドキュメントへリンクされるようになった。自作プラグインの場合,リンク先は「help_url」で指定する。

■ ■ ■

環境は Movable Type Open Source 4.1 である。

管理画面のドキュメントリンク


MTOS 4/MT 4 では,管理画面の右サイドバーに「ドキュメントリンク」が表示され,その中にテンプレート内で使用されているタグの一覧が表示されるようになった。プラグインのタグを使っていれば,それもこの中に表示される。便利だが,画面書き換えの度にテンプレートをスキャンするため,管理画面の表示が重たくなる原因にもなっている。残念ながら,グローバルモディファイアは表示されない。

自分でプラグインを作って登録した場合でも同様で,テンプレートの中でそのタグを使うと,そのタグの解説ページに自動的にリンクされる。

自作プラグインの場合,リンク先はプラグインの中で指定する。レジストリ登録の際に「help_url」としてリンク先を指定すればよい (テンプレートタグのリファレンス URL の登録 | Movable Type 4 ドキュメント)。リンク先としては,「%t」という変数が使える。プラグインの中に書いた %t は,テンプレートタグを dirify して,先頭の「mt」を取り除いたものに置換されて管理画面からリンクされる。dirify というのは,すなわち,「タグ名がすべて小文字に変換された文字列」に置き換わるということである。

dirify というのは,「dir 化」すなわち,ディレクトリ内のファイル名として問題なく表示できるように変換することを意味している。与えられた文字列を,英小文字と数字とアンダースコアに変換することになる (dirify | グローバル・モディファイアリファレンス)。さらには dirifyについて考えてみた。 - Ogawa::Memoranda が詳しい。

この help_url を指定しない場合でも,タグは表示される。そして,リンク先は Google の検索になる。例えば,拙作の nlog(n) - リダイレクタ追加プラグイン であれば,追加されるタグは <MTAddRedirector> なので,リンク先は次のようになる。

http://www.google.com/search?q=mtaddredirector

これはうまい実装である。明示的に指定すれば,指定したサイトへのリンクとなり,指定しなければ検索になる。ドキュメントが整備されていなくても,誰かが話題にしていれば何らかの情報が得られることになるからだ。

Posted by n at 2008-05-01 22:26 | Edit | Comments (0) | Trackback(0)
Trackbacks

  • 「手違いで複数トラックバックを送ってしまった!」という場合でも気にしないでください (重複分はこちらで勝手に削除させていただきます)
  • タイムアウトエラーは,こちらのサーバの処理能力不足が原因です (詳細は トラックバック送信時のエラー をご覧ください)
  • トラックバックする記事には,この記事へのリンクを含めてください(詳細は 迷惑トラックバック対策 をご覧ください)
Comments
Post a comment
  • 電子メールアドレスは必須ですが,表示されません (気になる場合は「メールアドレスのような」文字列でもOKです)
  • URL を入力した場合はリンクが張られます
  • コメント欄内ではタグは使えません
  • コメント欄内に URL を記入した場合は自動的にリンクに変換されます
  • コメント欄内の改行はそのまま改行となります
  • 「Confirmation Code」に表示されている数字を入力してください (迷惑コメント対策です)


(必須, 表示されます)


(必須, 表示されません)


(任意, リンクされます)


Confirmation Code (必須)


Remember info (R)?