Page last modified 01:37, 5 Dec 2008 by MaxM
MindTouch Community Portal > MindTouch Community Portal > Documentation > MindTouch > Specs (Implemented) > Commenting
Table of contents
- 1. Abstract
- 2. Goals
- 3. Requirements
- 4. Configuration
- 5.
Enhancements for Lyons
- 5.1.1. API enhancements
- 5.1.2. Permission system
Abstract
Commenting allows registered users of a wiki to discuss a page's contents.
Goals
- Facilitate discussion of a page's contents
Requirements
- Do not allow HTML tags (yet)
- Can only be made by registered users
- Can be deleted by the commenter and any administrator
- When deleted, a placeholder comment is put into the comment list to prevent the "jump" of comment numbers
- Can only be edited by commenter
- When edited, the edited timestamp is displayed
- Appear in chronological order (oldest first)
- Only show X most recent comments, where X is defined by $wgCommentCount in Default/LocalSettings.php
- User has the option of viewing all comments on a page
- All functionality must work without Javascript being enabled
Configuration
| Config Key | Default Value | Description | Addtl notes |
| $wgCommentCount | 15 | Determines number of comments to display on initial page load | Setting to '0' disables commenting on the UI |
| $wgCommentCountAll | 10000 | Determines the number of comments to show when requesting 'ALL' comments | A high number is set in case there's a ridiculous number of comments so there's no timeouts from API or mySQL |
Enhancements for Lyons
Enhance the usability and discoverability of comments by allowing DekiScripts and the front end to more easily find relevant comments.
- (implemented) Return comments from a page as well as its descendant pages
- Return comments matching a text substring
- (implemented) Return comments from a given user
- Perhaps extend this to allow a list of users or usernames
- Comments from members of group(s) ??
- (implemented) Change default sort to date.created descending
- (implemented) Output using atom
API enhancements
-
GET: pages/{id}/comments
-
New query params:
-
?depth: Use 'infinity' to return comments from all descendant pages. (default: 0)
- ?postedbyuserid: Only return comments posted by the id of a user
- ?search: Comments containing the text
- ?format: xml or atom. (default: xml)
-
-
Permission system
Enforce new operation "COMMENT".
- Upgrade: Any role with operation READ gets COMMENT as well to preserve current behavior?
- Tag page (Edit tags)
- What links here
Files 2
| File | Size | Date | Attached by | |||
|---|---|---|---|---|---|---|
 | comment-1.png No description | 19.32 kB | 00:04, 26 Jun 2007 | RoyK | Actions | |
 | comment-2.png No description | 22.28 kB | 00:04, 26 Jun 2007 | RoyK | Actions | |
| Images 2 | ||
|---|---|---|
 |  | |
1) will search be done against lucene or the database? If we hit the db directly, we should index cmnt_content (which is a text column :( )
2) if search by user, we need to index cmnt_poster_user_id
3) at some point we really need the API to start caching feeds