summaryrefslogtreecommitdiffstatshomepage
path: root/docs/usage/shortcuts.rst
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/usage/shortcuts.rst114
1 files changed, 114 insertions, 0 deletions
diff --git a/docs/usage/shortcuts.rst b/docs/usage/shortcuts.rst
new file mode 100644
index 0000000..b3f88bb
--- /dev/null
+++ b/docs/usage/shortcuts.rst
@@ -0,0 +1,114 @@
+Shortcuts
+=========
+
+**hircine** supports a number of shortcuts that are meant to streamline a few
+common actions. Shortcuts may be made up of multiple keys. In that case, type
+them in order.
+
+.. _shortcut-navigation:
+
+Navigation
+----------
+
+.. list-table::
+ :align: left
+ :header-rows: 1
+
+ * - Shortcut
+ - Navigates to
+ * - ``go``
+ - Home
+ * - ``gc``
+ - Comics
+ * - ``gn``
+ - Namespaces
+ * - ``gt``
+ - Tags
+ * - ``gh``
+ - Characters
+ * - ``gw``
+ - Worlds
+ * - ``ga``
+ - Artists
+ * - ``gi``
+ - Circles
+ * - ``gz``
+ - Archives
+ * - ``?``
+ - Help
+
+.. _shortcut-metadata:
+
+Adding metadata
+---------------
+
+.. list-table::
+ :align: left
+ :header-rows: 1
+
+ * - Shortcut
+ - Action
+ * - ``na``
+ - Add a new artist.
+ * - ``ni``
+ - Add a new circle.
+ * - ``nh``
+ - Add a new character.
+ * - ``nw``
+ - Add a new world.
+ * - ``nn``
+ - Add a new namespace.
+ * - ``nt``
+ - Add a new tag.
+
+.. _shortcut-reader:
+
+Reader
+------
+
+.. list-table::
+ :align: left
+ :header-rows: 1
+
+ * - Shortcut
+ - Action
+ * - ``z``
+ - Open edit menu.
+ * - ``Escape``
+ - Close reader.
+
+.. _shortcut-filtering:
+
+Filtering
+---------
+
+.. list-table::
+ :align: left
+ :header-rows: 1
+
+ * - Shortcut
+ - Action
+ * - ``F``
+ - Focus search.
+ * - ``f``
+ - Toggle favourites.
+ * - ``b``
+ - Toggle bookmarked.
+ * - ``o``
+ - Toggle organized.
+
+.. _shortcut-misc:
+
+Miscellaneous
+-------------
+
+.. list-table::
+ :align: left
+ :header-rows: 1
+
+ * - Shortcut
+ - Action
+ * - ``s``
+ - Toggle selection mode if available.
+ * - ``Delete``
+ - Delete selected items.