Summary
The Cache macro works well with many macros, however, there are cases that you may need to order your macros carefully to get the expected results. The Cache macro does not support macros that use javascript asynchronous approaches to bring data into a page. This is because the Cache macro caches the rendered HTML content, which in that case is just a place holder for data that then still needs to be brought in.
See Future macro - Interoperability for interoperability with the Future macro.
This page is intended to document interoperability with other advanced macros. Please comment or report on other interoperability problems.
Outer Macro | Macros | Status | Tested | Restrictions & Workarounds | Discussion |
---|---|---|---|---|---|
cache | chart | Use the Chart macro attachment parameters to persistently store the generated chart image so it can be displayed at a later time. Another alternative is to put the Cache macro inside the chart macro to save on the generation of the data from external sources while still doing normal rendering of the chart. | Normally, the Chart macro creates a temporary image to display. The Cache macro captures the html that references the temporary image. This displays properly as long as the temporary chart image is available. Once the temporary image is gone on the server, the chart can no longer be displayed by another browser. | ||
cache | expand | Reverse the macros — use the Cache macro inside the Expand macro. Avoid using the Cache refresh parameter. It makes all the Expand macros contract since the Expand macro does not remember the last setting. | Since 6.1, a workaround has been implement to make the expand macro work inside a Cache macro pending full availability of Confluence 5.4.3 (see CACHE-75). | ||
cache | expand or similar | Reverse the macros — use the Cache macro inside the Expand macro. Avoid using the Cache refresh parameter. It makes all the Expand macros contract since the Expand macro does not remember the last setting. | |||
cache | macros needing web resources | Workaround is to put the specific macro somewhere on the page outside of the Cache macro (this brings in the resources necessary). If necessary, use the Hide macro with render body to achieve this without showing anything on the page. | |||
cache | report-table | Tested with 6.1. | |||
cache | OfficeConnector macros | Requires release 6.1. | |||
cache | JIRA macro | ||||
cache | pagetree | Confluence 4.x - 5.1 Confluence 5.2 or above: Requires Cache for Confluence 6.4 or above | |||
cache | page gadget | Confluence 4.x - 5.1 Confluence 5.2 or above: Requires Cache for Confluence 6.4 or above | |||
cache | code | Confluence 5.2 or above: Requires Cache for Confluence 6.6 or above | |||
cache | excerpt-include excerpt | Avoid putting the Excerpt macro within a Cache macro if you need to access the data using excerpt-include. | |||
cache | details (Page properties) | ||||
cache | detailssummary (Page properties report) | Should display properly, but not have any significant performance benefit. | |||
cache | any asynchronous macro | Should display properly, but not have any significant performance benefit. | |||
cache | IPython Notebook | Indexing of the content is not happening with this app | - CACHE-278Getting issue details... STATUS |
Legend | Status |
---|---|
Works | |
Works with some restrictions or workarounds | |
Is not effective since macro uses asynchronous methods for bringing in data | |
Does not work in most cases | |
Unknown |