From 5e64361ed81c1c296e8d5926deaa7e22b5fc25be Mon Sep 17 00:00:00 2001 From: patrick96 Date: Mon, 26 Oct 2020 23:50:14 +0100 Subject: [PATCH] doc(actions): Start supported actions table --- doc/user/actions.rst | 76 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 75 insertions(+), 1 deletion(-) diff --git a/doc/user/actions.rst b/doc/user/actions.rst index f674b147..52883d72 100644 --- a/doc/user/actions.rst +++ b/doc/user/actions.rst @@ -111,7 +111,81 @@ also be used to trigger actions: Supported Actions ----------------- -.. TODO +.. TODO Finish table. Maybe one section per module type (table not really convenient) + ++-------------------------+---------------+----+---------------------+ +|Module Type |New Action Name|Data|Description | ++=========================+===============+====+=====================+ +|``internal/date`` |``toggle`` |no ||date_toggle_desc| | ++-------------------------+---------------+----+---------------------+ +|``internal/alsa`` |``inc`` |no | | +| +---------------+----+---------------------+ +| |``dec`` |no | | +| +---------------+----+---------------------+ +| |``toggle`` |no | | ++-------------------------+---------------+----+---------------------+ +|``internal/pulseaudio`` |``inc`` |no | | +| +---------------+----+---------------------+ +| |``dec`` |no | | +| +---------------+----+---------------------+ +| |``toggle`` |no | | ++-------------------------+---------------+----+---------------------+ +|``internal/xbacklight`` |``inc`` |no | | +| +---------------+----+---------------------+ +| |``dec`` |no | | ++-------------------------+---------------+----+---------------------+ +|``internal/backlight`` |``inc`` |no | | +| +---------------+----+---------------------+ +| |``dec`` |no | | ++-------------------------+---------------+----+---------------------+ +|``internal/xkeyboard`` |``switch`` |no | | ++-------------------------+---------------+----+---------------------+ +|``internal/mpd`` |``play`` |no | | +| +---------------+----+---------------------+ +| |``pause`` |no | | +| +---------------+----+---------------------+ +| |``stop`` |no | | +| +---------------+----+---------------------+ +| |``prev`` |no | | +| +---------------+----+---------------------+ +| |``next`` |no | | +| +---------------+----+---------------------+ +| |``repeat`` |no | | +| +---------------+----+---------------------+ +| |``single`` |no | | +| +---------------+----+---------------------+ +| |``random`` |no | | +| +---------------+----+---------------------+ +| |``consume`` |no | | +| +---------------+----+---------------------+ +| |``seek`` |yes | | ++-------------------------+---------------+----+---------------------+ +|``internal/xworkspaces`` |``focus`` |yes | | +| +---------------+----+---------------------+ +| |``next`` |no | | +| +---------------+----+---------------------+ +| |``prev`` |no | | ++-------------------------+---------------+----+---------------------+ +|``internal/bspwm`` |``focus`` |yes | | +| +---------------+----+---------------------+ +| |``next`` |no | | +| +---------------+----+---------------------+ +| |``prev`` |no | | ++-------------------------+---------------+----+---------------------+ +|``internal/i3`` |``focus`` |yes | | +| +---------------+----+---------------------+ +| |``next`` |no | | +| +---------------+----+---------------------+ +| |``prev`` |no | | ++-------------------------+---------------+----+---------------------+ +|``custom/menu`` |``open`` |yes | | +| +---------------+----+---------------------+ +| |``close`` |no | | +| +---------------+----+---------------------+ +| |``exec`` |yes | | ++-------------------------+---------------+----+---------------------+ + +.. |date_toggle_desc| replace:: Toggles the date/time format between ``date``/``time`` and ``date-alt``/``time-alt``. Legacy Action Names -------------------