feat: introduce v2.0 abstraction layer with core types, backend interface, and plugin system
feat: add fade effects with API control and real-time event subscription test: add API integration tests with isolated test environment and coverage reporting build: update Makefile for recursive source finding, dynamic linking, and test targets docs: document abstraction layer, fade effects, and API enhancements in README
This commit is contained in:
+152
-6
@@ -13,7 +13,7 @@
|
||||
<aside class="sidebar">
|
||||
<div class="sidebar-header">
|
||||
<h1>DWN</h1>
|
||||
<span class="version">v1.0.0</span>
|
||||
<span class="version">v2.0.0</span>
|
||||
</div>
|
||||
|
||||
<div class="search-box">
|
||||
@@ -47,6 +47,8 @@
|
||||
<div class="nav-section">
|
||||
<div class="nav-section-title">Advanced</div>
|
||||
<a href="architecture.html" class="nav-link">Architecture</a>
|
||||
<a href="abstraction-layer.html" class="nav-link">Abstraction Layer</a>
|
||||
<a href="plugin-development.html" class="nav-link">Plugin Development</a>
|
||||
<a href="building.html" class="nav-link">Building from Source</a>
|
||||
</div>
|
||||
</nav>
|
||||
@@ -66,15 +68,20 @@
|
||||
<li><a href="#tiling">Tiling Layout</a></li>
|
||||
<li><a href="#floating">Floating Layout</a></li>
|
||||
<li><a href="#monocle">Monocle Layout</a></li>
|
||||
<li><a href="#centered-master">Centered Master Layout</a></li>
|
||||
<li><a href="#columns">Columns Layout</a></li>
|
||||
<li><a href="#fibonacci">Fibonacci Layout</a></li>
|
||||
<li><a href="#grid">Grid Layout</a></li>
|
||||
<li><a href="#plugin-system">Plugin System</a></li>
|
||||
<li><a href="#per-workspace">Per-Workspace Settings</a></li>
|
||||
<li><a href="#shortcuts">Layout Shortcuts</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<h2 id="overview">Overview</h2>
|
||||
<p>DWN provides three layout modes that determine how windows are arranged on screen. Each workspace maintains its own layout settings independently.</p>
|
||||
<p>DWN provides six layout modes that determine how windows are arranged on screen. Each workspace maintains its own layout settings independently.</p>
|
||||
|
||||
<p>Press <code>Super+Space</code> to cycle through layouts: Tiling → Floating → Monocle → Tiling</p>
|
||||
<p>Press <code>Super+Space</code> to cycle through layouts: Tiling → Floating → Monocle → Centered Master → Columns → Fibonacci → Tiling</p>
|
||||
|
||||
<div class="alert alert-info">
|
||||
<strong>Tip:</strong> The current layout is shown in the panel with a symbol: <code>[]=</code> for tiling, <code>><></code> for floating, <code>[M]</code> for monocle.
|
||||
@@ -182,6 +189,141 @@
|
||||
<strong>Note:</strong> Windows maintain decorations in monocle mode unless fullscreen (<code>Alt+F11</code>).
|
||||
</div>
|
||||
|
||||
<h2 id="centered-master">Centered Master Layout</h2>
|
||||
<p>The master window is centered on screen with stack windows divided on left and right sides.</p>
|
||||
|
||||
<h3>How It Works</h3>
|
||||
<div class="code-block">
|
||||
<pre><code>+--------+------------------+--------+
|
||||
| Stack | Master | Stack |
|
||||
| 1 | Window | 3 |
|
||||
+--------+ +--------+
|
||||
| Stack | | Stack |
|
||||
| 2 | | 4 |
|
||||
+--------+------------------+--------+</code></pre>
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
<li>The <strong>master window</strong> occupies the center of the screen</li>
|
||||
<li>Stack windows are divided between left and right sides</li>
|
||||
<li>Odd-numbered stack windows go left, even go right</li>
|
||||
<li>Excellent for wide monitors and ultrawide displays</li>
|
||||
</ul>
|
||||
|
||||
<h3>Use Cases</h3>
|
||||
<ul>
|
||||
<li>Keeping primary work centered while referencing side content</li>
|
||||
<li>Video editing with timeline and tools on sides</li>
|
||||
<li>Development with editor centered and documentation on sides</li>
|
||||
</ul>
|
||||
|
||||
<h2 id="columns">Columns Layout</h2>
|
||||
<p>All windows arranged in equal-width vertical columns spanning the full height.</p>
|
||||
|
||||
<h3>How It Works</h3>
|
||||
<div class="code-block">
|
||||
<pre><code>+----------+----------+----------+----------+
|
||||
| | | | |
|
||||
| Window | Window | Window | Window |
|
||||
| 1 | 2 | 3 | 4 |
|
||||
| | | | |
|
||||
| | | | |
|
||||
+----------+----------+----------+----------+</code></pre>
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
<li>Each window gets an equal-width column</li>
|
||||
<li>Windows span the full usable height</li>
|
||||
<li>Simple and predictable arrangement</li>
|
||||
</ul>
|
||||
|
||||
<h3>Use Cases</h3>
|
||||
<ul>
|
||||
<li>Comparing multiple files side-by-side</li>
|
||||
<li>Monitoring multiple log files</li>
|
||||
<li>Multi-column text editing</li>
|
||||
<li>Concurrent terminal sessions</li>
|
||||
</ul>
|
||||
|
||||
<h2 id="fibonacci">Fibonacci Layout</h2>
|
||||
<p>Windows arranged in a spiral pattern using recursive splitting, inspired by the Fibonacci sequence.</p>
|
||||
|
||||
<h3>How It Works</h3>
|
||||
<div class="code-block">
|
||||
<pre><code>+------------------+----------+
|
||||
| | |
|
||||
| Window 1 | Window 2 |
|
||||
| +----+-----+
|
||||
| | W3 | |
|
||||
+------------------+----+ W4 |
|
||||
| Window 5 | |
|
||||
+-----------------------+-----+</code></pre>
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
<li>First window takes half the screen</li>
|
||||
<li>Each subsequent window takes half the remaining space</li>
|
||||
<li>Alternates between horizontal and vertical splits</li>
|
||||
<li>Creates a visually interesting spiral pattern</li>
|
||||
</ul>
|
||||
|
||||
<h3>Use Cases</h3>
|
||||
<ul>
|
||||
<li>Hierarchical window importance (larger = more important)</li>
|
||||
<li>Primary workspace with progressively smaller utilities</li>
|
||||
<li>Creative workflows with main canvas and tool windows</li>
|
||||
</ul>
|
||||
|
||||
<h2 id="grid">Grid Layout</h2>
|
||||
<p>Windows are arranged in a grid pattern with automatic row/column calculation.</p>
|
||||
|
||||
<h3>How It Works</h3>
|
||||
<div class="code-block">
|
||||
<pre><code>+----------+----------+----------+
|
||||
| Window | Window | Window |
|
||||
| 1 | 2 | 3 |
|
||||
+----------+----------+----------+
|
||||
| Window | Window |
|
||||
| 4 | 5 |
|
||||
+----------+----------+</code></pre>
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
<li>Automatically calculates optimal rows and columns</li>
|
||||
<li>Uses square root for balanced grid</li>
|
||||
<li>All windows have equal size</li>
|
||||
<li>Great for viewing multiple documents simultaneously</li>
|
||||
</ul>
|
||||
|
||||
<h3>Use Cases</h3>
|
||||
<ul>
|
||||
<li>Comparing multiple documents or files</li>
|
||||
<li>Monitoring multiple terminals</li>
|
||||
<li>Dashboard-style workflows</li>
|
||||
<li>Multi-way video calls</li>
|
||||
</ul>
|
||||
|
||||
<h2 id="plugin-system">Plugin System (v2.0)</h2>
|
||||
<p>DWN v2.0 introduces a layout plugin system that allows custom layout algorithms to be loaded dynamically or built-in.</p>
|
||||
|
||||
<h3>Built-in Layouts</h3>
|
||||
<ul>
|
||||
<li><strong>tiling</strong> - Master-stack tiling (default)</li>
|
||||
<li><strong>floating</strong> - Traditional floating windows</li>
|
||||
<li><strong>monocle</strong> - Single maximized window</li>
|
||||
<li><strong>centered-master</strong> - Master centered with stacks on sides</li>
|
||||
<li><strong>columns</strong> - Equal-width vertical columns</li>
|
||||
<li><strong>fibonacci</strong> - Spiral recursive splitting</li>
|
||||
<li><strong>grid</strong> - Grid arrangement</li>
|
||||
</ul>
|
||||
|
||||
<h3>Custom Layouts</h3>
|
||||
<p>Developers can create custom layout plugins using the Layout Plugin API. See <a href="plugin-development.html">Plugin Development</a> for details.</p>
|
||||
|
||||
<div class="alert alert-info">
|
||||
<strong>Plugin API:</strong> Layouts implement the <code>LayoutPluginInterface</code> vtable with an <code>arrange()</code> method that calculates window geometries.
|
||||
</div>
|
||||
|
||||
<h2 id="per-workspace">Per-Workspace Settings</h2>
|
||||
<p>Each workspace maintains independent layout settings:</p>
|
||||
|
||||
@@ -198,7 +340,7 @@
|
||||
<tr>
|
||||
<td>Layout Mode</td>
|
||||
<td>Per-workspace</td>
|
||||
<td>Tiling, floating, or monocle</td>
|
||||
<td>Tiling, floating, monocle, centered-master, columns, or fibonacci</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Master Ratio</td>
|
||||
@@ -224,7 +366,9 @@
|
||||
<li>Workspace 1: Tiling layout for coding (editor + terminal)</li>
|
||||
<li>Workspace 2: Floating layout for design work</li>
|
||||
<li>Workspace 3: Monocle layout for focused writing</li>
|
||||
<li>Workspace 4: Tiling with master count 2 for comparison</li>
|
||||
<li>Workspace 4: Centered-master for wide monitor development</li>
|
||||
<li>Workspace 5: Columns layout for log monitoring</li>
|
||||
<li>Workspace 6: Fibonacci for hierarchical work</li>
|
||||
</ul>
|
||||
|
||||
<h2 id="shortcuts">Layout Shortcuts</h2>
|
||||
@@ -278,7 +422,9 @@
|
||||
|
||||
<div class="code-block">
|
||||
<pre><code>[layout]
|
||||
default = tiling # Default layout for new workspaces
|
||||
# Default layout for new workspaces
|
||||
# Options: tiling, floating, monocle, centered-master, columns, fibonacci
|
||||
default = tiling
|
||||
master_ratio = 0.55 # Default master area ratio (0.1-0.9)
|
||||
master_count = 1 # Default master window count (1-10)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user