Renders a document graph in a graph language.
The graph macro traverses a limited number of projectdoc documents that are connected by attributes or association documents. On traversal it renders each encountered document as a node in a graph notation. Currently only DOT (Graphviz) is supported as an output format. Use the PlantUML for Confluence add-on to transfer the graph description into a graph.
Properties
Maximum Level
Limit the depth of the nodes to this level.
The following example shows the rendering of a graph with its maximum node level set to 2.
Note that the longest path is longer than the maximum level iff there is also a shorter path to the node that is within this limit.
Details
Usage Examples
Render Children
Suppose there is a document that describes the business process "Buy Product" by listing each activity associated with this process.
The activities may be selected by a query (for instances using the Display Table Macro) or by list of selected references (for instance using the Tour Macro). Either way, the list of activities associated with the process is rendered something like this:
To render the association of the process (the document that lists these activities) to its activities, use this macro like this:
This will render the graph in DOT syntax:
@startdot
digraph projectdoc {
subgraph Activity {
"Buy Product" -> "Determine Requirements" [label="Activity"]
"Buy Product" -> "Create Candidate List" [label="Activity"]
"Buy Product" -> "Evaluate Candidates" [label="Activity"]
"Buy Product" -> "Make Buy Decision" [label="Activity"]
}
}
@enddot
Using the PlantUML Render Macro will render the graph as an image.
Traverse Properties
The macro traverses the document tree by the properties specified in the body of the macro. Each property value is supposed to contain a list of references to projectdoc documents.
Let's extend the previous example so that each activity is associated with one or more role documents. The property that stores this information is named "Role". Then make the Role property be a significant link for the graph:
For each traversed document (beyond the implicit root that is the process document), the Role property will add additional nodes to the graph. Since we add a style information (blue edges), the graph is rendered like this:
