- 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
Set and manage preferences in RoboHelp. Manage the preferences across version control, User Interface, spell check, and many more.
In the Preferences dialog, you can modify the global settings which work across all projects. For modifying project-related settings, use the Project Settings dialog.
Launch preferences
General preferences
User Interface Language: Allows you to change the locale of the User Interface of RoboHelp. The locales that you can choose are English, French, German, and Japanese.
Theme: Allows you to choose a visual theme for RoboHelp. The options are Light, Lightest, Dark, Darkest. If you choose any option, the visual appearance of RoboHelp changes accordingly.
Use underscores In filenames: If this option is enabled, whenever you use a space when naming a file, then the space gets converted to an underscore in the filename.
Move deleted files to recycle bin: If this option is enabled, then any deleted file is moved to the recycle bin. On macOS, the deleted file is moved to the Trash.
Create cross-reference on dropping any topic in the editor: If you drag any topic from Contents or TOC panel and drop in the editor, then a hyperlink is created to that topic. If this option is enabled, then a cross reference is created instead of a hyperlink.
Enable auto save: When enabled, a topic gets saves automatically after a specified interval (in seconds).
Default Project Location: By default, the project location is set to “Documents\My RoboHelp Projects” folder. Click the browse icon and select any location on your system as your preferred location to save projects. Select Yes in the pop-up to change the default location permanently. Changing default location also changes the output location. You can also change the default project location while creating a new project.
- New projects are saved in the changed location.
- Sample and old projects remain in the same location.
Version control preferences
Get latest when project is opened: When enabled, gets the latest version of all the project file at the time of opening a project.
SharePoint options
Checkin files when project is closed: When enabled, after you close a project, all checked out project files get checked in to SharePoint. For more information on connecting and setting up SharePoint, see this article.
Automatically check out file on save: If you are editing a file, which was not checked out, then on saving that file it is automatically checked out. If this option is disabled, then it will ask for a confirmation to check the file out.
File Association preferences
You can map file types to associate them with the applications for editing and viewing. To associate a file extension with an application, enter the extension, browse to select the application to be associated, and click Add.
Tools preferences
In RoboHelp, you can use the eBook output preset type to generate your project output in ePub and Kindle formats.
Output generated in ePub (Electronic Publication) and Kindle formats can be viewed on devices like smartphones, tablets, computers, or e-readers with the compliant software. These files have the file extension .epub and .azw3, also known as Kindle Format 8 (KF8).
Specify the paths of the ebook and KindleGen previewer to convert, preview, and validate your eBooks.
Browse and specify the Java Home Path to set up the environment variable JAVA_HOME.
For Windows: "C:/Program Files/Java/jdkx.x.x"
For macOS: "/Library/Java/JavaVirtualMachines/jdkx.x.x.jdk/Contents/Home"
To install JRE on Windows, click here.
To install JRE on Mac, click here.
User Interface preferences
If this option is disabled, drag and drop happens without any confirmation.
Use single tab to open files: When enabled, if you open another topic from the Contents panel, the new tab will replace an already existing tab. If an existing tab has unsaved changes clicking a topic in the Contents panel will open in another tab.
Output and Review tabs: Toggle the options to display or hide the tabs on the interface. In an organization, if you want authors to not trigger output or review, you can disable the Output and Review tabs.
Grammar and spell check preferences
Use online grammar and spell checker
From the drop-down menu, select the required grammar checker that you've already created. For more information, see Grammar and Spell Checker Profiles.
Use offline spell checker
Run spell checking on opening a topic: Working with the spell check option is a good practice to ensure high quality. When this option is enabled, the spell check is run when any topic is opened in the editor.
User Dictionary: Adding a word to your dictionary makes the word available for spelling checks across the projects. Adding new words enables RoboHelp to recognize new words as correctly spelled words. At any time, you can add or delete new words.
Ignored Words: The Ignored Words list is specific to the application and is global. Add words, which are then never presented as misspelled words, useful for excluding specific words such as names, abbreviations, etc.