Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

 

Composition Setup

deck.tab.active.background = #6495ED

Section
Column
width20%15%

Excerpt
{roundrect:bgcolor=#828282|width=282px|height=50px|corners=} {roundrect} {deck:id=navbar|width=280px} * [Advanced Macros Plugin] * [Attachment Extractors] * [Basic Macros Plugin](/) * [Booking Plugin](/) * [Calendar Plugin](/) * [Composition Plugin] * [Content Formatting Macros] (/) * [Dynamic Task List Plugin](/) * [Gliffy Plugin] * [Google Maps Plugin] * [HTML Plugin] * [IM Presence Plugin] * [Information Macros] * [Job Manager Plugin] * [LaTeX Plugin] * [Layout Macros Plugin] * [Live Search Macros plugin] * [Office Connector Plugin] * [Page Tree] * [Profile Macros Plugin] * [Scaffolding Plugin] * [Slideshow Plugin] * [Survey Macros plugin] * [Table of Contents Plugin] * [Tabular Metadata Plugin] * [User Lister] * [User Status] * [WebDAV Plugin] * [Widget Connector] {deck} {roundrect:bgcolor=#828282|width=282px|height=50px|corners=false,false,true,true} {roundrect}
Round Rectangle
Wiki Markup
corners
true,true,false,false
bgcolor#828282
width202px
height50px

Deck of Cards
width200px
idnavbar
Center
Round Rectangle
cornersfalse,false,true,true
bgcolor#828282
width202px
height50px

Column
width60%
Deck of Cards
width907px
idAdvanced Macros
Card
labelOverview

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.
  • 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.
  • 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.
Card
labelDocumentation
Deck of Cards
idadvancedm

Card
labelExcerpt / IncludeMacros

Deck of Cards
idexcerptincludem

Card
labelinclude

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

Code Block

{include:HELP:Wiki Markup Editor}

Toggle Cloak
idcloak7
Result

Cloak
idcloak7

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

HELP:Wiki Markup Editor

Toggle Cloak
idcloak8
Parameters

Cloak
idcloak8
The 'space' parameter is case sensitive.
Card
labelexcerpt

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.

Note
titleA page can only have *ONE* excerpt.

The Code

Code Block

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

Toggle Cloak
idcloak10
Result

Cloak
idcloak10

Content to be included on another page.

Toggle Cloak
idcloak11
Parameters

Cloak
idcloak11

Name

Required?

Default

Description

hidden

false

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

Card
labelexcerpt-include

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

Code Block

{excerpt-include:Advanced Macros Plugin}

Toggle Cloak
idcloak13
Result

Cloak
idcloak13

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):

Advanced Macros Plugin

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.

Toggle Cloak
idcloak14
Parameters

Cloak
idcloak14

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.

Card
Card
labelLabel Macros

Deck of Cards
idlabelm

Card
labelpopular-labels

Displays the most popular labels used throughout a Wiki space.

The Code

Bulleted list:

Code Block

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

Heatmap :

Code Block

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

Toggle Cloak
idcloak2
Result

Cloak
idcloak2

Bulleted list:

listHELP15

Heatmap :

heatmapHELP15

Toggle Cloak
idcloak3
Parameters

Cloak
idcloak3

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).

Card
labelcontentbylabel

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

The Code

Code Block

{contentbylabel:Documentation}

Toggle Cloak
id13
Result

Cloak
id13
Documentation

Toggle Cloak
id14
Parameters

Cloak
id14

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.

Card
labelrelated-labels

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

The Code

Code Block

{related-labels}

Toggle Cloak
idcloak15
Result

Cloak
idcloak15

Toggle Cloak
idcloak16
Parameters

Cloak
idcloak16

Name

Required?

Default

Description

labels

none

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

Card
labelrecently-used-labels

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

The Code

Horizontal list:

Code Block

{recently-used-labels}

Table:

Code Block

{recently-used-labels:style=table}

Toggle Cloak
idcloak17
Result

Cloak
idcloak17

Horizontal list:

Table:

table

Toggle Cloak
idcloak18
Parameters

Cloak
idcloak18

Name

Required?

Default

Description

count

10

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

scope

global

Specifies the scope of labels to be displayed in the list. Valid values include:

  • global — covers all non-personal spaces in the Confluence installation.
  • space — the current space.
  • personal — your own personal space.

style

list

Displays the list of recently used labels in a horizontal 'list' style or in a 'table' style. The table style includes additional information such as the page to which the label was added user who added it.

title

none

Adds a title to the top of the list in table style. Titles are only visible when the List Style (style) parameter has been set to table.

Card
labellistlabels

Creates a hyper-linked alphabetically listed index of all labels within the current space.

The Code

Code Block

{listlabels}

Toggle Cloak
idcloak19
Result

Cloak
idcloak19
Card
Deck of Cards

Card
labelcontent-by-user

Creates a list of ALL current content by a specific Wiki user. This includes, pages, comments, and spaces.

The Code :

Code Block

{content-by-user:ggaskell}

Toggle Cloak
idcloak20
Result

