- 9 minutes to read

Reading Articles

New 7.11

Every reader tool below works the same way regardless of document type — whether you're reading an Article, a Snippet, a Template, or a Document Profile.

  • ✅ Jump straight to any heading with a pinnable Table of Contents
  • ✅ Find a word in a long document with Ctrl+F, without the rest of the page getting in the way
  • ✅ See everything a document uses and everything that uses it
  • ✅ Spot a missing or deleted reference before it becomes a support ticket
  • ✅ Know the impact of a change before you make it
  • ✅ Read an Article from a Repository list or a Monitor View without leaving the page

Read a Contoso O2C runbook with the Table of Contents, Find in this document, the Relationships panel, and the Relationship Map, animated walkthrough (7.12)
Animated walkthrough: a runbook from the Order-to-Cash demo read with the toolbox, from the Table of Contents to the Relationship Map.

  1. Open the Article in read mode, here Contoso O2C: order flow runbook.
  2. Click the TOC tab to open the Table of Contents, and click a heading, such as Failed orders, to scroll it into view.
  3. Click at the far right of the header and type ORD-10008 in Find in this document. The bar shows 1 of 2; press Enter to go to 2 of 2.
  4. Click Relationships to open the panel. It lists the Snippets the runbook includes, a deleted one among them, the Systems, Services, Integrations, and Domains it documents, the Linked Content Issues, and the Reference Explorer.
  5. Next to it, the Relationship Map draws the same relationships.

Understanding the Reader Toolbox

graph TD Document[fa:fa-file Document being read] TOC[fa:fa-list Table of Contents] Find[fa:fa-magnifying-glass Find in this document] Relationships[fa:fa-diagram-project Relationships Panel] Map[fa:fa-share-nodes Relationship Map] RefExplorer[fa:fa-magnifying-glass Reference Explorer] Print[fa:fa-print Print] Download[fa:fa-download Download] Document --> TOC Document --> Find Document --> Relationships Document --> Map Document --> RefExplorer Document --> Print Document --> Download

The reader toolbox sits alongside any Article, Snippet, Template, or Document Profile you open to read.

Table of Contents Toolbox

Collapsed by default behind the TOC tab; open it on demand. Pin it to keep it open — the pinned state is remembered per browser. While you scroll, it highlights the current heading, and clicking any entry jumps straight there. Below the headings, the toolbox shows the document's Dependency Impact.

Table of Contents toolbox pinned open for a runbook, with Escalation highlighted and Dependency Impact below it reporting 1 of 2 Snippets resolved and 1 unresolved snippet token (7.12)
The pinned Table of Contents highlights the heading you're reading; Dependency Impact warns about the unresolved Snippet.

Find in This Document

New 7.12 Press Ctrl+F, or click the search icon at the far top right of the reader header, to search only the document you're viewing. A slim find bar floats over the top right of the document. It takes no space from the text and stays in view as you scroll; while it's open, the Table of Contents tab moves down under it.

Reader page header with the search icon at the far right, after Download (7.12)
The search icon sits at the far right of the header. Below it, the bar of a Content Search you came from.

Find bar with the Find in this document box, the previous and next buttons, the search everywhere button, and close (7.12)
The find bar: type in Find in this document, step with ˄ and ˅, or search everywhere with .

  • Search: matches are highlighted as you type, ignoring case, and the bar shows n of m or No matches. If you selected text in the document first, the find bar starts with that text.
  • Move between matches: Enter and Shift+Enter, F3 and Shift+F3, or the arrow buttons go to the next or previous match, and wrap around at the end. A match inside a collapsed section opens that section.
  • Close: Esc or the close button removes the highlights and closes the bar. When you open it again, your last search is back.

Reader page of a runbook with ORD-10008 typed in the find bar, 1 of 2 matches, the current match outlined and the other highlighted (7.12)
The current match is outlined; the others are highlighted.

  • Diagrams: text inside Mermaid diagrams is not searched.
  • Search everywhere: the button opens Content Search with your text filled in, to search every Article and Snippet, not only this document.

Search content dialog opened from the find bar, with Order Entry filled in and Articles and Snippets ticked (7.12)
The search everywhere button takes your text to Search content.

Tip

Need the browser's own find, for example to search the whole page? Press Ctrl+F a second time while the find box has focus. Ctrl+F also goes to the browser while a dialog such as Compare or Mermaid is open, and when the document is shown in a reader dialog on another page.

The reader only finds. To change the text, press Ctrl+H: the document opens in the editor with the find bar's text, or the selected text, in the editor's replace bar. It works where the page offers Edit, never for shipped or deleted documents; see Find and Replace in the Editor.

When you open a document from a Content Search result, a bar under the header shows that search, such as Search: ORD-10008 1 of 2 matches, with ˄, ˅, and × to clear the highlights. Ctrl+F replaces those highlights with the find bar.

Relationships Panel

Lists what the document uses and what it is used by:

Direction Shows
Uses The Snippets it includes; its Document Profile, and the Snippets that profile's Parts use; its Source Template
Referenced by Related Resources, Categories, Applications, and C4 diagrams
Documents New 7.12 The Systems, Services, Integrations, Contracts, Message Types, Endpoints, and Domains the Article is linked to, one badge group per kind. You see only the ones your Role lets you read; an administrator sees all of them

Deleted related documents are still listed and marked, so a broken relationship stays visible instead of silently disappearing. The panel is collapsed until you open it.

