- 8 minutes to read

Macros Reference

New 7.11

Every macro and content token available in Nodinite Articles, in one place — what each one resolves to, and when it's available.

  • ✅ Look up any macro by category instead of hunting through the editor
  • ✅ Know exactly when a macro is available and when it isn't
  • ✅ Understand which macros require Resource or C4 node context
  • ✅ Use the same macros inside a Snippet as inside an Article
  • ✅ Reference Snippets, images, files, Articles, and inline icons by name with content tokens

Contoso O2C: order intake runbook in the Markdown editor, linked to the Integration INT1337 - Order-to-Cash; Macro Help opens Document Macro Help, Copy example on the entity.url row, the example pasted after Integration:, Save, View, and the read mode showing Integration: INT1337 - Order-to-Cash as a link, animated walkthrough (7.12)
Animated walkthrough: in the editor, open Macro Help, click Copy example on the entity.url row, paste it into the text, Save, and View. The macro shows the linked Integration's name as a link to its page, because the Article is linked to exactly one Repository entity.

How Macros Resolve

A macro is a {{ name }} placeholder that resolves every time the document is displayed. This page lists every supported macro and where it resolves.

Core Facts

  • Naming — macro names are case-insensitive
  • Unknown macro — left as written, unresolved
  • Full list — also available from the editor's Document Macro Help dialog, which shows the same groups as this page, each with when it is available. Open it with Macro Help in the Markdown editor's toolbar, or the icon in a Content Part's toolbar
  • New 7.12 Copy as Markdown in the dialog copies every group with all examples, plus the content tokens; Copy example, shown when you hover a row, copies that row's example, such as [{{ entity.name }}]({{ entity.url }}) for entity.url
  • Also resolve inside — Snippets, so a shared header or footer can show the current Article's own title, date, and so on

The dialog sums it up: Document macros are safe value substitutions only. They do not execute code and are resolved every time the document is displayed. Names are case-insensitive; an unknown name is left as written. Macros also resolve inside Snippets, so a shared header or footer shows the current Article's own values.

There is no insert-a-macro button: type a macro, or copy it from the dialog. The Insert buttons write content tokens instead; see Content Tokens.

Document Macro Help dialog with Copy as Markdown, the intro text, and the Date and time and Article groups, each marked Available: Always, with Macro, Description, and Example columns (7.12)
The Document Macro Help dialog, grouped like this page.

Date and Time Macros

Macro Resolves to Available when
year The current year Always
today The current date Always
now The current date and time Always
year.utc, today.utc, now.utc The UTC equivalent of the macro above Always

Article Macros

Macro Resolves to Available when
article.title The Article's title Always
article.description The Article's description Always
article.id The Article's id Always
article.url The Article's URL Always
article.slug The Article's slug, the readable part of its URL Always
article.tags The Article's tags Always
article.created, article.created.utc When the Article was created Always
article.updated, article.updated.utc When the Article was last updated Always

Environment Macros

Macro Resolves to Available when
customername The value of the CustomerName system parameter Always
environmentname The current environment's name Always
product.version The running Nodinite version Always
currentuser.name The signed-in user's name Always

The shipped Standard Footer Snippet uses these macros: it shows {{ customername }} · {{ environmentname }} · Nodinite {{ product.version }}, and the shipped Standard Copyright Snippet reads © {{ year }} {{ customername }}. All Rights Reserved.

Repository Entity Macros

New 7.12

Macro Resolves to Available when
entity.name The entity's name Shown for a Repository entity
entity.type The entity type: System, Service, Integration, Contract, MessageType, EndPoint, or Domain Shown for a Repository entity
entity.id The entity's id Shown for a Repository entity
entity.description The entity's description Shown for a Repository entity
entity.url The entity's page in the Web Client Shown for a Repository entity
entity.componenttype The entity's Component Type name Shown for a Repository entity
entity.icon The entity's Component Type icon Shown for a Repository entity

A document is shown for a Repository entity when, in this order:

  1. you open it from that entity's Articles card;
  2. otherwise, it is shown on a C4 diagram node bound to the entity;
  3. otherwise, the Article is linked to exactly one Repository Model entity.

With several linked entities and no page context, the entity.* macros stay empty in the reader.

{{ entity.icon }} {{ entity.name }}
[{{ entity.name }}]({{ entity.url }})

Resource Macros

Macro Resolves to Available when
resource.name, resource.type, resource.environment, resource.category, resource.application, resource.description The Resource's own field values Shown for a Monitoring Resource
resource.created, resource.created.utc, resource.updated, resource.updated.utc When the Resource was created or last updated Shown for a Monitoring Resource
resource.agentname, resource.logtext, resource.state The Resource's monitoring agent, latest log text, and current state Shown for a Monitoring Resource

