User Guide
Quick Reference Card
A single-page reference for all three macros, supported diagram types, and common LaTeX patterns.
Three Macros at a Glance
| Macro | Language | Best For | Reference |
|---|---|---|---|
| Easy Uml Diagrams | Diagram code | Flowcharts, sequence diagrams, ERDs, Gantt charts, mindmaps | Diagrams Macro |
| LaTeX Block Equations | LaTeX | Standalone centred equations, matrices, multi-line derivations | LaTeX Block |
| Latex Inline Equations | LaTeX | A single formula placed inline within paragraph text | LaTeX Inline |
Supported Diagram Types
| Type | Opening Keyword | Best For |
|---|---|---|
| Flowchart | flowchart TD or flowchart LR | Process flows, decision trees |
| Sequence Diagram | sequenceDiagram | API calls, system interactions |
| Entity Relationship | erDiagram | Database schemas, data models |
| Gantt Chart | gantt | Project timelines, sprint planning |
| Mindmap | mindmap | Topic breakdown, brainstorming |
| Class Diagram | classDiagram | OOP class structures |
| State Diagram | stateDiagram-v2 | State machine flows |
| Pie Chart | pie | Simple proportional data |
Common LaTeX Patterns
| Formula | LaTeX |
|---|---|
| Fraction | \frac{a}{b} |
| Square root | \sqrt{x} |
| Power / subscript | x^{2}, x_{i} |
| Greek letters | \alpha, \beta, \pi |
| Summation | \sum_{i=1}^{n} x_i |
| Integral | \int_{a}^{b} f(x)\,dx |
| Matrix (2×2) | \begin{pmatrix} a & b \\ c & d \end{pmatrix} |
| Aligned equations | \begin{aligned} ... \end{aligned} |
Editor Workflow (All Three Macros)
- Insert macro via
/command - Write or paste source in the left (Source) panel
- Preview renders live in the right (Preview) panel
- Use the Samples dropdown (Easy Uml Diagrams) or the Formula Examples gallery (LaTeX Block Equations, Latex Inline Equations) for ready-to-use examples
- Click Save in the editor - then Publish the Confluence page
Editing on Published Pages
Published macros don't have on-page controls. To make a change, open the page in edit mode and click the rendered macro to reopen its editor.