Index: openacs-4/packages/general-comments/www/doc/dev-guide.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/general-comments/www/doc/dev-guide.adp,v diff -u -r1.1.2.4 -r1.1.2.5 --- openacs-4/packages/general-comments/www/doc/dev-guide.adp 9 Jun 2016 13:03:12 -0000 1.1.2.4 +++ openacs-4/packages/general-comments/www/doc/dev-guide.adp 5 Jul 2016 16:52:02 -0000 1.1.2.5 @@ -1,14 +1,14 @@ -{/doc/general-comments {General Comments}} {Developer's guide} -Developer's guide +{/doc/general-comments {General Comments}} {Developer's guide} +Developer's guide
-

Chapter 1. Developer's +

Chapter 1. Developer's guide

1.1. Requirements Document

@@ -42,26 +42,26 @@ adding comments to objects in the system, and editing their own comments later on.

A user adding a comment:

Nurse Nancy is browsing through an ACS 4.0 site that has a page for medical emergencies. Upon reaching the bottom of the page, -Nancy sees a posting that reads, "Please help, -my child has just swallowed some cleaning solution!!!". Nancy -sees that this posting was made only 30 seconds ago and quickly -posts a remedy for this situation. After she makes her posting, she -immediately revisits the page and happily sees that her posting is -already available.

A user editing an old comment:

George Genius is reviewing all of the comments he has posted +Nancy sees a posting that reads, "Please +help, my child has just swallowed some cleaning +solution!!!". Nancy sees that this posting was made only +30 seconds ago and quickly posts a remedy for this situation. After +she makes her posting, she immediately revisits the page and +happily sees that her posting is already available.

A user editing an old comment:

George Genius is reviewing all of the comments he has posted over the last 24 hours. In one of his postings, George notices that his mathematical formula for earthquake prediction was incorrect. He then clicks on the edit link, makes changes to his formula and submits his changes. Since comments are moderated, others will only see his older incorrect version until his changes are approved. George eagerly awaits for his changes to be approved so that he -won't be ridiculed by his colleagues for his mistakes.

An adminstrator moderating:

Adam Admin is looking over all recently unnapproved changes to +won't be ridiculed by his colleagues for his mistakes.

An adminstrator moderating:

Adam Admin is looking over all recently unnapproved changes to comments. Adam sees that George Genius has made a correction to the earthquake prediction formula in which he helped write. He believes that the their original formaula is correct, so Adam does not approve of the changes. Several days later, George barges into -Adam's office wondering why his changes were not approved. After a -few hours George convinces Adam that the new modifications were -correct, and so Adam approves George's comment.

+Adam's office wondering why his changes were not approved. +After a few hours George convinces Adam that the new modifications +were correct, and so Adam approves George's comment.

1.1.8. Requirements: -Interface

The Community Member's Interface

The user interface for community members is a set of HTML pages +Interface

The Community Member's +Interface

The user interface for community members is a set of HTML pages that allow creation and editing of comments.

30.0 Customized presentation.

30.0.10 Show all comments that the @@ -109,7 +110,8 @@ 30.40 Provide a way to display attached images.

30.50 Allow download of attached -files.

The Administrator's Interface

The user interface for adminstrative members is a set of HTML +files.

The Administrator's +Interface

The user interface for adminstrative members is a set of HTML pages that allows deletion and approval of comments.

40.0 Customized presentation.

40.0.10 Show all created @@ -124,9 +126,9 @@

1.1.9. Revision History

-
Document -Revision #Action -Taken, NotesWhen?By +Document +Revision #Action +Taken, NotesWhen?By Whom?
0.2Revision12/11/2000Phong Nguyen