summaryrefslogtreecommitdiff
path: root/userdocs/study-settings.rst
diff options
context:
space:
mode:
Diffstat (limited to 'userdocs/study-settings.rst')
-rw-r--r--userdocs/study-settings.rst51
1 files changed, 51 insertions, 0 deletions
diff --git a/userdocs/study-settings.rst b/userdocs/study-settings.rst
new file mode 100644
index 0000000..a097072
--- /dev/null
+++ b/userdocs/study-settings.rst
@@ -0,0 +1,51 @@
+Study settings
+==============
+
+The scheduling algorithm shows cards according to the following principles:
+
+* New and scheduled cards are mixed together and shown randomly.
+* In order to scatter more the scheduled cards in time, the repetition interval is randomly adjusted by a small value. This prevents scheduling similar cards in exactly the same order as they were repeated.
+* Cards studied in one day are limited. The application shows a warning, when this limit is reached. The user may continue studying more cards after this warning.
+* New cards introduced in one day are limited in order not to burden the user too much. When this limit is reached, only the scheduled cards are shown.
+
+Certain parameters of the scheduling algorithm can be changed in :menuselection:`Options --> Study settings`. See figure below.
+
+.. figure:: images/settings/study_settings.png
+
+ Study settings
+
+
+The parameters are the following:
+
+.. versionadded:: 1.4.1
+ Added "Don't add new cards after scheduled cards threshold" parameter.
+
+.. versionadded:: 1.2.0
+ Added "Day starts at" parameter.
+
+.. csv-table:: Study parameters
+ :header: "Parameter", "Default value", "Description"
+ :widths: 14, 6, 50
+
+ "Day starts at, o'clock", 3, "At what time a new day starts to correctly count today's reviewed cards and shceduled cards for today."
+ "Share of new cards", 20%, "The share of new cards to show in comparison to all shown cards."
+ "Repetition interval randomness", ± 10%, "How much the repetition interval can be randomly adjusted by the algorithm. In percents of the absolute value of the interval."
+ "Add new cards in random order", yes, "Controls if new cards are taken in random order or in the same order as they appear in the dictionary."
+ "Day reviews limit", 80, "How many card reviews should be done per day. Just shows a warning, when this limit is reached."
+ "Day limit of new cards", 10, "Maximum number of new cards shown per day. When this number is reached, only scheduled cards are shown."
+ "Don't add new cards after scheduled cards threshold", 70, "New cards will not be added, if scheduled cards for today are too many. After this threshold is reached, new cards will not be shown."
+
+
+Language of user interface
+==========================
+
+By default, Fresh Memory uses the default language of the operating system (the system locale).
+
+The following translations are available: Czech, English, Finnish, French, German, Russian, Spanish, Ukrainian.
+
+.. versionadded:: 1.3.0
+ Language can be selected manually.
+
+It is possible to manually change the language in |Language icon| :menuselection:`Options --> Language` menu. The application must be restarted to use the changed language.
+
+.. |Language icon| image:: ../images/language.png