tonyair/silverstripe-comments
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-comments synced 2024-06-18 10:41:37 +02:00
Code Issues Projects Releases Wiki Activity

Update docs. Remove todo.md, see github issues for todo list now.

Browse Source
This commit is contained in:
Will Rossiter 2012-07-22 13:29:33 +12:00
parent f382617e59
commit 41f3c61718
3 changed files with 8 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,7 +1,5 @@
# Comments
NOTE: this is alpha and not designed for production just yet. Please see the TODO.md file for remaining issues.
## Maintainers
* Will Rossiter (Nickname: willr, wrossiter)
@ -9,18 +7,16 @@ NOTE: this is alpha and not designed for production just yet. Please see the TOD
## Introduction
This module provides a commenting functionality for Pages and other DataObjects. It replaces the built in
commenting functionality with a more flexible plug and play version.
This module provides commenting functionality for Pages and other DataObjects
on your SilverStripe site.
For more documentation about the module see the docs/ folder.
For more documentation about the module see the provided documentation located
inside the docs folder.
## Requirements
* SilverStripe Trunk
* SilverStripe 3.0
## Installation
See docs/en/Installing.md
If you are upgrading from 2.4 or older releases please run a /dev/build after installing
the module

15
TODO.md
View File

@ -1,15 +0,0 @@
# TODO
The module is still very much in development. I have published it simply as a proof of concept
of the new API. Feel free to recommend changes.
## Things to do.
* Merge Simon Welsh's jQuery work for page comments back in.
* Check comment moderation
* Rework CommentAdmin to ensure it still works
* Test enabling comments on more than 1 instance per page
* Test enabling comments on a dataobject
* Migration Scripts
* Testing
* Documentation

6
docs/en/Installing.md
View File

@ -24,13 +24,13 @@ where you want comments to appear.
To enable commenting on other objects (such as your own subclasses of DataObject) add the following
to your `mysite/_config.php` file.
// Adds commenting to the class Foo
Commenting::add('Foo');
// Adds commenting to the class SiteTree (all Pages)
Commenting::add('SiteTree');
You can also pass configuration options to the add function to customize commenting on that object. Again
in your `mysite/_config.php` file replace the previous line with the following
// Adds commenting to the class Foo but requires you login and comments
// Adds commenting to the class SiteTree (all Pages) but require the user to login and comments
// are moderated
Commenting::add('Foo', array(
'require_moderation' => true,