Single-source with snippets

  1. RoboHelp User Guide
  2. Introduction
    1. What's New in Adobe RoboHelp?
    2. What's new in RoboHelp (2020 Release) Update 6
    3. What's new in RoboHelp (2020 Release) Update 5
    4. What's new in RoboHelp (2020 Release) Update 4
    5. RoboHelp system requirements
    6. RoboHelp FAQs
    7. Download and install your Adobe app
    8. Download and install RoboHelp on macOS
    9. Get to know the RoboHelp workspace
    10. Fixed issues in RoboHelp
  3. Projects
    1. Plan your RoboHelp project
    2. Create a project
    3. Work with topics and folders
    4. Generate reports
    5. Work with context-sensitive help
    6. Manage References
    7. Set preferences in RoboHelp
  4. Collaborate with authors
    1. Collaborate using Git
    2. Collaborate using SharePoint Online
    3. Collaborate using Azure DevOps (Team Foundation Server)
  5. Editing and formatting
    1. Format your content
    2. Create and manage cross-references
    3. Create and manage links
    4. Single-source with snippets
    5. Work with images and multimedia
    6. Create and use variables for easy updates
    7. Work with Variable Sets
    8. Use Find and Replace
    9. Auto save your content
    10. Side-by-side editing in Split View
    11. Use the Spell Check feature
    12. Create and Edit Bookmarks
    13. Insert and update fields
    14. Switch between multiple views
    15. Autonumbering in CSS
  6. Import and linking
    1. Import Markdown files into a project
    2. Import Word documents into a project
    3. Import FrameMaker documents into a project
  7. TOCs, indexes, and glossaries
    1. Create and manage a Table of Contents
    2. Create and manage an index
    3. Create and manage a glossary
    4. Create and manage browse sequences
    5. Work with See Also and Related Topics
  8. Conditional content
    1. What is conditional content
    2. Create and apply condition tags
    3. Configure output presets for conditional content
    4. Optimize and manage conditional content
  9. Microcontent
    1. Microcontent
  10. Review and Collaboration
    1. Review and Collaboration
  11. Translation
    1. Translating content to multiple languages
    2. Configure a translation framework for a service provider
  12. Skins and master pages
    1. Work with skins
    2. Work with master pages
    3. Work with labels
    4. Customize PDFs
    5. Introduction to Frameless Skin Editor
  13. Generating output
    1. Generate output
    2. Generate Frameless output
    3. Generate Knowledge Base output
    4. Generate PDF output
    5. Generate Responsive HTML5 output
    6. Generate Word Document output
    7. Generate Content Only output
    8. Generate eBook output
    9. Generate Microsoft HTML Help output
    10. Generate Mobile App output
  14. Publish output
    1. Publish to a RoboHelp Server
    2. Publish to an FTP server, a Secure FTP server, or a File System
    3. Publish to SharePoint Online
    4. Publish to Zendesk Help Center
    5. Publish to Salesforce Knowledge Base
    6. Publish to ServiceNow Knowledge Base
    7. Publish to Zoho Knowledge Base
    8. Publish to Adobe Experience Manager
  15. Appendix
    1. Adobe RoboHelp Scripting Reference
    2. RoboHelp keyboard shortcuts

Learn about how to use and work with snippets in RoboHelp.

A snippet can be a para­graph of text, a piece of code, an object such as an image, or an entire topic itself. You can single-source a snippet and reuse it across multiple topics in a project or master pages. A snippet can also contain variables and conditional text tags. When you change the contents of a snippet, it is updated across all the topics and master pages that contain it.

Use inline snippets within your text to create emphasis on important key words. You can select text within the paragraph and create snippet of the selected portion, or create it directly in the snippet editor. On usage, it can be inserted within any paragraph or text as an inline snippet.

Create a snippet

Open a project in RoboHelp and follow these steps to create a snippet:

  1. In the Author toolbar, select Contents and open a desired topic from the Contents panel.

  2. In the Author toolbar, select Snippets. The Snippets panel opens.

  3. In the Snippets panel, click .

  4. In the New Snippet dialog box, specify the name and description of the snippet in Name and Description, respectively.

  5. Click Create. The snippet is created and can be accessed from the Snippets panel.

Create an inline snippet

Open a project in RoboHelp and follow these steps to create an inline snippet:

  1. In the Author toolbar, select Contents and open a desired topic from the Contents panel.

  2. Within a paragraph, select the text for which you want to create an inline snippet. You can choose to apply inline formatting like Bold, Underline, and so on. 

  3. Right-click the highlighted text and choose Create snippet.

  4. In the New Snippet dialog box, specify the name and description of the snippet in Name and Description, respectively.

  5. Click Create. The snippet is created and can be accessed from the Snippets panel.

    You can now use this inline snippet with other text as part of the paragraph.

Note:

You can use snippets for any formatted content whereas variables are for any plain text as they can be used inside attributes.

Insert a snippet

To insert or use a snippet in an open topic or master page:

  1. To open a topic:

    In the Author toolbar, select Contents and open a topic of your choice from the Contents panel.

    To open a master page:

    In the Author toolbar, select Master Pages and open a master page of your choice from the Master Pages panel.

  2. In the Author toolbar, select Snippets. In the Snippets panel, choose a snippet.

  3. Now drag-and-drop the selected snippet at the preferred location in the open topic or master page.

    Alternatively, press Ctrl+2. In the Snippet dialog box, you can filter snippets by typing the first few alphabets. Press the upward and downward arrow keys to navigate through the list of snippets. Press Enter to insert a snippet. 

  4. Click the Save All icon  at the left side of the standard toolbar.

Delete a snippet

To delete a snippet from a project, follow these steps:

  1. In the Author toolbar, select Snippets. The Snippets panel opens.

  2. Select the snippet that you want to delete and click Options  next to the snippet.

  3. In the Options list, select Delete.

  4. In the Confirm dialog box, click Yes.

Generate Snippets report

You can generate a Snippets report to view the details of snippets in your project. You can also customize, download, or print your report.

  1. In the Author toolbar, select Reports. The Reports panel opens.

  2. In the Reports panel that appears, select Snippets.

  3. You can customize a report using the Filters panel on the right side of the screen. To know more, see Customize a report.

  4. Click the Download icon  in the standard toolbar to instantly download the report.

  5. Click the Print icon  in the standard toolbar to print your report.

Search and preview a snippet

In the Snippets panel, you can search and preview a snippet. It searches in the snippet name only. From the results, right-click an item, and click Preview.

You can preview the snippet in rich text format.

Search and preview a snippet
Search and preview a snippet

The gif below demonstrates the search and preview workflow.

Adobe logo

Sign in to your account