拡張機能のインストールに用いるtplファイルについて

yama · 投稿記事 by **yama** » 2012年12月16日(日) 15:56

/**
 * ManagerManager
 *
 * 投稿画面を自由自在にカスタマイズ。
 *
 * @version 	0.3
 * @license 	http://www.gnu.org/copyleft/gpl.html GNU Public License (GPL)
 * @internal	@properties &config_chunk=Configuration Chunk;text;mm_rules;
 * @internal	@events OnDocFormRender,OnDocFormPrerender,OnBeforeDocFormSave,OnPluginFormRender
 * @internal	@modx_category Manager and Admin
 */

インストールベースファイル(tplファイル)は現在、上記のようなDocblockコメントでセッティング情報を記述することになっています。ここに書かれている内容をインストーラがレシピとして解釈し、各々インストールする仕組みになっています。

DocblockはPHPの関数の仕様を正確に表現する記述方法として一般化していますが、PHPの読み書きを得意としないユーザも多く、チャンクやテンプレートなど、PHPとは関係ないエレメントの管理はDocblockでは躊躇することが多いと思います。本家もちゃんとDocblockで書いているデベロッパーは少なく、現状としては活用されていません。
また、Docblock書式のパースは少し複雑なので、WordPressなどのように拡張機能やテンプレートを簡単・確実にインストールする仕組みを整備しにくいという不都合もあります。

コード: 全て選択

Name        : ManagerManager
Version     : 0.3
License     : GPL
Description : Customize the MODX Manager
Properties  : &config_chunk=Configuration Chunk;text;mm_rules;
Events      : OnDocFormRender,OnDocFormPrerender,OnBeforeDocFormSave,OnPluginFormRender
Category    : Manager and Admin
Text Domain : managermanager
Domain Path : languages/

コード: 全て選択

// japanese-utf8.inc.php(言語ファイル)の内容
$_lang['Customize the MODx Manager'] = '投稿画面を自由自在にカスタマイズ。';

シンプルに上記のように変更することを現在検討中です。
コード本文は、MODXらしく@CODEや@FILEなどで記述することも考えています。（省略時は@CODEとして扱う）