Skip to content

The source language ​

A Layup document contains named diagrams. Shared rules cover comments, values, annotations and scoped references; the diagram's type selects its body grammar. The optional layup 1 header asserts the supported revision. The current checkout uses this replacement syntax throughout; older title-only diagrams and bare presentation flags are rejected.

Items and blocks ​

A service and its worker{"languageVersion":1,"diagramId":"main","diagrams":["main"],"manifest":[{"id":"main","diagramType":"graph","status":"selected","reason":null,"annotations":[],"span":{"start":0,"end":387,"line":1,"column":1,"endLine":12,"endColumn":2}}],"targets":[],"diagnostics":[],"diagram":{"declaration":"diagram","attributes":{"layout":{"value":{"type":"choice","value":"auto"},"span":{"start":51,"end":62,"line":1,"column":52,"endLine":1,"endColumn":63},"valueSpan":{"start":58,"end":62,"line":1,"column":59,"endLine":1,"endColumn":63},"nameSpan":{"start":51,"end":57,"line":1,"column":52,"endLine":1,"endColumn":58}},"type":{"value":{"type":"choice","value":"graph"},"span":{"start":40,"end":50,"line":1,"column":41,"endLine":1,"endColumn":51},"valueSpan":{"start":45,"end":50,"line":1,"column":46,"endLine":1,"endColumn":51},"nameSpan":{"start":40,"end":44,"line":1,"column":41,"endLine":1,"endColumn":45}}},"path":null,"authoredId":null,"documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}},"objects":{"object:[\"api\"]":{"declaration":"node","attributes":{"palette":{"value":{"type":"choice","value":"blue"},"span":{"start":89,"end":101,"line":2,"column":25,"endLine":2,"endColumn":37},"valueSpan":{"start":97,"end":101,"line":2,"column":33,"endLine":2,"endColumn":37},"nameSpan":{"start":89,"end":96,"line":2,"column":25,"endLine":2,"endColumn":32}}},"path":["api"],"authoredId":"api","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}},"object:[\"backend\",\"store\"]":{"declaration":"node","attributes":{"palette":{"value":{"type":"choice","value":"purple"},"span":{"start":281,"end":295,"line":8,"column":26,"endLine":8,"endColumn":40},"valueSpan":{"start":289,"end":295,"line":8,"column":34,"endLine":8,"endColumn":40},"nameSpan":{"start":281,"end":288,"line":8,"column":26,"endLine":8,"endColumn":33}}},"path":["backend","store"],"authoredId":"store","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}},"object:[\"backend\",\"worker\"]":{"declaration":"node","attributes":{"palette":{"value":{"type":"choice","value":"green"},"span":{"start":242,"end":255,"line":7,"column":26,"endLine":7,"endColumn":39},"valueSpan":{"start":250,"end":255,"line":7,"column":34,"endLine":7,"endColumn":39},"nameSpan":{"start":242,"end":249,"line":7,"column":26,"endLine":7,"endColumn":33}}},"path":["backend","worker"],"authoredId":"worker","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}},"object:[\"backend\"]":{"declaration":"group","attributes":{},"path":["backend"],"authoredId":"backend","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}}},"relationships":{"relationship:\"dispatch\"":{"declaration":"edge","attributes":{},"path":null,"authoredId":"dispatch","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}},"relationship:\"save\"":{"declaration":"edge","attributes":{},"path":null,"authoredId":"save","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}}}}Copyright © 2017 IBM Corp. with Reserved Font Name "Plex" This Font Software is licensed under the SIL Open Font License, Version 1.1. This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL ----------------------------------------------------------- SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 ----------------------------------------------------------- PREAMBLE The goals of the Open Font License (OFL) are to stimulate worldwide development of collaborative font projects, to support the font creation efforts of academic and linguistic communities, and to provide a free and open framework in which fonts may be shared and improved in partnership with others. The OFL allows the licensed fonts to be used, studied, modified and redistributed freely as long as they are not sold by themselves. The fonts, including any derivative works, can be bundled, embedded, redistributed and/or sold with any software provided that any reserved names are not used by derivative works. The fonts and derivatives, however, cannot be released under any other type of license. The requirement for fonts to remain under this license does not apply to any document created using the fonts or their derivatives. DEFINITIONS "Font Software" refers to the set of files released by the Copyright Holder(s) under this license and clearly marked as such. This may include source files, build scripts and documentation. "Reserved Font Name" refers to any names specified as such after the copyright statement(s). "Original Version" refers to the collection of Font Software components as distributed by the Copyright Holder(s). "Modified Version" refers to any derivative made by adding to, deleting, or substituting -- in part or in whole -- any of the components of the Original Version, by changing formats or by porting the Font Software to a new environment. "Author" refers to any designer, engineer, programmer, technical writer or other person who contributed to the Font Software. PERMISSION & CONDITIONS Permission is hereby granted, free of charge, to any person obtaining a copy of the Font Software, to use, study, copy, merge, embed, modify, redistribute, and sell modified and unmodified copies of the Font Software, subject to the following conditions: 1) Neither the Font Software nor any of its individual components, in Original or Modified Versions, may be sold by itself. 2) Original or Modified Versions of the Font Software may be bundled, redistributed and/or sold with any software, provided that each copy contains the above copyright notice and this license. These can be included either as stand-alone text files, human-readable headers or in the appropriate machine-readable metadata fields within text or binary files as long as those fields can be easily viewed by the user. 3) No Modified Version of the Font Software may use the Reserved Font Name(s) unless explicit written permission is granted by the corresponding Copyright Holder. This restriction only applies to the primary font name as presented to the users. 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font Software shall not be used to promote, endorse or advertise any Modified Version, except to acknowledge the contribution(s) of the Copyright Holder(s) and the Author(s) or with their explicit written permission. 5) The Font Software, modified or unmodified, in part or in whole, must be distributed entirely under this license, and must not be distributed under any other license. The requirement for fonts to remain under this license does not apply to any document created using the Font Software. TERMINATION This license becomes null and void if any of the above conditions are not met. DISCLAIMER THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE FONT SOFTWARE.A service and its workerPublic APIPOST /jobsAccepts a request and returns a job identifier.BackendWorkerStoragesavedispatch
text
diagram main "A service and its worker" type=graph layout=auto {
  node api "Public API" palette=blue {
    code "POST /jobs"
    text "Accepts a request and returns a job identifier."
  }
  group backend "Backend" {
    node worker "Worker" palette=green
    node store "Storage" palette=purple
    edge save worker -> store "save"
  }
  edge dispatch api -> backend.worker "dispatch"
}

Statements end at a newline or semicolon. Braces contain nested statements. // comments continue to the end of the line; /* … */ comments can appear inline, span lines and nest. Comment markers inside strings remain text.

Graph object declarations have an explicit ID, optional display label and named properties. A quoted ID can contain punctuation without changing reference rules. Every graph object uses a fixed declaration such as node or group; style=service selects a presentation style without introducing a keyword.

text
node api "Public API" style=service palette=blue
edge dispatch api -> worker "dispatch" stroke-style=dashed

Edges can precede their endpoints. All supported definitions are validated before diagram or view selection.

Scoped identities and stable names ​

IDs are unique within their container. A group, package, crate or composite state introduces a scope. A reference such as backend.worker resolves from the current scope; ::backend.worker resolves from the diagram root. Sibling scopes may each declare worker. Rows and sequence fragments organize content without creating identity scopes.

Labels can change without changing IDs. Objects require explicit IDs. Named edges use edge ID FROM -> TO; sequence messages require message ID and states use transition ID. Graph edges and state transitions can also be anonymous. Name relationships that views, steps or external tools use. Renderer IDs are opaque; use document metadata's objectPath and authoredId to recover authored identities.

Typed values, strings and Unicode ​

Properties and annotation arguments distinguish choices, strings, integers, floats, booleans, null, lists, records and references. blue and "blue" retain different types in inspection even when a style property accepts both. Integers are exact within signed/unsigned 64-bit ranges; floats must be finite. Geometry imposes further constraints, such as positive widths and row weights.

text
row weights=[1, 2] gap=24 { … }
slide size={width: 1200, height: 1800}
@company.analysis(data={public: true, score: 1.5, tags: ["entry", "HTTP"]})

Strings support \", \\, \n, \t and \r, as well as literal newlines. Unknown escapes, repeated properties and duplicate record keys are errors. Identifiers support Unicode letters and combining marks, digits, underscores and internal hyphens. Dots separate reference segments; quote a segment whose ID contains punctuation.

Backticks inside a prose string create an inline code run:

text
text "The worker calls `process(job)` before saving the result."

Content and diagram grammars ​

Graph nodes accept text, code and tag content. Containers hold child objects; row, section, band, divider and gap organize layout. Sequence diagrams use participants, named messages, chronological notes and fragments. State diagrams use semantic states, markers and transitions, plus entry and exit display actions.

TypeLayout and semantics
type=graphAuthored blocks or layout=auto with directed relationships
type=state-machineScoped initial/final validation, reachability and machine placement
type=sequenceAuthored participant columns; event order advances downward

Annotations such as @source, @doc and @meta attach code locations and evidence. Arbitrary annotations are preserved in order. Unavailable diagram types are preserved and skipped with warnings. See shared language rules and the DSL reference for the complete contract.

MIT OR Apache-2.0 · Bundled fonts: SIL OFL 1.1