Documentation

 

Installation

As any app for Confluence Cloud, you can install the app via the Confluence admin menu.

  1. Log into your Confluence instance as an admin.

  2. Click on “Apps > Manage apps” in the header menu.

  3. Click on “Find new apps” on the right navigation.

  4. Search for “Content Mirror for Confluence” and select it.

  5. Click on “Try it free” to install the app.

Usage

Content Mirror for Confluence provides a macros that allows you to mirror content from one existing Confluence page (the source page) into another page (the target page).

To make use of the macro click the “Insert” / “+” Button in the edit mode, select one of the Content Mirror macros such as the macro “Content Mirror - Section“ and configure the macro specific options as defined below.

Please note: If you see “No options” when defining the “Source page” options, just start typing and pages to select will show up.

Macro “Content Mirror - Page” & “Content Mirror - Page (Block)”

The macros “Content Mirror - Page” and “Content Mirror - Page (Block)” allow you mirror a complete page. The first macro renders the mirrored content in the “inline mode” and the other one in the “block mode”. The macros provides the following options:

  • Source page: Defines the page that contains the content to “mirror”

  • Hide errors for: Set to “Everyone” to hide errors (such as “The source page does not exist, does not contain any content or you don't have the permission to view it.”)

Macro “Content Mirror - Section”

The macro “Content Mirror - Section” allows you to select the content to mirror based on the headlines. The macro provides the following options:

  • Source page: Defines the page that contains the content to “mirror”

  • Match expression: Defines a search expression that identifiers the section to mirror

  • Match mode: Defines how the “Match expression” is used. The following modes are supported

    • FullMatch: Matches the headline based on a exact text match against “Match expression”

    • PartialMatch: Matches the headline if the headline contains the “Match expression”

    • Nth: Matches the n-th headline where n is the number defined as “Match expression”

  • Match case: Check if match case for match modes “Like” or “Substring”

  • Heading level: Defines the level of the headlines that are used for the matching

  • Include matched headline: Check to include the matched headline when “mirroring” the content

  • Hide errors for: Set to “Everyone” to hide errors (such as “The source page does not exist, does not contain any content or you don't have the permission to view it.”)

Macro “Content Mirror - Table”

The macro “Content Mirror - Table” allows you to select the table to mirror. The macro provides the following options:

  • Source page: Defines the page that contains the content to “mirror”

  • Match expression: Defines a search expression that identifiers the table to mirror

  • Match mode: Defines how the “Match expression” is used. The following modes are supported

    • Nth: Matches the n-th table where n is the number defined as “Match expression”

  • Hide errors for: Set to “Everyone” to hide errors (such as “The source page does not exist, does not contain any content or you don't have the permission to view it.”)

Macro “Content Mirror - Table Cell”

The macro “Content Mirror - Table” allows you to select the table to mirror. The macro provides the following options:

  • Source page: Defines the page that contains the content to “mirror”

  • Table match expression: Defines a search expression that identifiers the table to mirror

  • Table match mode: Defines how the “Table match expression” is used. The following modes are supported

    • Nth: Matches the n-th table where n is the number defined as “Table match expression”

  • Row match expression: Defines a search expression that identifiers the table row to mirror

  • Row match mode: Defines how the “Row match expression” is used. The following modes are supported

    • Nth: Matches the n-th table row where n is the number defined as “Row match expression”

  • Column match expression: Defines a search expression that identifiers the table col to mirror

  • Column match mode: Defines how the “Match Expression” is used. The following modes are supported

    • Nth: Matches the n-th table column where n is the number defined as “Column match expression”

  • Hide errors for: Set to “Everyone” to hide errors (such as “The source page does not exist, does not contain any content or you don't have the permission to view it.”)

Macro “Content Mirror - Layout Cell”

The macro “Content Mirror - Layout Cell” allows you to select the layout cell to mirror. The macro provides the following options:

  • Source page: Defines the page that contains the content to “mirror”

  • Section match expression: Defines a search expression that identifiers the section to mirror

  • Section match mode: Defines how the “Section match expression” is used. The following modes are supported

    • Nth: Matches the n-th section where n is the number defined as “Section match expression”

  • Cell match expression: Defines a search expression that identifiers the cell inside the section to mirror

  • Cell match mode: Defines how the “Cell match expression” is used. The following modes are supported

    • Nth: Matches the n-th cell inside the section where n is the number defined as “Cell match expression”

  • Hide errors for: Set to “Everyone” to hide errors (such as “The source page does not exist, does not contain any content or you don't have the permission to view it.”)

Permissions an restrictions

All macros provided by Content Mirror for Confluence consider the (view) permissions of the mirrored content. In other words: A user can only see the mirrored content (on the target page) if the user has also view access to the source page (where the content is originally coming from). This makes sure that users cannot get access to restricted content via one of the macros.

Example: If some content is mirrored from Confluence page X to Confluence page Y, a user can only see the content on page Y if he/she has read access to page X.

Please also note that anonymous access is currently not supported, i.e. the provided macros don’t work for anonymous users.

You can use the macro option “Hide errors for” (see above) to hide error messages if any (permission) error occurs while retrieving the mirrored content.