User Guide - Server and Data Center

Support for Atlassian Server Products has ended in February 2024. Consider migrating to MultiExcerpt’s Data Center version.

If you plan to migrate to the Cloud, ensure you do not lose your data/configurations. Check out the Migration guide for information on how to migrate the app’s data to Cloud. Contact our support team if you have any questions.

The following is for the MultiExcerpt Server and Data Center. MultiExcerpt Cloud information may be found here.


The MultiExcerpt app performs similarly to the excerpt macro, allowing for excerpts from multiple spaces. 

Features 

  • Ability to seamlessly transfer content between multiple pages and spaces

  • Reduces the need for rewriting boilerplate documentation 

  • It can be transferred in line with current content or a resizable block

  • MultiExcerpts can contain Informational boxes, Flow Boards, and JIRA issues

  • MultiExcerpts can render inline comments from excerpted content

  • Allows admin to turn off visibility of inline comments for anonymous users (not possible using Confluence permissions)

  • Enables users to toggle the visibility of inline comments on a page

User Guide 

The MultiExcerpt function is a two-step process involving both macros:

  1. Creating the MultiExcerpt key - the text you want to multiply and display in various locations.

  2. Inserting the MultiExcerpt Include to display the key text.

Create the MultiExcerpt key 

  1. Select the MultiExcerpt macro.

    image-20240403-133132.png

  2. Name the MultiExcerpt, then click Insert.


    The MultiExcerpt key is displayed on the page.

  3. Add the text you want to display inside the MultiExcerpt macro body in multiple locations.

Insert the MultiExcerpt Include Macro

  1. Select the MultiExcerpt Include macro. To include the MultiExcerpt inline with the current content, select MultiExcerpt Fast Include (Inline). Or, select MultiExcerpt Fast Include (Block) to insert the content as a resizable block. 

  2. Add where the MultiExcerpt key is located (Space and Page) and its Name, then click Insert.

  3. The MultiExcerpt Include block displays while the Confluence page is in edit mode.

In view mode, your text displays exactly how it looks in the MultiExcerpt key.

Using the “@self” keyword for the “Page with Excerpt” parameter

The "@self" feature is helpful in page templates employing the MultiExcerpt-Include macro. It allows you to incorporate a MultiExcerpt from the template directly. Subsequently, when representing pages using that template, the MultiExcerpt-Include seamlessly operates without modifying the page title within the "Page with Excerpt" parameter.

When you're creating a new page, and you include both "MultiExcerpt" and a "MultiExcerpt-Include" at the same time before you've published the page, you might notice that the dropdown menu for selecting a "MultiExcerpt Name" in the "MultiExcerpt-Include" menu doesn't show any names. This happens because the system can't see the new page yet since it has not been published.

Here's what you can do:

If you're adding the "MultiExcerpt-Include" in the first version of the page (version 0), you can just manually type the name of the MultiExcerpt in the "MultiExcerpt Name" box.

Alternatively, you can add the MultiExcerpt, publish the page, and then go back to edit it. When you add the "MultiExcerpt-Include," the dropdown will show the names because the page has been published.

In simple terms, the system can't see a MultiExcerpt you just added until the page is published. So, either type it in manually when adding or publish the page first and then add it to see the dropdown names.

Find MultiExcerpt Includes 

You can search for all the locations where a specific MultiExcerpt has been included.

  1. Navigate to the page where the MultiExcerpt is located.

  2. Click Edit (page edit mode) to view the MultiExcerpt macro.

  3. Click the MultiExcerpt macro.

  4. Click Find includes - this space/Find includes - selected space

The list of pages that include MultiExcerpt are listed. Click any link to go to that page.

MultiExcerpt integration with Comala Document Management (CDM)

MultiExcerpt macros work with other apps like the Comala Document Management. Administrators must enable the feature from the app's Configuration page and CDM to make this integration work smoothly.