Cloak
idcloak20

Card
labelchildren

Creates a hyper-linked list of a pages' children and its' descendants (childrens' children).

The Code

Code Block

{children:all=true}

Toggle Cloak
idcloak21
Result

Cloak
idcloak21
true

Toggle Cloak
idcloak22
Parameters

Cloak
idcloak22

Name

Required?

Default

Description

all

false

Display all descendants.

page

current

Specify which page to display children for in a current space or in a different space.
If the page parameter is '/', then the macro will list all the current space's top-level pages i.e. those without parents. If the page parameter is a space key followed by a
colon (e.g "children:page=DOC:"), then the top-level pages of that space will be listed.

depth

none

Specify the depth of descendents to display.

If your *children* macro includes both 'all=true' and 'depth=X' parameter-value combinations where X is a number, 'all=true' takes precedence. If an 'all=false' and 'depth=X' parameter-value combination is used, 'depth=X' takes precedence.

first

none

Restrict the number of children displayed at the top level.

style

none

Specify the style in which descendents are displayed.

excerpt

false

Display the child pages' excerpts, if they exist.

sort=creation
sort=title
sort=modified

Manual if manually ordered, otherwise alphabetical

he 'sort' attribute is an optional attribute that allows you to configure how the children are sorted. Specify 'creation' to sort by content creation date, 'title' to sort alphabetically on title and 'modified' to sort of last modification date.

reverse

false

Use this parameter in conjunction with the 'sort' parameter described above. Set 'reverse=true' to change the sort from ascending to descending order.

Card
labelsearch

The search macro searches your Confluence site based on search terms specified in the macro code, and displays the results on the wiki page.

The Code

Code Block

{search:query=help|maxLimit=5}

Toggle Cloak
idcloak24
Result

Cloak
idcloak24

A list of content based on the 'help' search term with a max of 5 results:

help5

Toggle Cloak
idcloak45
Parameters

Cloak
idcloak45

Name

Required?

Default

Description

query

none

The search terms which this macro will use to generate its results. You can refine your search query by using operators such as 'AND' and 'OR'. For example:

  • In the macro browser Search Terms entry box: my_query1 AND my_query2
  • In wiki markup editor: "search:query=my_query1 AND my_query2"

maxLimit

no limit

Set a limit to the number of search results displayed.

spacekey

all

Specify the key of the space you want to search in. Note that this is case sensitive.

type

all

Specify the content type. The content types are: page, comment, blogpost, attachment, userinfo (the content of user profiles only), spacedesc (the content of space descriptions only) and mail.

lastModified

all

Specify a period of time in weeks, days, hours and/or minutes, to see the content modified within that time frame. For example:

  • 2h 35m
  • 3d 30m
    These are the values you can use:
  • w = weeks
  • d = days
  • h = hours
  • m = minutes
    If no time category is specified, Confluence assumes minutes. If you specify more than one time period (e.g. weeks and days), the periods must be separated by a space and they can come in any order. The time categories are not case sensitive e.g. '4d' is the same as '4D'.

contributor

all

Specify the username of a Confluence user, to show only content created or updated by that user.

Card
labelindex

The index macro creates a hyper-linked alphabetical index of all pages within the current space.

The top section of the Index contains a cell for letter of the alphabet, including separate cells for numbers and symbols. Each of these cells indicates the number of pages in which the first letter of the title matched the corresponding letter, number or symbol in the cell.

The lower section is effectively an extended version of the top section. However, each cell shows the page name followed by the first few sentences of content on that page.

The Code

Code Block

{index}

Toggle Cloak
idcloak25
Result

Cloak
idcloak25
Card
labelgallery

The gallery macro displays a gallery of thumbnail images in a table, based on the images attached to a Wiki page. When viewing the page, a user can click a thumbnail image to zoom into the full-size image and then view the images as a slide show.

The Code

Code Block

{gallery:title=Castles}

Toggle Cloak
idcloak26
Result

Cloak
idcloak26
Castlescontent_by_user.png

Toggle Cloak
idcloak27
Parameters

Cloak
idcloak27

Name

Required?

Default

Description

title

none

Specify a title for your gallery.

columns

4

Specify the number of columns for your table.

exclude

no exclusions; all
images included

The gallery will ignore any pictures specified by exclude=picture file name i.e. they will not be included in the gallery. You can specify more than one picture, separated by commas. Example: exclude=my picture.png,my picture2.gif.

include

nclude all the pictures on the page.

If you specifically include one or more pictures, the gallery will show only those pictures. Format is include=picture file name. You can specify more than one picture, separated by commas. Example: include=my picture.png,my picture2.gif.

page

current

Specify the title of the page which contains the images you want displayed. If the page is in the same space as the page containing the macro, use the format page=My Page Name. To specify a page in a different space, use page=SPACEKEY:My Page Name, such as page=DOC:Gallery Macro.

reverseSort

Nothing, i.e. sort order is ascending.

Used in conjunction with 'sort' parameter above. Use 'reverseSort' to reverse the sort order, from ascending to descending.

sort

None i.e. the sort order is unspecified and therefore unpredictable.

Specify an attribute to sort the images by that attribute. Sort order is ascending, unless you specify the 'reverseSort' parameter (see below). Options are:

  • 'name' – file name.
  • 'comment' – comment linked to the attached file.
  • 'date' – date/time last modified.
  • 'size' – size of the attached file.
Card
labelchange-history

Creates a table displaying the history of a page including version number, author, date and any comments associated with the change.

The Code

Code Block

{change-history}

Toggle Cloak
idcloak28
Result

Cloak
idcloak28
Card
labelfavpages

Displays a list of pages marked "favorite".

The Code

Code Block

{favpages:maxResults=5}

Toggle Cloak
idcloak29
Result

Cloak
idcloak29
5

Toggle Cloak
idcloak30
Parameters

Cloak
idcloak30

Name

Required?

Default

Description

maxResults

all

Specifies the maximum number of results to be displayed.

Card
labelnavmap

Creates a list of pages associated with a specific label in a navigation map.

The Code

Code Block

{navmap:help}

Toggle Cloak
idcloak31
Result

Cloak
idcloak31
help

Toggle Cloak
idcloak32
Parameters

Cloak
idcloak32

Name

Required?

Default

Description

label

none

Specify the label associated with the pages you want to show in the navigation map.

title

none

Specify a title for the navigation map.

wrapAfter

5

Specify the number of cells in a row.

cellWidth

90px

Specify the cell width.

cellHeight

60px

Specify the cell height.

Card

Deck of Cards

Round Rectangle
cornersfalse,false,true,true
bgcolor#828282
width909px
height50px
Column
width60%
{deck:id=Advanced Macros|width=907px} {card:label=Overview} h4. Advanced Macros This plugin provides many macros which generates information on Wiki content. h5. 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. {card} {card:label=Documentation} {deck:id=advancedm} {card:label=Excerpt / Include Macros} {deck:id=excerptincludem} {card:label=include} 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. h3. The Code : {code} {include:HELP:Wiki Markup Editor} {code} h3. What you will get : The page 'Wiki Markup Editor' from the wiki space 'HELP' is not displayed on this page: {include:HELP:Wiki Markup Editor} h3. Parameters {code} {include:SPACE:Name_of_page} {code} {note:title=The 'space' parameter is case sensitive.} {card} {card:label=excerpt} 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. {note:title=A page can only have *ONE* excerpt.} h3. The Code : {code} {excerpt} Content to be included on another page. {excerpt} {code} h3. What you will get : Content to be included on another page. h3. Parameters ||*Name*||*Required?*||*Default*||*Description*|| |hidden|(x)|false|Controls whether the text between the excerpt tags will appear on that page when users read it.| {card} {card:label=excerpt-include} 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. h3. The Code : {code} {excerpt-include:Advanced Macros Plugin} {code} h3. 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): {excerpt-include:Advanced Macros Plugin} 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. h3. Parameters ||*Name*||*Required?*||*Default*||*Description*|| |nopanel|(x)|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.| {card} {deck} {card} {card:label=Label Macros} {deck:id=labelm} {card:label=popular-labels} Displays the most popular labels used throughout a Wiki space. h3. The Code : Bulleted list: {code} {popular-labels:style=list|spacekey=HELP|count=15} {code} Heatmap : {code} {popular-labels:style=heatmap|spacekey=HELP|count=15} {code} h3. What you will get : *Bulleted list:* {popular-labels:style=list|spacekey=HELP|count=15} *Heatmap :* {popular-labels:style=heatmap|spacekey=HELP|count=15} h3. Parameters ||*Name*||*Required?*||*Default*||*Description*|| |count|(x)|100|Specifies the total number of labels to display in the heatmap.| |spacekey|(x)|none|Restricts the list of popular labels to the specified space. | |style|(x)|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).| {card} {card:label=contentbylabel} Generates a list of content associated with a specific label or labels. h3. The Code : {code} {contentbylabel:Documentation} {code} h3. What you will get : {contentbylabel:Documentation} h3. Parameters ||*Name*||*Required?*||*Default*||*Description*|| |spacekey|(x)|all|Filter by space.| |type|(x)|false|Filter by content type.| |showLabels|(x)|true|Show or hide labels for results.| |showSpace|(x)|true|Show or hide spaces for results.| |excerpt|(x)|false|Show or hide excerpts for results.| |maxResults|(x)|5|Specify maximum results to display.| |sort=creation sort=title sort=modified sort=recent|(x)|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|(x)|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.| {card} {card:label=related-labels} {card} {card:label=recently-used-labels} {card} {card:label=listlabels} {card} {deck} {card} {card:label=content-by-user} {card} {card:label=children} {card} {card:label=search} {card} {card:label=index} {card} {card:label=rss} {card} {card:label=blog-posts} {card} {card} {deck} {deck} {roundrect:bgcolor=#828282|width=907px|height=50px|corners=false,false,true,true} {roundrect}
Wiki Markup

Column
width20%