modules/topic/README.txt

$Id$

Copyright 2005 http://2bits.com

Description:
------------
        
This is a simple topic/answer module.

An user with the correct permission, usually an admin or a moderator,
posts topics on a web site. These are normally questions.
The user creating the node determines how many answers each user can
enter, and how many days the topic will remain open.

Users with the appropriate permissions then answer the topic. They
can also edit their answers, as long as the topic is still open.

After the defined number of days have passed, the topic and answers are 
formatted in an email and sent to the user who posted it, with the
profile fields of those who answered it.

The email is formatted to 72 columns, and the HTML tags are stripped.

Topics can be closed by the admin any time, before the specified number
of days have passed.

Although the current implementation is specific to the requirements of
one client (they wanted the results collated and emailed), I am releasing
this module because it can be a building block for more functionality.
For example, the answers can be "graded/rated" online, and the best 
answers published on the topic after it is closed. Many other variations
are possible.

Sponsored By:

http://humourauthority.com

Installation:
-------------

- Copy the topic.module file to the modules directory.

- Create the database table by running the topic.mysql script from
  phpmyadmin or mysql command line.

- Enable the module in Admin > Modules

- Grant permissions for creating topics, and answering topics as
  needed. Only registered users can answer topics.

- The following profile fields must be configured so that they are
  included in the email:

    profile_last_name
    profile_first_name
    profile_city
    profile_state

- In order for topics to be closed and sent by email, cron must be
  configured.

Author
------

Khalid Baheyeldin (http://baheyeldin.com/khalid and http://2bits.com)

If you use this module, find it useful, and want to send the author
a thank you note, then use the Feedback/Contact page at the URL above.

The author can also be contacted for paid customizations of this
and other modules.
1	$Id$
2
3	Copyright 2005 http://2bits.com
4
5	Description:
6	------------
7
8	This is a simple topic/answer module.
9
10	An user with the correct permission, usually an admin or a moderator,
11	posts topics on a web site. These are normally questions.
12	The user creating the node determines how many answers each user can
13	enter, and how many days the topic will remain open.
14
15	Users with the appropriate permissions then answer the topic. They
16	can also edit their answers, as long as the topic is still open.
17
18	After the defined number of days have passed, the topic and answers are
19	formatted in an email and sent to the user who posted it, with the
20	profile fields of those who answered it.
21
22	The email is formatted to 72 columns, and the HTML tags are stripped.
23
24	Topics can be closed by the admin any time, before the specified number
25	of days have passed.
26
27	Although the current implementation is specific to the requirements of
28	one client (they wanted the results collated and emailed), I am releasing
29	this module because it can be a building block for more functionality.
30	For example, the answers can be "graded/rated" online, and the best
31	answers published on the topic after it is closed. Many other variations
32	are possible.
33
34	Sponsored By:
35
36	http://humourauthority.com
37
38	Installation:
39	-------------
40
41	- Copy the topic.module file to the modules directory.
42
43	- Create the database table by running the topic.mysql script from
44	phpmyadmin or mysql command line.
45
46	- Enable the module in Admin > Modules
47
48	- Grant permissions for creating topics, and answering topics as
49	needed. Only registered users can answer topics.
50
51	- The following profile fields must be configured so that they are
52	included in the email:
53
54	profile_last_name
55	profile_first_name
56	profile_city
57	profile_state
58
59	- In order for topics to be closed and sent by email, cron must be
60	configured.
61
62	Author
63	------
64
65	Khalid Baheyeldin (http://baheyeldin.com/khalid and http://2bits.com)
66
67	If you use this module, find it useful, and want to send the author
68	a thank you note, then use the Feedback/Contact page at the URL above.
69
70	The author can also be contacted for paid customizations of this
71	and other modules.