Macro linkgraph

Purpose

Create a graphical overview of incoming and outgoing links of a wiki page.

Available since

This macro was added in version 5.4.2 of the PlantUML Plugin.

Parameter

All parameters are optional.

NameDescription
spaceKey of space to create image for. Current space will be used if empty
page

Title of page that will be treated as root.
Only its descendants will be shown in graph. There a

  • @self  the current page will be used
  • pagetitle
  • spacekey:pagetitle (parameter space will be ignored)
outgoingLinkLevels

Number of pages to follow outgoing links
0 do not follow outgoing links
1 only follow link in selected page (default)
2 ....

incomingLinkLevels

Number of pages to follow incoming links

0 do not follow incoming links
1 only follow link in selected page (default)
2 ....

rootNodeColor

Color of selected page either as

Default: lightblue

nodeColor

Color of linked pages

Default: lightyellow

nodeFontsizeFontsize to be used in graph.
directionTB - Top to bottom
LR - Left to right (default)
labels

A comma separated list of labels can be defined here. If given, than only pages that contain one of the listed labels will be shown.

(available since 5.15)

metadata

Displays metadata created with Metadata Plugin

  • @all to show all metadata
  • comma separated list of metadata keys to show

(available since 5.3.1)

format

PNG (default)

SVG (beta)

exportNameThe graph will be stored as attachment if exportName is given.
debug

true = Enable debugging.

Limitations

  • PNG images do not contain links to the pages that are displayed in the graph

Security Considerations

The linkgraph macro shows only pages which are visible for the current user.
However, if exportName is given, the image will be created as an attachment. This image contains all pages, which were visible to the user who viewed the page when the attachment was created.

 

Sample Images



 

Sample Code

{linkgraph:space=ds|page=Home|outgoingLinkLevels=2|nodeFontsize=8|direction=TD|metadata=@all|debug=true}
{linkgraph}

Macro Browser