You are here

README.txt in Answers 7.4

Same filename and directory in other branches
  1. 5.2 README.txt
DESCRIPTION
============

This file gives a brief guide to the Answers Module, which provides a
question-answer service.

HOW IT WORKS
============

This module defines two content types, questions and answers related to
questions.

It defines views and page displays to work with them.

It offers a series of submodules that add:
- Answers_Notifications: Subscribing to questions and getting emails when new
answers are added
- Answers_Userpoints: Point system for questions and answers (via userpoints and
rules)
- Answers_Voting: Voting on questions and answers
- Best_Answer: Flagging of the best answer for a question (which is then shown
first)

TYPES OF USERS
============

There are 6 relevant roles (these are not drupal system roles but rather types
of users for the module):
1  Viewers: Those who view questions and answers
2  Question Authors: Those who ask a question.
3  Answer Authors: Those who answer a question
4  Site Administrator: Those who have the "administer settings" privilege and
who can set up the module
5  Site Developer: Those who code sites using modules
6  Module Developers: Those who want to create modules using the Answers
functionality

What the module does:
•  Question Authors can create new questions by going to the path
'node/add/question' (in this approach, users are taken directly to the new
question form)
•  Viewers can review a list of all questions. This is available at the path
'questions/'
•  When viewing the list of questions, Viewers can sort by author, title,
post date, and number of answers. If answers_voting is implemented, viewers
can sort by votes.
•  When displaying a question, the system shows all the answers to that question
•  When deleting a question, the system also deletes all of the answers to it.

Features that are coming (but have not yet be re-implemented in 7.x-4.x)
•  Question Authors can create new questions by going to the path
'questions/start_ask' (in this approach, users are asked to review questions
that match theirs first)
•  Viewers can review a list of questions that match a search query. This is
available at the path 'questions/search' [NOT YET RE-IMPLEMENTED]
•  Viewers can also see lists of questions they asked and they answered

HISTORY & KEY CONTRIBUTORS
============================

This module is based on:
•  The original D5 "answers" module written by Amanuel Tewolde.
•  The original D6 conversion of that module written by Inders Singh
•  The original features version of the module written by Greg Harvey
•  An updated features version of the module was written in 2011 by Chip Cleary.
•  Module reengineered (features removed) in Dec 2012 by Alessandro Mascherpa.

File

README.txt
View source
  1. DESCRIPTION
  2. ============
  3. This file gives a brief guide to the Answers Module, which provides a
  4. question-answer service.
  5. HOW IT WORKS
  6. ============
  7. This module defines two content types, questions and answers related to
  8. questions.
  9. It defines views and page displays to work with them.
  10. It offers a series of submodules that add:
  11. - Answers_Notifications: Subscribing to questions and getting emails when new
  12. answers are added
  13. - Answers_Userpoints: Point system for questions and answers (via userpoints and
  14. rules)
  15. - Answers_Voting: Voting on questions and answers
  16. - Best_Answer: Flagging of the best answer for a question (which is then shown
  17. first)
  18. TYPES OF USERS
  19. ============
  20. There are 6 relevant roles (these are not drupal system roles but rather types
  21. of users for the module):
  22. 1 Viewers: Those who view questions and answers
  23. 2 Question Authors: Those who ask a question.
  24. 3 Answer Authors: Those who answer a question
  25. 4 Site Administrator: Those who have the "administer settings" privilege and
  26. who can set up the module
  27. 5 Site Developer: Those who code sites using modules
  28. 6 Module Developers: Those who want to create modules using the Answers
  29. functionality
  30. What the module does:
  31. • Question Authors can create new questions by going to the path
  32. 'node/add/question' (in this approach, users are taken directly to the new
  33. question form)
  34. • Viewers can review a list of all questions. This is available at the path
  35. 'questions/'
  36. • When viewing the list of questions, Viewers can sort by author, title,
  37. post date, and number of answers. If answers_voting is implemented, viewers
  38. can sort by votes.
  39. • When displaying a question, the system shows all the answers to that question
  40. • When deleting a question, the system also deletes all of the answers to it.
  41. Features that are coming (but have not yet be re-implemented in 7.x-4.x)
  42. • Question Authors can create new questions by going to the path
  43. 'questions/start_ask' (in this approach, users are asked to review questions
  44. that match theirs first)
  45. • Viewers can review a list of questions that match a search query. This is
  46. available at the path 'questions/search' [NOT YET RE-IMPLEMENTED]
  47. • Viewers can also see lists of questions they asked and they answered
  48. HISTORY & KEY CONTRIBUTORS
  49. ============================
  50. This module is based on:
  51. • The original D5 "answers" module written by Amanuel Tewolde.
  52. • The original D6 conversion of that module written by Inders Singh
  53. • The original features version of the module written by Greg Harvey
  54. • An updated features version of the module was written in 2011 by Chip Cleary.
  55. • Module reengineered (features removed) in Dec 2012 by Alessandro Mascherpa.