Publish 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.

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.
• Create and configure an output preset.

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:

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:

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.

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. 

Layout

Use the option to configure the appearance of your output.

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. 

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.

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.