Commit 6f89a21b authored by OJ Random's avatar OJ Random Committed by Mario

Flashcards v2.01

parent 173f1b0d
This source diff could not be displayed because it is too large. You can view the blob instead.
This plugin is a [flashcard software](https://en.wikipedia.org/wiki/List_of_flashcard_software) that uses [spaced repetition](https://en.wikipedia.org/wiki/Spaced_repetition) as a learning technique.
This addon is a [flashcard software](https://en.wikipedia.org/wiki/List_of_flashcard_software) that uses [spaced repetition](https://en.wikipedia.org/wiki/Spaced_repetition) as a learning technique.
You can share the flash cards with other users of Hubzilla and ZAP.
......@@ -6,24 +6,41 @@ Your learning progress will be kept private.
<img src="/addon/flashcards/view/img/leitner-system.png" align="center" width="70%">
### In Praxis
### In Praxis - The School Example
The school and the students all have an account at Hubzilla or ZAP. The school has the Flashcards-Addon installed.
#### Introduction
Everybody could have an account on differnt hubs:
A school and its students all have an account at Hubzilla or ZAP. The school has the addon Flashcards installed. The URL is https://school.com/flashcards/school .
It is possible that the school and the students have accounts on different instances. let's say
- The school on https://school.com/
- A student on https://student.org/
The school has the addon installed at https://school.com/flashcards/school .
#### How to begin?
The school...
The school creates a box of flashcards "English-Italian" and possibly some more. The URL for "English-Italian" could be something like https://school.com/flashcards/school/xy12tlsel89q81o .
- opens the addon https://school.com/flashcards/school
- creates a box of flashcards "English-Italian". This box a available at for example https://school.com/flashcards/school/xy12tlsel89q81o
- adds title, description and some card.
- saves the box
- sends the URL to the student https://school.com/flashcards/school/xy12tlsel89q81o
The student learns "English-Italian" by opening https://school.com/flashcards/school/xy12tlsel89q81o .
The student wants to learn "English-Italian" and
- opens https://school.com/flashcards/school/xy12tlsel89q81o
- starts to learn
- saves the box
- can now continue to learn on all other devices by opening https://school.com/flashcards/school/xy12tlsel89q81o again
The school and the students can both change or add cards. The syncronization is done automatically as soon as they upload changes.
#### How to fix errors in the cards?
The school and the students can both add or modify cards. The syncronization is done automatically as soon as they upload (save) changes.
### Permissions and Technically
A student sees those flashcards only the school allows him to see. The student will get a copy of "English-Italian". For both users it looks the same, same URL, same content. Everything is done under the hood. The student does not own the flashcards. The school can withdraw the permissions for a student or even delete the flashcards at any time.
### Federation
It is not tested yet but should be available in the near future. If enabled a student will be able to use the addon without having an account at Hubzulla or ZAP as long as the account supports [ActivityPub](https://en.wikipedia.org/wiki/ActivityPub). Mastodon users have this for example. Stay tuned.
version: 1.2.2
version: 2.01
url: $baseurl/flashcards/$nick
requires: local_channel
name: Flashcards
......
......@@ -4,8 +4,8 @@ use Zotlabs\Extend\Route;
/**
* Name: Flashcards
* Description: Flashcard software that uses spaced repetition as a learning technique.
* Version: 1.2.2
* Description: Grandma style learning method that uses spaced repetition as a learning technique.
* Version: 2.01
* Author: Tom Wiedenhöft (ojrandom@protonmail.com)
* Maintainer: Tom Wiedenhöft (ojrandom@protonmail.com)
*
......
This diff is collapsed.
......@@ -98,14 +98,27 @@
<hr/>
</div>
</div>
<div class="row">
<div class="col-sm-10">
Restore all settings below to default values
</div>
<div class="col-sm-2">
<button class="btn" id="button_flashcards_settings_default"><i class="fa fa-mail-reply fa-lg"></i> Restore</button>
</div>
</div>
<div class="row">
<div class="col-sm-12">
<label><input type="checkbox" id="flashcards-switch-learn-directions"> Switch learn direction. </label>
<hr/>
</div>
</div>
<div class="row">
<div class="col-sm-12">
<label><input type="checkbox" id="flashcards-switch-learn-all"> Learn all displayed cards no matter wether due to learn or not. </label>
<label><input type="checkbox" id="flashcards-autosave"> Automatically upload changes (sync) </label>
</div>
</div>
<div class="row">
<div class="col-sm-12">
<label><input type="checkbox" id="flashcards-card-sort"> Show sortation </label>
</div>
</div>
<div class="row">
......@@ -114,11 +127,28 @@
</div>
</div>
<div class="row">
<div class="col-sm-10">
Restore all settings below to default values
<div class="col-sm-12">
<h4>How to learn</h4>
</div>
<div class="col-sm-2">
<button class="btn" id="button_flashcards_settings_default"><i class="fa fa-mail-reply fa-lg"></i> Restore</button>
</div>
<div class="row">
<div class="col-sm-12">
<hr/>
</div>
</div>
<div class="row">
<div class="col-sm-12">
<label><input type="checkbox" id="flashcards-switch-learn-directions"> Switch learn direction (sides of cards) </label>
</div>
</div>
<div class="row">
<div class="col-sm-12">
<label><input type="checkbox" id="flashcards-default-sort"> Always start to learn with first box (Leitner default)</label>
</div>
</div>
<div class="row">
<div class="col-sm-12">
<label><input type="checkbox" id="flashcards-switch-learn-all"> Learn all displayed cards no matter wether due to learn or not </label>
</div>
</div>
<div class="row">
......@@ -129,6 +159,7 @@
<div class="row">
<div class="col-sm-12">
<h4>Adapt the Learn System</h4>
<br>
</div>
</div>
<div class="row">
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment