User Guide Cancel

Publish to Atlassian Confluence Knowledge Base

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 publish your content directly to Atlassian Confluence Knowledge Base.

Introduction

Atlassian Confluence knowledge base gives teams quick and easy access to solutions. It provides an accessible platform for knowledge management with easy content creation, organization and a powerful search engine to help employees and customers.

With the integration of Confluence, Adobe RoboHelp has expanded its publishing capabilities to allow for direct publishing of articles to the Confluence Knowledge Base.

Pre-requisites

To connect with Confluence Knowledge Base, your organization must set up an account in Atlassian. For more information, view Atlassian Support.

Key resources:

  • Profiles
  • Set up accounts

Set up the workflow

Following are the steps to configure Confluence Knowledge Base before publishing your output.

Configure a publish profile

You must create and configure a publish profile before publishing your output to Confluence 
Knowledge Base. To create and configure a profile:

  1. On the toolbar, click Edit > Publish Profiles.

  2. In the Publish Profiles dialog, to create a profile, click  .

  3. In the Server Type drop-down list field, select Atlassian Confluence.

  4. Add the profile name for confluence.

  5. There are two ways to connect your profile to the Atlassian server.

    Using OAuth

    Select the option for OAuth to connect to the Atlassian site and click Login.

    Note:

    This is supported only for accounts available on Confluence Cloud.

    publish profile using Site URL

    Using Site URL

    Enter Site URL. For example,  https://yourdomain.atlassian.net.

    publish profile using OAuth

  6. Click Save.

    RoboHelp saves the profile and displays the profile name in the Profiles column.

EDIT A PROFILE

To edit a profile, click the profile name, and edit its fields.

DELETE A PROFILE

To delete a profile, click  near the profile.

Create an output preset

To create an output preset in RoboHelp, do the following:

  1. In the Output Presets panel, click .

  2. In the New Preset dialog box, specify the following:

    Type Use the drop-down list to select Knowledge Base preset type.

    Name Specify a name for the output preset.

    Target From the target drop-down, choose Confluence Knowledge Base.

    Create Output preset

  3. Click Done.

    You can access the output preset from the Output Presets panel in the Output toolbar. Alternatively, you can access the output preset in the Quick Generate dialog box of the authoring window.

Configure a Confluence Knowledge Base output preset

You can use the following settings to configure the Confluence Knowledge Base output preset:

General

Use the following options to specify basic output settings, such as title, target, output path, encoding, and more:

Title: Specify the title for the generated output.

You can use variables in the title. To do so, type Ctrl+Shift+9, select a variable from the drop-down list, and press Enter. Note that if you've provided a variable set in the Content tab > Variable Set field, the value of the selected variable is picked from the variable set during output generation.

Output Path: Specify a location for the output. To select a location, select  . 

Ensure that the output path is NOT located inside the project folder. The output generation fails if the output path is inside the project folder. Also, the folder you select should NOT have any content you need. RoboHelp deletes the contents of the folder before generating the output.

Save output path as relative to the project: If enabled and you browse to the output path., the path to the output will now be relative instead of absolute.

Language: Use the drop-down list to select the language for the output. It displays the list of languages supported by Confluence.

Encoding: Confluence recommends Unicode (UTF-8) encoding, which is selected by default.

Post Generation Script: Select the script .js file from the drop-down list to run your custom script after output generation.

Confluence general settings

Content

Use the following options to specify content-related output settings, such as the settings for Table of Contents, condition expression, and variable set.

Table Of Contents: Use the drop-down list to select a Table of Contents to be included in the output. This drop-down list displays the Tables of Contents available in your project. The first Table of Contents in this drop-down list is selected by default.

The set of files and their references present in the selected Table of Contents appear in the generated output.

Condition Expression: Use the drop-down list to specify the condition expression for your output. This setting allows you to easily include or exclude content depending on the desired type of output or user base. Click  to edit the selected condition expression. You can also select None in the drop-down list to not specify any condition expression.

Variable Set: Use the drop-down list to specify the variable set to use in this output. In the drop-down list, you can select Default Variable Set to use the project's default variable set. Variable sets allow you to implement output-specific use of variables. For example, you can have different variable sets for generating output for customers and internal users.

Include Expanding Text content: Select this option to include expanding Text in your Knowledge Base output; otherwise, only the Expanding Title goes into the output. 

Include Drop-down Text content: Select this option to include drop-down Text in your Knowledge Base output; otherwise, only the Drop-down Title goes into the output. 

Note:

It's important to note that Confluence does not permit adding JavaScript or Cascading Style Sheets (CSS) within the articles, so your publication must not use Drop-down text, Expanding text, or Thumbnail images. However, if used, the enclosed text is preserved as plain text.

Confluence content settings

Layout

Use the option to configure the appearance of your output.

Confluence layout settings

Confluence

Publish Profile: Use the drop-down to select your Confluence connection profile. To learn how to create a publish profile, view Configure a publish profile.

Space: Enter the space where the content has to be published. This space must exist in your Confluence site.

Page: Enter the Parent Page under which the content has to be published. If no page is selected, then the content is published in the root of the selected space.

Convert all styles to inline styles: Select this option to ensure that your styling used in RoboHelp is maintained when you publish your output to Confluence, as attaching stylesheets isn't allowed.

Remove topic heading from the article body: Select this option to remove the topic headings used in RoboHelp when you publish your output to Confluence.

Use search keywords from topic as article tags: Select this option to use search keywords from the topic as article tags from the output you published to Confluence.

Upload as draft: If you allow this option, all articles published to Confluence will be in a draft state.

Upload images: Select this option if you want any images in topics to be included in the published output.

Upload linked documents:  Select this option if you want documents like PPT, PPTX, DOC, DOCX, and PDF linked-in topics to be included in the published output. 

Confluence settings

Articles

Choose the topics that you want to publish to Confluence Knowledge Base. Expand a TOC node and choose the topics that you want to publish.

Confluence articles settings

Select Save   to save the changes made into the output preset.

Publish to Confluence Knowledge Base

You can configure Knowledge Base output preset to link to Confluence and then publish your content to Confluence Knowledge Base. 

  1. In the toolbar, click the Output tab. You will see a list of pre-defined output presets.

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

  3. After you've configured the preset, you can publish it to Confluence. Select the menu icon (...) near the preset and select Publish.

    You can also edit the settings for Confluence output preset after clicking Edit.

  4. Click the Generate Preset icon  in the Output Presets panel. 

    You can then view a progress bar next to the selected output preset in the Output Presets panel. Once the output generation is complete, a Success dialog box is visible at the lower-right corner of the screen. 

    After the output generation is complete, click  in the Output Presets panel to view the output.

    output generation successful message

  5. To publish to the selected profiles (servers), select the articles to be published from articles tab. Select the output preset, and then select  in the standard toolbar. Or, right-click the output preset and click Publish.

  6. RoboHelp pushes the content to Confluence. After the publishing is completed, RoboHelp displays a report of the published content.

    Generated reports

  7. To view the published output, select the preview   icon to view the preview of the published content. 

    Output at Atlassian knowledge base

 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