Works with MODx Version(s): 0.9.2.1, 0.9.2
Submitted: Oct 8th 2006 | License: GPL - GNU Public | Downloads: 826
This resource has been deprecated.

Description

Features:

* Add comments to your documents.
* Use multiple instances on one page
* Comments are stored in DB (added Jot tables)
* Pagination
* Use custom fields in your form
* Subscriptions (email notify on new posts)
* Email notifications for moderators
* Access control
* Moderation (publish/unpublish/delete)
* Anti-spam: Captcha validation
* Anti-spam: Post delay
* Anti-spam: Specify bad words and take specific action (do nothing, unpublish, reject)
* Output to placeholders
* Enhanced templating (ala PHx - not required)

Usage (examples):

[!Jot? &customfields=`name,email` &subscribe=`1` &pagination=`10`!]

Parameters:

• &action - default | count-comments | count-subscriptions
  default value is to show all (form + comments)
  


• &docid - document id
  Link comments to this document, defaults to parent document.
  


• &tagid - string [A-Za-z0-9]
  Extra tag to use when two instances use the same docid
  


• &subscribe - 0 | 1
  0 = disable subscriptions (default)
  1 = enable subscriptions
  


• &moderated - 0 | 1
  0 = new comments will be published (default)
  1 = new comments will be unpublished, so a moderator/manager user can review before publishing.
  


• &notify - 0 | 1 | 2
  Notify moderators specified by &canmoderate by email
  0 = do not notify
  1 = notify on new unpublished reply (default)
  2 = notify on every new reply
  


• &subjectSubscribe - string
  Subject for subscription notification email.
  


• &subjectModerate - string
  Subject for moderator notification email.
  


• &captcha - 0 | 1 | 2
  0 = disable captcha when posting. (default)
  1 = enable captcha when posting.
  2 = enable captcha when posting, but disable it for logged in users.
  


• &badwords - comma delimited list of words not allowed in post
  best practise is to create a chunk with bad words seperated by a comma and call Jot like &badwords=`{{MyBadwordsChunk}}` to allow central administration of your badwords list. Use the &bw parameter to specify the required action on detection.
  


• &bw - 0 | 1 | 2
  when a word specified by &badwords is detected:
  0 = do nothing
  1 = do not publish the comment (default)
  2 = reject the comment
  


• &customfields- comma seperated list of extra form fieldnames
  Using this command will save the specified fields when posting. The default templates require you to add "name, email" as custom fields.
  


• &guestname- string
  Name to use when none is specified.
  


• &postdelay - number of seconds between posts from the same user
  0 = disable the delay(default)
  1 > enable delay with specified number
  


• &pagination - number of comments per page
  0 = disable, show all comments on one page (default)
  1 > enable paging with specified number.
  


• &placeholders - 0 | 1
  0 = no placeholders are created (default)
  1 = placeholders are created for every debug value (see &debug parameter)
  
  if no tagid is specified the placeholders are created like this: [+jot.html.form+]
  if the tagid is specified the placeholders are created like this: [+jot.html.form.tagid+]
  
  
• &output - 0 | 1
  0 = hide output (can be used in combination with &placeholder parameter)
  1 = show output (default)
  


• &debug - 0 | 1
  0 = disable output of all jot variables (default)
  1 = enable output of all jot variables
  


• &authorid - id of topic author
  defaults to author value for the current document.
  


• &trusted - comma delimitted web groups
  comma delimitted web groups that are trusted and have their comments published by default when &moderated is set 1. Badwords also does not apply for trusted webgroups. Manager users are always trusted.
  


• &canpost - comma delimitted web groups
  comma delimitted web groups that can post comments. leave blank for public posting
  


• &canview - comma delimitted web groups
  comma delimitted web groups that can post comments. leave blank for public viewing
  


• &canmoderate - comma delimitted web groups
  comma delimitted web groups that can moderate comments. leave blank for no webuser moderation (moderation by using manager account)
  

Templates/Chunks:

• &tplForm
• &tplComments
• &tplModerate
• &tplNav
• &tplNotify
• &tplNotifyModerator
• &tplSubscribe
• &cssRowAlt
• &cssRowMe
• &cssRowAuthor

Extended MODx templating:

Jot uses an internal template handler that includes the functionality of the PHx plugin available from the repository. For more details on the modifiers check it's description here.

Note: Jot does not require that the PHx plugin is installed. If not installed PHx functionality will still be available for the Jot templates only.

Tips and Tricks:

Active identity:
When logged in as both web- and manager user your webuser identity will overrule your manager identity but your permissions will be the same. When logged in as a manager user you will always have moderator options.

Custom fields:
The custom fields you specify with &customfields will have to be added to your form chunk manually. The default templates holds an example of how a guest form looks like (added fields here are: name and email)

Bad words:
Bad words are checked on all input, including custom fields.

URL/Link generation:
All generated links by jot will preserve the current querystring and only the variables specific for the Jot instance are altered if necessary. This ensures that the current page state (that could be altered by other snippets on the same page) is preserved.

Instructions

Install:

1) Download and extract the archive.
2) Create a directory called "jot" in your [MODx Directory]/assets/snippets directory
3) FTP or copy the files into [MODx Directory]/assets/snippets/jot
4) Create a new snippet in the manager called "Jot" and copy/paste the contents of jot.snippet.txt into the code field.

Update:

1) Download and extract the archive.
2) Backup and delete the contents of [MODx Directory]/assets/snippets/jot
3) Copy the files into [MODx Directory]/assets/snippets/jot
4) Update the "Jot" snippet in the manager and copy/paste the contents of jot.snippet.txt into the code field.

Snippet call example:

[!Jot? &customfields=`name,email` &subscribe=`1` &pagination=`10`!]

or

[[Jot? &customfields=`name,email` &subscribe=`1` &pagination=`10`]]

Depending on your page cache settings.

Updates

Jot Beta 8

Addressed many issues reported in the support topic

- code cleanup
- changed: default templates
* xhtml validated
* removed javascript
* using phx conditionals for cleaner templates
* merged moderate comment template into comment template
- added: comment info to notify messages
- updated chunkie/phx
- changed: moderation views
* added mixed view (default)
* added CSS style for unpublished comments

important! because of the significant changes in the default templates you should edit your custom templates accordingly if any when updating.