Runic
REFERENCES

See every document that calls this one

A badge counts the callers. Open it to list every .go and .do site with its document and line, and click straight through.

Try it free →Read the docs

What it is

Documents call each other with .go (jump and stop) and .do (run, then return). Both document kinds have the two commands: a process can call a sequence diagram, a diagram can reference a process. The reference index turns those lines into a symbol table: who calls whom, from which line, and whether the target exists. The same index drives autocomplete, rename, the broken-link quick fix, the process map and the sidebar’s nesting.

How it works

A row in the sidebar shows a violet pill with a count when other documents reference it; the tooltip reads “Referenced by N places — click to list”. Click it and a panel titled “References to “Name”” opens beside the sidebar, one row per call site: the calling document, “· line N”, and the line itself in monospace.

Click a row to switch to that document. When the call site is in a process, the editor scrolls to the line, puts the caret on it and flashes it for 1.4 seconds; when it is in a sequence diagram, the diagram opens without the line jump. Any folds in the document you came from are cleared. Esc or a click outside closes the panel.

Matching is by full name, case-insensitive and trimmed; an arrow caption after the name is not part of the target. When a process and a sequence diagram share a name, the process is the definition; within one kind the earlier document in the list wins. Renaming keeps names unique across both kinds, so the tie only arises from documents that already existed.

The index also shapes the sidebar. A document nests under its caller only when exactly one other document references it, with .go or .do; anything called from two places stays top-level with its badge. When two documents call each other, one of the pair is kept at the top level so the pair never vanishes from the list.

Why it matters

“What breaks if I change this?” is the question before every edit. The badge answers it at a glance and the panel walks you through each caller in context, instead of a search across every document.

Limits

References inside the same document do not count toward the badge. The sidebar indents nesting up to three levels; deeper rows stay at the third indent. The panel is a fixed box 340 px wide and at most 300 px tall, so a very long list scrolls inside it.

How to use it

  1. Find the badge
    In the Documents list, look for the violet pill with a number on the right of a row. No pill means nothing calls it yet.
  2. Open the panel
    Click the pill. A panel titled “References to “Name”” lists every calling document with “· line N” and the exact .go or .do line.
  3. Jump to a call site
    Click a row. The editor switches to that document; in a process it scrolls to the line, puts the caret on it and flashes it.
  4. Jump from the text
    In a process, hold ⌘ (Ctrl on Windows) and click a .go or .do line to open the document it names, whichever kind it is; in a sequence diagram click the REF or GO TO box instead. Clicking a Go or Do card in the process diagram does the same.
  5. Close it
    Press Esc or click anywhere outside the panel.

Commands & shortcuts

.go NameJump to another document; the path ends here
.do NameRun another document, then return
Referenced by N placesSidebar badge tooltip; click to list
⌘ / Ctrl + clickIn a process, on a .go/.do line: opens the referenced document (in a sequence diagram, click the REF box)
EscCloses the References panel
references (MCP)The same index as a tool: every .do/.go edge, orphans, unresolved names, cycles

Tips

  • A row that is indented under another in the sidebar has exactly one caller. Collapse the caller’s chevron to hide its subprocesses; the choice is remembered.
  • Before renaming or deleting a document, open its References panel and walk the list.
  • Drop a sidebar row onto the middle of another row and the target document gains a .do line calling the dropped one; the nesting appears the moment the panel re-renders.
  • An amber dot on a sidebar row means the document contains a reference to a name that no document answers to.

Questions

Why does a .do to itself not show in the badge?

The badge counts call sites in other documents; a document referencing itself is excluded. Two .do lines in the same caller count as two. The panel lists every site, including self-references.

Why is a called document still at the top level?

It has two or more distinct callers, or it is the member of a two-way cycle that Runic keeps at the top so the cycle stays reachable. Only single-parent documents nest, so the tree never misrepresents shared subprocesses.

Does the index see sequence diagrams?

Yes. A .do or .go line in a sequence diagram is a call site, a sequence diagram can be the target of a process’s .do, and a diagram nests under its only caller like a process does. If a process and a diagram share a name, the process is what the reference resolves to.