- 11 minutes to read

Content Search

New 7.12

Find every document that mentions a queue, a server, or an old system name. Search content searches the text of your Articles, Snippets, Templates, and Document Profiles in one go, shows each match in context with its line number, and opens a document with the matches highlighted.

  • ✅ Search words, an exact phrase, or a regular expression
  • ✅ Choose the document types, and whether to search titles, content, or metadata
  • ✅ See each match in context, with the section and line it's on
  • ✅ Open a result with its matches highlighted, and step from one to the next
graph LR Query[fa:fa-keyboard Words, phrase,
or pattern] Search[fa:fa-magnifying-glass Search content] Results[fa:fa-list Results
one card per document] Preview[fa:fa-eye Reader dialog
matches highlighted] Edit[fa:fa-pen-to-square Editor] Tab[fa:fa-arrow-up-right-from-square New tab] Query --> Search Search --> Results Results --> Preview Results --> Edit Results --> Tab style Query fill:#2678BD style Search fill:#93d16d style Results fill:#3F827B style Preview fill:#FFD525 style Edit fill:#FFD525 style Tab fill:#FFD525

You type what you're looking for (blue), the search (green) lists one card per matching document (teal), and each card opens the document in the reader dialog, the editor, or a new tab (yellow). The search covers Articles, Snippets, Templates, and Document Profiles.

Content Search only reads. It finds text; to change it, open the document in the editor. Nothing is stored except your search options, which your browser remembers; the query text and the excerpts are not logged.

To use Content Search, you need the Administrator role, or a Role with a Repository permission set that can read Articles. The same permission covers all four document types and the document list pages. Without it, the side-menu search button is hidden and Ctrl+Shift+F does nothing.

Open Search content in one of these ways. The page you open it from decides which document types are ticked:

Open from Types ticked
next to the Articles heading in the side menu Articles and Snippets
Search content in the toolbar of All Articles Articles and Snippets
Search content in the toolbar of Snippets, Templates, or Document Profiles That page's own type
Search content in the toolbar of Documentation Health All four types
Ctrl+Shift+F, on any page, also over another dialog The same types as that page's toolbar button; Articles and Snippets on pages without one
in the reader's find bar, or Ctrl+Shift+F while you read a document Articles and Snippets, with the find bar's text (or the selected text) filled in

All Articles page header with the subtitle Select an Article to manage, and the Copy API URL, Search content, and Add Article buttons (7.12)
The Search content button sits in the toolbar of every document list.

Side menu with the search button next to the Articles heading, above All Articles, Snippets, Templates, Document Profiles, and Documentation Health (7.12)
The search button in the side menu opens Search content from anywhere under Articles.

Search content dialog opened from Documentation Health, with Articles, Snippets, Templates, and Document Profiles all ticked and the options shown (7.12)
Opened from Documentation Health, the search covers every document type, like the page's own findings.

Search content dialog opened from the reader's find bar, with link filled in (7.12)
From the find bar of one document to a search of every Article and Snippet.

Type what you're looking for, and press Enter or click Search.

Search content dialog as it opens: the search box with the Words hint below it, the options folded behind the cog, and Articles and Snippets ticked (7.12)
The dialog as it first opens. The hint under the box explains the current find mode, here Words, the default.

Tick the document types to search: Articles, Snippets, Templates, and Document Profiles. At least one stays ticked. Profile-based Articles are searched section by section. A match in a Snippet is the Snippet's own result; it isn't repeated under the Articles that include it. Deleted documents are searched only when you tick Include deleted.

Search Options

Click next to Search to show the options. When the options are folded, the line under the cog shows the find mode, and says Deleted included while Include deleted is on.

Search content dialog with the options shown at their defaults: Words, Titles and Content, Icons, Images, and Files ticked, Include deleted off (7.12)
The defaults: Words, case ignored, titles and content searched, metadata left out, and deleted documents left out.

