MODxスニペットのJotで使用できるパラメータの説明。

今更、MODxでJotを使ってみようと思って、Let’s enjoy MODxさんのサイトを見たら、「しばらく閉鎖します」になっていた・・・。いつも頼りにしていたので一瞬、目が潤んでしまったが、これは、人に頼らず自分で調べるいい機会だ。神様が与えてくれた試練なんだ。そう自分に言い聞かせて、エキサイト翻訳を開いた。

インストール!

公式サイトのリソースページから、Jotをダウンロード。今回は1.1.4をダウンロード。そして解凍。FTPでファイルをアップしようとして、Jotが最初から入っていることに気付いた。

基本書式

[!Jot? &subscribe=`1` &pagination=`10`!]

もしくは、

[[Jot? &subscribe=`1` &pagination=`10`]]

通常は、キャッシュを無効にしたほうが良いと思います(ビックリマークのほうを使用)。

パラメータ

まだ途中だけど

パラメータ
説明
&action
  • default (form & comments)
  • count-comments
  • count-subscriptions
  • comments
  • form
コメント欄に表示する内容を指定します
&docid 任意のドキュメントID
指定することで、現在表示されているドキュメントではなく、別のドキュメントに対するコメント欄を表示することができます(通常は、何も指定せずに、現在表示されているドキュメントに対するコメント欄を表示します。)
&tagid 任意の英数字
同じドキュメント内に2つ以上のコメント欄を表示する時に、お互いを区別するためのIDです。
&subscribe
  • 0(デフォルト)
  • 1
サブスクリプションを使用するか。よくわからないけど、新しいコメントが投稿されたときに、メールで通知してくれる機能かな?
&moderated
  • 0(デフォルト)
  • 1
1にすると、管理者が承認するまでコメントが非公開になります。
&notify
  • 0
  • 1(デフォルト)
  • 2
1で非公開コメント、2で全てのコメントの新規投稿時に&canmoderateで設定した管理者にメールで通知します。
&subjectSubscribe 任意の文字
サブスクリプションのメールの件名
&subjectModerate 任意の文字
管理者に送る新規投稿時の通知メールの件名
&captcha
  • 0(デフォルト)
  • 1
  • 2
1でコメント投稿時にキャプチャ認証させる。2で、ログインしていないユーザーのみキャプチャ認証させる。
&badwords 任意の文字(複数ある場合はカンマ区切り)
NGワード(古い?)を指定できる。チャンクを指定することで、チャンク内にNGワードを書いておけて便利。
&badwords=`{{チャンク}}`
&bw
  • 0
  • 1(デフォルト)
  • 2
&badwordsで指定したNGワードがあった場合、0で何もせず、1で公開せず、2で投稿を拒絶します。
&customfields 任意の文字(複数ある場合はカンマ区切り)
コメント投稿時に、ここで指定された入力フォーム項目が保存されます。デフォルトはname(名前)とemail(メール)です。
&title 任意の文字
subjectが空の場合に使用されるタイトルを指定します。デフォルトは、カレントドキュメントのlongtitle。
&css
  • 0
  • 1(デフォルト)
0にすると、ヘッダーでJot用のcssを読み込まなくなる。
&cssFile CSSファイルのMODxルートからの相対パス
デフォルトは、assets/snippets/jot/templates/jot.cssです。
&sortby 例)fieldname:a
並び順を指定。基準となるフィールドネーム、コロンの後にa(昇順)かb(降順)を記述します。デフォルトはcreatedon:dです。
&numdir
  • 0
  • 1(デフォルト)
0にすると、最初のコメントが最も低い数になるように通し番号が付きます。 デフォルトではコメントの投稿日順で新しいものが上にくるので、ここを0にすると時系列とは逆に通し番号が振られることになります。
&validate fieldname:message (:validation)
(複数ある場合はカンマで区切る)
fieldnameで指定したフィールドを必須項目にします。また、validationで入力チェック形式が指定できます。フィールドが未入力もしくはチェックでエラーの場合にmessageを表示します。

validationの形式

  • number|数字かどうかチェックします
  • email|メール形式かどうかチェックします
  • 任意の正規表現|正規表現で独自のルールを指定できます
デフォルトは、”content:You forgot to enter a comment.”です。
&guestname 任意の文字
名前がない場合の表示名(デフォルト:anonymous)
&postdelay 任意の数字
(0で無効)
同じユーザーからの投稿を制限する時間を秒単位で指定できます。
&pagination 任意の数字
(0で無効)
1ページに表示するコメントの件数を指定します。デフォルトの0は、全件を1ページで表示します。
&placeholders
  • 0(デフォルト)
  • 1
&output
&debug
&trusted
&canpost
&canview
&canedit
&canmoderate
&notifyAuthor
&subjectAuthor

Let’s enjoy MODxさんのサイトも復活したみたいですし、まだ途中だけど放置します。