From 87aa98923847dfd64874736d62d9288c175e82de Mon Sep 17 00:00:00 2001 From: Teddy Wing Date: Mon, 17 Jun 2019 19:55:56 +0200 Subject: Document `i` shortcut --- README.rst | 4 ++++ docs.json | 48 ++++++++++++++++++++++++------------------------ init.lua | 2 ++ 3 files changed, 30 insertions(+), 24 deletions(-) diff --git a/README.rst b/README.rst index 39757bf..d6f6756 100644 --- a/README.rst +++ b/README.rst @@ -25,6 +25,10 @@ Upon activating the mode, the following shortcuts are available: | ``Shift-l`` | Move window right 5 units | +-------------+----------------------------+ ++-------+---------------------+ +| ``i`` | Move window to top | ++-------+---------------------+ + +-------+------------------------------+ | ``[`` | Move window left one screen | +-------+------------------------------+ diff --git a/docs.json b/docs.json index 269959e..851696e 100644 --- a/docs.json +++ b/docs.json @@ -15,33 +15,24 @@ "stripped_doc" : [ ], - "desc" : "Adds a hotkey mode for manipulating windows.", "type" : "Module", + "desc" : "Adds a hotkey mode for manipulating windows.", "Deprecated" : [ ], "Constructor" : [ ], - "doc" : "Adds a hotkey mode for manipulating windows.\n\nUpon activating the mode, the following shortcuts are available:\n\nh: Move window left 20 units\nj: Move window down 20 units\nk: Move window up 20 units\nl: Move window right 20 units\n\nShift-h: Move window left 5 units\nShift-j: Move window down 5 units\nShift-k: Move window up 5 units\nShift-l: Move window right 5 units\n\n[: Move window left one screen\n]: Move window right one screen\n\ne: Reduce window height 20 units\ns: Reduce window width 20 units\nd: Increase window height 20 units\nf: Increase window width 20 units\n\nShift-e: Reduce window height 5 units\nShift-s: Reduce window width 5 units\nShift-d: Increase window height 5 units\nShift-f: Increase window width 5 units", - "Field" : [ - - ], - "Command" : [ - - ], - "items" : [ + "doc" : "Adds a hotkey mode for manipulating windows.\n\nUpon activating the mode, the following shortcuts are available:\n\nh: Move window left 20 units\nj: Move window down 20 units\nk: Move window up 20 units\nl: Move window right 20 units\n\nShift-h: Move window left 5 units\nShift-j: Move window down 5 units\nShift-k: Move window up 5 units\nShift-l: Move window right 5 units\n\ni: Move window to top\n\n[: Move window left one screen\n]: Move window right one screen\n\ne: Reduce window height 20 units\ns: Reduce window width 20 units\nd: Increase window height 20 units\nf: Increase window width 20 units\n\nShift-e: Reduce window height 5 units\nShift-s: Reduce window width 5 units\nShift-d: Increase window height 5 units\nShift-f: Increase window width 5 units", + "Method" : [ { - "doc" : "Bind keys for WindowMode\n\nParameters:\n * mapping – A table containing hotkey modifier\/key details for the following items:\n * mode – Activate and deactivate window mode", "desc" : "Bind keys for WindowMode", + "def" : "WindowMode:bindModal(mapping)", "stripped_doc" : [ "Bind keys for WindowMode", "" ], - "parameters" : [ - " * mapping – A table containing hotkey modifier\/key details for the following items:", - " * mode – Activate and deactivate window mode" - ], + "doc" : "Bind keys for WindowMode\n\nParameters:\n * mapping – A table containing hotkey modifier\/key details for the following items:\n * mode – Activate and deactivate window mode", "notes" : [ ], @@ -50,22 +41,25 @@ "returns" : [ ], - "def" : "WindowMode:bindModal(mapping)", - "name" : "bindModal" + "name" : "bindModal", + "parameters" : [ + " * mapping – A table containing hotkey modifier\/key details for the following items:", + " * mode – Activate and deactivate window mode" + ] } ], - "Method" : [ + "Command" : [ + + ], + "items" : [ { - "doc" : "Bind keys for WindowMode\n\nParameters:\n * mapping – A table containing hotkey modifier\/key details for the following items:\n * mode – Activate and deactivate window mode", "desc" : "Bind keys for WindowMode", + "def" : "WindowMode:bindModal(mapping)", "stripped_doc" : [ "Bind keys for WindowMode", "" ], - "parameters" : [ - " * mapping – A table containing hotkey modifier\/key details for the following items:", - " * mode – Activate and deactivate window mode" - ], + "doc" : "Bind keys for WindowMode\n\nParameters:\n * mapping – A table containing hotkey modifier\/key details for the following items:\n * mode – Activate and deactivate window mode", "notes" : [ ], @@ -74,9 +68,15 @@ "returns" : [ ], - "def" : "WindowMode:bindModal(mapping)", - "name" : "bindModal" + "name" : "bindModal", + "parameters" : [ + " * mapping – A table containing hotkey modifier\/key details for the following items:", + " * mode – Activate and deactivate window mode" + ] } + ], + "Field" : [ + ], "name" : "WindowMode" } diff --git a/init.lua b/init.lua index 6f6f837..a0dd423 100644 --- a/init.lua +++ b/init.lua @@ -14,6 +14,8 @@ --- Shift-k: Move window up 5 units --- Shift-l: Move window right 5 units --- +--- i: Move window to top +--- --- [: Move window left one screen --- ]: Move window right one screen --- -- cgit v1.2.3