In the Author toolbar, select Snippets. The Snippets panel opens.
- RoboHelp User Guide
- Introduction
- Projects
- Collaborate with authors
- PDF Layout
- Editing and formatting
- Format your content
- Create and manage cross-references
- Create and manage links
- Single-source with snippets
- Work with images and multimedia
- Create and use variables for easy updates
- Work with Variable Sets
- Use Find and Replace
- Auto save your content
- Side-by-side editing in Split View
- Use the Spell Check feature
- Create and Edit Bookmarks
- Insert and update fields
- Switch between multiple views
- Autonumbering in CSS
- Import and linking
- TOCs, indexes, glossaries, and citations
- Conditional content
- Microcontent
- Review and Collaboration
- Translation
- Generating output
- Publish output
- Publish to a RoboHelp Server
- Publish to an FTP server, a Secure FTP server, or a File System
- Publish to SharePoint Online
- Publish to Zendesk Help Center
- Publish to Salesforce Knowledge Base
- Publish to ServiceNow Knowledge Base
- Publish to Zoho Knowledge Base
- Publish to Adobe Experience Manager
- Publish to Atlassian Confluence Knowledge Base
- Publish to a RoboHelp Server
- Appendix
Learn about how to use and work with snippets in RoboHelp.
A snippet can be a paragraph of text, a piece of code, an object such as an image, or an entire topic. You can single-source a snippet and reuse it across multiple topics in a project. A snippet can also contain variables and conditional text tags. When you change the contents of a snippet, it's updated across all the topics that include it.
Use inline snippets within your text to create emphasis on essential keywords. You can select text within the paragraph and create a 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.
You can organize your snippets in different categories for better view and ease of use while authoring. It's mandatory to add the snippet to a category. Snippets are added to the default category if a category isn't specified.
Open a project in RoboHelp and follow these steps to create a snippet category:
-
-
In the Snippets panel, select , and then select Category.
-
In the dialog box, add Name for the category.
A new category is added in the snippet panel.
You can also drag and drop snippets across categories to organize them more easily.
Additional options for Snippet Category
Hover over the snippet category name, and select the
menu for additional options.
Rename
Change the name of the snippet category.
You can't rename or delete the default category. Only the import function applies to the default category.
Delete
Delete the snippet category, which is no longer required. Deleting a category will move the snippets under this category to the default category.
Import
You can import snippets directly into a category by selecting the import option. You can import more than one snippet at a go. The snippets will directly get imported into the category. Learn more about importing the snippet from Import a snippet.
Create a snippet
Open a project in RoboHelp and follow these steps to create a snippet:
-
In the Author toolbar, select Snippets. The Snippets panel opens.
-
In the Snippets panel, select , and then select Snippet.
Alternatively, you can right-click the snippet panel and select New to add a new snippet.
-
In the Snippet dialog box, specify Name, Category, and Description for the snippet. You can also create a category from this dialog box by directly writing a category name in the category field.
Nota:You can specify the new snippets in the default category if no other category is created. Learn more about creating a new snippet category from Create a Snippet Category.
-
Click Create. The snippet is created and can be accessed from the Snippets panel.
Additional options for Snippet
Hover over the snippet name, and select the
menu for the following additional options.Edit
Edit the snippet content.
Preview
Preview the snippet in a preview box.
Rename
Change the name of the snippet.
Delete
Delete the snippet which is no longer required.
Export
Export the snippet to your system. Select the folder in which you want to export the snippets.
Reveal in Finder/Show in Explorer?
Check how snippets files view in your system by opening them in file explorer.
Properties
Check the properties of the snippet and make changes as required. These properties include file name, language, tags, styles, and many more options. Learn more about these properties from Topic Properties.
The .hts file stands for HyperTuner Skin. They are primary files that are generally considered settings files.
To import a snippet file, follow these steps:
-
Right-click in the snippets panel, and select Import.
It opens the file explorer.By default, snippets are imported to the Default category. If you select a category and then import, snippets are imported to that category.
-
Select the .hts file from the file explorer.
The selected snippet file is now added to the snippet panel.
Create an inline snippet
Open a project in RoboHelp and follow these steps to create an inline snippet:
-
In the Author toolbar, select Contents and open a desired topic from the Contents panel.
-
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.
-
Right-click the highlighted text and choose Create snippet.
-
In the New Snippet dialog box, specify the name and description of the snippet in Name, Category, and Description, respectively.
-
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.
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:
-
To open a topic:
In the Author toolbar, select Contents and open a topic of your choice from the Contents panel.
-
In the Author toolbar, select Snippets. In the Snippets panel, choose a snippet.
-
Now drag-and-drop the selected snippet at the preferred location in the open topic.
Alternatively, select Snippets from the standard toolbar or 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. Select the snippet and click Insert.
-
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:
-
In the Author toolbar, select Snippets. The Snippets panel opens.
-
Select the snippet that you want to delete and select options icon next to the snippet.
-
In the options list, select Delete.
-
In the confirm dialog box, click Yes.
Delete a snippet category
To delete a snippet category from a project, follow these steps:
-
In the Author toolbar, select Snippets. The Snippets panel opens.
-
Select the snippet category that you want to delete and select options icon next to the snippet category.
-
In the options list, select Delete.
-
Select Yes to confirm the deletion of the snippet category from the project.
Nota:The snippets present in the deleted category are moved to the default category.
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.
-
In the Author toolbar, select Reports. The Reports panel opens.
-
In the Reports panel that appears, select Snippets.
-
You can customize a report using the Filters panel on the right side of the screen. To know more, see Customize a report.
-
Click the Download icon in the standard toolbar to instantly download the report.
-
Click the Print icon in the standard toolbar to print your report.