From d1d654ebac2d51e3841675faeb56480e440f622f Mon Sep 17 00:00:00 2001
From: Wolfgang Müller
Date: Tue, 5 Mar 2024 18:08:09 +0100
Subject: Initial commit

---
 docs/usage/reading.rst | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 docs/usage/reading.rst

(limited to 'docs/usage/reading.rst')

diff --git a/docs/usage/reading.rst b/docs/usage/reading.rst
new file mode 100644
index 0000000..f48e4c6
--- /dev/null
+++ b/docs/usage/reading.rst
@@ -0,0 +1,50 @@
+Reading
+=======
+
+The reader interface may be accessed by clicking on any comic page. The reader
+overlay will then open with the selected page in view. There are two metadata
+settings that affect the reader, **Direction** and **Layout**. The former
+adjusts reading direction and the latter determines how many pages are rendered
+at once.
+
+Navigation
+----------
+
+The reader is controlled with the mouse or the keyboard. When displaying a
+single page, clicking on the left side of the image will advance left, whilst
+clicking on the right side of the image will advance right. Similarly, when
+displaying two pages, clicking on the left image will advance left while
+clicking on the right image will advance right.
+
+Additionally, the following keyboard shortcuts are available:
+
++-------------+----------------------------------------------------+
+| Key         | Action                                             |
++=============+====================================================+
+| Left Arrow  | Advance left.                                      |
++-------------+----------------------------------------------------+
+| Right Arrow | Advance right.                                     |
++-------------+----------------------------------------------------+
+| Down Arrow  | Advance to the next page in reading direction.     |
++-------------+                                                    |
+| Page Down   |                                                    |
++-------------+                                                    |
+| Space       |                                                    |
++-------------+----------------------------------------------------+
+| Up Arrow    | Advance to the previous page in reading direction. |
++-------------+                                                    |
+| Page Up     |                                                    |
++-------------+                                                    |
+| Backspace   |                                                    |
++-------------+----------------------------------------------------+
+
+Editing when reading
+--------------------
+
+A comic may be edited in the reader interface by opening the edit menu in the
+top left corner or hitting ``z``. Changes to **Direction** and **Layout** will
+be visible in the reader right away, but will only persist if saved. This makes
+it easy to preview changes.
+
+Pending changes will not be lost when closing the reader interface - they can
+still be modified and saved in the normal *Edit* tab.
-- 
cgit v1.2.3-2-gb3c3