Creating a Page Rendering

Intermediate

Write a page template for a type, and preview it against a real element as you go.

A rendering is the page template for one type. Every element of that type is presented through it.

Create one

  1. In the Model Navigator, click + and choose New Rendering.
  2. Pick the Target type — the node or relationship type these pages will be about, or one of the Views (as publication pages) kinds for view pages (see Showing Diagrams and Dashboards as Pages).
  3. Click Create. The rendering appears in the Renderings section and its properties panel opens.

Give it a name you will recognise later — Service page, Board summary. You can have several renderings for the same type (a rich one for the website, a short one for a management report), and each publication picks the one it wants.

Write the document

The Document field is the template. It is ordinary Markdown plus two additions:

  • {{ subject.label }} — drops in a value from the element the page is about
  • :::view{ ... } — a block that pulls in related elements

A short but genuinely useful page:

# {{ subject.label }}

:::prose{ source=subject.description }

:::properties

That is a title, the element's description rendered as Markdown, and a table of its properties — for every element of the type, automatically.

Writing Rendering Documents covers the full vocabulary.

Preview as you write

Below the document, Preview shows the page rendered against a real element; Preview subject chooses which one.

Use it constantly. The most common mistake is a block that quietly finds nothing — the page just renders without that content, and nothing in the template tells you. The preview does.

Renaming is safe

A publication remembers the rendering it selected even if you rename it. If the panel warns that a selection could not be resolved, the rendering was deleted or pointed at a different type — choose one again.

This content was written collaboratively with AI.