ExtraFields Plugin ReadMe.htmlの邦訳

ExtraFields Plugin/Hack for Movable Type

• Download/Other Plugins
• ExtraFieldsについて
  • 必要条件
  • 動作
  • 注意点
  • 将来的な計画
  • 連絡先
• インストール
  • 1) ExtraFields関連ファイルのインストール
  • 2) テーブルの定義を決める
  • 3) Configuration情報の記述
  • 4) CMS.pmの変更
  • 5) edit_entry.tmplの変更
  • 6) 動作確認
  • 7) トラブルシューティング
• このプラグインで使えるタグ
  • MTExtraFields
  • MTIfExtraFields
  • MTIfExtraField
  • MTExtraFieldsLoop
  • MTExtraFieldValue
  • MTExtraFieldLabel
• Version History

EXTRAFIELDSについて

多くのMovable Type ユーザーは、各エントリーに登録できる項目(fields)の数を追加したいと願っています。将来的には、公式にその様な機能が追加されるかもしれません。このプラグインは、そのような項目を簡単に追加できるMovable Typeが出てくるまでの、間に合わせの手段です。これは、追加情報を保存する１つ以上のMySQLテーブルを作成して、１つのweblog上に独自の項目を定義することを可能にします（このプラグインはMySQLで作成しているMTのみ対応しています）

一部のユーザーは、MT内部の項目の定義を変更して、独自の項目を追加しています。こちらのページやこのスレッド、このスレッドをご覧下さい。しかし、この方法にはいくつか問題が生じます。

• MT独自のデータ構造を修正しなければなりません。これは、アップデートするときに問題の生じる可能性があります。ExtraFieldsはデータを保存するテーブルを追加し、この問題を避けています。（MT独自のテーブルを変更しない）
• MTのスクリプトソースを書き換えなければなりません。これも、アップデートするときに問題の生じる可能性があります。Extrafieldsも同じ問題を抱えていますが、私（作者）が、できる限りスクリプトを細かく簡単に更新し、新しいバージョンのMTが出た時にこのドキュメントも更新する様に努力します。
• どの様な変更をしても、１つのMTで作成されている全てのweblogに反映されてしまいます。ExtraFieldsでは、各weblogに異なる定義をした項目を定めることができます。

もしExtraFieldsを使うにあたって迷っているならば、他の選択肢としてBrad ChoateのKey Values pluginがあります。このプラグインは、既存のMTの項目（例えばExcerpt（概要）、もし実際に概要として使っていなければ）いずれにもkeysとvaluesを保存することができます。テンプレート上で簡単に特定のKeyの値を利用することができます。

要約すると、ExtraFieldsは決して完全な解決法ではありません（注意点をよく読んでください。）。また、導入に数段階必要です。しかし、もし独自の項目が本当に必要なら、ExtraFieldsは有効でしょう。

必要条件

• Movable Type 3.14 または 2.661. 実際には、ExtraFieldsは2.21より新しければ、どのバージョンでも動作するはずです。しかし、下記にある様に、CMS.pmとedit_entry.tmplでパッチを当てる部分が、3.14と（ついでに言えば）2.661での説明となっています。
• SQL database? ExtraFieldsは、Movable Typeのデータを格納するデータベースがMySQLまたはSQLベースの場合のみに対応していました。しかし、Berkely DBでも動作すると報告がありました。-下部のインストール手順のステップ2を省略するだけです。しかし私（作者）は自分では試していませんが。
• Direct database access. 独自の項目を格納するSQLデータベースのテーブルを作成しなければなりません。もし、お使いのサーバーでphpMyAdminの様な操作環境が利用できるならば、それで可能です。しかし、シェルでアクセス可能であることと、コマンドからにデータベースにアクセスする知識が必要です。また、SQLのテーブルをどのように定義するか基本的な知識も必要でしょう。

動作

ExtraFieldsで行われることは簡単です: 項目を追加したい各weblogに、entry IDのカラムをprymary keyとしてテーブルを作成し、必要な追加項目用カラムを作成します。そのweblogに、追加項目のデータを加えたエントリーを作成したときに、追加したテーブルに同じentry IDの列が追加されます。（注：作成したテーブルを複数のweblogに関連付けることができます。この点は下記のインストールにてnumbingな詳細が記されています。）

追加項目のデータを書き込まなかったエントリーを作成・保存した場合、その追加したテーブルに列は追加されませんので注意してください。

エントリーを削除したとき、対応する行も削除されます。

注意点

ExtraFieldsをインストールする前に、以下に目を通してください。もしいずれかの点で赤信号が灯れば、ExtraFieldsは利用すべきではないかもしれません。