The following points must be remembered:

  • A MultiExcerpt Include renders the latest approved version of MultiExcerpt content.

  • If the MultiExcerpt content was not approved and only draft versions exist, users without the relevant permissions cannot see the draft content in a MultiExcerpt Include. Instead, an error message that says they cannot see drafts is displayed.

Administrators must select the Comala Published Version Integration Enabled parameter in the MultiExcerpt Admin configuration page (Settings > Appfire Configuration > MultiExcerpt in the left sidebar). The same feature must be enabled (Published view macro transform parameter in CDM's configuration) from the Comala plugin.

MultiExcerpt Enhanced Permissions

The 'MultiExcerpt Enhanced Permissions' feature allows users to include content from restricted pages and spaces with specific users and groups. Use this feature to render content in a controlled way to anyone you want.

This macro is in its module, so it can easily be enabled/disabled by an administrator for the Confluence Server. It is disabled by default.

The "enhanced permissions" feature is complex enough that we document it in its article: MultiExcerpt Enhanced Permissions.

MultiExcerpt Include Server Cache

Using several instances of MultiExcerpt Include on the same page in Confluence Server may cause slower page performance if you use several instances of MultiExcerpt Includes on a single Confluence page and if caching is disabled. To improve page performance when using several instances of MultiExcerpt Include, select the Cache Enabled box in the MultiExcerpt Include macro. 

How to enable/disable cache for your site

Access the MultiExcerpt Admin tool under Confluence Administration:

How to disable cache for individual MultiExcerpt Includes 

Select the Disable Caching box for the individual MultiExcerpt Name and click Save.


Cache flush and performance tuning 

Use the Cache Management tool in Confluence administration: General Configuration > Cache Management > Show advanced view and scroll down to our app.

Inline Comments

As of MuliExcerpt 5.5.0, we have added the ability to make inline comments on our MultiExcerpt and Atlassian's Excerpts that are also visible on the MultiExcerpt Include and Atlassian's Includes.

Disable Inline Comment Viewing for Anonymous Users

At the time of the release of MultiExcerpt 5.5.0, Confluence has no way for admins (or anyone else) to use permissions to disable the viewing of comments for anonymous users on pages that the anonymous users are allowed to view.

Now your site admin has the power to hide inline comments from anonymous users using the MultiExcerpt Admin tool:

Users Can Toggle Inline Comment Visibility on a Page

MultiExcerpt adds an item to the page menu that allows users to show/hide inline comments for that page (only for that user). This setting is persisted and is used for subsequent page visits by that user until they change it.

Enable Inline Comment Viewing in Excerpted/Included Content

Allows your site admin to enable/disable the viewing of inline comments in MultiExcerpt Includes, where the comments have been made in the body of a MultiExcerpt on some other page that contains the MultiExcerpt that is included by the MultiExcerpt Include.

That’s a long way to say, “You can now view inline comments on included content!”

This feature works on the MultiExcerpt Include macro and Confluence’s “out of the box” Excerpt Include macro.

Specify Custom Colors for Included Inline Comments

Allows your site admin to specify custom colors for inline comments rendered in an include. They can specify a color for an inline comment when it is not selected and when it is selected (via the user, using their mouse).

This feature works on the MultiExcerpt Include macro and Confluence’s “out of the box” Excerpt Include macro.

Per-macro control over inline comments

In the MultiExcerpt macro, there is a new parameter available in the macro editor to configure whether or not inline comments will be rendered in MultiExcerpt Includes that include the excerpt:

Admin control for inline comments in MultiExcerpt Includes vs Confluence Excerpt Includes

The admin configuration tool for the MultiExcerpt plugin has been enhanced to allow an admin to configure the rendering of inline comments for MultiExcerpt separately to Include macros, and for Confluence Excerpt, Include macros:

Migrating MultiExcerpt from Server to Cloud or from Cloud to Server

There are MultiExcerpt apps for both Confluence Server and Confluence Cloud. There is a migration path for either direction:

Migrating MultiExcerpt from Server/Data Center to Cloud

Migrating MultiExcerpt from Cloud to Server/Data Center

Release Notes

Knowledge Base & Support Info

Additional Related Articles