|
| 1 | +# Moodle Journal module |
1 | 2 |
|
2 | | -[](https://github.com/elearningsoftware/moodle-mod_journal/actions?query=workflow%3A%22Moodle+Plugin+CI%22+branch%3Amaster) |
| 3 | +[](https://github.com/elearningsoftware/moodle-mod_journal/actions?query=workflow%3A%22Moodle+Plugin+CI%22+branch%3Amaster) [](http://www.gnu.org/licenses/gpl-3.0) |
3 | 4 |
|
4 | | -# Moodle Journal module |
5 | | -- Documentation: http://docs.moodle.org/en/Journal_module |
6 | | -- Source Code: https://github.com/elearningsoftware/moodle-mod_journal |
7 | | -- License: http://www.gnu.org/licenses/gpl-2.0.txt |
8 | | - |
9 | | -## Install from git |
10 | | -- Navigate to Moodle root folder |
11 | | -- If you plan to use git submodules, then: |
12 | | - - **git submodule add -f https://github.com/elearningsoftware/moodle-mod_journal mod/journal** |
13 | | - - **cd mod/journal** |
14 | | - - [For Moodle 2.0 - 2.5 only] **git checkout MOODLE_XY_STABLE** (where XY is the moodle version, e.g: MOODLE_30_STABLE, MOODLE_28_STABLE...) |
15 | | -- If you are not using submodules, then: |
16 | | - - **git clone git://github.com/elearningsoftware/moodle-mod_journal.git mod/journal** |
17 | | - - [For Moodle 2.0 - 2.5 only] **git checkout MOODLE_XY_STABLE** (where XY is the moodle version, e.g: MOODLE_30_STABLE, MOODLE_28_STABLE...) |
18 | | -- Click the 'Notifications' link on the frontpage administration block or **php admin/cli/upgrade.php** if you have access to a command line interpreter. |
19 | | - |
20 | | -## Install from a compressed file |
21 | | -- Extract the compressed file data |
22 | | -- Rename the main folder to journal |
23 | | -- Copy to the Moodle mod/ folder |
24 | | -- Click the 'Notifications' link on the frontpage administration block or **php admin/cli/upgrade.php** if you have access to a command line interpreter. |
| 5 | +The Journal activity allows teachers to obtain student feedback or reflections on a specific topic. Students can edit and refine their entries over time, and teachers can provide private feedback and grades. |
| 6 | + |
| 7 | +- **Documentation:** [MoodleDocs: Journal Module](http://docs.moodle.org/en/Journal_module) |
| 8 | +- **Source Code:** [GitHub](https://github.com/elearningsoftware/moodle-mod_journal) |
| 9 | +- **Plugin Directory:** [Moodle.org](https://moodle.org/plugins/mod_journal) |
| 10 | + |
| 11 | +## Features |
| 12 | +* **Simple Interface:** A single page for students to write and refine their entry. |
| 13 | +* **Private:** Entries are visible only to the student and the teacher. |
| 14 | +* **Grading & Feedback:** Teachers can grade entries and provide feedback. |
| 15 | +* **Time Constraints:** Set availability windows (days/weeks). |
| 16 | +* **Mobile Support:** Fully compatible with the official Moodle Mobile App. |
| 17 | +* **Privacy API:** Full compliance with Moodle's GDPR privacy API. |
| 18 | + |
| 19 | +## Installation |
| 20 | + |
| 21 | +### Via Git (Recommended) |
| 22 | +1. Navigate to your Moodle `mod` directory: |
| 23 | + ```bash |
| 24 | + cd /path/to/moodle/mod |
| 25 | + ``` |
| 26 | +2. Clone the repository: |
| 27 | + ```bash |
| 28 | + git clone https://github.com/elearningsoftware/moodle-mod_journal.git journal |
| 29 | + ``` |
| 30 | +3. Log in to your Moodle site as an administrator and go to **Site administration > Notifications** to complete the installation. |
| 31 | + |
| 32 | +### Via Zip |
| 33 | +1. Download the zip file from the [GitHub Releases page](https://github.com/elearningsoftware/moodle-mod_journal/releases) or the Moodle Plugin Directory. |
| 34 | +2. Unzip the file. |
| 35 | +3. Upload the resulting `journal` folder to your Moodle `mod/` directory. |
| 36 | +4. Log in to your Moodle site as an administrator and go to **Site administration > Notifications** to complete the installation. |
| 37 | + |
| 38 | +## Compatibility |
| 39 | +This version is compatible with Moodle 4.0 and higher. |
| 40 | + |
| 41 | +## Credits |
| 42 | +* Originally developed by Martin Dougiamas. |
| 43 | +* Maintained by [Elearning Software SRL](http://elearningsoftware.ro). |
| 44 | +* Various community contributors. |
25 | 45 |
|
| 46 | +## License |
| 47 | +This program is free software: you can redistribute it and/or modify it under the terms of the **GNU General Public License** as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. |
0 commit comments