エレメントのインストール方法について

スニペットやプラグイン、モジュールのインストールの仕方を例を挙げて説明します。

スニペットの導入

各スニペットによって、若干異なりますが、大まかなところは同じです。ここでは、比較的大きなスニペット「Maxigallery」を例にとって説明してみましょう。

たいていzip形式で圧縮されていますので、それを解凍します。Maxigallery0.5.2 の場合、以下のファイル構成になっています。

[MaxiGallery_0.5.2]

この作業はどのスニペットにも共通しています。MODx本（MODxでつくる！最強のCMSサイト）の p175～の説明と同じになります。

管理画面＞リソース＞リソース管理＞スニペット　と進む
「スニペットの新規作成」をクリックする
スニペット名に「MaxiGallery」と入力します。
- ※スニペット名は、任意のもので動作するものもありますが、原則として指定されたスニペット名を入力した方が間違いがないと思います。
「スニペットコード (php)」に「maxigallery.txt」の内容を貼り付け、保存します
- 「スニペットコード」に貼り付ける内容が書かれたファイル名は、スニペットによってまちまちです。「*.snippet.php」などとなっている場合もありますので、添付のドキュメントに従ってください。
外部リソースを必要としないスニペットの場合インストールはこれで完了です。

この作業は、外部リソースを必要とするスニペットの場合に必要な作業です。「Maxigallery」の様に大きなスニペットの場合、たいてい外部リソースを必要としますので、この作業が必要になります。

FTP で接続し、解凍ファイルのうち「assets」フォルダ以下をサーバー上の該当箇所にアップロードします。
「galleries」フォルダのパーミッションを777に変更します（phpSuExec環境の場合は「755」）。
- さくらインターネットの場合は上記の環境かどうかちょっとわからないんですが、「755」でOKです。
- 実際は、「maxigallery」の外部リソースは「assets/snippets/maxigallery」以下のファイルになります。「assets/galleries」フォルダには、Maxigallery でアップロードした画像が格納されていきます。

ドキュメントを新規に作成し、書式に従ってスニペットコールをします。

プラグインは、各プラグインによって、違いがあるので、添付のドキュメントを良く参照してください。ここでは、例として「Phx」の導入方法を解説します。

たいていzip形式で圧縮されていますので、それを解凍します。PHx2.1.2 の場合、以下のファイル構成になっています。

[PHx_2.1.2]

管理画面＞リソース＞リソース管理＞プラグイン　と進む
「プラグインの作成」をクリックする
プラグイン名に「PHx」と入力します。
- プラグイン名は、各プラグインで指定されたプラグイン名を入力してください。
「プラグインコード (php)」に「phx.plugin.txt」の内容を貼り付け、保存します
- 「プラグインコード」に貼り付ける内容が書かれたファイル名は、プラグインコードによってまちまちです。添付のドキュメントに従ってください。
「システムイベント」タブを開き、「OnParseDocument」にチェックを入れます
- どのシステムイベントにチェックを入れるかは、プラグインによって異なります。添付のドキュメントに従ってください。
「設定」タブを開き、「プラグイン設定:」に「&phxdebug=Debug;int;0 &phxmaxpass=Max. Passes;int;50」と入力します。
- 「パラメータ」に反映されます。値は意味は、wiki を参照してください
- なお、こちらの「設定」も、各プラグインによって異なります。添付のドキュメントを参照してください。
外部リソースを必要としないプラグインの場合インストールはこれで完了です。

FTP で接続し、「assets/plugins/」以下にフォルダを新規作成し、フォルダ名を「phx」とします。
- フォルダは、指定された場所、名前を間違わないように注意します。各プラグインのドキュメントを良く参照してください。
解凍したファイルのうち「phx.parser.class.inc.php」を１．で作成したフォルダにアップロードします