{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.
* *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.
* *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 / IncludeMacros}
{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.{toggle-cloak:id=cloak7} Result
{cloak:id=cloak7}
The page 'Wiki Markup Editor' from the wiki space 'HELP' is not displayed on this page:
{include:HELP:Wiki Markup Editor}
{cloak}

h3.{toggle-cloak:id=cloak8} Parameters
{cloak:id=cloak8}
{code}
{include:SPACE:Name_of_page}
{code}
{note:title=The 'space' parameter is case sensitive.}
{cloak}
{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.{toggle-cloak:id=cloak10} Result
{cloak:id=cloak10}
Content to be included on another page.
{cloak}
h3. {toggle-cloak:id=cloak11} Parameters
{cloak:id=cloak11}
||*Name*||*Required?*||*Default*||*Description*||
|hidden|(x)|false|Controls whether the text between the excerpt tags will appear on that page when users read it.|
{cloak}
{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. {toggle-cloak:id=cloak13} Result
{cloak:id=cloak13}
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.
{cloak}
h3.{toggle-cloak:id=cloak14} Parameters
{cloak:id=cloak14}
||*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.|
{cloak}
{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. {toggle-cloak:id=cloak2} Result
{cloak:id=cloak2}
*Bulleted list:*
{popular-labels:style=list|spacekey=HELP|count=15}
*Heatmap :*
{popular-labels:style=heatmap|spacekey=HELP|count=15}
{cloak}
h3. {toggle-cloak:id=cloak3} Parameters
{cloak:id=cloak3}
||*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).|
{cloak}
{card}

{card:label=contentbylabel}
Generates a list of content associated with a specific label or labels.
h3. The Code 
{code}
{contentbylabel:Documentation}
{code}
h3.{toggle-cloak:id=cloak13} Result
{cloak:id=cloak13}
{contentbylabel:Documentation}
{cloak}
h3.{toggle-cloak:id=cloak14} Parameters
{cloak:id=cloak14}
||*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.|
{cloak}
{card}

{card:label=related-labels}
Lists all tagged labels from every page which has one or more labels in common with the current page.
h3. The Code 
{code}
{related-labels}
{code}
h3. {toggle-cloak:id=cloak15} Result
{cloak:id=cloak15}
{related-labels}
{cloak}
h3.{toggle-cloak:id=cloak16} Parameters
{cloak:id=cloak16}
||*Name*||*Required?*||*Default*||*Description*||
|labels|(x)|none|Specify the labels for which you want to view related labels. For example, documentation, help.| 
{cloak}
{card}

{card:label=recently-used-labels}
Generates a list of recently used labels on a specific scale : Global, Space, Personal.
h3. The Code 
Horizontal list:
{code}
{recently-used-labels}
{code}
Table:
{code}
{recently-used-labels:style=table}
{code}
h3. {toggle-cloak:id=cloak17} Result
{cloak:id=cloak17}
*Horizontal list:*
{recently-used-labels}
*Table:*
{recently-used-labels:style=table}
{cloak}
h3. {toggle-cloak:id=cloak18} Parameters
{cloak:id=cloak18}
||*Name*||*Required?*||*Default*||*Description*||
|count|(x)|10|Specifies the total number of labels to display in the list. |
|scope|(x)|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|(x)|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|(x)|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.| 
{cloak}
{card}

{card:label=listlabels}
Creates a hyper-linked alphabetically listed index of all labels within the current space.
h3. The Code 
{code}
{listlabels}
{code}
h3. {toggle-cloak:id=cloak19} Result
{cloak:id=cloak19}
{listlabels}
{cloak}
{card}
{card}
{deck}


{card:label=content-by-user}
Creates a list of ALL current content by a specific Wiki user. This includes, pages, comments, and spaces.
h3. The Code :
{code}
{content-by-user:ggaskell}
{code}
h3. {toggle-cloak:id=cloak20} Result
{cloak:id=cloak20}
!content_by_user.png!
{cloak}
{card}

{card:label=children}
Creates a hyper-linked list of a pages' children and its' descendants (childrens' children).
h3. The Code 
{code}
{children:all=true}
{code}
h3.{toggle-cloak:id=cloak21} Result
{cloak:id=cloak21}
{children:all=true}
{cloak}
h3.{toggle-cloak:id=cloak22} Parameters
{cloak:id=cloak22}
||*Name*||*Required?*||*Default*||*Description*||
|all|(x)|false|Display all descendants.|
|page|(x)|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|(x)|none|Specify the depth of descendents to display. {note:title=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|(x)|none|Restrict the number of children displayed at the top level.|
|style|(x)|none|Specify the style in which descendents are displayed.|
|excerpt|(x)|false|Display the child pages' excerpts, if they exist.|
|sort=creation
sort=title
sort=modified|(x)|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|(x)|false|Use this parameter in conjunction with the 'sort' parameter described above. Set 'reverse=true' to change the sort from ascending to descending order.|
{cloak}
{card}

{card:label=search}
The *search* macro searches your Confluence site based on search terms specified in the macro code, and displays the results on the wiki page.
h3. The Code
{code}
{search:query=help|maxLimit=5}
{code}
h3.{toggle-cloak:id=cloak24} Result
{cloak:id=cloak24}
A list of content based on the 'help' search term with a max of 5 results:
{search:query=help|maxLimit=5}
{cloak}
h3. {toggle-cloak:id=cloak45} Parameters
{cloak:id=cloak45}
||*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|(x)|no limit|Set a limit to the number of search results displayed. |
|spacekey|(x)|all|Specify the key of the space you want to search in. Note that this is case sensitive.|
|type|(x)|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|(x)|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|(x)|all|Specify the username of a Confluence user, to show only content created or updated by that user.|
{cloak}
{card}

{card:label=index}
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.
h3. The Code 
{code}
{index}
{code}
h3. {toggle-cloak:id=cloak25} Result
{cloak:id=cloak25}
{index}
{cloak}
{card}

{card:label=gallery}
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.
h3. The Code 
{code}
{gallery:title=Castles}
{code}
h3.{toggle-cloak:id=cloak26} Result
{cloak:id=cloak26}
{gallery:title=Castles|exclude=content_by_user.png}
{cloak}
h3. {toggle-cloak:id=cloak27} Parameters
{cloak:id=cloak27}
||*Name*||*Required?*||*Default*||*Description*||
|title|(x)|none|Specify a title for your gallery.|
|columns|(x)|4|Specify the number of columns for your table.|
|exclude|(x)|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|(x)|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|(x)|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|(x)|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|(x)| 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.|
{cloak}
{card}

{card:label=change-history}
Creates a table displaying the history of a page including version number, author, date and any comments associated with the change.
h3. The Code 
{code}
{change-history}
{code}
h3. {toggle-cloak:id=cloak28} Result
{cloak:id=cloak28}
{change-history}
{cloak}
{card}

{card:label=favpages}
Displays a list of pages marked "favorite".
h3. The Code 
{code}
{favpages:maxResults=5}
{code}
h3. {toggle-cloak:id=cloak29} Result
{cloak:id=cloak29}
{favpages:maxResults=5}
{cloak}
h3. {toggle-cloak:id=cloak30} Parameters
{cloak:id=cloak30}
||*Name*||*Required?*||*Default*||*Description*||
|maxResults|(x)|all|Specifies the maximum number of results to be displayed.|
{cloak}
{card}

{card:label=navmap}
Creates a list of pages associated with a specific label in a navigation map.
h3. The Code 
{code}
{navmap:help}
{code}
h3. {toggle-cloak:id=cloak31} Result
{cloak:id=cloak31}
{navmap:help}
{cloak}
h3.{toggle-cloak:id=cloak32} Parameters
{cloak:id=cloak32}
||*Name*||*Required?*||*Default*||*Description*||
|label|(/)|none|Specify the label associated with the pages you want to show in the navigation map. |
|title|(x)|none|Specify a title for the navigation map. |
|wrapAfter|(x)|5|Specify the number of cells in a row.|
|cellWidth|(x)|90px|Specify the cell width.|
|cellHeight|(x)|60px|Specify the cell height.|
|theme|(x)|Confluence|Define a theme for the navmap.
If you want to create your own navmap 'look and feel' (for example, one with rounded corners), you need to add a customised navmap macro theme file to the WEB-INF/classes/templates/macros directory. The file name convention to use is navmap-mytheme.vm. Use the name of your choice for the mytheme part of the file name, which is also the value you use for this parameter. Hence, if your theme was called navmap-roundededges.vm, use the value of roundededges for this parameter.|
{cloak}
{card}
{card}
{card}
{deck}
{deck}

{roundrect:bgcolor=#828282|width=909px|height=50px|corners=false,false,true,true}
{roundrect}