Topic Tree macro key and configuration options.

Key

topic-tree

ParameterDescriptionValue(s)Example(s)
Labels*a list of content to include in the tree; labels appear as top-level items; to override, use the Names parameter
  • page label
  • blog label
  • attachment label
  • hr,vacation

Namesa list of names to show in place of labels
  • label=Name
  • hr=Human Resources, vacation=Holidays

Include Pagestoggles the visibility of pages in the results
  • checkmark

 

Include Blog Poststoggles the visibility of blog posts in the results
  • checkmark

 

Include Filestoggles the visibility of files (page attachments) in the results
  • checkmark
 
Filter Bydefines a type of space from which to show content; when selecting specified categories or specified keys, use in conjunction with the Specify Spaces parameter
  • all spaces
  • all global spaces
  • specified categories
  • specified keys
  • all global spaces

Specify Spacesa specific list of spaces from which to show content; leave this setting blank to show results from the current space; this parameter is case sensitive
  • space label
  • space key
  • PRESS,Human Resources

Number of Resultslimits the results under each topic to the specified number
  • numeric
  • 5

Sort Orderdefines the order in which to present topics; the order is based on creation date
  • alphabetical
  • most recent
  • alphabetical

Show Space Namestoggles the visibility of space names after page titles
  • checkmark
 
Show Create Datetoggles the visibility of creation dates after page titles
  • checkmark
 
Show Creatortoggles the visibility of author names after page titles
  • checkmark
 
Convert Page Labelstoggles the appearance of labels (on the current page) between the Confluence style and a human-readable style; the human-readable style (1) replaces hyphens/underscores with spaces, (2) uses title case and (3) removes links
  • checkmark
 

* Required field

If using:

  1. Replace me with something to note about the content on this page that falls outside the scope of the Reference section; and
  2. Add the tight-bottom class to the Reference block above to narrow the gap between the two blocks.