MDL-14493 First checkin of Feedback module into HEAD.
[moodle.git] / mod / feedback / README.txt
1 Feedback-Module
2 ===============
3 Overview
4 --------
5 The Feedback-Module is intended to create individual surveys in an easy way.
7 This module consists of two parts
8 a) the "activity" feedback (required)
9 b) the "sideblock" feedback (optional)
11 The activity is the main part an can run without the block. Here you can create, fill out or analyse the surveys.
12 The sideblock is an optional part. It works as a bridge between different courses and
13 an central placed feedback-activity. So you can create one feedback on the main site of moodle and then publish
14 it in many courses.
16 Requirements
17 ------------
18 Moodle 1.9 or later
20 Installation 
21 ------------
22    The zip-archive includes the same directory hierarchy as moodle
23    So you only have to copy the files to the correspondent place.
24    copy the folder feedback.zip/mod/feedback --> moodle/mod/feedback
25    and the folder feedback.zip/blocks/feedback --> moodle/blocks/feedback
26    The langfiles normaly can be left into the folder mod/feedback/lang.
27    The only exception is the feedback-block. The langfile is block_feedback.php and
28    have to be copied into the correspondent lang folder of moodle/moodledata.
29    All languages should be encoded with utf8.
31 After it you have to run the admin-page of moodle (http://your-moodle-site/admin)
32 in your browser. You have to loged in as admin before.
33 The installation process will be displayed on the screen.
34 That's all.
36 using the block-feature
37 -----------------------
38    1. create one or more new feedback-activitys on the moodle main-site
39    2. go into some course and enable the feedback-block. This block now shows the feedbacks from the main-site.
40    3. login as student and go into the course where the feedback-block is enabled
41    4. fill out the feedback chosen from block
42    5. login as admin and look at the feedback you created above
43    6. now you can analyse the answers over the courses
45 good luck
51 CHANGELOG
52 =========
54 04.04.2008
55 - the heading has not supported multilang strings
57 03.04.2008
58 - anonymous feedback was send the userid on email-notification
59   (http://tracker.moodle.org/browse/CONTRIB-355)
60 - users can not see the own values if there are chars like single-(') or doublequotas (")
62 08.03.2008
63 - admin users now respect capability-setting
64   (http://tracker.moodle.org/browse/CONTRIB-321)
66 17.12.2007
67 - resolved issue http://tracker.moodle.org/browse/CONTRIB-231
69 03.12.2007
70 - changing the table feedback_template, field public -> ispublic, public is reserved in oracle
71 - resolved issue http://tracker.moodle.org/browse/CONTRIB-95
73 16.09.2007
74 - changing access.php, removed the lines with coursecreator, added some RISK_xxx
75 - removed the check of legacy roles on has_capability()
76 - coursesearch now use unicode characters
78 13.09.2007
79 - updated edit.php to make the output more xhtml 1.0 strict like
81 11.09.2007
82 - Update feedback settings has help showing wrongly
83 - Menu on "Add question to activity" should be sorted alphabetically
84 - missing "Add Pagebreak" is now at the item-list
85 - no hardcoded css
86 - use new print_header() (note it only is available on moodle 1.9!!!)
87 - missing sesskey checks in feedback
88 - uninitialised $filename when importing into feedback
90 31.07.2007
91 - fixed bug with missing numbers after xml Question-Import.
93 29.07.2007
94 - added "require_course_login()" in view.php
95 - added missing langstring "no_itemname"
97 25.07.2007
98 - now defined in applicable_formats() to hide the block in moodle My-Site
100 07.07.2007
101 - all functions in lib.php now are with comments in phpdoc-style
102 - removed all depricated function-calls
103 - some code-styling changes (http://docs.moodle.org/en/Coding)
105 06.07.2007
106 - Adding some missing lang-strings
107 - fixing some notice-messages with $SESSION-lstgroupid
108 - excelexport now uses the localwincharset from langconfig.php
109     Now it is possible to export excel with utf8. But to many data will crash the excel
110     file. If the excefile crashes so you switch to latin-export in lang-settings
111 - adding the default permission CAP_ALLOW to the legacy-role:user for the capabilities view and complete
113 24.06.2007
114 - fixed excel-problem with tempfiles
115 - added new field "idnumber" into excel detailed report
117 21.06.2007
118 - better support for xhtml
120 09.05.2007
121 - items now are classes
122 - most of forms use formslib
123 - gui now uses tabs
124 - new item "captcha"
125 Now it only runs on Moodle 1.8 or later
127 09.05.2007
128 - added two columns (random_response,anonymous_response) to feedback_complete and feedback_complete_tmp
129 - userids now will be logged even if the feedback is anonymous so you now can filter by group
130 - excelexport now use pear so cell-values can be greater then 255 chars
131 - logs now include the cm->id
133 16.01.2007
134 - the installation now uses the install.xml
135 - roles are full implemented
136 - now radiobuttons and checkboxes can be aligned horizontally or vertically
137 - now you can insert pagebreakes
138 - a feedback what is switch to the next page is saved temporary. the user can cancel the completion and later continue at the last filled page.
139 - now you can ex-/import feedbacks into/from a xml-file
140 - course-reseting is supported
142 01.01.2007
143 happy new year!
145 14.09.2006 21:22
146 improve the layout of analysis (thanks to Katja Krueger)
148 02.06.2006 21:22
149 several bugfixes
150 improve the block "feedback"
152 20.05.2006 01:00
153 adding the block "feedback" to publish feedback over all courses
154 Thanks to Jun Yamog!
156 21.04.2006 16:00
157 version 2006042102
158 adding moving behavior like moodle activities
159 adding a dropdownlist on create/update item page to adjust the position
161 21.04.2006 16:00
162 version 2006042101
163 prefixed all function-names like "feedback_"
164 fixed security issues (e.g. optional_variable() >> optional_param())
165 improve group-feature
167 03.01.2006 16:00
168 Added "addslashes" and "stripslashes_safe" for preserving (')
170 03.10.2005 13:00
171 action handling error recovery improved (failed when debug=false)
172 function feedback_action_handler() argument list changed
173 added action handler debug modes: silent, normal, verbose
175 30.09.2005 00:00
176 version 2005300900
177 action handling functions added
178 picture item (an example for action handling added)
179 XHTML compliance improved
180 number of PHP Notify-level errors reduced
181 source code transferred to CVS
183 14.09.2005 00:20
184 fixed problem with restoring
185 new feature user-tracking (prevent multiple_submit)
186 new feature deleting of some completeds
188 22.08.2005 19:12
189 fixed problem with secureforms-option
191 16.08.2005 14:07
192 fixed html-syntax in edit.php
194 12.08.2005 21:38
195 fixed problem with IE
196 If feedback is not anonym now guest is it not allowed to fill it out
198 11.08.2005 22:00
199 added email-notification
200 anonymous feedbacks can be filled out by anonymous users
202 03.08.2005 01:20
203 item specific functions were moved into the items-librarys
204 now developers can create individual feedback-items
205 javascript based filling-control was replaced by php-based control
207 version = 2005072000
208 20.07.2005 01:09
209 adding group-ability
210 fixed missing bcmod()-Function-Problem
211 fixed referer-problem under https