User Guide Cancel

Manage projects

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 access, save, and merge projects in RoboHelp.

Project Settings

To launch the Project Settings dialog, select File > Project Settings.

General

  • Title: Enter a project title. This title appears in the window bar of the output.
  • Language: Select the default project language. 
Note:

The default project language would be the output language for the project. Learn more about output presets from 

  • Default Stylesheet: Select the stylesheet to be used for the project. You can, however, override the styles using inline and internal stylesheets.
  • Default Word Import Settings: Select the Word Settings File the project uses when published to Microsoft Word.
  • Default FrameMaker Import Settings: Select the FrameMakerSettings File the project uses when published to Adobe FrameMaker.
  • Do not allow inline formatting: If you enable the option, all text formatting properties are turned off in the Content Properties panel of a topic in authoring mode.
  • Enable advanced HTML Help options: Enable this option to customize the TOC icons for the CHM output.

Topic Status

Add a new status for a topic. Several statuses already exist. To add a new status, enter the name, and select the + icon.

Colors

Set colors for fonts, borders, backgrounds, and so on. To add a new color, enter the name, and select the + icon.

If you've upgraded from a Classic version, you'll view the colors you defined earlier.

Tag Groups

Add custom tags that you want to use for creating conditional content. To add a new tag, enter the name, and select the + icon.

Font List

Add the fonts, for example, Arial, Tahoma, and so on, so only the fonts you've added appear in the list of fonts in Content Properties  > Font. If you misspell a font and add it, the misspelled font will appear in the list of fonts. But if you apply the misspelled font on a text, the font will fall back to the default browser font, Times New Roman. You can also add multiple fonts as a comma-separated list.

Panels

Enable or disable the panels that you'd like to use. If you don't need a panel, turn it off.

Citations

Change the style of citations. Choose the citation style from the drop-down you want to use in your project. You can use different styles of citations in your project.

Project settings for Citations

  • MLA: Modern Language Association Style
  • APA: American Psychological Association Style
  • Chicago: Chicago Manual of Style
  • IEEE: Institute of Electricals and Electronics Engineers Style
  • AHA: American Heart Association Style

The reference list added to the Citations page is formatted according to the guidelines specified by the selected Citation Style. To learn more about back matter settings, view Insert back matter.

Open a project

You can access your projects in RoboHelp from the home screen or use the File menu.

Home screen

When you launch RoboHelp, the first screen that you view is the home screen. On this screen, you can access your recently edited projects under the Recent section. RoboHelp displays up to two recent projects. Simply click one of the displayed projects to open and start working with it.

You can also pin, unpin, or remove a project from the Recent section:

  • To pin a project, hover over the desired project name and click the  icon. Your pinned projects appear at the top of the Recent list. 
  • To unpin a project, simply click the  icon. 
  • To remove a project from the Recent list, hover over the desired project name and click the  icon.

File menu

Do one of the following to access your project:

  • Select File > Recent Projects, select your desired project, and click Open.
  • To open a recently edited project, select File > Recent Projects and select your desired project.
  • To open a project of RoboHelp Classic, select File > Upgrade RoboHelp Classic Project. You can then select your desired project and click Open.

Save a project

To save your work in RoboHelp, follow these steps:

  1. Select the File menu.

  2. In the drop-down list, select Save All. Alternatively, you can press Ctrl+S to save all the updated files in the project.

    It is recommended that you save your project as and when you update it so that you don't lose any content.

Close a project

Once you've edited and saved your project, follow these steps to close your project in RoboHelp:

  1. Select the File menu.

  2. Select Close Project. Alternatively, you can press Alt+Ctrl+C to close the project.

    Note:

    When you close a project, all the related files are closed. The application (RoboHelp) however remains open so that you can open or create a project and work with it.

Merged projects

Using RoboHelp, you can create projects in an enterprise or a distributed setup where different documentation projects (child projects) feed into a common project (the master project). You can achieve collaborative authoring without using source-control software because multiple writers can work on their individual child projects. In the master project's Table of Contents, you can insert references to child projects (the master project does not actually contain child projects).

Insert each reference to a child project as a placeholder in the master project's Table of Contents. The location of the placeholder should be where you want the Table of Contents of the child project to appear in the output. The placeholder retains the original hierarchy of the TOC of the child project and is expanded in the output. The merging takes place after the output of the projects are generated. By using skins and templates in the master project, you can achieve a unified appearance in the merged projects.

To insert child projects, follow these steps:

  1. In your master project, click Table of Contents in the Author toolbar. The Table of Contents panel opens.

  2. In the Table of Contents panel, against the appropriate Table of Contents file, choose Options () > Edit.

    The Table of Contents editor opens as a tab and RoboHelp displays the Table of Contents toolbar at the center of the standard toolbar.

  3. In the Table of Contents editor, click the location at which you want to insert the child project's placeholder.

    Note:

    If you do not select a location, the placeholder is inserted after the currently selected topic. If a folder is selected at the time of insertion, the placeholder is inserted at the end of the list of topics in the selected folder.

  4. Do one of the following:

    • In the Table of Contents toolbar, click .
    • Right-click in the Table of Contents editor and choose Insert > Child Project. 

  5. In the Insert Child Project dialog box, click  to select your child project (.rhpj file). Click Insert.

    A placeholder of the child project's Table of Contents is inserted. 

  6. To modify the properties of the child project placeholder, see Work with a Table of Contents' properties.

  7. Configure an output preset. In the General tab > Output Path field, specify the following location at which the output of all child projects must be generated:

    [master_project_output_folder]/mergedProjects/[child_project_name]

  8. Generate output.

Child HTML Help File

You can include a CHM file in the TOC in your project so that it can be opened in your output. 

To merge Microsoft HTML Help files (CHM), follow these steps:

  1. In your master project, click Table of Contents in the Author toolbar. The Table of Contents panel opens.

  2. In the Table of Contents panel, against the appropriate Table of Contents file, choose Options () > Edit.

    The Table of Contents editor opens as a tab and RoboHelp displays the Table of Contents toolbar at the center of the standard toolbar.

  3. In the Table of Contents editor, click the location at which you want to insert the HTML file placeholder.

    Note:

    If you do not select a location, the placeholder is inserted after the currently selected topic. If a folder is selected at the time of insertion, the placeholder is inserted at the end of the list of topics in the selected folder.

  4. Do one of the following:

    • In the Table of Contents toolbar, click .
    • Right-click in the Table of Contents editor and choose New > HTML Help File. 

  5. In the Insert HTML Help File dialog box, click  to select your .chm file. Click Insert.

    The Microsoft HTML Help File is copied into the project in the Content Explorer under assets/chm/. For example: assets/chm/xxxx.chm

  6. To modify the properties of the HTML File placeholder, see Work with a Table of Contents' properties.

  7. Configure a Microsoft HTML Help output preset. Select the same Table of Contents (TOC) 

  8. Generate output.

More like this

 Adobe

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