summaryrefslogtreecommitdiff
path: root/userdocs/statistics.rst
diff options
context:
space:
mode:
authorJedidiah Barber <contact@jedbarber.id.au>2021-07-14 11:49:10 +1200
committerJedidiah Barber <contact@jedbarber.id.au>2021-07-14 11:49:10 +1200
commitd24f813f3f2a05c112e803e4256b53535895fc98 (patch)
tree601e6ae9a1cd44bcfdcf91739a5ca36aedd827c9 /userdocs/statistics.rst
Initial mirror commitHEADmaster
Diffstat (limited to 'userdocs/statistics.rst')
-rw-r--r--userdocs/statistics.rst42
1 files changed, 42 insertions, 0 deletions
diff --git a/userdocs/statistics.rst b/userdocs/statistics.rst
new file mode 100644
index 0000000..cc9539a
--- /dev/null
+++ b/userdocs/statistics.rst
@@ -0,0 +1,42 @@
+Cards statistics
+================
+
+.. versionadded:: 1.3.0
+
+It is possible to see detailed statistics of reviewed, scheduled and new cards. Select :menuselection:`Tools --> Statistics` in the menu (hotkey :kbd:`F7`) or click |Stats icon| :guilabel:`Statistics` tool button.
+
+.. |Stats icon| image:: ../images/statistics.png
+
+.. versionadded:: 1.4.0
+ Added the Study progress chart.
+
+The first page is |Study progress icon| :guilabel:`Study progress`. It shows a pie chart with reviewed cards, shceduled for today and new cards.
+
+.. |Study progress icon| image:: ../images/pie-chart-3d.png
+
+.. figure:: images/stats/stats_progress.png
+
+ Study progress
+
+
+|Studied cards icon| :guilabel:`Studied cards` page shows the number of cards reviewed on each day in the past. The right-most point is today, and previous days extend to the left.
+
+.. |Studied cards icon| image:: ../images/chart-past.png
+
+.. figure:: images/stats/stats_studied.png
+
+ Statistics of the studied cards
+
+By default, the displayed period is 1 week. The period can be changed with the :guilabel:`Period` combo box: 2 weeks, 4 weeks, 1 month, etc. The statistics is shown individually for each card pack. It is possible to select another card pack in :guilabel:`Card pack` combo box. The total number of reviewed cards in the selected period is shown at the very bottom of the window.
+
+Hovering the mouse over a point of the chart shows a tooltip with information about that particular day (or period): date and number of cards.
+
+.. figure:: images/stats/chart_tooltip.png
+
+|Scheduled cards icon| :guilabel:`Scheduled cards` page shows number of scheduled cards, i. e. cards to be reviewed in the future. The left-most point is today, and the following days extend to the right. This chart shows numbers of cards, which will be scheduled at the same time as today in the future days.
+
+.. |Scheduled cards icon| image:: ../images/chart-future.png
+
+.. figure:: images/stats/stats_scheduled.png
+
+ Statistics of the scheduled cards