Jot 1.0 Beta 6
Give your site users the opportunity to enter feedback on your articles. Add comments to articles, create guestbooks, you can even use multiple instances on the same page. Jot is the reincarnation of the former Replix snippet.
Submitted: Oct 2nd 2006 | License: GPL - GNU Public | Downloads: 680
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 (notify on new posts)
* 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:
default value is to show all (form + comments)
Link comments to this document, defaults to parent document.
Extra tag to use when two instances use the same docid
0 = disable subscriptions (default)
1 = enable subscriptions
0 = new comments will be published (default)
1 = new comments will be unpublished, so a moderator/manager user can review before publishing.
0 = disable captcha when posting. (default)
1 = enable captcha when posting.
2 = enable captcha when posting, but disable it for logged in users.
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.
when a word specified by &badwords is detected:
0 = do nothing
1 = do not publish the comment (default)
2 = reject the comment
Using this command will save the specified fields when posting. The default templates require you to add "name, email" as custom fields.
Name to use when none is specified.
0 = disable the delay(default)
1 > enable delay with specified number
0 = disable, show all comments on one page (default)
1 > enable paging with specified number.
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+]
0 = hide output (can be used in combination with &placeholder parameter)
1 = show output (default)
0 = disable output of all jot variables (default)
1 = enable output of all jot variables
defaults to author value for the current document.
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.
comma delimitted web groups that can post comments. leave blank for public posting
comma delimitted web groups that can post comments. leave blank for public viewing
comma delimitted web groups that can moderate comments. leave blank for no webuser moderation (moderation by using manager account)
Templates/Chunks:
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) Copy the files into [MODx Directory]/assets/snippets/jot (overwrite)
3) 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`!]
Known problems:
I expect some issues with the db-installer (triggers on first run) on different systems. If you get an error telling you some tables alreayd exist, comment out line 189 in jot.inc.php:
$this->_provider->FirstRun($this->_config["path"]);
Updates
- fixed: auto install tables always trigger
- fixed: if no custom fields in the database an error occurs when unpublishing.