ClickHelp User Manual

Importing Confluence Macros

This topic describes how ClickHelp handles Confluence macros during the import process.

Supported Macros

All supported Confluence macros will be automatically converted to the corresponding ClickHelp elements or processed, keeping their content. Here's the list of supported macros:

Confluence macro
ClickHelp element

Children Display
See Also

Code Block
Code Sample

Conditional Content
Conditional Content Part of the Scroll Versions functionality. Conditional pages with Variants are imported as topics with Output Tags created from Variants applied to them.
Quick Parts
Inserted as Info Box template with the different background color.
Quick Parts
Inserted as Error Box template.
Excerpt and Excerpt Include
Content Snippets
Learn the specifics of the Excerpts import below.
Dropdown Text
Hide If/Show If
Conditional Content
Inserted as Including/Excluding blocks converting User Groups into Output Tags.
Horizontal Rule
Horizontal Line
Quick Parts
Inserted as Info Box template.
Quick Parts
Inserted as Info Box template.

Imported as a <p> HTML element preserving its styles like font-weight, border styles, background color, etc.
Quick Parts
Inserted as Success Box template.
Quick Parts
Inserted as Info Box template.
Table of Contents

Inline styles such as list-style-type, indent, etc., are not preserved.

The Table of Content Zone macro is not supported.

Quick Parts
Inserted as Warning Box template.

Unsupported Macros

There is an Unsupported macros processing setting in Step 3 of the Confluence import wizard, which allows you to choose how to handle unsupported macros: Remove unsupported macros or Replace unsupported macros with placeholders.

The Unsupported macros processing option in the Import Project Wizard

Here is how both options work.

Remove unsupported macros

Unsupported macros will be processed in the following way:

  • If a macro doesn't have any content, it will be removed.
  • If a macro has content, only the content will be imported. The container of the macro will be removed.
The Remove unsupported macros option is the recommended way of handling the unsupported macros.

Replace unsupported macros with placeholders

Choosing this option will keep the unsupported macros and wrap their content in the <div> or <span> containers. The <div> tag is used for the macro with content, <span> — for the one without.

Here's an HTML example of what an unsupported macro without content looks like after the import if the Replace... option is chosen:

<span unknown-macro-name="status" unknown-macro-attribute="{&quot;colour&quot;:&quot;Green&quot;,&quot;title&quot;:&quot;Test&quot;}">

  • The unknown-macro-name attribute contains the name of the macro.
  • The unknown-macro-attribute attribute contains the macro's settings that were used in Confluence.

The markup for the macro with content is similar, except for the <div> tag being used instead and the macro's content being wrapped in it.

After the import, you can always use the Global Find and Replace feature to perform the cleanup of the imported unsupported macros.

The Excerpt Macro Import Specifics

The Excerpt macros are imported to ClickHelp as Content Snippets. However, there are two different scenarios of Excerpt handling:

  • The excerpt makes up all Page content. The Page is imported as a single topic and placed under the Snippets folder.
  • The excerpt makes up a part of the Page content. The Page is imported as two topics: the Excerpt's content is imported as a separate topic that is placed under the Snippets folder, and the rest of the content is imported as the "main" topic; the topic made from the Excerpt is then inserted into the "main" topic as a snippet.