From 0e97847a3ae4614cc1dcb7cf51ece2e63745c97f Mon Sep 17 00:00:00 2001 From: ElKowar <5300871+elkowar@users.noreply.github.com> Date: Wed, 25 Nov 2020 10:32:16 +0100 Subject: [PATCH] Add docs for `stacking`, `focusable` and `screen` on window Adds missing documentation for the `` attributes `stacking`, `focusable` and `screen` --- docs/content/main/configuration.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/content/main/configuration.md b/docs/content/main/configuration.md index 943f33a..51a2cb1 100644 --- a/docs/content/main/configuration.md +++ b/docs/content/main/configuration.md @@ -208,7 +208,7 @@ The `` config should look something like this: ```xml - +
@@ -221,5 +221,12 @@ The window block contains multiple elements to configure the window. - `` is used to specify the position and size of the window. - `` will contain the widget that is shown in the window. -The `stacking="fg"` specifies if the window should appear on top of or behind other windows. -Possible values here are `foreground`, `fg`, `background` and `bg`. It defaults to `fg`. +There are a couple things you can optionally configure on the window itself: +- `stacking`: stacking describes if the window will be shown in the foreground (in front of other windows) + or in the background (behind other windows). + Possible values: `"fg"`, `"bg"`. Default: `"fg"` +- `focusable`: whether the window should be focusable by the windowmanager. + This is necessary for things like text-input-fields to work properly. + Possible values: `"true"`, `"false"`. Default: `"false"` +- `screen`: Specifies on which display to show the window in a multi-monitor setup. + This can be any number, representing the index of your monitor.