Option Choices Default
Find Words, Phrase, or Regular expression; plus Match case and Whole word Words; Match case and Whole word off
Search in Titles (the title and the slug), Content, Metadata (the Tags and the Custom Metadata values) Titles and Content
Match inside Icons, Images, Files: also match inside icon, image, and file references (see below) All three
Include deleted Also search deleted documents Off

Your browser remembers every option you change, and whether the options are shown, for your next search. The ticked document types are never remembered: the page you open the dialog from sets them (see Search).

The hint under the box explains the current find mode:

Find Matches Example
Words (default) Every word must occur somewhere in the document, in any order. Put words in quotes to require them side by side invoice "Service Bus"
Phrase The words must occur side by side, in this order, even when the document wraps them onto the next line Service Bus queue
Regular expression A .NET regular expression of up to 512 characters. An invalid expression shows the error, an expression that matches empty text is refused, and one that takes more than a second is stopped INT[0-9]{3}

Whole word counts letters, digits, and _ as word characters, so Order doesn't match OrderNumber. Every user who can read Articles can use every mode, regular expressions included.

When the search refuses a regular expression, the dialog shows only the warning, with the reason; earlier results are cleared.

Search content in Regular expression mode with a pattern missing its closing bracket, showing the warning The expression is not valid: Unterminated set (7.12)
The closing bracket is missing, so the warning says where the pattern breaks.

Match Inside Icons, Images, and Files

Option Matches Doesn't match
Icons Icon shortcodes such as , and the text of {ndx}/… tokens, so an icon name is searchable —
Images The alt text of Markdown images, and the text of bare {ndi}/… tokens The URL or path inside ![alt](url)
Files The label of links to files, and the text of bare {ndf}/… tokens The target URL of a labelled link

When you untick an option, the whole element is left out of the search, its alt text or label included.

Search Custom Metadata

Tick only Metadata under Search in to find documents by a Tag or a Custom Metadata value, for example every Article whose Confidentiality field is set to Internal. A metadata match shows the field name and the matching value instead of a line of text.

Search content with Regular expression and only Metadata ticked, finding two Articles whose Confidentiality field is Internal (7.12)
Confidentiality is a Custom Metadata field of the Select type; both Articles have it set to Internal.

Include Deleted Documents

Tick Include deleted to also search deleted documents; the checkbox turns red as a reminder. A deleted match looks like any other result, plus a red Deleted badge. For a profile-based Article, its sections are searched with it.

Search content with Include deleted ticked, finding the deleted Article INT001: Orders - old runbook with a red Deleted badge (7.12)
The Deleted badge tells a deleted document from the current ones.

The reader page of a deleted document says that it has been deleted. To use it again, click on the card and restore the document from its edit page, or see Show deleted records.

Read the Results

The line above the results says how many documents matched, how many matches are on this page, and how long the search took, for example 12 documents, 14 matches on this page · 153 ms. When a limit cut the result, the line says so. Page through the results with the pagers above and below them, and choose 10, 25, or 50 per page.

Search content results for link: a card per document with its kind, title, match count, tags, and the matches in context with section and line number (7.12)
Each card shows where in the document the match is: the section heading and the line.

Each result is one card:

  • Header: the kind (Article, Snippet, ...), the title, the number of matches, a Deleted or Shipped badge, and the document's Tags.
  • Matches: each match with the text around it, under the section heading and line number it's on. The matched text is highlighted. In a table, the cells are separated by ·. The first two matches are shown; Show n more matches expands the rest. Click a match to open the document at that section.
  • Buttons:
    • opens the document with the matches highlighted, in a reader dialog, or in a new tab when you have chosen Open Articles in a new tab by default (see Reading Articles).
    • opens the document in the editor, at the line of the first match. Documents shipped by Nodinite are read-only, so they have no edit button.
    • opens the document in a new tab.

Best Match First

The results are sorted best match first. Each document falls in one of these classes, best first:

Class The document matches when
1 The whole title equals your search
2 Your search occurs in the title
3 Your search occurs as written somewhere in the document; for several words, side by side as typed
4 All the words occur, but not together

