Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleProperties


Section
titleDocument

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
titleProperty

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
titleImplicit Association

Check if this document links to first children.

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


Section
titleAdd Labels

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


Section
titleSelected Columns

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


Section
titleRender Startdot

Adds @startdot at the first line.

Deactivated by default.

This is required by plantUML.


Section
titleRender 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
titleRender Wrapper

Wraps graph description inside a preformat element.

This is required by plantUML.

Deactivated by default.


Section
titleRender Text Newline

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

Activated by default.


Section
titleGraph Type


Caution Box

No longer supported!

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

Use

  1. Render Startdot
  2. Render Digraph
  3. Render Wrapper
  4. Render Text Newline
Panel

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
titleProperty 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
titleURL 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
titleStyle Property / Entity

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

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


Section
titleStyle Property / DOT

The name of the property with DOT style information.

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


Section
titleType 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
titleGraph Name

Specify the name of the graph.

Defaults to "projectdoc".


Section
titleMaximum 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
titleFull Graph

 



Column


Panel
titleReduced 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.



...