Skip to content

Commit e7b3fc7

Browse files
TamaroWalterTamaroWalter
authored
New readme
Updated the README to improve clarity and organization, including installation instructions and core features.
1 parent 8c8dd66 commit e7b3fc7

File tree

1 file changed

+54
-67
lines changed

1 file changed

+54
-67
lines changed

‎README.md‎

Lines changed: 54 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,61 @@
11
# ![moodle-mod_groupmembers](pix/icon.png) Activity Module: Moodleoverflow
22

3-
[![Coverage Status](https://coveralls.io/repos/github/learnweb/moodle-mod_moodleoverflow/badge.svg?branch=master)](https://coveralls.io/github/learnweb/moodle-mod_moodleoverflow?branch=master)
3+
The Moodleoverflow activity provides users the ability to create discussion forums that are not strictly linear or chronological.
4+
It has similarities to the Moodle _forum_, but it is more intended for question-and-answer style discussions and provides additional features that support meaningful interaction. Moodleoverflow features
5+
are highly customizable to ensure that it fits the needs of all users. A Moodleoverflow instance represents a forum that contains multiple discussions with posts.
46

5-
This plugin enables Moodle users to create a non-linear, non-chronologic discussion forum.
6-
The plugin has similar features as the Moodle forum, but is not intended for general discussions, but rather for straightforward question-and-answer discussions.
7-
Additionally, users can rate posts and gain a rating score ("reputation") by being rated by other users.
8-
Users who have started a discussion can mark a post as helpful, and teachers can mark a post as a (correct) solution to the posed question.
7+
## Installation
8+
Clone the content into `{your/moodle/dirroot}/mod/moodleoverflow` and complete the installation in
9+
_Site administration > Notifications_ or run `$ php admin/cli/upgrade.php` in your cli.
910

10-
This plugin is developed by Kennet Winter, [Tamara Gunkel](https://github.com/TamaraGunkel), and [Jan Dageförde](https://github.com/Dagefoerde)
11-
and is maintained by Learnweb (University of Münster).
11+
## Core features
12+
The main features of Moodleoverflow are the *rating and reputation system*, *subscription and read tracking*, the *anonymous mode* and *other forms of moderation*.
1213

13-
## Installation
14-
This plugin should go into `mod/mooodleoverflow`. Upon installation, several default settings need to be defined that pre-configure future instances of this activity (see [Settings](#settings)).
15-
16-
## Rating
17-
If a post is rated up or down, the post owner's rating score increases or decreases. The rating score of a user is always shown after the user name.
18-
In the settings, you can define what amount of reputation a downvote or upvote gives.
19-
Posts with a high score are displayed further up than posts with a lower score.
20-
If a post is marked as helpful or solved, the post owner's rating score also increases. By default, a mark gives a higher amount of reputation than an upvote.
21-
A marked post is always displayed first, but you can choose which mark (solved or helpful) is more important.
22-
23-
## Screenshots
24-
Moodleoverflow activity:<br><br>
25-
<img src="https://user-images.githubusercontent.com/432117/31946828-26b0b968-b8d3-11e7-9f99-e1434d7a60d8.png" width="500">
26-
<br><br>
27-
28-
Every user can see the discussions and the posts.
29-
The discussion overview shows the status, among other things. Thus users can see if a discussion is already solved (green tick) or if a post is marked as helpful (orange tick).
30-
<br><br>
31-
<img src="https://user-images.githubusercontent.com/432117/31946826-26981d72-b8d3-11e7-9773-b6547ea9276f.png" width="500">
32-
<br><br>
33-
Posts can be marked as helpful (orange) by the question owner or as solved (green) by a teacher. The current post is marked blue.
34-
Additionally, everybody can vote posts up or down. The posts are ordered by the number of upvotes. The post owner's reputation increases if the post is upvoted and decreases if it is downvoted.
35-
Post owners can edit their posts until 30 minutes after posting. Teachers can edit and delete posts from everybody without time restrictions.
36-
<br><br>
37-
<img src="https://user-images.githubusercontent.com/432117/31946825-267c07d6-b8d3-11e7-8ae1-4f86ea375fd5.png" width="500">
38-
<br><br>
39-
Users can attach files. If a picture is attached, it will be displayed as an image. If another file type is attached, the file will be shown but not the content.
40-
<br><br>
41-
<img src="https://user-images.githubusercontent.com/432117/31946824-2660a64e-b8d3-11e7-879f-70fc5cd2fc98.png" width="500">
42-
<br><br>
43-
A discussion can be deleted by deleting the first post.
44-
45-
### Students' view
46-
Unlike teachers, students can't edit or delete a post or mark it as solved.
47-
<br><br>
48-
<img src="https://user-images.githubusercontent.com/432117/31946823-2646aece-b8d3-11e7-92d0-49745ada27e3.png" width="500">
49-
<br><br>
14+
### Rating and reputation system
15+
Like in _Stackoverflow_, users can rate posts with up- and downvotes, which rank the posts in a discussion. Additionally, the user that started the
16+
discussion can mark posts as _"helpful"_(orange) and course teachers can mark a post as _"solution"_(green).
17+
18+
If enabled, Moodleoverflow tracks the users activity within a single course with a *reputation* score. Activities like voting or getting upvotes and helpful/solution marks
19+
increase the reputation, while downvotes decrease it. A user's reputation is displayed when they write a post. Detailed explanation as well as instructions on how
20+
to tailor the reputation system to your own needs can be found [here](https://github.com/learnweb/moodle-mod_moodleoverflow/wiki/Documentation-for-administrators).
21+
22+
What a typical discussion looks like:
23+
24+
<img width="811" height="740" alt="lively_discussion" src="https://github.com/user-attachments/assets/11d2ab6a-e12a-470e-8666-dfcd5b3408e9" />
25+
26+
Moodleoverflow offers the ability for teachers to show the user statistics for a single course. Teachers can then see which students are particularly active in Moodleoverflow forums:
27+
28+
<img width="1510" height="398" alt="userstats" src="https://github.com/user-attachments/assets/528bd76b-9967-43d7-b597-fc7f6107bb9e" />
29+
30+
<br>
31+
32+
### Subscription and read tracking
33+
Users can subscribe to individual discussions or entire forums to receive notifications via email. Teachers have the ability to enforce subscriptions for important forums.
34+
Moodleoverflow can track unread discussions and display a visual hint. All users can control their personal moodleoverflow settings in the overview:
35+
36+
<img width="843" height="269" alt="overview" src="https://github.com/user-attachments/assets/7eb3ee9f-5227-4922-96dd-0d2b37176c67" />
5037

38+
A forum with unread posts:
39+
40+
<img width="796" height="318" alt="unread_posts" src="https://github.com/user-attachments/assets/25d459d1-62ec-413c-950b-0931d9b938d7" />
41+
42+
<br>
43+
44+
### Moderation options
45+
Teachers can restrict certain features in a forum. With the *anonymous mode* certain users (the discussion starter or all users) are anonymous within a forum. This can motivate users
46+
to interact with other students and increase their activity in discussions. Especially in Q&A this can be an ice breaker.
47+
48+
<img width="817" height="587" alt="anonymous_forum" src="https://github.com/user-attachments/assets/bd5c273b-c371-4a10-b9b8-694f32ddfb79" />
49+
50+
51+
If teachers want to limit the time users can post replies, the *limited answer mode* can be activated when creating a moodleoverflow. The teacher sets a time frame in which
52+
the students can write posts. This can be used to collect questions before answers are allowed, or to enforce a posting deadline.
53+
54+
---
5155
## Settings
52-
### Global
53-
In the global settings, you can set e.g. the number of discussions per page, the maximum attachment size, or read tracking.
54-
In addition to these settings which are the same as in the forum, you can define the amount of reputation a vote or mark gives.
55-
<br><br>
56-
<img src="https://user-images.githubusercontent.com/432117/31946822-262bb664-b8d3-11e7-88fd-1a400864f8aa.png" width="500">
57-
<br><br>
58-
59-
### Course wide
60-
In the course settings you can override a few settings like maximum attachment size or read tracking.
61-
Moreover, you can decide if helpful or solved posts are displayed first and how the reputation is calculated.
62-
<br><br>
63-
<img src="https://user-images.githubusercontent.com/432117/31946820-260d778a-b8d3-11e7-9425-2af44f00e716.png" width="500">
64-
<br><br>
65-
If read tracking is set to "optional" and turned on by the students, the unread posts are highlighted.
66-
<br><br>
67-
<img src="https://user-images.githubusercontent.com/432117/31946819-25f2e5b4-b8d3-11e7-88b7-97b80f159a2d.png" width="500">
68-
<br><br>
69-
70-
### Students
71-
Depending on the global and course settings students can choose if they want to track posts and receive email notifications.
72-
<br><br>
73-
<img src="https://user-images.githubusercontent.com/432117/31946818-25c4c3aa-b8d3-11e7-88f6-891f1db51618.png" width="500">
74-
<br><br>
56+
57+
The global settings allow administrators to enable or disable core features or to set the boundaries of what the teachers can customize in the local settings.
58+
With the local settings in each moodleoverflow teachers can specify the use case of a forum and make use of the core features A detailed explanation of the settings can be found [here](https://github.com/learnweb/moodle-mod_moodleoverflow/wiki/Documentation-for-administrators)
59+
60+
---
61+
This plugin was initially implemented by Kennet Winter and is further developed and maintained by the [Learnweb development team](https://github.com/learnweb) (University of Münster)

0 commit comments

Comments
 (0)