@diagrammo/dgmo 0.8.12 → 0.8.13

package/docs/guide/chart-kanban.md

@@ -0,0 +1,156 @@
+# Kanban Board
+
+```dgmo
+kanban Plunder Sprint 7
+
+tag Priority
+  Urgent(red)
+  High(orange)
+  Low(green) default
+
+tag Crew alias c
+  Blackbeard(red)
+  Anne Bonny(purple)
+  Calico Jack(teal)
+
+[Awaiting Orders](red)
+  Recruit gunners at Tortuga | priority: High, c: Calico Jack
+  Chart new trade route | priority: Urgent, c: Anne Bonny
+    Scout the Windward Passage
+    Avoid Royal Navy patrols
+  Resupply rum and powder | priority: Low, c: Calico Jack
+
+[Underway](orange) | wip: 2
+  Forge letters of marque | priority: High, c: Anne Bonny
+  Raid merchant convoy | priority: Urgent, c: Blackbeard
+    Three ships spotted off Nassau
+
+[Done](green)
+  Bribe the harbour master | priority: High, c: Anne Bonny
+  Repair hull damage | priority: Low, c: Blackbeard
+```
+
+## Overview
+
+Kanban boards visualize work items as cards organized into columns. Columns typically represent workflow stages (To Do, In Progress, Done). Cards can carry tags for color-coded categorization and freeform detail text.
+
+**Drag-and-drop:** In the app, drag cards between columns or reorder within a column. The editor text updates automatically.
+
+## Syntax
+
+```
+kanban Board Title
+
+[Column Name]
+Card Title
+Card Title | key: Value, key: Value
+  Freeform detail text
+  Another detail line
+```
+
+## Settings
+
+| Key     | Description      | Default |
+| ------- | ---------------- | ------- |
+| `chart` | Must be `kanban` | —       |
+| `title` | Board title      | None    |
+
+## Columns
+
+Columns are defined with `[Column Name]` syntax. All cards between one column header and the next belong to that column.
+
+```
+[To Do]
+[In Progress]
+[Done]
+```
+
+### WIP Limits
+
+Add `| wip: N` after a column header to set a work-in-progress limit. A warning appears when the limit is exceeded:
+
+```
+[In Progress] | wip: 3
+```
+
+## Cards
+
+Each non-indented line within a column creates a card. Cards can have tags and detail lines.
+
+### Tags
+
+Tags follow the card title, separated by `|`. Multiple tags are comma-separated:
+
+```
+Build login | priority: High, assignee: Alice
+```
+
+### Detail Lines
+
+Indented lines under a card are freeform detail text:
+
+```
+Build login | priority: High
+  OAuth + email/password support
+  Needs design review first
+```
+
+### Card Colors
+
+Add a color suffix to a card title:
+
+```
+Urgent fix(red)
+```
+
+## Tag Groups
+
+Tag groups define categories with color-coded values. They appear before columns and use the `tag` directive:
+
+```
+tag Priority
+  High(red)
+  Medium(yellow)
+  Low(green) default
+
+tag Assignee alias a
+  Alice(blue)
+  Bob(purple)
+```
+
+- `default` marks the fallback value for cards without an explicit tag
+- `alias` provides a short name for the tag (e.g., `a` instead of `assignee`)
+- Colors are shown as dots on each card
+
+## Complete Example
+
+```dgmo
+kanban Product Roadmap
+
+tag Status
+  Blocked(red)
+  Active(green) default
+
+tag Team alias t
+  Frontend(blue)
+  Backend(purple)
+  Design(yellow)
+
+[Backlog]
+Dark mode support | t: Frontend
+API rate limiting | t: Backend
+  Research token bucket vs sliding window
+
+[In Progress] | wip: 3
+User dashboard | t: Frontend, status: Active
+  Charts and metrics overview
+Auth refactor | t: Backend, status: Active
+
+[Review]
+Payment integration | t: Backend, status: Blocked
+  Waiting on Stripe webhook setup
+
+[Done]
+Onboarding flow | t: Design
+Landing page | t: Frontend
+```

package/docs/guide/chart-line.md