• ExtraFieldsを利用するには、Movable Typeのソースに変更を加えなければなりません。―ライブラリ中のモジュール１つと、CMSテンプレートの１つです。書き換えることに不安が無いか、よく考えてください。また、MTの新しいバージョンをインストールするときに、それらのファイルが更新された場合、再度パッチを当てなければなりません。（MTの最新バージョンに対応させる努力はします。）
• 現時点で、追加項目で保存されたデータは、MTの閲覧者用（？public）の検索では検索できません。
• プレビュー（確認）では正しく動作しません。 この点に注意してください。例えば、追加項目にデータが含まれるエントリーを書いているとします。そして プレビュー（確認）をクリックします。もしその確認ページでSave（保存）をクリックしたならば、問題はありません。しかし、もしRe-Edit（変更）をクリックすると、追加項目の変更は保存されません。プレビュー（確認）ページをどれほど拡張して利用するかにもよりますが、難点のひとつになるかもしれません。
• 追加項目は、データをエクスポートしたときに一緒にエクスポートされません。もし近い将来、サーバーの変更やデータベースをリストアする予定があるならば、ExtraFieldsの利用を2度考えなければなりません。他のMTデータベースと追加したテーブルを分けてエキスポート・インポートすることは難しくないかもしれませんが、相当のSQLに関する知識が必要になるでしょう。
• 最終的にMovable Typeに追加項目の機能が採用されたとき、おそらくExtraFieldsとは異なる方法でデータを保存することになるでしょう。よって、変換作業が必要になるでしょう。
• ExtraFieldsは現時点の形式では強健なものではありません。例えば、追加項目にデータを加えるときに検証しませんし、数的カラムに特別な処理をしている訳ではありません。 下部の将来的な計画を参照し、他の欠けている点と、なぜそのような状態にあるか確認してください。
• もしMovable TypeのソースコードやSQL,プラグインを書き換える自信、また、Movable Typeの作者によるサポートのないhacked-togetherな方法を使ってデータを保存することに自信がなければ、ExtraFieldsは使わないで下さい。

Other than that, Mrs. Lincoln, you'll love the play.

Future Plans

As emphasized above, ExtraFields is a stopgap measure, designed to tide us over until we have a version of MT or MT Pro that does custom fields natively. Meanwhile, adding more features would most likely add more steps to the already somewhat cumbersome installation process. For these reasons, it's not likely that ExtraFields will be improved much in the future. But to the extent that it does get updated (by me or by anyone else who'd like to work on it), here are some obvious enhancements that would be nice to have.

• Patch Search.pm so custom fields will be searched when the user searches for text in entries.
• Fix the Preview/Re-Edit problem.
• Create an interface within MT's CMS for editing the custom field configuration.
• Add the ability to specify a maximum length for a field, make a field required, specify that a field should be numeric, and other validation.
• Add the option to define a choice list for a field.
• Improve the interfaces to the ExtraFields modules, making them more object-oriented-esque-ish. The reason it's done the way it's done is to minimize the amount of code that needs to be hacked into CMS.pm, but there's probably a better way.

Contact

Please address questions, comments, bug reports, feature requests, interesting usage examples, etc., to mtplugins [AT] staggernation [DOT] com, or post them in the Plugin Development area of the Movable Type Support Forum.

インストール

1) ExtraFields関連ファイルのインストール

ExtraFieldsをダウンロードして含まれた3つのファイルを、MTのインストールディレクトリ内の正しい場所にアップロードしなければなりません。

• ExtraFields.plをpluginsディレクトリにアップロードする。もしpluginsディレクトリが無ければ、MTのメインディレクトリに作成する。
• ExtraFields.pmをextlibディレクトリにアップロードする。
• EFConfig.txtをextlibディレクトリにアップロードする。この構成（Configration）ファイルは、下記のstep 3で変更が必要なconfig情報のサンプルです。

EFDebug.plは、インストールの手順を終えた後、トラブルが生じたときにpluginsディレクトリにアップロードしてください。それ以外は必要ありません。（下記のトラブルシューティングを参照）

2) テーブルの定義を決める

項目を追加したいMTの各weblogに対して、MySQLにテーブルを加える必要があります。（実際は、同じ追加したテーブルを複数のweblogで利用することができます。詳細は下部のstep 3を参照のこと。）

テーブルと、そのテーブルのカラムの名前は重要です。初めに、端的に保存するデータを示す特有な短い名前を選んでください。ここでdatasourceとします。その場合:

• テーブルの名前はmt_datasource
• そのテーブルにはdatasource_idという名の整数（integer）のカラムを作成し、index化させる
• 追加するカラムの名前は頭にdatasource_と付ける

