svg-diagram

# SVG Diagramming Conventions ## Output location and referencing > Diagrams go in SVG, never ASCII art. That rule decides *whether* to draw; this skill covers *how*, starting with where the file lands. - Put the file in an `assets/` directory next to the document (e.g. `docs/foo.md` → `docs/assets/foo-arch.svg`) - Reference it from markdown with a relative path, ``. Do not inline SVG XML. - When data in the document changes, the corresponding SVG must be updated too. A figure that contradicts the prose beside it is worse than no figure ## Core principles ### Get it right on the first pass The first SVG you generate must already satisfy every item in the verification checklist at the end of this document. Do not rely on user feedback to fix basic layout problems (spacing, padding, alignment, viewBox clipping). After generating, walk the checklist yourself and fix anything you find before showing the result. ### No overlapping elements - Text must not sit on top of boxes or lines - Lines must not cut through boxes (unless the line is an arrow terminating at that box) - Keep 10–20px between text and lines - **For spacing between sibling/adjacent boxes see the "Block spacing" section below** (single standard: ≥25px, 25–30px recommended) - Put color-key legends outside the diagram body (bottom or side), never overlapping the content area ```xml <!-- ✅ Correct: label sits beside the line --> <path d="M35,200 C 35,120 ..." .../> <text x="55" y="200">Label text</text> <!-- 20px clearance --> <!-- ❌ Wrong: label sits on the line --> <text x="35" y="200">Label text</text> ``` ### Visual balance The left and right halves should carry similar visual weight; add or remove annotation boxes to even them out. ## Layout rules ### Centering ``` content width = right edge of rightmost element - left edge of leftmost element left margin = (viewBox width - content width) / 2 ``` **Center the title on the *content* center, not the viewBox center** (they differ whenever the content is asymmetric): ```xml <!-- content center = (content left edge + content right edge) / 2 --> <text x="[content center x]" y="[top_padding + font_ascent]" text-anchor="middle">Title</text> ``` Only when the content is left-right symmetric does `content center x = viewBox width / 2`. When it is asymmetric, center the whole group with `<g transform="translate(...)">` and update the title's `x` to the new content center as well. ### Shifting everything after the fact If you only notice asymmetric left/right (or top/bottom) padding after the SVG is finished, you do not need to touch every coordinate. Wrap the content in one `<g transform="translate(dx, dy)">`: ```xml <svg viewBox="0 0 800 460" ...> <defs>...</defs> <g transform="translate(22, 0)"> <!-- all content here, coordinates unchanged --> </g> </svg> ``` **Computing the offset**: `dx = (right padding - left padding) / 2`, where padding is the distance from the viewBox edge to the nearest content element. - `dx > 0`: shift content right (use when content sits too far left) - `dx < 0`: shift content left (use when content sits too far right) When to use it: the content as a whole is off-center and you do not want to edit every `x` coordinate. Downside: the coordinates in the file no longer equal rendered positions, so later edits require mentally subtracting the offset — if a larger layout rework is coming, fold the offset into the individual coordinates and drop the `<g>`. ### viewBox margins The title is part of the content, so top and bottom margins are measured from the title: ``` title y = margin + font ascent (≈ font-size × 0.75) viewBox height = bottom y of content + margin ``` **Recommended margin**: 20–25px ```xml <!-- Example: 16px title, 20px margin --> <!-- title y = 20 + 16×0.75 ≈ 32 --> <!-- content bottom 270px, viewBox height = 270 + 25 = 295 --> <svg viewBox="0 0 680 295" ...> <text x="340" y="32" font-size="16">Title</text> ... </svg> ``` ### Box layout - Boxes in the same row differ in size by ≤60px; text is centered (`text-anchor="middle"`) - Boxes in the same column share a center line - An outer box fully encloses the inner boxes: `outer size = content size + padding × 2` ### Dashed grouping boxes (containers) Used to group related boxes together (e.g. "Server", "Client", "Employee instances"). **Style consistency**: within one diagram, every dashed grouping box must share these attributes: - `stroke-dasharray` (recommended `6,4`) - `rx` (corner radius, recommended 8–12) - `fill` (recommended `#f8fafc` or `none`) - Inner padding (recommended 15–20px) - Title font size (recommended 11px, to distinguish it from the 12px box body text) **Title placement**: put the group title inside the top-left corner of the box (`x = box x + 10, y = box y + 14`) using the secondary text color `#64748b`. **Vertical-centering trap**: compute the group box's vertical position from the combined height of **title + inner content**, not from the box alone. With a title, the top of the box is occupied for roughly 20–25px, and inner boxes start below it: ```xml <!-- ✅ Group box: title + content laid out as a whole --> <!-- box top y=100, title takes 20px, inner boxes start at y=125 --> <rect x="50" y="100" width="200" height="120" rx="10" stroke="#94a3b8" stroke-dasharray="6,4" fill="#f8fafc"/> <text x="60" y="114" font-size="11" fill="#64748b">Server</text> <!-- inner boxes --> <rect x="65" y="125" width="170" height="36" rx="6" .../> <rect x="65" y="170" width="170" height="36" rx="6" .../> ``` **Connectors pointing at a group**: when a connector logically targets a set of elements rather than one of them, terminate it on the group box boundary instead of on a single member. Alternatively, wrap the elements in a grouping box and point the arrow at that box. ### Box dimensions Derive box height from the font size so there is enough inner padding: | Content | Height formula | Example (12px font) | |---------|----------------|---------------------| | One line | font-size × 3 | 36px | | Two lines | font-size × 3 + line height | 36 + 18 = 54px | | Multiple lines | font-size × 3 + (lines - 1) × line height | +18px per extra line | **Where the formula comes from**: `font-size × 3 = top padding (≈font-size) + glyph height (≈font-size) + bottom padding (≈font-size)`. Scale the same ratio for non-standard font sizes. **Recommended line height**: font-size × 1.5 (e.g. 18px for a 12px font) ### Vertically centering text in a box (baseline positioning) In SVG, `<text y=...>` is the **baseline**, not the top of the glyph. To center text optically inside a box: ``` text y = box center y + font-size × 0.35 = box y + box height/2 + font-size × 0.35 ``` The 0.35 factor is an empirical value for "optical glyph center to baseline" (roughly one third of the font size). **Keep the two factors apart**: - `font-size × 0.75` (ascent): for elements **positioned from the top**, such as titles (y = top_padding + ascent) - `font-size × 0.35` (baseline offset): for **vertical centering inside a box** ```xml <!-- One line: height = 12 × 3 = 36px --> <rect x="30" y="50" width="110" height="36" rx="6" .../> <!-- y = 50 + 36/2 + 12×0.35 = 50 + 18 + 4.2 ≈ 72 --> <text x="85" y="72" ...>Single line</text> <!-- Two lines: height = 36 + 18 = 54px --> <rect x="30" y="50" width="110" height="54" rx="6" .../> <text x="85" y="70" ...>First line</text> <text x="85" y="88" ...>Second line</text> <!-- 18px apart --> ``` ### Display size ```xml <svg viewBox="0 0 750 400" width="750" xmlns="http://www.w3.org/2000/svg"> ``` | Diagram type | width | |--------------|-------| | Simple list | 400px | | Flowchart | 600–700px | | Architecture diagram | 700–800px | ## Connector rules ### Choosing a connector Use a straight `L` line for co-axial connections; use smooth `C`/`Q` curves whenever the path **turns or routes around** something. Never use right-angle elbows. ```xml <!-- ✅ Horizontally co-axial: straight line --> <path d="M190,77 L 320,77" .../> <!-- ✅ Vertically co-axial: straight line --> <path d="M130,145 L 130,213" .../> <!-- ❌ Right-angle elbow for a turn --> <path d="M100,100 L100,200 L200,200" .../> <!-- ✅ Smooth curve for a turn --> <path d="M100,100 C 100,150 150,200 200,200" .../> ``` | Case | Recommended | Syntax | |------|-------------|--------| | Co-axial (horizontal/vertical) | L | `L endx,endy` | | Simple turn | Q | `Q ctrlx,ctrly endx,endy` | | S-curve / complex path | C | `C ctrl1x,ctrl1y ctrl2x,ctrl2y endx,endy` | ### Arrow rules - **Direction comes from the final path segment**: rightward means x increases, downward means y increases - **Symmetric clearance**: 5px between the arrow and the source box, and the same visual clearance at the target box - **Centered labels**: `x = (source right edge + target left edge) / 2`, together with `text-anchor="middle"` **Fixing arrow direction on curved paths**: `orient="auto"` aligns the arrowhead with the tangent at the end of the path. The end tangent of a C/Q curve can be skewed, which makes the arrowhead look crooked. The fix: place the second control point (cp2) so that the direction cp2 → end point is exactly the direction you want the arrowhead to face. ```xml <!-- ❌ cp2 placed arbitrarily, arrow direction uncontrolled --> <path d="M100,100 C 100,200 250,200 300,250" marker-end="url(#arrow)"/> <!-- ✅ cp2 shares x with the end point, tangent naturally points down --> <path d="M100,100 C 100,200 300,220 300,250" marker-end="url(#arrow)"/> <!-- ✅ cp2 shares y with the end point, tangent naturally points right --> <path d="M100,100 C 100,200 270,250 300,250" marker-end="url(#arrow)"/> ``` **Rules for controlling arrow direction**: | Desired direction | cp2 constraint | Example | |-------------------|----------------|---------| | ↓ down | cp2.x = end.x, cp2.y < end.y | `C ...,... ex,ey-20 ex,ey` | | → right | cp2.y = end.y, cp2.x < end.x | `C ...,... ex-20,ey ex,ey` | | ← left | cp2.y = end.y, cp2.x > end.x | `C ...,... ex+20,ey ex,ey` | | ↑ up | cp2.x = end.x, cp2.y > end.y | `C ...,... ex,ey+20 ex,ey` | **Computing path endpoints** (5px clearance, arrowhead extends 6px past the end of the line): Core rule: **start 5px away from the source box, end 11px away from the target box** (5px clearance + 6px arrowhead extension). Because we use `refX="2"` (the notch at the tail of the arrowhead), the tip extends 6px (8-2=6) beyond the end of the line, and the line joins the arrowhead at the center of its notch, so the join reads as continuous. **Formulas for the four directions**: | Direction | Start | End | |-----------|-------|-----| | → right | source right edge + 5 | target left edge - 11 | | ← left | source left edge - 5 | target right edge + 11 | | ↓ down | source bottom edge + 5 | target top edge - 11 | | ↑ up | source top edge - 5 | target bottom edge + 11 | ```xml <!-- Rightward arrow →: source right edge 180, target left edge 220 --> <!-- start: 180+5=185, end: 220-11=209, tip reaches 209+6=215 --> <path d="M185,70 L 209,70" marker-end="url(#arrow)"/> <!-- Leftward arrow ←: source left edge 220, target right edge 180 --> <!-- start: 220-5=215, end: 180+11=191, tip reaches 191-6=185 --> <path d="M215,70 L 191,70" marker-end="url(#arrow)"/> <!-- Downward arrow ↓: source bottom 140, target top 170 --> <!-- start: 140+5=145, end: 170-11=159, tip reaches 159+6=165 -->