User Guide Cancel

Work with topics and folders

Search
Robohelp

Robohelp

Open app
  1. RoboHelp User Guide
  2. Introduction
    1. Get to know RoboHelp workspace
    2. What's new in RoboHelp 2022 release
      1. What's new in Update 5
      2. What's new in Update 4
      3. What's new in Update 3
      4. What's new in Update 2
      5. What's new in Update 1
    3. Fixed Issues in RoboHelp
    4. RoboHelp System Requirements
    5. Download RoboHelp on Windows and macOS
    6. Download and install Adobe app
    7. RoboHelp FAQs
    8. What's new in RoboHelp 2020 release
      1. What's new in Update 8
      2. What's new in Update 7
      3. What's new in Update 6
      4. What's new in Update 5
      5. What's new in Update 4
      6. What's new in Update 3
      7. What's new in Update 2
      8. What's new in Update 1
  3. Projects
    1. Plan your RoboHelp project
    2. Create a project
    3. Manage projects
    4. Work with topics and folders
    5. Generate reports
    6. Work with context-sensitive help
    7. Manage References
    8. 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. PDF Layout
    1. PDF templates
    2. Design a page layout
    3. Publish PDF output
    4. Work with the common content styles
    5. Components of a PDF template
    6. Support for language variables
    7. Customize PDFs
  6. 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
  7. Import and linking
    1. Import Markdown files into a project
    2. Import Word documents into a project
    3. Import FrameMaker documents into a project
  8. TOCs, indexes, glossaries, and citations
    1. Create and manage a Table of Contents
    2. Create and manage an index
    3. Create and manage a glossary
    4. Create and manage citations
    5. Create and manage browse sequences
    6. Work with See Also and Related Topics
  9. 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
  10. Microcontent
    1. Microcontent
  11. Review and Collaboration
    1. Review and Collaboration
  12. Translation
    1. Translating content to multiple languages
    2. Configure a translation framework for a service provider
  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
    9. Publish to Atlassian Confluence Knowledge Base
  15. Appendix
    1. Adobe RoboHelp Scripting Reference
    2. RoboHelp keyboard shortcuts

Learn how to work with topics to build your content in RoboHelp.

Note:

Resolve known issues and limitations in the latest versions of Adobe Captivate, Adobe FrameMaker, and Adobe RoboHelp.

For more information, see Resolve known issues in Technical Communication Suite.

A 'Topic' is your project's basic element that contains content, such as text, images, multimedia, links, and more. You can add, edit, format, and delete content in a topic. A project can have multiple folders with multiple topics organized within a folder. This organization helps you create structured content in your project.

Create a folder

Folders store your topics. You can have multiple folders in a project. 

You can create a folder at the root level in the Contents panel or a subfolder inside a folder. 

To create a root-level folder in an open project:

  1. In the Author toolbar, click Contents. The Contents panel opens.

  2. In the Contents panel, click  in the upper-right corner of the panel and then click New Folder.

  3. In the Folder Details dialog box, specify the folder name in Name.

  4. Click Create.

    The folder is created at the root level in the Contents panel.

    Note:

    To create a subfolder inside a folder, select the folder, click  in the upper-right corner of the Contents panel, and then click New Folder. Or, right-click the folder or click  against it, and choose New > New Folder. 

Create a topic

You can create a topic inside a folder or at the root level in the Contents panel.

To create a topic in a folder:

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

  2. In the Contents panel, do one of the following:

    • Select the desired folder, then click  in the upper-right corner of the panel, and click New Topic.
    • Right-click the folder or click  against it, and choose New > New Topic.
    Note:

    If you don't select a folder, the topic is created at the root level in the Contents panel. 

  3. In the New Topic dialog box, specify the properties for the topic in different sections as required.

    The 'New Topic'  and 'Topic Properties' dialog box have same sections, except for the 'File Info' section which is specific to the Topic Properties. For more information, see Topic properties.

  4. Click Create.

    The topic is created inside the selected folder in the Contents panel. You can create multiple topics inside a folder or a subfolder.

Add content to or edit a topic