Relationships card of the Snippet Contoso O2C: escalation contacts, Referenced by one runbook, with its Reference Explorer and Relationship Map (7.12)
The Relationships panel of a Snippet lists the Articles that include it under Referenced by.

New 7.12 An Article lists the Repository entities you linked in the editor as badge groups in the panel, after Resources.
Relationships panel of a runbook with badge groups for the linked Systems, Services, Integration, and Domains, followed by the Linked Content Issues banner and the Reference Explorer (7.12)
Each kind of Repository Model entity gets its own badge group.

Relationship Map

A Mermaid diagram of the same relationships, always drawn as one left-to-right flowchart: the documents that reference this one, the document itself, and then one node per kind of relationship, fanning out to its items. For the same relationships across the whole Repository, open the document in Mapify.

Relationship Map of a Snippet: Contoso O2C: order flow runbook, Referenced by, Snippet: Contoso O2C: escalation contacts (7.12)
The map of a Snippet starts with the runbook that includes it.

New 7.12 The map draws a node for each linked Repository Model entity, grouped under one node per kind that counts them when there are several.
Relationship Map of a runbook fanning out to Snippets (2), Systems (2), Services (2), Integrations, and Domains (2), each with its items (7.12)
Each kind gets its own branch.

Reference Explorer and Linked-Content Issues

A filterable list of every image from the Image Library, file from the File Library, Snippet, and Article reference in the document, each marked resolved, missing, deleted, or wrong type — with an issue count so a broken reference is never buried in a long document.

A deleted Snippet that a document still includes shows in the text as Missing snippet '…' (Snippet not found), and under Issues as its {nds}/… token.

Reference Explorer filtered on Issues (1), listing the snippet token of a deleted Snippet (7.12)
The Issues filter shows only the broken references, here the token of a Snippet that was deleted.

New 7.12 A Repository (n) chip filters the list to the Repository entities the Article is linked to. The count and the list hold only the entities you may read. A linked entity that has since been deleted is listed under Issues, so you know to remove the link or restore the entity (see Show deleted records).
Linked Content Issues banner reporting 1 broken reference, and the Reference Explorer with Issues (1) and Repository (7) among the filters, listing the deleted Snippet token, the included Snippet, and the linked Systems, Integration, Services, and Domains (7.12)
Repository (7) counts the linked entities. Issues collects every broken reference, here a deleted Snippet; a deleted Repository entity is listed there the same way.

Tip

While editing, the reference health banner checks the same {nds}/, {ndi}/, {ndf}/, {nda}/, and custom-icon {ndx}/custom/ references live, as you type. Font Awesome, Azure, and Mermaid icons ship with Nodinite, so their {ndx} references are never flagged. It's a warning, not a save blocker — the Reference Explorer above is where you go afterward to see the full picture and fix things.

Dependency Impact

For a Snippet, Template, or Document Profile, the reader shows every document that depends on it — so the effect of a change is visible before you make it, not after.

Print

Print the document directly from the reader.

Download

Download the document as a Markdown file from the Download menu in the toolbar:

  • Markdown (as shown) - what you see in the reader, with macros already replaced by their values.
  • RAW markdown - the source as written. Macros, links, and references to other content stay as they are, so the content they point to isn't included.

Download menu on the reader with Markdown (as shown) and RAW markdown (7.12)
Markdown (as shown) suits sharing; RAW markdown suits reusing the source elsewhere.

Compare

New 7.12 Click Compare in the reader's header and pick another document to compare this one with, side by side. The compare tool only reads, so you can use it with read access to the Repository. See Compare Articles.

Reader page header with the Compare button between Mermaid and Edit, followed by Print and Download (7.12)
Compare opens the compare tool with this document on the left and the one you pick on the right.

Read an Article Without Leaving the Page

New 7.12 You don't have to open the reader page to read an Article. Wherever a row shows the Articles button, click an Article to read it in a reader dialog on top of the page you're on, and close it to carry on where you were.

The button appears on:

Where Shows the Articles of
The lists of Systems, Services, Integrations, Contracts, Message Types, Endpoints, and Domains, in the Repository and Administration menus The entity on the row (see the Articles card)
The live tab of a Monitor View The Resource on the row, including Articles shared through its Category or Application
The status dialog in the Integration Landscape The Resource

With one Article, the button opens it directly. With several, the badge on the button counts them, and the button opens a list. Each entry has a icon that opens the Article in a new browser tab instead.

Articles list of a System row opened, listing two Contoso O2C runbooks with new-tab icons and the Open Articles in a new tab by default check box (7.12)
Click a title to read it in the dialog, or the icon next to it to open a new tab.

The reader dialog shows the Article with its macros filled in for the row you came from, exactly as on the full reader page, with badges for when it was created and changed and how long it takes to read. Use the icons in its header to maximize it, open the Article in a new tab, or close the dialog; Esc or a click outside it closes it too. Click Open full article at the bottom to open the reader page, with its toolbox, in a new tab.

Reader dialog of Contoso O2C: order flow runbook opened from the Systems list, with the created, changed, and reading-time badges, the Article text, and Open full article (7.12)
The reader dialog opens on top of the page; the list stays where you left it.

Prefer a new tab every time? Tick Open Articles in a new tab by default at the bottom of the button's list. Nodinite remembers the choice in your browser, so set it again on another computer or browser. Untick it to get the dialog back.

You see the button only when you may read the Articles: on the Repository lists, your Role needs access to Articles in the Permission Set for the Repository Model; in a Monitor View, it needs View Articles in the Permission Set for Monitor Views.

Next Steps