@@ -0,0 +1,79 @@
+# Line Chart
+
+```dgmo
+line Ship Speed Over Voyage
+series Knots
+x-label Day
+y-label Speed
+
+era Day 1 -> Day 3 Rough Seas (red)
+era Day 3 -> Day 7 Fair Winds (blue)
+
+Day 1: 8
+Day 2: 10
+Day 3: 7
+Day 4: 12
+Day 5: 9
+Day 6: 11
+Day 7: 6
+```
+
+## Syntax
+
+```
+line Chart Title
+series Series Name
+x-label X Axis Label
+y-label Y Axis Label
+
+Label: value
+```
+
+## Era Bands
+
+Annotate named time periods with a shaded background band and label:
+
+```dgmo
+line U.S. Strategic Petroleum Reserve
+y-label Million Barrels
+
+era '77 -> '81 Carter (blue)
+era '81 -> '89 Reagan (red)
+era '89 -> '93 Bush (red)
+
+'77: 7
+'78: 67
+'79: 91
+'80: 108
+'81: 230
+'82: 294
+'83: 379
+```
+
+Era syntax: `era <start> -> <end> Label (color)`
+
+- `start` and `end` must exactly match data point labels
+- Color is optional; omit for the palette default
+- Named colors: `red`, `blue`, `green`, `orange`, `purple`, `teal`, etc.
+- Multiple eras can overlap — both render without error
+
+## Metadata Keys
+
+| Key       | Description                               | Required |
+| --------- | ----------------------------------------- | -------- |
+| `chart`   | Must be `line`                            | Yes      |
+| `title`   | Chart title displayed above the chart     | No       |
+| `series`  | Name of the data series (shown in legend) | No       |
+| `x-label` | Label for the X axis                      | No       |
+| `y-label` | Label for the Y axis                      | No       |
+| `color`   | Override the line color                   | No       |
+
+## Data Format
+
+Each data line follows the pattern `Label: value`:
+
+```
+Day 1: 8
+Day 2: 10
+Day 3: 7
+```

package/docs/guide/chart-multi-line.md

@@ -0,0 +1,84 @@
+# Multi-Line Chart
+
+```dgmo
+line Monthly Captures by Fleet
+series Blackbeard(red), Roberts(blue), Vane(green)
+x-label Month
+//y-label Captures
+
+era Jan -> Mar Atlantic Season
+era Mar -> Jun Caribbean Season (teal)
+
+Jan: 3, 5, 2
+Feb: 4, 3, 4
+Mar: 2, 7, 3
+Apr: 6, 4, 1
+May: 5, 6, 5
+Jun: 3, 8, 2
+```
+
+## Syntax
+
+```
+line Chart Title
+series Series1(color), Series2(color), Series3(color)
+x-label X Axis Label
+
+Label: value1, value2, value3
+```
+
+## Metadata Keys
+
+| Key       | Description                                                      | Required |
+| --------- | ---------------------------------------------------------------- | -------- |
+| `chart`   | Must be `line` (or `multi-line` as an alias)                     | Yes      |
+| `title`   | Chart title displayed above the chart                            | No       |
+| `series`  | Comma-separated series names with optional colors in parentheses | Yes      |
+| `x-label` | Label for the X axis                                             | No       |
+| `y-label` | Label for the Y axis                                             | No       |
+
+## Data Format
+
+Each data line provides comma-separated values matching the series order:
+
+```
+Jan: 3, 5, 2
+Feb: 4, 3, 4
+```
+
+The number of values per line must match the number of series names.
+
+## Era Bands
+
+Annotate named time periods with a shaded background band and label:
+
+```dgmo
+line Monthly Captures by Fleet
+series Blackbeard(red), Roberts(blue)
+x-label Month
+
+era Jan -> Mar Q1 (green)
+era Apr -> Jun Q2 (orange)
+
+Jan: 3, 5
+Feb: 4, 3
+Mar: 2, 7
+Apr: 6, 4
+May: 5, 6
+Jun: 3, 8
+```
+
+Era syntax: `era <start> -> <end> Label (color)`
+
+- `start` and `end` must exactly match data point labels
+- Color is optional; omit for the palette default
+- Era bands render on the first series only
+
+## Series Colors
+
+Colors can be specified in parentheses after each series name using named colors:
+
+```
+series Gold(yellow), Silver(gray), Bronze(orange)
+series Fleet A(red), Fleet B(blue)
+```

package/docs/guide/chart-org.md

