XOOPS Themes and Templates Advent Calendar 2012の12日目の投稿です!
<- 前日:ブロックによって表示方法を変えるテーマの修正方法
-> 翌日: おたのしみに♪
0. xoops-watch-templateって?
XOOPSのモジュール開発で一番めんどくさい作業といえば、テンプレートの更新です。いちいち手動でモジュールアップデートを実行しないといけません。開発者仲間からどうにかならないの?と言われたので、テンプレート更新を検知したらモジュールアップデート自動でやってくれるコマンドラインツールを作りました。それが xoops-watch-template
です。
xoops-watch-template
はXOOPSのテンプレートの変更を検知して自動でテンプレートの更新をかけるコマンドラインツールです。モジュールのテンプレートファイルを変更することが多い開発者やデザイナなどのテンプレート編集者向けに作られました。めんどくさいテンプレート更新作業は xoops-watch-template
を使って楽ちんにしちゃいましょう!
1. 先達たち
テンプレートの自動更新を行う方法は、既に複数存在します。その先達たちにも触れておきます。
1.1 TemplateAutoUpdate
メリット
- プリロードといわれるファイルを置くだけでテンプレートの自動更新ができる
デメリット
- プリロードのPHPを書き換えないといけない
- d3モジュールに対応していない
入手先
1.2 ALTSYSのテンプレート自動更新機能
メリット
- 情報が多い
- d3モジュールの発案者が作っているだけあって、d3モジュールに対応している
デメリット
- mainfile.phpにプログラムを書かないといけない
- mainfile.phpを書き換えたのを消すのを忘れて本番環境でもムダなアップデート処理が走る
入手先
2. 先達とxoops-watch-templateの違い
xoops-watch-template は先達たちとは違うアプローチで作られています。先達たちはどちらかというと、XOOPS自体に細工を施して対応するという方法論でした。xoops-watch-templateは直接XOOPSに変更を加えなくていいようにデザインされました。そのため、xoops-watch-templateには先達たちにはない次のようなメリットがあります。
メリット
- XOOPSのプログラムを書き換えなくていい
- 設定の手間がない
- PHPを知らなくていい
もちろん、弱点もあります。xoops-watch-template はコマンドラインツールという点から、コマンドを使い慣れていない人には導入が難しいかもしれません。更に、Windows環境では使えないかもしれません。
3. xoops-watch-templateのインストール方法&使い方
ここでは、Mac(MacOSX Mountain Lion)でのインストール方法を解説します。
1 xoops-watch-templateをダウンロードします
xoops-watch-template.php を名前をつけて保存します。
2 「アプリケーション」→「ユーティリティ」→「ターミナル」を起動します。
3 php
とタイプしたあと、スペース (
) をタイプします
4 先ほどダウンロードした xoops-watch-template.php
ファイルをターミナルにドラッグ&ドロップします
5 テンプレート自動更新をしたいXOOPSのmainfile.phpをターミナルにドラッグ&ドロップします
6 enterキーを押せば、xoops-watch-template.php
が走り始めます
これで、あとはテンプレートを変更すれば、自動でテンプレートが更新されるようになります!
終了する場合は、ターミナルを閉じるか「Ctrl + C」を押します。
xoops-watch-templateプロジェクトページ: https://github.com/suin/xoops-watch-template