Movable Type プラグイン 「TODO」について

簡単な説明

おもにTODOコメントの出力に特化させたテンプレートタグです。

テンプレートタグ内容を、コメントとして出力して、かつ、コメント先頭に"TODO: " の文字を含めます(TODOコメント)。

一行コメント向けにファンクションタグを、ブロックタグは、複数行コメント向けとして用意しています。

出力のときに、言語にあわせたコメント書式が使えるように、type 属性を設けました（後述）。

提供されるタグ

ファンクションタグ

<$MTTodoNote$>

ブロックタグ

<MTTodo>

使用例

ファンクションタグの場合

<$mt:TODONote note="xxxのyyyをxxxxする"$>

出力

<!-- TODO: xxxのyyyをxxxxする -->

ブロックタグの場合

<mt:TODO type="#">
 xxxのyyyをxxxxする
 コメント1
 コメント2
 ブログID <$mt:BlogID$>
</mt:TODO>

出力

# TODO:  xxxのyyyをxxxxする
# コメント1
# コメント2
# ブログID 2
#

使用可能な属性について

note

　　ファンクションタグで出力したい内容を書きます。

例： note="内容"

type

　　ファンクションタグ、ブロックタグ共通で使えます。

例： type="js"

使用可能な値

html
  HTMLのコメント(<!-- -->)として出力します。type属性省略のときはデフォルトとしてこのtypeとなります。

js
  JavaScript 用コメントです。
  ファンクションタグで使うと // TODO: という形です。
  ブロックタグでは　/* から　*/ で囲みます。
   
javascript
  js と同じです。

#
  コメントとして # を使用します。

perl
  #と同じです。
python
  #と同じです。
ruby
  #と同じです。

plain
  内容のまま出力します（TODO:も付与しません）。
  コメント書式が自動でなされないので、体裁を独自のものにしたい場合などに使います。

noprint
  内容を出力しません。MTIgnoreタグと同じ結果になります。

制限 / ライセンス

制限によって出力されない文字などがあります。

ダイナミック用は用意していません。

htmlコメントの関係で、連続ハイフンを除去するようにしています。

現在のところ、<>などをエスケープしています。

テンプレートデバッグ用途を想定しているので、ユーザー数の多い場合で利用は勧められません。

ライセンス

ライセンスは MIT Licenseとします。

ダウンロード

• markdiarycom/mt-plugin-todo

リポジトリ

• markdiarycom / mt-plugin-Todo -- Bitbucket

インストール

TODOフォルダをプラグインディレクトリ（plugins）にアップロードすれば、使用できる状態となります。プラグインの設定はありません。