wiki: Document config includes

docs/mkdocs.yaml

@@ -103,6 +103,7 @@ nav:
     - Animations: Configuration:-Animations.md
     - Gestures: Configuration:-Gestures.md
     - Debug Options: Configuration:-Debug-Options.md
+    - Include: Configuration:-Include.md
   - Development:
     - Design Principles: Development:-Design-Principles.md
     - Developing niri: Development:-Developing-niri.md

docs/wiki/Configuration:-Include.md

@@ -0,0 +1,243 @@
+<sup>Since: next release</sup>
+
+You can include other files at the top level of the config.
+
+```kdl,must-fail
+// Some settings...
+
+include "colors.kdl"
+
+// Some more settings...
+```
+
+Included files have the same structure as the main config file.
+Settings from included files will be merged with the settings from the main config file.
+
+Included config files can in turn include more files.
+All included files are watched for changes, and the config live-reloads when any of them change.
+
+Includes work only at the top level of the config:
+
+```kdl,must-fail
+// All good: include at the top level.
+include "something.kdl"
+
+layout {
+    // NOT allowed: include inside some other section.
+    include "other.kdl"
+}
+```
+
+### Positionality
+
+Includes are *positional*.
+They will override options set *prior* to them.
+Window rules from included files will be inserted at the position of the `include` line.
+For example:
+
+```kdl
+// colors.kdl
+layout {
+    border {
+        active-color "green"
+    }
+}
+
+overview {
+    backdrop-color "green"
+}
+```
+
+```kdl,must-fail
+// config.kdl
+layout {
+    border {
+        active-color "red"
+    }
+}
+
+// This overrides the border color and the backdrop color to green.
+include "colors.kdl"
+
+// This sets the overview backdrop color to red again.
+overview {
+    backdrop-color "red"
+}
+```
+
+The end result:
+
+- the border color is green (from `colors.kdl`),
+- the overview backdrop color is red (it was set *after* `colors.kdl`).
+
+Another example:
+
+```kdl
+// rules.kdl
+window-rule {
+    match app-id="Alacritty"
+    open-maximized false
+}
+```
+
+```kdl,must-fail
+// config.kdl
+window-rule {
+    open-maximized true
+}
+
+// Window rules get inserted at this position.
+include "rules.kdl"
+
+window-rule {
+    match app-id="firefox$"
+    open-maximized true
+}
+```
+
+This is equivalent to the following config file:
+
+```kdl
+window-rule {
+    open-maximized true
+}
+
+// Included from rules.kdl.
+window-rule {
+    match app-id="Alacritty"
+    open-maximized false
+}
+
+window-rule {
+    match app-id="firefox$"
+    open-maximized true
+}
+```
+
+### Merging
+
+Most config sections are merged between includes, meaning that you can set only a few properties, and only those properties will change.
+
+```kdl
+// colors.kdl
+layout {
+    // Does not affect gaps, border width, etc.
+    // Only changes colors as written.
+    focus-ring {
+        active-color "blue"
+    }
+
+    border {
+        active-color "green"
+    }
+}
+```
+
+```kdl,must-fail
+// config.kdl
+include "colors.kdl"
+
+layout {
+    // Does not set border and focus-ring colors,
+    // so colors from colors.kdl are used.
+    gaps 8
+
+    border {
+        width 8
+    }
+}
+```
+
+#### Multipart sections
+
+Multipart sections like `window-rule`, `output`, or `workspace` are inserted as is without merging:
+
+```kdl
+// laptop.kdl
+output "eDP-1" {
+    // ...
+}
+```
+
+```kdl,must-fail
+// config.kdl
+output "DP-2" {
+    // ...
+}
+
+include "laptop.kdl"
+
+// End result: both DP-2 and eDP-1 settings.
+```
+
+#### Binds
+
+`binds` will override previously-defined conflicting keys:
+
+```kdl
+// binds.kdl
+binds {
+    Mod+T { spawn "alacritty"; }
+}
+```
+
+```kdl,must-fail
+// config.kdl
+include "binds.kdl"
+
+binds {
+    // Overrides Mod+T from binds.kdl.
+    Mod+T { spawn "foot"; }
+}
+```
+
+#### Flags
+
+Most flags can be disabled with `false`:
+
+```kdl
+// csd.kdl
+
+// Write "false" to explicitly disable.
+prefer-no-csd false
+```
+
+```kdl,must-fail
+// config.kdl
+
+// Enable prefer-no-csd in the main config.
+prefer-no-csd
+
+// Including csd.kdl will disable it again.
+include "csd.kdl"
+```
+
+#### Non-merging sections
+
+Some sections where the contents represent a combined structure are not merged.
+Examples are `struts`, `preset-column-widths`, individual subsections in `animations`, pointing device sections in `input`.
+
+```kdl
+// struts.kdl
+layout {
+    struts {
+        left 64
+        right 64
+    }
+}
+```
+
+```kdl,must-fail
+// config.kdl
+layout {
+    struts {
+        top 64
+        bottom 64
+    }
+}
+
+include "struts.kdl"
+
+// Struts are not merged.
+// End result is only left and right struts.
+```

docs/wiki/Configuration:-Introduction.md

@@ -13,6 +13,7 @@ You can find documentation for various sections of the config on these wiki page
 * [`animations {}`](./Configuration:-Animations.md)
 * [`gestures {}`](./Configuration:-Gestures.md)
 * [`debug {}`](./Configuration:-Debug-Options.md)
+* [`include "other.kdl"`](./Configuration:-Include.md)
 
 ### Loading
 

docs/wiki/_Sidebar.md

@@ -33,6 +33,7 @@
 * [Animations](./Configuration:-Animations.md)
 * [Gestures](./Configuration:-Gestures.md)
 * [Debug Options](./Configuration:-Debug-Options.md)
+* [Include](./Configuration:-Include.md)
 
 ## Development
 * [Design Principles](./Development:-Design-Principles.md)