COLUM

コラム

  • HOME
  • COLUM
  • MODX JOTを使ってコメント機能を付けてみる

MODX JOTを使ってコメント機能を付けてみる

MODX備忘録

2022/02/04

MODX JOTを使ってコメント機能を付けてみる

コラム記事にコメント機能を追加してみました！

だんだんと、Evolution CMSへと変わりつつあるMODXですが、やはりMODX Evolution日本語版（yamaさんにおんぶにだっこ版）は使い勝手がよく手放せません！

以前はあった説明サイトも日々減っているような気がします。このままでは、ますます利用者が少なくなってしまいますので、いろんな機能を備忘録ついでに掲載しています。

以前は、よく使っていたJOTですが迷惑書き込みなんかもあってすっかり使っていません。コメント機能Jotです。（下記はサンプルには承認制機能をON・コメント書き込みで管理者にメール通知ONとしています）

ダウンロード（本家）は、こちらです→ Jot 1.1.5 ダウンロード
↑本記事のコメントはこちらを使っています。

ダウンロード（日本版）は、こちらです→ Jot 1.1.6 ダウンロード

マニュアルが詳しいのですが、ロシア語です。→マニュアル

ちょっと日本語版はこちら。→マニュアル（この下にコメント欄）

JOTのスニペットコール

コメント機能を付けたいテンプレート（またはリソース）へ下記を記載します。

［Jot? &subscribe=`1` &pagination=`10` &moderated=`1` output=`1` &tplForm=`form` &canmoderate=`commentGp`］

※［ ］は半角に変換してください。

subscribe：　電子メールによる通知を有効にする
pagination：1ページのコメント数を10件とする
moderated：新しいコメントは公開しないとする
output：結果を表示します（省略可）
tplForm：コメント登録フォームのカスタマイズ用
canmoderate：メール通知を行うウェブグループ名

グローバル設定：グループ管理機能を使用「はい」
ウェブグループユーザーを作成しておく

※電子メールによる通知を有効としない場合は、グループユーザーを作る必要はありません。

　

