User Guide Cancel

Publish to a RoboHelp Server

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 4
      2. What's new in Update 3
      3. What's new in Update 2
      4. 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 configure and publish to a RoboHelp Server.

What is RoboHelp Server

Adobe RoboHelp Server is a server-based Help solution that provides real-time end-user feedback on your Help and knowledgebase. Generate the output of your project in RoboHelp and then publish the output to a RoboHelp Server. RoboHelp Server gathers and logs data about what questions users ask while searching content and how users navigate through topics. Results are displayed in an easy-to-view graphical format for quick interpretation.

How to publish to RoboHelp Server

To publish to RoboHelp Server, first setup a publishing profile providing information about the RoboHelp Server instance. RoboHelp supports Frameless and Responsive HTML5 output types. You can publish content from the Output Presets panel. Edit a Frameless or Responsive HTML5 output preset and select the publish profiles you want to use. Then publish the content to RoboHelp Server.

Configure a publish profile for RoboHelp Server

You must create and configure a profile before publishing your output to RoboHelp Server. To create and configure a profile:

  1. Choose Edit > Publish Profiles.

    The Publish Settings dialog box opens. 

  2. Click  to create a new profile.

  3. In the Server Type field, select the type of server as RoboHelp Server. Default is SharePoint Online.

    Other fields in the dialog box change based on the server type selected.

  4. For the SharePoint Online server type, do the following:

    • Name Shows the default profile name. Modify the name if required.
    • Connection Profile Displays the connection profiles created using the Connection Profiles dialog box (accessed by choosing Collaborate > Connection Profiles). Choose a connection profile from the drop-down list. If no connection profile is listed, create one using the Connection Profiles dialog box.
    • Remote Path Specify the server path at which you want to publish content. The default value / publishes to the default directory on the server.

  5. For the RoboHelp Server server type, do the following:

    • Name Shows the default profile name. Modify the name if required.
    • Address Specify the address of the Robohelp server to which you want to publish your projects. The address must be in the following format:
      http://<server-name>:<port-number>/<context-name>/server
      • server-name: The host name or IP address of the machine on which RoboHelp Server is setup. If its on the same machine, you can specify localhost as server name.
      • port-number: (Optional) The port on which RoboHelp Server is running. Default is 8080. If you are using port 8080, specify it here. However, if you are using the default ports for HTTP or HTTPS protocols, you need not provide the port number. For example, the default port for HTTP is 80. So if you are using HTTP and port 80, you need not provide the port number. 
      • context-name: The context to which you want to publish. Default is robohelp. 

    For example, http://localhost:8080/robohelp/server.

    Note:

    By default, RoboHelp Server uses the http protocol. For the https protocol, use the following format:
    https://<server-name>:<port-number>/<context-name>/server

    • User ID and Password Enter your credentials.
    • Areas: Select an area on the server on which you want to publish content. To refresh areas, click .
    • Use Single Sign-on (SSO): Single sign-on (SSO) is an authentication mechanism that enables you to securely authenticate with multiple applications and websites by using one set of credentials. In this dialog, enable the option to have SSO to RoboHelp Server.

  6. Click Save.

    RoboHelp saves the profile and displays the profile name under the Profiles column. To edit a profile, click the profile name and edit its fields. To delete a profile, click  against it.

Publish to a RoboHelp Server

You can configure a Frameless or Responsive HTML5 output preset to link it to the RoboHelp Server profile, and then publish your content to the RoboHelp Server. You can publish content to multiple RoboHelp Servers.

  1. Click the Output tab in the standard toolbar. Output Presets is the default selection in the Output toolbar. 

  2. In the Output Presets panel, double-click an output preset to edit it. 

  3. In the output preset editor, click the Publish tab to view the servers created across projects.

    You can also edit server information in the Publish Profiles dialog box, which you can launch by clicking . 

  4. Select the profiles (servers) to which you want to publish content.

  5. Select Republish All to republish entire content. If this field is not selected, RoboHelp publishes only updated content since the previous publish, not the entire content.

  6. To publish to the selected profiles (servers), click the output preset and then click  in the standard toolbar. Or right-click the output preset and click Publish.

    If you selected multiple RoboHelp Servers, RoboHelp publishes to RoboHelp Servers in a sequence. Two prompts appear, one displays publishing information (such as the file being published, preset name, and server name) and the other displays publishing status.

    Note:

    RoboHelp creates log files at %/AppData/%/Local/Temp/RHTMP. To view log files, right-click the output preset and click View Publish Log. If you published content to multiple servers, the log file shows publishing information (success or failure and errors) about all servers.

  7. To view the published content, click  in the Results column against the published profile.

    If publishing fails, the Results column does not show the  icon. 

Note:

Before publish, you need to generate the output locally. To generate output using a command-line utility locally, see Generate output.

Publish RHS output from the command line

You can now publish Adobe RoboHelp projects to Adobe RoboHelp Server using the below command line.

Robohelp.exe --cl "<project_path (.rhpj)>" -o "<output_preset>" -l "<logfile_path>" -p "<output_path>" -u -s "<publish_profile_name>"

For example:

Robohelp.exe --cl "C:\Latte.rhpj" -o "My Responsive Output" -l "C:\logfile.html" -p "C:\outputfolder" -u -s "publish_profile_name"

Command description:

  • path_of_Robohelp.exe Path of the RoboHelp executable file.
  • --cl Launches RoboHelp in command-line mode.
  • project_path Path of the project you want to generate.
  • -o Includes output preset.
  • output_preset Name of the output preset you want to use to generate output.
  • -l or --log (Optional) Includes the log file argument.
  • logfile_path If you include the log file argument, specify the path of the log file in which logs are generated. The log file must be in HTML format as logs are in HTML format.
  • -p or --path (Optional) Includes the output path argument.
  • output_path If you include the output path argument, specify the path at which you want to save the output generated. If you exclude this argument, RoboHelp generates output at the output path specified in the selected output preset's properties.
  • -u parameter is for publishing. (publishing gets priority over the generation).
  • -s for publishing to a particular publish profile(eg. -s "publish_profile_name"). If not provided, publishing is done to the selected servers in the preset.
  • -verbose shows the logs on the command line.
Note:

It is important to note that publishing gets priority over output generation. 

 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