MTの既存のテーブルと衝突するので、以下の名前は使えません。mt_author, mt_blog, mt_category, mt_comment, mt_entry, mt_ipbanlist, mt_log, mt_notification, mt_permission, mt_placement, mt_template, mt_templatemap, mt_trackback, mt_tbping.

ひとつの例として、レストランのレビューのweblogを運営しているとします。各レストランの場所(location)・料理(cuisine)・平均価格(average meal price)・数字で表した評価(a numeric rating)のデータを保存したいとします。テーブルの定義は以下の様になります：

CREATE TABLE mt_restaurant (
    restaurant_id INTEGER NOT NULL,
    restaurant_location VARCHAR(100),
    restaurant_cuisine VARCHAR(40),
    restaurant_price VARCHAR(20),
    restaurant_rating TINYINT,
    INDEX(restaurant_id)
);

テーブルの定義を決定したらMySQLにログインしてテーブルを作成してください。

3) Configuration情報の記述

ExtraFieldsは、extlibディレクトリ内のEFConfig.txt、configurationファイルによって、weblogと追加したテーブルを関連付けます。あるひとつのweblogの追加項目のセットアップのフォーマットは以下の様になります:

blog_id:datasource
colname1:Column Label 1:lines
colname2:Column Label 2:lines

weblogのblog_idを確認するために、Movable Typeにログインし、そのweblogに関連するリンク（新しいエントリーを投稿・ウェブログの設定 etc.）をどれでも構わないのでクリックしてください。そのリンクのURLに目的のIDが&blog_id=7の様に含まれます。

"datasource"は上部のstep 2で選んだものです。―頭の"mt_"を省いたテーブルの名前です。

各"colname"は、追加したテーブルの、頭の"datasource_"を省いた各カラムの名前です。注：このリストにはidを含むカラムは加えないで下さい。

各"Column Label"は各項目を記述する名前(Label)となります。この名前(Label)がMTでエントリーを書くときに表示されます。また、ExtraFieldsのプラグインタグを利用するとテンプレートにも並ぶことになります。

"lines"の値はこの項目に書き込む部分の大きさに影響します。もし"lines"が1ならば、type="text"のinput要素が表示されます。"lines"が1より大きければ、その値分の行のtextarea 要素が表示されます。

7:restaurant
location:Location:1
cuisine:Type of Cuisine:1
price:Average Meal Price:1
rating:My Rating:1

CREATE TABLE mt_extra (
    extra_id INTEGER NOT NULL,
    extra_col1 VARCHAR(255),
    extra_col2 VARCHAR(255),
    extra_col3 VARCHAR(255),
    extra_col4 VARCHAR(255),
    extra_col5 VARCHAR(255),
    INDEX(extra_id)
);

3:extra
col1:Amazon URL:1
col2:Author:1
col3:Publisher:1
col4:Year:1
col5:Pages:1
-----
6:extra
col1:IMDb URL:1
col2:Director:1
col3:Releasing Company:1
col4:Year:1
col5:Length:1

</div>

<TMPL_IF NAME=DISP_PREFS_BASIC>

<TMPL_VAR NAME=EF_FIELDS>

		</tr>
		</TMPL_IF>

		</table>

		<TMPL_VAR NAME=EF_FIELDS>

<$MTExtraFieldsDebug$>

<MTEntries>
 <p><$MTEntryTitle$><br>
 <$MTEntryBody$>
 <MTExtraFields>
  <MTIfExtraFields>
   <p>ADDITIONAL INFORMATION:<br>
   <MTIfExtraField field="location">
    Location: <$MTExtraFieldValue field="location"><br>
   </MTIfExtraField>
   <MTIfExtraField field="cuisine">
    Type of Cuisine: <$MTExtraFieldValue field="cuisine"><br>
   </MTIfExtraField>
   <MTIfExtraField field="price">
    Average Meal Price: <$MTExtraFieldValue field="price"><br>
   </MTIfExtraField>
   <MTIfExtraField field="rating">
    My Rating: <$MTExtraFieldValue field="rating"> of 4 stars<br>
   </MTIfExtraField>
  </MTIfExtraFields>
 </MTExtraFields>
</MTEntries>

<MTEntries>
 <p><$MTEntryTitle$><br>
 <$MTEntryBody$>
 <MTExtraFields>
  <MTIfExtraFields>
   <MTExtraFieldsLoop>
    <p>ADDITIONAL INFORMATION:<br>
    <MTIfExtraField>
     <$MTExtraFieldLabel$>: <$MTExtraFieldValue$><br>
    </MTIfExtraField>
   </MTExtraFieldsLoop>
  </MTIfExtraFields>
 </MTExtraFields>
</MTEntries>