You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 353 Next »

Advanced Macros

This plugin provides many macros which generates information on Wiki content.

This plugin includes the following macros:
  • listlabels – Displays the pages for a label in a pretty matrix.
  • content-by-user – List all the content created by a particular user.
  • children – List all the children of a page (and possibly their children).
  • search – Perform a full-text search, and include the results in the page.
  • index – Create an index of all pages within the space.
  • rss – Retrieve a remote RSS feed and summarise it in the page.
  • blog-posts – View, summarise or list the most recent news items in the space.
  • excerpt – Mark a section of a page as an excerpt for page summaries.
  • excerpt-include – Include the excerpt from one page within another page.
  • include – Include the full content of one page within another page.
  • gallery – Create a thumbnail gallery from a page's attachments.
  • doc – Link to the documentation using the doc macro.
  • change-history – Show the history of version comments.
  • popular-labels – List the most popular labels.
  • contentbylabel – List the pages labelled by a specified set of labels.
  • favpages – List the pages in your favourites list.
  • related-labels – List the related labels for a given set of labels, or for the current page.
  • recently-used-labels – List the labels that have been used recently.
  • navmap – Displays the pages for a label in a pretty matrix.

The Include macro displays the contents of one Wiki page in another. If the page is from another space, you will need to include the space name.

The Code :

{include:HELP:Wiki Markup Editor}

What you will get :

The page 'Wiki Markup Editor' from the wiki space 'HELP' is not displayed on this page:

Error formatting macro: include: java.lang.IllegalArgumentException: No link could be created for 'HELP:Wiki Markup Editor'.

Parameters

{include:SPACE:Name_of_page}

The 'space' parameter is case sensitive.

The Excerpt Macro is used to mark a part of a page's content for re-use. By itself, the excerpt macro does not change the display of a page. However, defining an excerpt enables other macros such as excerpt-include and blog-posts macros to display the specified content elsewhere.

A page can only have *ONE* excerpt.

The Code :

{excerpt}
Content to be included on another page.
{excerpt}

What you will get :

Content to be included on another page.

Parameters

Name

Required?

Default

Description

hidden

false

Controls whether the text between the excerpt tags will appear on that page when users read it.

This macro allows a portion of a page to 'excerpted' in another. To use this macro you must define the 'excerpted' content with the excerpt macro.

The Code :

{excerpt-include:Advanced Macros Plugin}

What you will get :

This is the plugin libraries navigation bar, which was created using the excerpt and excerpt-include macros. The panel displays the name of the page where the 'excerpted' content is being pulled from. It can be removed by adjusting the 'nopanel' parameter (see below):

If any changes are made to the content within the body of the excerpt macro, it will automatically be changed on any pages it is being 'excerpted'. This makes the excerpt and excerpt-include macros ideal for creating navigation bars.

Parameters

Name

Required?

Default

Description

nopanel

false

Controls whether the square panel border around the excerpt should be removed. Also controls whether the name of the page where the 'excerpted' content is being pulled from is displayed.

Displays the most popular labels used throughout a Wiki space.

The Code :

Bulleted list:

{popular-labels:style=list|spacekey=HELP|count=15}

Heatmap :

{popular-labels:style=heatmap|spacekey=HELP|count=15}

What you will get :

Bulleted list:

Heatmap :

Parameters

Name

Required?

Default

Description

count

100

Specifies the total number of labels to display in the heatmap.

spacekey

none

Restricts the list of popular labels to the specified space.

style

list

Displays the list of popular labels in standard bullet-point 'list' form or as a 'heatmap'. The heatmap style uses different font sizes depending on their rank of popularity, ordered by label names. The list style orders labels by popularity (highest first).

Generates a list of content associated with a specific label or labels.

The Code :

{contentbylabel:Documentation}

What you will get :

Error formatting macro: contentbylabel: com.atlassian.confluence.api.service.exceptions.BadRequestException: Could not parse cql : null

Parameters

Name

Required?

Default

Description

spacekey

all

Filter by space.

type

false

Filter by content type.

showLabels

true

Show or hide labels for results.

showSpace

true

Show or hide spaces for results.

excerpt

false

Show or hide excerpts for results.

maxResults

5

Specify maximum results to display.

sort=creation
sort=title
sort=modified
sort=recent

recent

The 'sort' attribute is an optional attribute that allows you to configure how the children are sorted. Use the 'reverse' attribute to optionally reverse the sorting.

operator

OR

The operator to apply to the supplied lists of labels. By default, a page with any of the labels will be listed. By using operator=AND, only pages with all of the supplied labels will be listed.

Lists all tagged labels from every page which has one or more labels in common with the current page.

The Code :

{related-labels}

What you will get :

There are no related labels.

Parameters

Name

Required?

Default

Description

labels

none

Specify the labels for which you want to view related labels. For example, documentation, help.

Generates a list of recently used labels on a specific scale : Global, Space, Personal.

The Code :

{recently-used-labels}

What you will get :

uplink, primer, surface_ops, 2023, post-landing, 2022

Parameters

Name

Required?

Default

Description

deck: com.atlassian.confluence.macro.MacroExecutionException: java.lang.NullPointerException
deck: com.atlassian.confluence.macro.MacroExecutionException: java.lang.NullPointerException
Unknown macro: {roundrect}
  • No labels