⚠️ The new ZFordDev Documentation Portal is currently under active development. Search is not yet enabled and some pages are still missing. Please bear with us while we transition to the new system.

Exporting Workspace

SnapBoard can export a column directly into SnapDock using the SDWS format — a structured workspace manifest that tells SnapDock which files to load and how to present them.

This page explains how SDWS works, how to export columns, how to import them into SnapDock, and what features are planned for the future.


What Is SDWS?

SDWS (SnapDock Workspace Snapshot) is a lightweight JSON‑based format used to transfer a column from SnapBoard into SnapDock.

An .sdws file contains:

This format ensures SnapDock can load your files cleanly without confusion — especially when multiple cards reference files with identical names like index.md.

Why SDWS Exists

SnapBoard was created to solve a real problem:

How do you connect documents that live in different folders, and how do you organise them into a workflow SnapDock can understand?

SDWS is the bridge between planning (SnapBoard) and writing (SnapDock).


Exporting Boards (Column Export)

SnapBoard currently exports one column at a time.

To export:

  1. Open any board
  2. Hover over a column
  3. Select Export to SnapDock
  4. Choose:
    • Open in SnapDock (direct hand‑off)
    • Save .sdws file (manual import later)

What Happens During Export

SnapBoard collects:

It then generates a structured .sdws file.

Example SDWS Structure (Simplified)

{
  "workspace": {
    "title": "My Project",
    "sub": "Planning",
    "header": "My Project/Planning"
  },
  "files": [
    {
      "path": "C:/Users/user/docs/outline.md",
      "name": "Outline"
    },
    {
      "path": "C:/Users/user/docs/notes/index.md",
      "name": "Notes"
    }
  ]
}

SnapDock reads this file and loads the workspace accordingly.


Importing SDWS Files

You can import an .sdws file into SnapDock in two ways:

✔ Direct Export

If SnapDock is installed, SnapBoard can hand the workspace off instantly.

✔ Manual Import

  1. Save the .sdws file
  2. Open SnapDock
  3. Choose Open Workspace
  4. Select the .sdws file

SnapDock will:


Limitations

SDWS is powerful, but still evolving.

Current limitations include:

These limitations will be addressed during the Beta cycle.


Future Plans

SnapBoard’s export system is expanding significantly.
Planned features include:

✔ Full‑Board Export

Export an entire board into a multi‑column workspace for SnapDock.

✔ Multi‑Board Containers

Bundle multiple boards into a single workspace package.

✔ Portable Attachments

Embed or bundle attachments for safer sharing.

✔ SDWS v2 Schema

A more robust format with:

✔ Import Improvements

Allow SnapBoard to re‑import SDWS files for round‑trip workflows.