Reference

A shortcut to other content, placed in a container’s library tree.

A Reference is a pointer wearing a name — it holds no content, only a link. Its purpose is to let one piece of content appear in more than one place without being duplicated: a monster defined in a compendium can be listed under the chapter it ambushes the party in, and a map can be filed under two locations at once.

It differs from an inline link in Page/content by being a first-class library item: it sits in the tree with its own name, position and parentId, so it shows up when browsing rather than only when reading.

• Note: The link is a soft one. Nothing keeps a reference and its target in step, so linkedObject() returns nil once the target is gone.

• SeeAlso: Group, Page, Module

View JSON Schema

Property	Type	Required	Description
id	string	Yes	The unique identifier for this reference. A UUID string automatically generated when the reference is created. This serves as the primary key in the Realm database.
name	string	Yes	The display name of the reference. Shown in the library in place of the target’s own name, so a link can be labelled for the context it appears in. Examples: "Klarg (Bugbear Boss)"
slug	string	Yes	A URL-friendly identifier for the reference. Examples: "klarg-bugbear-boss"
reference	string	No	The app URL of the content this reference points at. Examples: "/monster/bugbear"; "/map/cragmaw-hideout"; "/page/goblin-ambush" SeeAlso: linkURL, linkedObject()
parentId	string	Yes	The identifier of the Group containing this reference in the library tree. Empty for a reference at the top level of its container.
rank	integer	Yes	The manual sort position among its siblings. Lower values sort first.