Skip to content

Commit

Permalink
Merge branch 'release/1.2.2'
Browse files Browse the repository at this point in the history
* release/1.2.2: (60 commits)
  feat(version): increase version for new release (1.2.2)
  fix(multiple): multiple small bugfixes
  fix(coding style): multiple coding style changes
  fix(security): added sesskey() check for multiple actions (and done some chore)
  fix(view): fix for downloading entries
  fix(multiple): fix for backup api, events and js
  fix(version): increase version
  fix(entry): revert change for feedback format
  fix(multiple): multiple fixes and chore
  fix(annotations): sorting of annotations now uses absolute start positions
  fix(backup): processing new annotation properties
  feat(annotations): added loading overlay if annotations are not fully fetched
  chore(results): renaming file
  fix(annotations): fix for annotation mechanism
  feat(lang): updating language strings and readme
  feat(lang): updating and tidying language strings
  fix(db): fix for saving annotations in db and started updating and tidying language strings
  chore (renaming): renaming some plugin settings and emptying upgrade file
  chore (js): tidied up js files, divided methods into functional units and added license information
  chore (user preferences): margic user preferences are now sidewide and can be exported via privacy api
  ...
  • Loading branch information
Daniel Nolte committed Sep 12, 2022
2 parents 7c9f708 + c08c066 commit a2fd606
Show file tree
Hide file tree
Showing 78 changed files with 5,787 additions and 3,076 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,30 @@ this program. If not, see <http://www.gnu.org/licenses/>.

@copyright 2022 coactum GmbH

# margic #
This plugin is based on the official mod_diary Moodle plugin (v. 3.4.1) from AL Rachels (<https://moodle.org/plugins/mod_diary>) which itself is a fork of the mod_journal plugin (<https://moodle.org/plugins/mod_journal>). The mod_diary plugin code was widely rewritten in the making of this plugin.

The plugin also incorporates JavaScript Code from the Hypothesis project (<https://github.com/hypothesis/client>) which is released under the 2-Clause BSD License (<https://opensource.org/licenses/BSD-2-Clause>), sometimes referred to as the "Simplified BSD License".

It also uses JavaScript Code form the approx-string-match-js project (<https://github.com/robertknight/approx-string-match-js>) by Robert Knight wich is released under the MIT License (<https://opensource.org/licenses/MIT>).

# Margic #

## Description ##

Allows to annotate entries for various purposes (fork of mod_diary).
In the Margic activity, participants can create unlimited entries which can then be evaluated and annotated by teachers.

Margics can be used in a meaningful way in language lessons, for example. Students can create entries to answer variable tasks, write their own texts and stories, or practice vocabulary.

Teachers can then view, correct and evaluate these entries on a customizable overview page. For this purpose, they can mark specific text passages and write annotations for them, whereby an error type and a short text can be stored for each annotation. The entire entry can also be graded and provided with textual or acoustic feedback. Participants then have the opportunity to revise their original entry and use the feedback received to improve it.

The available error types for the annotations can be flexibly adjusted. In an error summary, instructors can also evaluate for each participant how many and which errors they made in a Margic. Finally, it is also possible to export or print the entries in a Margic for further use.

Core features of the plugin:

- Write and revise multimedia entries.
- Individually customizable overview page with all (own) entries available in Margic
- Extensive possibilities for annotation and evaluation of entries for teachers
- Customizable error types and detailed error evaluation

## Quick installation instructions ##

Expand Down
12 changes: 10 additions & 2 deletions amd/build/annotations.min.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion amd/build/annotations.min.js.map

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions amd/build/highlighting.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions amd/build/highlighting.min.js.map

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions amd/build/match-quote.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions amd/build/match-quote.min.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit a2fd606

Please sign in to comment.