Once you've created a topic, to add or edit content:

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

  2. In the Contents panel, expand the folder that contains your topic, and double-click a topic to open it.

    Note:

    To quickly search for the topic you want to edit, click  on the upper-left toolbar or press Ctrl+F. In the search dialog box, type the topic title and filename. Double-click to open the relevant topic from the search results.

    You can open and work on several topics simultaneously. Each topic opens as a tab in the authoring workspace.

  3. In an open topic, you can add or edit text, images, and multimedia content. You can also include expanding text, drop-down text, and create links within topics and to external content. It also allows you to insert and customize a Mini TOC, variables, snippets, and fields.

    See the following resources for more details:

    Note:

    To toggle the display of paragraph markers in a topic, choose View > Show > Paragraph Markers.

  4. To quickly run a spell check in an open topic, do the following:

    1. Choose Edit > Preferences or press Ctrl+Shift+T. It opens the 'Application Preferences' dialog box.
    2. Click Spell Check and select 'Run spell checking on opening a topic' checkbox.
    3. Click Done.

    RoboHelp highlights the misspelled words in the topic. You can right-click on a misspelled word to perform following actions:

    • View the suggested spellings. You may click the appropriate suggested spelling to replace the misspelled word.
    • Ignore the instance of misspelled word by clicking Ignore.
    • Ignore all the instances of the misspelled word in the topic by clicking Ignore All.
    • Add the word to the dictionary by clicking Add to Dictionary.
    • Apply condition tags to the word by clicking Apply Condition Tags.
      In the left pane of the Apply Condition Tags dialog box, select the condition tags that you want to apply. The selected tags appear in the right pane. You can click  against a tag to remove it from the right pane. Click Apply.
    • Create a snippet by clicking Create Snippet. For more information, see Create a snippet.
    • Locate the topic file in the Contents panel by clicking Locate in Contents panel.
    • Open the Topic tab in the Properties panel by clicking Topic Properties.

  5. To close a topic tab, click .

    Note:

    Save your work before closing a topic. When you click  to close a tab, the Save Changes dialog box appears.

    In the Save Changes dialog box, do the following:

    • If your project is connected to a version control system, click Check-in the file and specify a version label. Then, click Save & Check-In.
    • If your project is local, click Save to save your work and close the tab.

Work with breadcrumbs

The breadcrumb navigation bar at the top of the topic editor shows the element at the current cursor position and all its parent elements. 

Besides the usual context menu options in the Author window, you can now invoke basic operations such as cut, copy, paste or remove. To perform any of these operations, you right-click on the element shown in the breadcrumb. You can also identify the structure of a breadcrumb trail through the listing of sibling and child text elements. To do a styling at the tag level, you can click the specific breadcrumb and apply styling from the Properties panel.

Import files and folders

You can import files and Word documents as topics in a project folder. You can also import folders and Adobe Captivate videos.

To import:

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

  2. To import a file:

    1. Right-click a folder or click  against it, and choose Import > File. It will show the 'Open' dialog box.
    2. Select the file that you want to import and click Open. 
    Note:

    The file type drop-down list in the Open dialog box displays the supported file types, for example, all files, topics, style sheets, and more. Use this drop-down list to filter files according to its type during file selection.

    The selected file is copied as a topic inside your project folder.

  3. To import a folder:

    1. Right-click a folder or click  against it, and choose Import > Folder.
    2. In the Open dialog box, select the folder you want to import and click Select Folder. 

    The selected folder and its files are copied inside your project folder.

  4. To import the HTML version of a Word document, see Import Word documents into a project.

  5. To import an Adobe Captivate video, see Import and insert an Adobe Captivate video.

Link files and folders

You can link files and folders from your system to your project folder.

To link:

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

  2. To link a file:

    1. Right-click a folder or click  against it, and choose Link > Link File. It will open the 'Open' dialog box.
    2. Select the file you want to link and click Open. 

    The file is copied inside the selected folder. RoboHelp notifies that the copied/project file is linked to the original/source file. A green arrow precedes the project file in the Contents panel, indicating in-sync status. 

    Note:

    For all non-topic files (.docx, .xlsx, .pdf), you can right-click on the file and access the properties to see its general information and the reference data.

    Note:

    When you modify a project or its source version, the preceding arrow color changes from green to red to indicate its 'out-of-sync' status. To sync the linked files:

    • From source to project: Right-click the topic or click  against it, and click Sync > From Source to Project. 
    • From project to source: Right-click the topic or click  against it, and click Sync > From Project to Source. 

    A sync success or failure notification appears.

    To remove the link between the project and source versions, right-click the topic or click  against it, and click Remove Link. This action will also remove the arrow preceding the project file in the Contents panel.

  3. To link a folder:

    1. Right-click a folder or click  against it, and choose Link > Link Folder. It will open a dialog box.
    2. Select the folder you want to import and click Select Folder. 

    The selected folder and its files are copied inside your project folder.

  4. To import the HTML version of a Word document, see Import Word documents into a project.

  5. To import the HTML version of a FrameMaker document, see Import FrameMaker documents into a project.

  6. To import an Adobe Captivate video, see Import and insert an Adobe Captivate video.