@@ -0,0 +1,209 @@
+# Org Chart
+
+```dgmo
+org The Dread Fleet
+sub-node-label Crew
+show-sub-node-count
+
+tag Rank alias r
+  Captain(red)
+  FirstMate(orange)
+  Quartermaster(yellow)
+  Bosun(green)
+  Gunner(teal)
+  Sailor(blue) default
+  Jester(cyan)
+  Swab(purple)
+
+tag Ship alias s
+  Revenge(blue) default
+  Serpent(green)
+  Phantom(purple)
+
+tag Status alias st
+  Loyal(green) default
+  Turncoat(red)
+  NewRecruit(yellow)
+
+Blackbeard| r: Captain, s: Revenge
+  Anne Bonny| r: FirstMate
+    [Gun Deck]
+      Cannonball Pete| r: Gunner
+      Smokey Jack| r: Gunner, st: NewRecruit
+      Powder Meg| r: Swab, st: NewRecruit
+    [Boarding Party]
+      Cutlass Jim| r: Bosun
+      Red Mary
+      One-Eyed Dan| st: Turncoat
+  Calico Rackham| r: Quartermaster
+    [Cargo Hold]
+      Barnacle Bob
+      Slippery Sal| st: Turncoat
+  Long John| r: FirstMate, s: Serpent
+    [Rigging Crew]
+      Monkey Fist| r: Bosun
+      Pegleg Pete
+      Crow Jane
+    [Navigation]
+      Stargazer Quinn| r: Quartermaster
+      Compass Rose| st: NewRecruit
+```
+
+## Overview
+
+Org charts use **indentation** to define reporting hierarchy. Each person is a line of text, and metadata like `role:` appears indented beneath them. Children are indented under their manager.
+
+## Syntax
+
+```
+org Chart Title
+
+Person Name
+  role: Job Title
+
+  Direct Report
+    role: Job Title
+```
+
+## Settings
+
+| Key     | Description   | Default |
+| ------- | ------------- | ------- |
+| `chart` | Must be `org` | Yes     |
+| `title` | Chart title   | None    |
+
+## Nodes
+
+Each non-indented (or less-indented) text line creates a person node. Deeper indentation creates a child (direct report):
+
+```
+CEO
+  VP of Engineering
+    Senior Engineer
+    Junior Engineer
+  VP of Sales
+    Account Executive
+```
+
+## Metadata
+
+Add key-value pairs indented under a node:
+
+```
+Alice Park
+  role: Senior Engineer
+  location: New York
+  focus: APIs
+```
+
+Metadata renders as secondary text on the node card.
+
+### Compact Pipe Syntax
+
+For concise entries, use `|` to put metadata on a single line:
+
+```
+Alice Park | role: Senior Engineer | location: NY
+Bob Torres | role: Junior Engineer | location: CO
+```
+
+## Containers (Teams)
+
+Use `[Team Name]` to create a container that groups its children visually:
+
+```
+Alex Chen
+  role: CTO
+
+  [Platform Team]
+    goal: Core infrastructure and APIs
+
+    Alice Park | role: Senior Engineer
+    Bob Torres | role: Junior Engineer
+
+  [Frontend Team]
+    goal: Ship new design system by Q3
+
+    Carol Wu | role: Senior Engineer
+    Dave Kim | role: Junior Engineer
+```
+
+Containers render as labeled boxes. They can have metadata like `goal:` and `charter:` which display below the container label.
+
+## Node Colors
+
+Add a color name in parentheses:
+
+```
+[Platform Team(blue)]
+[Frontend Team(green)]
+```
+
+## Tag Groups
+
+Define color-coded tags for metadata values like location or status. Tag groups must appear before org content:
+
+```
+org Acme Corp
+
+tag Location
+  NY(blue)
+  LA(yellow)
+  Remote(purple)
+
+tag Status
+  FTE(green)
+  Contractor(orange)
+
+Jane Smith
+  role: CEO
+  location: NY
+  status: FTE
+```
+
+- `tag GroupName` starts a tag group
+- `alias` provides a shorthand for metadata keys (e.g., `tag Location alias l`)
+- `default` marks the fallback value for nodes without that metadata
+- When a node's metadata value matches a tag entry, it renders with that tag's color as a badge
+
+## Comments
+
+```
+// This line is ignored by the parser
+```
+
+## Collapse / Expand
+
+In the app, click a node that has children to focus it. Click again to collapse its subtree — a "+N hidden" label shows how many nodes are hidden. Click once more to expand. Containers can be collapsed independently.
+
+Keyboard: Tab to focus a node, Enter or Space to toggle.
+
+## Complete Example
+
+```dgmo
+org Engineering Division
+
+Alex Chen
+  role: CTO
+
+  [Platform Team]
+    goal: Core infrastructure and APIs
+    charter: Platform reliability and developer experience
+
+    Alice Park | role: Senior Engineer | location: NY
+    Bob Torres | role: Junior Engineer | location: CO
+
+  [Frontend Team]
+    goal: Ship new design system by Q3
+
+    Carol Wu
+      role: Senior Engineer
+    Dave Kim
+      role: Junior Engineer
+
+  [Data Team]
+    goal: ML pipeline and analytics
+
+    Eve Martinez
+      role: Data Scientist
+```

package/docs/guide/chart-pie.md

