Graph Macro

...

Document Properties Marker

override	false

Short Description

Renders a document graph in a graph language.

Doctype

macro

hide

Name

Graph Macro

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property	Audience

Tags

Tag List

names	Confluence, Render Page Graph, projectdoc, Graphviz, plantuml

hide

Iteration


value	filled

hide

Extension

Graph Extension

Since

1.0

Sort Key

hide

Section

index	true
show-title	false
title	Description

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.

Section

title	Properties

Section

title	Document

Specify the document to fetch the list of documents to traverse.

If the value is empty, the document the macro is on is selected.

Section

title	Property

The name of the property of the document to fetch the list of documents to traverse.

The expected value is either a list of Confluence links or a list of links created by a projectdoc macro (it needs a data attribute named "data-projectdoc-id" on the rendered HTML anchor element). These links need to point to projectdoc documents.

The property may also specify a section containing references to documents.

Section

title	Implicit Association

Check if this document links to first children.

That is make this document as the root node of the document tree.

Section

title	Add Labels

Check if the edges should be labelled with the association namesassociation names.

Section

title	Selected Columns

If the Property parameter points to a section containing a table, specify the names of the columns to use for implicit associations.

Section

title	Render Startdot

Adds @startdot at the first line.

Deactivated by default.

This is required by plantUML.

Section

title	Render Digraph

Wraps the content inside a digraph element with the graph name.

This is required if the generated diagram is complete.

Activated by default.

Section

title	Render Wrapper

Wraps graph description inside a preformat element.

This is required by plantUML.

Deactivated by default.

Section

title	Render Text Newline

When checked a simple newline is rendered. Otherwise a XML break (br) is rendered.

Activated by default.

Section

title	Selected Columns

If the Property parameter points to a section containing a table, specify the names of the columns to use for implicit associations.

	Graph Type

Section

title	Graph Type

Caution Box

No longer supported!

Users need to define the four parameters for rendering the graph description individually.

Specify the type of graph to render. This controls the syntax of the graph notation.

Valid values are

dot-plantuml - renders some additional information for the PlantUML Render Macro.
dot-condensed - does not render the enclosing digraph element.

It defaults to dot-plantuml. The default can be set with the space property Graph Type.

Section

title	Property Name for Node

Specify the name of the document property to label the graph nodes.

If not specified, the property name defaults to the Name Property (Name).

Section

title	URL Property

Name of the document property that stores the URL. Defaults to the page URL.

If no URL should be rendered, then use #none as value.

Section

title	Style Property / Entity

The name of the property with entity style information for style templates.

Defaults to projectdoc.extension.graph.style.entity.

Section

title	Style Property / DOT

The name of the property with DOT style information.

Defaults to projectdoc.extension.graph.style.dot.

Section

title	Type Property

The name of document property storing type information. The type information styles, specified by the property, are applied to the node projectdoc.extension.graph.style.dot automatically.

Defaults to "Type".

Section

title	Graph Name

Specify the name of the graph.

Defaults to "projectdoc".

Section

title	Maximum Level

Limit the depth of the nodes to this level.

Example Box

The following example shows the rendering of a graph with its maximum node level set to 2.

Section

Column

Panel

title	Full Graph

Column

Panel

title	Reduced Graph

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.

...

Section

index	true
title	Related macros

Section

index	true
title	Sub-Macros

Display Table

doctype	macro
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

...

Section

title	References

Section

title	Resources

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-macro
Type	graph

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 4

New Version 5

Key

About

Keep up-to-date!

Powered by