C4 Diagram Node Macros

Macro Resolves to Available when
node.name, node.type, node.technology The bound node's own field values Shown for a C4 diagram node
node.componenttype The node's Component Type name Shown for a C4 diagram node
node.icon The Component Type's icon — Font Awesome, Azure, custom upload, or Mermaid Shown for a C4 diagram node
node.entity.name, node.entity.type, node.entity.description, node.entity.url The Repository entity the node is bound to Shown for a C4 diagram node bound to a Repository entity

Warning

The node.* macros only resolve on a C4 diagram node. On a Repository entity's own page, use the Repository Entity Macros, such as entity.componenttype and entity.icon.

A content token is different from a macro: instead of resolving a value, it references other Nodinite content by name, so a document stays portable between environments. You rarely type one by hand: each editable section has a toolbar that opens a picker and inserts the token for you.

The Main Body Content Part Overview in the WYSIWYG editor, its toolbar ending with Insert Image, Insert File, Insert Article Link, Insert Snippet, Insert Icon, and Macro Help (7.12)
The toolbar above every editable section. Each Insert button opens a picker and writes the content token for you; Macro Help lists every macro and token.

Button Inserts
Insert Image An {ndi} image from the Image Library
Insert File An {ndf} link to a file in the File Library
Insert Article Link An {nda} link to another Article
Insert Snippet An {nds} Snippet include
Insert Icon An {ndx} inline icon, the same icons as Component Types (shown only with a Mapify license, see below)
Macro Help Opens the Document Macro Help dialog, which lists every macro and content token

Each token can also be typed or pasted directly into the Markdown:

Token References Example
{nds}/<slug> Includes the Snippet with that slug at this position {nds}/std-header
{ndi}/<name-or-id> The address of an image in the Image Library; use it as a Markdown image. A reference-style image takes an optional size: xxs, xs, s, m, l, xl, or xxl ![Logo]({ndi}/company-logo), or the reference style the image button writes: ![Logo][ndi-24][m] with [ndi-24]: {ndi}/company-logo, where 24 is the image id
{ndf}/<name-or-id> The address of a file in the File Library; use it as a Markdown link [Specification]({ndf}/spec-v2)
{nda}/<slug-or-id> The address of another Article; use it as a Markdown link [Overview]({nda}/erp-overview)
{ndx}/<source>/<reference>[size] An inline icon from the same sources as Component Type icons — see below {ndx}/fa/far/fa-cloud

Inline Icons with

New 7.11

Put the same icons you use for Component Types straight into the text of an Article, Snippet, or Template: a cloud icon next to an Azure service, a brand icon next to a partner, or your own uploaded icon in a runbook step.

Important

The {ndx} token requires a Mapify license, the same license that includes Mapify Component Type icon support. If your Nodinite instance doesn't have the Mapify license, the editor doesn't show the Insert Icon button.

Source Reference Example
fa Font Awesome, as <style>/<name> {ndx}/fa/far/fa-cloud, {ndx}/fa/fab/fa-github
azure An Azure service icon, as <category>/<file> {ndx}/azure/databases/10121-icon-service-Azure-Cosmos-DB.svg
mermaid The Mermaid logo, as <category>/<file> (the only Mermaid icon shipped) {ndx}/mermaid/mermaid/mermaid.live.logo.svg
custom An uploaded custom icon, by id {ndx}/custom/12

Azure category folders can contain spaces and other special characters, which are URL-encoded in the token, for example {ndx}/azure/ai%20%2B%20machine%20learning/00028-icon-service-Batch-AI.svg. The icon picker writes the encoding for you.

Add an optional size in square brackets directly after the reference. The size names match the image size modifiers, but because icons sit inline with the text, they map to an icon scale rather than the image pixel widths:

Size Image icon Font Awesome class
(none) 20 px, the Component Type size (none)
xxs 12 px fa-2xs
xs 16 px fa-xs
s 24 px fa-sm
m 32 px fa-lg
l 48 px fa-xl
xl 64 px fa-2xl
xxl 96 px fa-3x
{ndx}/fa/far/fa-circle-exclamation Renew the certificate before it expires.
The certificate is stored in {ndx}/azure/app%20services/00049-icon-service-App-Service-Certificates.svg App Service Certificates.
Messages are archived in {ndx}/fa/far/fa-cloud Azure Blob Storage.
Source code lives in {ndx}/fa/fab/fa-github[l] GitHub.
Owned by the {ndx}/custom/12[m] Finance integration team.

Examples of inline icons: Font Awesome icons and an Azure service icon at the default size, a brand icon at size l, and a custom uploaded icon at size m.

Note

Sizes are names only. A numeric suffix such as [64] isn't recognized; like any unknown size name, it stays in the text as written, after the icon.

Next Steps