koekeishiya#337 update docs and changelog

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Implemented support for stacking multiple windows in the same region (bsp node) [#203](https://github.com/koekeishiya/yabai/issues/203)
+- Implemented a fullscreen layout, using stacking as its backing mechanism [#337](https://github.com/koekeishiya/yabai/issues/337)
+
 ### Changed
 - Fixed an issue that caused a window to not become unmanaged when a space with a single window changed to float [#586](https://github.com/koekeishiya/yabai/issues/586)
 - Restore opacity back to full if *window_opacity* is disabled [#585](https://github.com/koekeishiya/yabai/issues/585)

doc/yabai.1

@@ -2,12 +2,12 @@
 .\"     Title: yabai
 .\"    Author: [see the "AUTHOR(S)" section]
 .\" Generator: Asciidoctor 2.0.10
-.\"      Date: 2020-06-14
+.\"      Date: 2020-08-25
 .\"    Manual: Yabai Manual
 .\"    Source: Yabai
 .\"  Language: English
 .\"
-.TH "YABAI" "1" "2020-06-14" "Yabai" "Yabai Manual"
+.TH "YABAI" "1" "2020-08-25" "Yabai" "Yabai Manual"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .ss \n[.ss] 0
@@ -234,9 +234,14 @@ Action performed when pressing \fImouse_modifier\fP + \fIbutton1\fP.
 .RS 4
 Action performed when pressing \fImouse_modifier\fP + \fIbutton2\fP.
 .RE
+.sp
+\fBmouse_drop_action\fP [\fIswap|stack\fP]
+.RS 4
+Action performed when a bsp\-managed window is dropped in the center of some other bsp\-managed window.
+.RE
 .SS "Space Settings"
 .sp
-\fBlayout\fP [\fIbsp|float\fP]
+\fBlayout\fP [\fIbsp|stack|float\fP]
 .RS 4
 Set the layout of the selected space.
 .RE
@@ -345,7 +350,7 @@ Size of the gap that separates windows on the selected space.
 Toggle space setting on or off for the selected space.
 .RE
 .sp
-\fB\-\-layout\fP \fIbsp|float\fP
+\fB\-\-layout\fP \fIbsp|stack|float\fP
 .RS 4
 Set the layout of the selected space.
 .RE
@@ -377,11 +382,18 @@ Swap position of the selected window and the given window.
 Re\-insert the selected window, splitting the given window.
 .RE
 .sp
-\fB\-\-insert\fP \fI<DIR_SEL>\fP
+\fB\-\-stack\fP \fI<WINDOW_SEL>\fP
+.RS 4
+Stack the given window on top of the selected window.
+.br
+Any kind of warp operation performed on a stacked window will unstack it.
+.RE
+.sp
+\fB\-\-insert\fP \fI<DIR_SEL>|stack\fP
 .RS 4
-Set the splitting area of the selected window.
+Set the splitting mode of the selected window.
 .br
-If the current splitting area matches \fIDIR_SEL\fP, the action will be undone.
+If the current splitting mode matches the selected mode, the action will be undone.
 .RE
 .sp
 \fB\-\-grid\fP \fI<rows>:<cols>:<start\-x>:<start\-y>:<width>:<height>\fP

doc/yabai.asciidoc

@@ -85,7 +85,6 @@ WINDOW_SEL  := prev | next | first | last | recent | mouse | largest | smallest
 DISPLAY_SEL := prev | next | first | last | recent | DIR_SEL | <arrangement index (1-based)>
 
 SPACE_SEL   := prev | next | first | last | recent | <mission-control index (1-based)> | LABEL
-
 ----
 
 Domains
@@ -172,10 +171,13 @@ Global Settings
 *mouse_action2* ['move|resize']::
     Action performed when pressing 'mouse_modifier' + 'button2'.
 
+*mouse_drop_action* ['swap|stack']::
+    Action performed when a bsp-managed window is dropped in the center of some other bsp-managed window.
+
 Space Settings
 ^^^^^^^^^^^^^^
 
-*layout* ['bsp|float']::
+*layout* ['bsp|stack|float']::
     Set the layout of the selected space.
 
 *top_padding* ['<integer number>']::
@@ -256,7 +258,7 @@ COMMAND
 *--toggle* 'padding|gap|mission-control|show-desktop'::
     Toggle space setting on or off for the selected space.
 
-*--layout* 'bsp|float'::
+*--layout* 'bsp|stack|float'::
     Set the layout of the selected space.
 
 *--label* ['<LABEL>']::
@@ -283,9 +285,13 @@ COMMAND
 *--warp* '<WINDOW_SEL>'::
     Re-insert the selected window, splitting the given window.
 
-*--insert* '<DIR_SEL>'::
-    Set the splitting area of the selected window. +
-    If the current splitting area matches 'DIR_SEL', the action will be undone.
+*--stack* '<WINDOW_SEL>'::
+    Stack the given window on top of the selected window. +
+    Any kind of warp operation performed on a stacked window will unstack it.
+
+*--insert* '<DIR_SEL>|stack'::
+    Set the splitting mode of the selected window. +
+    If the current splitting mode matches the selected mode, the action will be undone.
 
 *--grid* '<rows>:<cols>:<start-x>:<start-y>:<width>:<height>'::
     Set the frame of the selected window based on a self-defined grid.