Classes 1 and 2 apply only while Titles is searched. Within a class, the document with more matches comes first, then the most recently changed, then the title from A to Z.

No Results

When nothing matches, the dialog suggests how to widen the search. Each suggestion is a link that changes the option and searches again, and a suggestion shows only when it would widen the search: turn off Match case or Whole word, search every kind of document, or search titles, content, and metadata together.

Search content with No matching content found and the suggestions Turn off Match case, Turn off Whole word, Search every kind of document, and Search titles, content and metadata together (7.12)
Every suggestion is a one-click way to search again more widely.

Open a Result with the Matches Highlighted

Click on a card to read the document in a reader dialog, on top of the results. A bar at the top shows your search and the match you're on, for example Search: link 1 of 3 matches. Use ˄ and ˅ to go to the previous or next match.

Reader dialog opened from a search result, with the Search: link 1 of 3 matches bar and the first match highlighted (7.12)
The bar keeps your search in view; the current match is outlined.

Close the dialog to go back to the results where you left them. Open full article, or on the card, opens the reader page in a new tab, where the same bar sits under the header; × clears the highlights.

Reader page with the Search: link 1 of 3 matches bar under the header, and the search icon at the far right (7.12)
On the reader page, the bar keeps your search; the search icon at the right opens the document's own find bar.

A match in something the reader doesn't show as text, such as an image or link reference, a token, a macro, a Tag, or a metadata value, is explained in the bar, which offers to open the editor at that line.

To search for something else in the open document, press Ctrl+F: the find bar replaces the search's highlights. Text inside Mermaid diagrams is not highlighted.

Limits

Three System Parameters keep searches fast. An administrator can change them; a value saved on the System Parameters page applies to the next search.

System Parameter Limits Default
ContentSearchMaxResults Documents one search returns 100
ContentSearchMaxMatchesPerDocument Matches listed per document; the match count stays exact 10
ContentSearchMaxScannedDocuments The newest documents a Regular expression search reads 2000

When a limit cut the result, the line above the results says which one: an orange limited to n documents badge (ContentSearchMaxResults), or only the newest n documents were searched (ContentSearchMaxScannedDocuments). Narrow the search first: tick fewer document types, search Titles only, or use Phrase or Whole word.

Search content results for INT001 Orders with the orange badge limited to 5 documents next to 5 documents, 122 matches on this page (7.12)
Here ContentSearchMaxResults was set to 5, so the result stops at five documents. Excerpts from tables show the cells separated by a dot.

Content Search for AI Assistants

The MCP Endpoint offers the same search as the tool search_content, to the Web Client's AI Assistant and to other MCP clients such as Visual Studio Code or Claude Desktop. It finds where a word, phrase, or pattern is documented and returns the matches grouped per document, with excerpts, section names, and a link to each document's reader page, so the assistant answers with links. Unlike the Web Client dialog, it searches all four document types unless told otherwise. One call returns at most 50 documents and 5 matches per document. See MCP Tool Reference.

AI Assistant answering Where is the Service Bus queue documented? with links to the Article INT001: Bad Filter on Send Port and the Snippet Receive port INT001: Receive Orders (7.12)
The AI Assistant finds the documents with search_content and links each one.

Frequently Asked Questions

Does Content Search find deleted documents?

Only when you tick Include deleted in the options. See Include Deleted Documents, and Show deleted records to restore one.

Why are Templates and Document Profiles not ticked?

The page you open Search content from decides the ticked types. From the side menu, All Articles, and most other pages, Articles and Snippets are ticked; from Documentation Health, all four are. Tick the others yourself, or click Search every kind when nothing is found.

Why does a word in a Mermaid diagram not light up in the document?

The highlighting leaves diagram text alone, so the diagram keeps drawing correctly.

Can I change the text from the results?

No. Content Search only reads. Click on the card to open the document in the editor.

Why was my regular expression stopped?

An expression that takes more than a second is stopped, so a slow pattern can't hold up the search. Make it more specific, for example anchor it on a fixed prefix such as INT[0-9]{3} instead of starting with .*.

Next Steps