@@ -0,0 +1,39 @@
+# Pie Chart
+
+```dgmo
+pie Crew Roles Distribution
+
+Sailors: 45
+Gunners: 20
+Marines: 15
+Officers: 8
+Specialists: 7
+Cooks & Surgeons: 5
+```
+
+## Syntax
+
+```
+pie Chart Title
+
+Label: value
+```
+
+## Metadata Keys
+
+| Key     | Description                           | Required |
+| ------- | ------------------------------------- | -------- |
+| `chart` | Must be `pie`                         | Yes      |
+| `title` | Chart title displayed above the chart | No       |
+
+## Data Format
+
+Each data line follows the pattern `Label: value`:
+
+```
+Sailors: 45
+Gunners: 20
+Officers: 8
+```
+
+Slices are automatically colored using the Nord palette.

package/docs/guide/chart-polar-area.md

@@ -0,0 +1,38 @@
+# Polar Area Chart
+
+```dgmo
+polar-area Captain's Skills
+
+Navigation: 90
+Swordsmanship: 75
+Leadership: 85
+Cunning: 95
+Seamanship: 80
+```
+
+## Syntax
+
+```
+polar-area Chart Title
+
+Label: value
+```
+
+## Metadata Keys
+
+| Key     | Description                           | Required |
+| ------- | ------------------------------------- | -------- |
+| `chart` | Must be `polar-area`                  | Yes      |
+| `title` | Chart title displayed above the chart | No       |
+
+## Data Format
+
+Each data line follows the pattern `Label: value`:
+
+```
+Navigation: 90
+Swordsmanship: 75
+Leadership: 85
+```
+
+Segments are automatically colored using the Nord palette.

package/docs/guide/chart-quadrant.md

@@ -0,0 +1,69 @@
+# Quadrant Chart
+
+```dgmo
+quadrant Crew Performance Assessment
+x-label Low Skill, High Skill
+y-label Low Loyalty, High Loyalty
+
+top-right Promote (green)
+top-left Train (yellow)
+bottom-left Maroon (red)
+bottom-right Watch Closely (purple)
+
+Quartermaster 0.9, 0.95
+Navigator 0.85, 0.8
+Gunner 0.7, 0.6
+Surgeon 0.8, 0.75
+Boatswain 0.6, 0.85
+Cook 0.4, 0.9
+New Recruit 0.2, 0.5
+Troublemaker 0.65, 0.2
+```
+
+## Syntax
+
+```
+quadrant Chart Title
+x-label Low Label, High Label
+y-label Low Label, High Label
+
+top-right Quadrant Label (color)
+top-left Quadrant Label (color)
+bottom-left Quadrant Label (color)
+bottom-right Quadrant Label (color)
+
+Item Name x, y
+```
+
+## Metadata Keys
+
+| Key            | Description                                             | Required |
+| -------------- | ------------------------------------------------------- | -------- |
+| `chart`        | Must be `quadrant`                                      | Yes      |
+| `title`        | Chart title displayed above the chart                   | No       |
+| `x-label`      | Two comma-separated labels for X axis (low, high)       | No       |
+| `y-label`      | Two comma-separated labels for Y axis (low, high)       | No       |
+| `top-right`    | Label for the top-right quadrant with optional color    | No       |
+| `top-left`     | Label for the top-left quadrant with optional color     | No       |
+| `bottom-left`  | Label for the bottom-left quadrant with optional color  | No       |
+| `bottom-right` | Label for the bottom-right quadrant with optional color | No       |
+
+## Data Format
+
+Each data point specifies X and Y coordinates between 0 and 1:
+
+```
+Item A 0.9, 0.95
+Item B 0.4, 0.3
+```
+
+## Quadrant Colors
+
+Colors can be specified in parentheses after each quadrant label:
+
+```
+top-right Promote (green)
+top-left Train (yellow)
+bottom-left Maroon (red)
+bottom-right Watch Closely (purple)
+```

package/docs/guide/chart-radar.md

@@ -0,0 +1,38 @@
+# Radar Chart
+
+```dgmo
+radar Ship Combat Rating
+
+Firepower: 85
+Speed: 70
+Armor: 60
+Maneuverability: 90
+Crew Morale: 75
+```
+
+## Syntax
+
+```
+radar Chart Title
+
+Label: value
+```
+
+## Metadata Keys
+
+| Key     | Description                           | Required |
+| ------- | ------------------------------------- | -------- |
+| `chart` | Must be `radar`                       | Yes      |
+| `title` | Chart title displayed above the chart | No       |
+
+## Data Format
+
+Each data line defines one axis of the radar with its value:
+
+```
+Firepower: 85
+Speed: 70
+Armor: 60
+```
+
+Values are plotted on axes radiating from the center, connected by a filled polygon.