A topic is the basic element that contains your content (text, images, multimedia, links, and more) in a project. You can add, edit, format, and delete content in a topic. You can have multiple topics organized in a folder and have multiple folders in a project. This way you can easily maintain structured content in your project.
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:
You can create a topic inside a folder or at the root level in the Contents panel.
To create a topic in a folder:
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.
If you don't select a folder, the topic is created at the root level in the Contents panel.
In the New Topic dialog box, specify the properties for the topic in different sections as required.
The New Topic dialog box has the same sections as the Topic Properties dialog box, except for the File Info section, which is specific to topic properties. For more information, see Topic properties.
In the Contents panel, expand the folder that contains your topic, and double-click a topic to open it.
To quickly search for the topic you want to edit, click on the top 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.
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. You can also insert and customize a Mini TOC, variables, snippets, and fields.
See the following resources for more details:
To toggle the display of paragraph markers in a topic, choose View > Show > Paragraph Markers.
To quickly run a spell check in an open topic, do the following:
- Choose Edit > Preferences or press Ctrl+Shift+T.
- In the Application Settings dialog box, select Enable Spell Checking.
- Click Done.
RoboHelp highlights the misspelled words in the topic. Right-click a misspelled word to:
- View suggested spellings. To correct the misspelled word, click the appropriate suggested spelling.
- 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 Conditon Tags.
In the left pane of the Apply Conditon Tags dialog box, select the condition tags you want to apply. The selected tags are removed from the left pane and 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.
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.
You can import files and Word documents as topics in a project folder. You can also import folders and Adobe Captivate videos.
To import a file:
- Right-click a folder or click against it, and choose Import > File.
- In the Open dialog box, select the file you want to import and click Open.
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.
To link a file:
- Right-click a folder or click against it, and choose Link > Link File.
- In the Open dialog box, 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.
If modifications are made in the project or the source version, the green color of the preceding arrow changes to red, indicating out-of-sync status. To sync 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 also removes the arrow preceding the project file in the Contents panel.
Applicable only for Word and FrameMaker files.
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.
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
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.
If a topic is not included in any TOC, the Locate in TOC option is not visible.
For information about setting topic properties, see Set topic properties.
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.
While closing 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. If you do not want to save a file, click to deselect it. Click Save.
Locate in Contents panel Opens the Contents panel if it's not open already, and highlights the topic.