MultiExcerpt Server and Data Center - User Guide

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

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

Click to View in Marketplace

Demo



Features 

  • Ability to seamlessly transfer content between multiple pages and spaces
  • Reduces need for rewriting boilerplate documentation 
  • Can be transferred inline with current content or in 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)
  • Allows users to toggle visibility of inline comments on a page


User Guide 

The MultiExcerpt function is a two-step process involving two 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
  2. Name the MultiExcerpt, then click Insert. 
  3. The MultiExcerpt key displays on page
  4. Add the text you want to display in multiple locations to the MultiExcerpt box


Insert the MultiExcerpt Include 

  1. Select the MultiExcerpt Include. If you wish to include the MultiExcerpt inline with the current content select MultiExcerpt Fast Include (Inline). Select MultiExcerpt Fast Include (Block) if you would like 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
  4. In view mode, your text displays exactly how it looks in the key MultiExcerpt

                


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 (page edit mode) to view the MultiExcerpt macro
  3. Click on the MultiExcerpt macro and a few options will display
  4. Click on 'Find Includes'
  5. The list of pages that include MultiExcerpt are listed. Clicking on the link will take you to that page.


   

MultiExcerpt Enhanced Permissions


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

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

The "enhanced permissions" feature is complex enough that we document it in its own 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. 

Loading the page for the first time after enabling caching may still be slow while everything is cached in memory. Page performance will increase once everything has been cached. You may experience slowness for subsequent visits to the page if you leave it before this caching is complete. So if you have hundreds of MultiExceprt Includes we suggest you pull up the page and let it do its thing while you do something else. Or stare at it.  Whatever method works for you to give it some time.



How to enable/disable cache for your site: 

Access the MultiExcerpt Admin tool under Confluence Administration:


Other Admin Settings

"Case Sensitive MultiExcerptNames" is used to enforce case-sensitivity for excerpts names, as specified by a MultiExcerpt Include. The default is true because the proper functioning of the cache and the "Find Includes" button depends on case-sensitive MultiExcerpt names. You can opt-out of this if you have a large number of mismatched references to excerpts and need time to fix them all. In old releases of MultiExcerpt, the names were case-insensitive and this may have allowed some users to mismatch their names/keys for excerpts.

"Find Includes" is a feature that can be used by page authors to find a list of the location of the MultiExcerpt Includes that include their MultiExcerpt.  It can be a DB and CPU intensive operation so some admins prefer to disable this feature.

"Regular Expression to Match For MultiExcerpt-Include" is for a beta feature of MultiExcerpt Include. It allows the inclusion of other macros that are not MultiExcerpt macros.

The regular expression is used to match the type/name of a macro. For example, the Code Block macro name/type is "code" so you could set the regular expression to "code" (without quotes) to include Code Block macros with MultiExcerpt Include. In the MultiExcerpt Include macro instead of using a MultiExcerpt name you would use a colon-delimited set of parameters that match the Code Block macro you want to include. For example, language=java:title=HelloWorldExample.

This could be used to include a Code Block macro from one page to another page.

Note that the "Find Includes" button does not work for includes that use this beta feature for inclusion of other macros. This beta feature is not wired up to the "Find Includes" functionality.


How to disable cache for individual MultiExcerpt Includes 

Click 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 > Scroll down to our app 



Inline Comments

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 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 both the MultiExcerpt Include macro and on 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 that are rendered in an include. They can specify both 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 both the MultiExcerpt Include macro and on Confluence’s “out of the box” Excerpt Include macro.


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