| Div |
|---|
|
On this page| Table of Contents |
|---|
| maxLevel | 1 |
|---|
| exclude | On this page |
|---|
| type | flat |
|---|
| separator | pipe |
|---|
|
|
...
| Table plus |
|---|
| Parameter | Default | Macro Browser Label | Description |
|---|
| id | automatically generated | Reference id | Defaults to an automatically generated sequence number. The id must be unique on the page. Specifying the id can improve performance during edit by reducing cache refreshes during macro browser refresh, preview, and save cycle. It also helps when re-ordering cache macros on a page. The can be used when doing cache macro specific refreshes - see Cache Refresh below. Since 5.1.0. | | refresh | 1d (one day) | Cache refresh period | Cacheisrefreshed the next time page is viewed after the refresh period. Anunqualified numberistreated as seconds. A number followed by one of the following charactersistreated as follows: - s - seconds.
- m - minutes.
- h - hours.
d- days. | Note |
|---|
Any data after a s, m, h, or d is ignored. For example, 10days is the same as 10d or 10 days. |
| | cron |
| Cron expression | Cron-like expression for finer grained cache expiration and refresh. See Cron Expressions. For example: 30 * * * * - cacheexpires30 minutes past each hour of the day.
| | checkAttachments | true | Check attachments | If true, the cache is refreshed if there is any change in the attachments on this page. This includes adding, removing, or changing the version of any attachment. For instance, if you are caching the rendering of the an excel spreadsheet, then the data is refreshed if the attached spreadsheet is updated. | | showRefresh | false | Show refresh icon | When shown, the icon can be clicked to cause the immediate refresh of the data. | | showDate | false | Show date | Show the date and time of data was last generated. See also dateFormat. | | index | false | Index content | Add cached content to the Confluence search index. Whenever the cached data is updated, the page is re-indexed. This enables external content to be found using Confluence search. | | title | Refresh | Title | Title to show when mouse is over the refresh icon. | | dateFormat | user date format | Date format | Defaults to the system defined format modified by the users time zone. The refresh date can be have a specific format. Use a simple date format string. Since 6.1. | | anchor |
| Anchor | Name of a page anchor used to position after refresh link is pressed. Use @default to have an anchor generated at the macro location. Since 6.7. | | retry | Default | Retry feature | Special handling for render errors that can be retried. See Retry Feature for more details. Since 6.8. |
|
Customization
See New Cache Management Options.
Usage
| No Format |
|---|
{cache}
Something to cache for a day
{cache}
|
...
| No Format |
|---|
{cache:refresh=1d|showRefresh=true|showDate=true}
{beanshell}
System.out.println("Hello world " + (new Date()) );
{beanshell}
{cache}
|
Advanced Examples
Tips and Techniques
Page display performance tips and techniques
Compatibility With Other Macros
See Interoperability
Cache Refresh
...