Page Operations
Browse SpaceThese macros are available to Confluence instances ("clients") that have the Confluence Atlassian Plugin Repository v.2.0.13+ installed and configured to talk to a server that provides data about plugins.
{repository-plugin}
Displays rendered information from the metadata in the repository.
| Parameter | Required | Values | Default | Notes |
|---|---|---|---|---|
| key | yes | plugin key, such as com.atlassian.confluence.extra.rsvp | (none) | The plugin to display data about. |
| profile | no | the key of one of the profiles configured locally | default | This profile will be used to get plugin data. |
| outputType | no | overview-table, version-grid, description | overview-table | Format of the macro output. |
| suppressHeader | no | true, false | false | Whether or not to include a header with the output. Only applies when outputType is version-grid or description. |
{recentlyupdated-plugins}
Displays an ordered list of the plugins with the most recently released versions, according to the plugin metadata.
| Parameter | Required | Values | Default | Notes |
|---|---|---|---|---|
| product | no | a name of a product that plugins can be written for and stored in the repository (in our case confluence or jira) | (all products) | Allows restricting results to those plugins for a particular product. |
| count | no | integer | 10 | Number of result plugins to return. |
| mode | no | table, list | table | Indicates the form in which to display the results |
{popular-plugins}
Displays an ordered list of the most popular plugins. The popularity of a plugin is based on number of downloads of the plugin jar that have been recorded on the server.
| Parameter | Required | Values | Default | Notes |
|---|---|---|---|---|
| product | no | a name of a product that plugins can be written for and stored in the repository (in our case confluence or jira) | (all products) | Allows restricting results to those plugins for a particular product. |
| count | no | integer | 10 | Number of result plugins to return. |
| range | no | one of two formats:
|
month | The length of time from which to consider plugin downloads:
|
| rangeStart | no | date in the form yyyy-MM-dd | depends on range and rangeEnd | Cannot be used with the second form of the range parameter. |
| rangeEnd | no | date in the form yyyy-MM-dd | today's date (if rangeStart is not given) | Cannot be used with the second form of the range parameter. |
| mode | no | table, list | table | Indicates the form in which to display the results |
{download-stat}
Provides statistics about the number of downloads for each plugin.
| Parameter | Required | Values | Default | Notes |
|---|---|---|---|---|
| product | no | a name of a product that plugins can be written for and stored in the repository (in our case confluence or jira) | (all plugins) | Allows restricting results to those plugins for a particular product. If both product and key are specified, then key will be ignored. |
| key | no | plugin key, such as com.atlassian.confluence.extra.rsvp | (all plugins) | Allows restricting results to those for a particular plugin. If both product and key are specified, then key will be ignored. |
| version | no | build number of the plugin specified by key | (all versions) | Allows restricting results to those for a particular version of a plugin. Can only be used if a plugin key (and not a product name) is provided. |
| range | no | one of two formats:
|
month | The length of time from which to consider plugin downloads:
|
| rangeStart | no | date in the form yyyy-MM-dd | depends on range and rangeEnd | Cannot be used with the second form of the range parameter. |
| rangeEnd | no | date in the form yyyy-MM-dd | today's date (if rangeStart is not given) | Cannot be used with the second form of the range parameter. |
| increment | no | monthly, daily, yearly, weekly, total | daily | Size of the chunks of hits to return. |
| format | no | compact, full | full | Will be ignored unless increment equals total. In the compact mode, only the number of hits will be displayed. In the full mode, the number of hits are displayed in a table with the date range; the table is similar to other result tables displayed by the download-stat macro. |
{confluence-status}
Displays the update status of Confluence.
| Parameter | Required | Values | Default | Notes |
|---|---|---|---|---|
| update-only | no | true, false | false | If true, a result will only be shown if updates are required. |
| profile | no | the key of one of the profiles configured locally | default |
{plugin-status}
Displays a list of plugins that need to be updated. Currently, this macro has a bug where it will cause a Confluence system error if someone who is not logged in tries to view it.
| Parameter | Required | Values | Default | Notes |
|---|---|---|---|---|
| update-only | no | true, false | false | If true, a result will only be shown if updates are required. |
| profile | no | the key of one of the profiles configured locally | default | This profile will be used to get plugin data. |
{plugin-repository}
Displays the table of plugin information that by default only appears in the admin section. Info that non-admins should not see is hidden from them.
| Parameter | Required | Values | Default | Notes |
|---|---|---|---|---|
| profileKey | no | the key of one of the profiles configured locally | default | This profile will be used to get plugin data. |
Docu for {repository-plugin} is wrong - the outputType parameter does't exist, that setting is actually for the default parameter.