Clause de non-responsabilité: Cet article a été généré par traduction automatique.

Snippets

Prev Next
This content is currently unavailable in French. You are viewing the default (English) version.

A snippet is a reusable block of content — text, paragraphs, tables, images, callouts, code blocks, or a combination — that you create once and insert into multiple articles. When you update a snippet, the change is automatically reflected in every article that uses it.

Snippets are stored in a central library within Document360 and are invisible as a separate element to readers. On the knowledge base site, snippet content renders as regular article content — readers cannot tell the difference.

Why use snippets?

Snippets address a common documentation problem: content that appears in multiple articles needs to be maintained in multiple places. Without snippets, updating a product disclaimer, a support contact block, or a shared warning means finding every article that contains it and editing each one individually. A missed instance leads to inconsistent information.

With snippets, that content lives in one place. The benefits are:

  • Single source of truth — one edit, consistent updates everywhere.

  • Reduced maintenance overhead — no hunting across articles for repeated content.

  • Consistency at scale — the same warning, note, or step appears identically across all articles.

  • Faster authoring — writers insert predefined blocks instead of retyping or copy-pasting.

Snippets vs variables - when to use which

Document360 offers two content reuse tools. Choosing the right one depends on what you are reusing:

Snippets

Variables

Content type

Formatted blocks — paragraphs, tables, images, callouts, code

Plain text values — names, numbers, URLs, short phrases

Typical use

Disclaimers, shared steps, contact blocks, repeated warnings

Product names, version numbers, support email addresses

Can contain formatting?

Yes — full editor formatting

No — text only

Can nest other snippets?

Yes (Markdown snippets only)

Yes

Inserted via

Toolbar ({} button) or merge code syntax

Toolbar or merge code syntax


Accessing the Snippets page

You can view, edit, or delete a snippet from the Snippets page.  

  1. Navigate to Content tools (Content tools icon) in the left navigation bar in the Knowledge base portal.

  2. In the left navigation pane, navigate to Content resources > Snippets.

    The Snippets page displays a list of all snippets that have been added to your project.

Overview of snippets management interface with highlighted options for creating and finding duplicates.

  1. How to: View a tutorial on how to use snippets.

  2. Docs: Open the documentation article about snippets.

  3. Create: Create a new snippet.

  4. Duplicate content detection: Identify and manage duplicate text across your documentation and convert them into snippets.

  5. Languages: Filter the snippet list by Global or a specific language.

  6. Search snippets: Search for snippets by name.

  7. Selection box: Select one or more snippets to perform bulk delete action.

  8. Name: Click the snippet name to preview its content.

  9. Used in: Shows where the snippet is used.

    • If the snippet is unused, the field shows a dash -.

    • If the snippet is used, click View to see the articles or category pages where it has been inserted.

  10. Language: Indicates the language of the snippet.

  11. Last modified: Displays the date and time the snippet was last updated.

  12. Translation status: View the translation status of the snippet. Click the globe () icon next to each snippet. A indicates that the snippet has been translated into that language, while the icon indicates it has not yet been translated.

  13. Edit (): Edit the snippet content.

  14. Delete (): Click to delete a snippet. To delete multiple snippets in a single instance, select the desired checkboxes and click Delete at the top.