主なパラメーター
&action - ディスプレイコントロール フォーマット: default | count-comments | count-subscriptions | comments | form
デフォルト値: default
注意
default - フォームとコメント
count-comments - コメント数
count-subscriptions - カウント購読数
例　&action=`count-comments`
&docid -ドキュメント・リファレンス フォーマット：文書ID
デフォルト値：親文書
例  &docid=`23`
&tagid - 同じdocidが2回使用される場合に使用するオプションのタグ フォーマット: 文字列 [A-Za-z0-9］
例  &tagid=`tag`
&subscribe - メール通知 フォーマット: 0 | 1
デフォルト値: 0
注意
0 - Eメールによる通知を無効にする。
1 - 電子メールによる通知を有効にする。
例  &subscribe=`1`
&moderated - コメントのモデレーション フォーマット: 0 | 1
デフォルト値: 0
注意
モデレーターは公開前にコメントを確認することができる
0 - 新しいコメントが公開される
1 - 新しいコメントは公開されない
例 &moderated=`1`
&notify - ウェブユーザー通知 フォーマット: 0 | 1 | 2
デフォルト値: 1
注意
ウェブグループはcanmoderateパラメータで指定する
0 = 通知しない
1 = 投稿されていない新しいコメントを通知
2 = すべての新しいコメントを通知
例 &notify=`2`
&subjectSubscribe - 購読者へのメール通知の件名 フォーマット: string
デフォルト値: none
例: &subjectSubscribe=``
&subjectModerate - モデレータに通知するメールの件名 フォーマット: 文字列
デフォルト値: none
例: &subjectModerate=``
&captcha - CAPTCHAコードを使う フォーマット: 0 | 1 | 2
デフォルト値: 0
0 = 無効1 = 有効2 = 有効、ただし未登録・未認証ユーザーに対してのみ有効
例 &captcha=`2`
&badwords - コメントで使ってはいけないフレーズのリスト フォーマット: フレーズのリスト | チャンク名
デフォルト値：なし
備考: カンマ区切りのフレーズリスト、またはチャンク名とフレーズリスト。bwパラメータと併用
例　&badwords=``
&bw - badwordsパラメータの悪い単語が検出されたときのアクション フォーマット: 0 | 1 | 2
デフォルト値：1
0 - 公開する1 - 公開しない2 - コメントを拒否する。
特別な場合、メッセージは永久に失われます。
例　&bw=`2`
&customfields - ユーザーに関する情報を持つ追加フィールドのリスト フォーマット: カンマ区切りの追加フィールド
デフォルト値: name,email
注：フィールドは追加テーブルに自動的に作成されます。デフォルト値は 「name,email 」です。(注意:カンマ区切りのリストにはスペースを入れてはいけません)
例　&customfields=``
&authorid - 著者ID フォーマット: author id
デフォルト値：コメントの作者
備考: デフォルト値はコメントの作者。
例　&authorid=``
&title - デフォルトのタイトル フォーマット：
デフォルト値：longtitle
備考: フォームのタイトルフィールドが空白の場合にコメント件名に使用されます。
例　&title=``
&css - テンプレートヘッダにスタイルを含める フォーマット：0｜1
デフォルト値：1
0 - <link rel="stylesheet" src="assets/snippets/jot/templates/jot.css" />をテンプレートヘッダの<HEAD></HEAD>タグに含めない。
1 - <link rel="stylesheet" src="assets/snippets/jot/templates/jot.css" />をテンプレートのヘッダーに含めます。
例 &css=`0`
&cssFile - サイトルートからのスタイルファイルへの代替パス。 フォーマット: ファイルパス
デフォルト値: assets/snippets/jot/templates/jot.css
例　&cssFile=``
&sortby - コメントを並べ替える フォーマット：コンマ区切りの条件リスト
デフォルト値：createdon:d
フィールド名：a - 昇順
フィールド名:d - 降順
例 &sortby=``
&numdir - コメントの追加順にソートする フォーマット: 0 | 1
デフォルト値: 1
0 - 一番下のコメント
1 - 一番上のコメント。
例 &numdir=`0`
&validate - フィールドが正しく記入されているかチェックする フォーマット
デフォルト値: content:コメントを入力するのを忘れています。
注意事項
構文 フィールド名:メッセージ(:バリデーション)
validationにフィールドが追加された場合、そのフィールドは必須になります。可能な値
数値
電子メール
正規表現
例
必須フィールド
MyRequiredField:このフィールドは必須です！
Eメール検証：
MyEmailField:入力されたメールアドレスが正しくありません:email
数値のチェック
MyNumberField:番地は数値でなければなりません。:number
要件の組み合わせ：
MyRequiredField:フィールドは入力されていなければなりません！,MyEmailField:入力されたメールアドレスが正しくありません。:email,MyNumberField:家屋番号は数値でなければなりません。:number
例
&validate=`MyRequiredField:このフィールドは必ず入力してください。,MyEmailField:入力されたメールアドレスが間違っています。:email,MyNumberField:番地は必ず数字で入力してください。:number`.
&guestname - 登録も認証もされていない匿名著者名。 フォーマット: 文字列
デフォルト値: anonymous
例 guestname=`ゲスト名`
&postdelay - 同じユーザーが次のメッセージを送信するまでに待つ秒数 フォーマット: seconds, 整数
デフォルト値: 15
例 postdelay=`10`
&pagination - 1ページのコメント数 フォーマット: number
デフォルト値: 0
注意
0 - 無効、全てのコメントを1ページに表示する(デフォルト値)
1 > 任意の数値
例 &pagination=`10`
&placeholders - プレースホルダーを追加する フォーマット: 0 | 1
デフォルト値: 0
注意
0 - プレースホルダは作成されない（デフォルト）
1 - デバッグ値ごとにプレースホルダが作成される（debugパラメータを参照）。
tagidが見つからない場合、プレースホルダは次のように作成されます：
[jot.html.form+]
tagidが見つかった場合、プレースホルダーは次のように作成されます：
[jot.html.form.tagid+]
例 &placeholders=`1`
&output - 表示結果 フォーマット: 1 | 0
デフォルト値: 1
0 - 結果を隠す（プレースホルダパラメータと併用可能）
1 - 結果を表示（デフォルト）
例 &output=`0`
&debug - デバッグ フォーマット: 0 | 1
デフォルト値：0
0 - 「hidden」 変数の出力を無効にする。(デフォルト)。
1 - 「hidden」 変数の出力を有効にする。
例 &debug=`1`の場合
&trusted - 信頼できるウェブグループのカンマ区切りリスト フォーマット: ユーザグループのリスト
注意: moderatedが1に設定されている場合、これらのグループからのユーザーコメントはデフォルトで公開されます。badwordsパラメータはこれらのグループには適用されません。
例 &trusted=``の場合
&canpost - コメントを投稿できるウェブグループのカンマ区切りリスト フォーマット: ユーザグループのリスト
備考: コメントを公開する場合は空白のままにする
例 &canpost=``
&canview - コメントを閲覧できるウェブグループのカンマ区切りリスト フォーマット: ユーザグループのリスト
注意: 一般公開する場合は空白にしてください。
例 canview=``
&canedit - コメントを編集できるウェブグループのコンマ区切りリスト フォーマット: ユーザーグループのリスト
注意: ユーザーがコメントを編集できないようにするには空白のままにしてください。
例 &canedit=``
&canmoderate - コメントをモデレートできるウェブグループのコンマ区切りリスト フォーマット: ユーザグループのリスト
例 &canmoderate=``
&notifyAuthor - 誰かがコメントを追加したときに作者に通知する フォーマット: 0 | 1
デフォルト値: 0
例 &notifyAuthor=`1`
&subjectAuthor - 作成者に通知するメールの件名 フォーマット: string
例 &subjectAuthor=``

　

テンプレート
&tplForm - コメントフォームテンプレートを追加する フォーマット: チャンク名
デフォルト値: chunk.form.inc.html
例　&tplForm=``
&tplComments - コメントテンプレート フォーマット: チャンク名
デフォルト値: chunk.comment.inc.html
備考: ページ上の各コメントに対して繰り返される
例　 &tplComments=``
&tplModerate - ブロックモデレーション用テンプレート フォーマット: チャンク名
デフォルト値: chunk.moderate.inc.html
注：このテンプレートはコメントに対して一度だけ使われます
例　&tplModerate=``
&tplNav - ナビゲーション用テンプレート フォーマット: チャンク名
デフォルト値：chunk.navigation.inc.html
注：このテンプレートはブロックの上部と部分に適用されます。
例 &tplNav=``
&tplSubscribe - 購読ブロックのテンプレート フォーマット: チャンク名
デフォルト値: chunk.subscribe.inc.html
例： &tplSubscribe=``
&tplNotify - メールで購読者に通知するテンプレート フォーマット: チャンク名
デフォルト値：chunk.notify.inc.txt
例　 &tplNotify=``
&tplNotifyModerator - モデレータへのメール通知テンプレート フォーマット: チャンク名
デフォルト値：chunk.notify.moderator.inc.txt
例　 &tplNotifyModerator=``.
&tplNotifyAuthor - 著者へのメール通知用テンプレート フォーマット: チャンク名
デフォルト値：chunk.notify.author.inc.txt
例　&tplNotifyAuthor=``
&cssRowAlt - 代替行の CSS スタイルクラス名 例 &cssRowAlt=``.
&cssRowMe - 現在のユーザー行の CSS スタイルクラス名 例　 &cssRowMe=``
&cssRowAuthor - 著者行の CSS スタイルクラス名 例　&cssRowAuthor=``

　

プレースホルダー

Jotのスニペット呼び出しページに以下のプレースホルダーを配置します
［+jot.html.navigation+］- 最初：ナビゲーション用にページ上に配置する
［+jot.html.comments+］- 2番目：コメント用のページに配置する
［+jot.html.moderate+］- 3番目：モデレーション用のページに配置する
［+jot.html.form+］- 4番目：フォーム用ページに設置

ブロックの順番は自由に変更できます。 ［+jot.html.form+］- 最初：フォームのページに配置する
［+jot.html.comments+］- 2番目：コメント用ページに設置
［+jot.html.moderate+］- 3番目：モデレーションのページに配置する
［+jot.html.navigation+］- 4番目：ナビゲーション用のページに配置

| 一覧へ |

CONTACT

 092-406-9941

受付 9:30～18:00（土･日･祝日除く）

お問い合わせフォーム LINE 

MEETING

福岡市近郊は
無料でお伺いします

九州