Create HTML topics

Note:

Applicable only for Word and FrameMaker files.

To create HTML topics:

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

  2. To create HTML topics from a Word or a FrameMaker file, right-click the file or click  against it, and click Update HTML. 

    RoboHelp creates a folder with the same name as the Word or FrameMaker file and places all HTML topics and referenced assets inside the new folder.

    Note:

    To create HTML topics, RoboHelp considers the settings specified in the following fields in the Project Settings dialog box (General tab):

    • For Word documents: Default Word Import Settings
    • For FrameMaker documents: Default FrameMaker Import Settings

    If a folder has multiple files, use the following options to simultaneously create HTML topics from all files:

    • For Word files, right-click the folder and choose Word Documents > Update All.
    • For FrameMaker files, right-click the folder and choose FrameMaker Documents > Update All.

Rename a topic or a folder

You can rename a topic or a folder in your project without having to open it.

To rename:

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

  2. To rename a folder, right-click it or click  against it, and click Rename. 

    To rename a topic's filename, first expand the folder that contains the topic you want to rename. Then, right-click the topic or click  against it, and click Rename. 

  3. In the Rename dialog box, specify the new name, and click Done. 

    Note:

    To view the new filename of the topic you renamed, choose View > Show and deselect Topics by Title. From the default title view, RoboHelp switches to the filename view and displays all topics by filename.

Create a duplicate topic

To create a duplicate topic in the same folder:

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

  2. To create a duplicate topic, first expand the folder that contains the topic you want to duplicate. Then, right-click the topic or click  against it, and click Duplicate.

  3. In the Duplicate dialog box, specify a title and filename for the duplicate topic, and click Done. The duplicate topic created in the same folder as the original topic.

Delete a topic or a folder

To delete a topic or a folder in your open project:

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

  2. To delete a folder, right-click it or click  against it, and click Delete.

    To delete a topic, first expand the folder that contains the topic you want to delete. Then, right-click the topic or click  against it, and click Delete.

  3. Click Yes in the Confirm dialog box. The topic or the folder is deleted.

Save a Topic as PDF

To save an individual topic as PDF:

  1. In the Author toolbar, select Contents. It will open the Contents panel.

  2. Hover over the topic you want to save as PDF and right-click or click  against it to open the context menu.
    Alternatively, you can open the context menu by right clicking anwhere in the topic editor or by clicking File from the menu bar.

  3. Click Save As PDF. It will open a 'Save As' dialog box.

  4. Select an appropriate folder, provide a filename, and click Save.
    The topic will be saved as PDF in the selected folder.

Collapse all folders in the project

To collapse all expanded folders in your project:

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

  2. Right-click or click  against any expanded folder or any topic inside an expanded folder, and click Collapse All.

    All expanded folders in your project collapse.

Locate a topic in a TOC

To locate a topic in a TOC:

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

  2. Right-click or click  against a topic and hover over Locate in TOC.

    RoboHelp displays the TOCs to which the topic belongs. Click the TOC in which you want to locate the topic.

    The Table of Contents panel displays the TOC in expanded view in which, the topic is highlighted.

    Note:

    If a topic is not included in any TOC, the Locate in TOC option is not visible. 

Show topics or folders in Windows Explorer

To show the location of specific topics or folders in Windows Explorer:

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

  2. Right-click or click  against a folder or a topic inside an expanded folder, and click Show in Explorer (Mac: Reveal in Finder)

    The location of the folder or the topic is displayed.

Search for topics

In the Contents panel, you can search for the topics and any asset files in the project. It will search in the file names and the topic titles.

The gif below demonstrates the search and preview workflow.

Set topic properties

For information about setting topic properties, see Set topic properties.

Topic tab context menu options

You can open and work on several topics simultaneously. Each topic opens as a tab in the authoring workspace. You can right-click a topic tab to use the following options:

Close Closes the current file.

Close Others Closes all open files except for the current file.

Close All Closes all open files. 

When you close multiple open files, RoboHelp prompts you to save your changes. In the Save Changes dialog box, you can save a specific file or all files. By default, all open files are selected for saving; you may deselect a file that you don't want to save. Click Save.

Locate in Contents panel Opens the Contents panel if it's not open already, and highlights the topic.

More like this

Get help faster and easier

New user?

Quick links

View all your plans Manage your plans
View quick links
Hide quick links

Legal Notices    |    Online Privacy Policy