Skip to end of banner
Go to start of banner

Space graph macro - Cloud

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Current »

Description

Displays an image of pages in space and the connections between them. This is done by generating a Graphviz diagram using the Flowchart macro from the page relationship information available in Confluence. Parameters determine what pages are included in the graph.

Graphviz resources

Graphviz is a powerful way of describing diagrams of any kind, using just text. Graphviz provides automatic layout of diagrams based on the text. Have a look at the following Graphviz resources.

Parameters

Macro specific parameters

Macro Editor LabelDefaultDescriptionMacro Parameter
Space keycurrent spaceSpace key used to restrict pages to be displayed.space
Start page
Subset page selections to this page and its descendants. Use @home for space home page.page
Descendant depth3

Descendant depth to include in page subset. Use:

  • 0 - to include all descendants.
  • 1 - to include all children.
  • 2 - to include all children and children of children.
depth
Labels
Blank separated list of labels used to subset pages to be included.labels
Direction of graph (rankdir)LR

Sets the graphviz rankdir parameter

  • TB – top to bottom
  • LR – left to right
direction
Show outgoing linksFALSEIf true, show outgoing links on the graph.showOutgoingLinks


Removal notice

Please note that the URL user and URL user password parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data.

The following parameters are available with all Graphviz macros:

Macro Editor Label
Default
Description
Macro Parameter
Output typesvg

Specifies the output type to be generated by Graphviz. 

  • png
  • svg
  • jpg
  • gif
output
Profile

Specifies the profile the macro uses to read data from an external application such as GitLab or GitHub.

Profiles refer to common parameters, that administrators create and configure, to access data from external sources. Contact your administrator to know more about the profiles that are configured in your instance. Refer to the administrator guide to understand more about profiles.

This parameter is not available in Graph from table and Space graph macros.


Location of Graphviz source

Specifies the source from where the macro reads the data. 

  • blank - The body is used.
  • ^attachment - Data is read from an attachment to the current page. Input the value in the format ^Filename.extension.
  • page^attachment - Data is read from an attachment to the page name provided.
  • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.
  • global page template name - Data is read from a global page template.
  • space:page template name - Data is read from a space template.
  • Files and templates are not applicable for Confluence Cloud. Refer to the Migration guide for more details.

  • Graphviz recognizes the commands only when you nest the commands under noformat, code, or code-pro macros, for the sources mentioned below:

    • global page template name 
    • space:page template name
script
Show Graphviz markup codeFalseShows the Graphviz markup code below the generated graph. Useful for fixing syntax errors or to see the markup that is generated by macro processing or macros like the Space graph macro.showCode
Attachment name

The name of the attachment to use. Useful when the Graphviz image must be uploaded as a new attachment or to update an existing attachment. Use of attachments is optional but can be useful for linking from other places.

Examples:

  • graphviz.png — the image is saved as an attachment to the current page.
  • page^graphviz.png — the image is saved as an attachment to the page name provided.
  • space:page^graphviz.png — the image is saved as an attachment to the page name provided in the space indicated.
attachment
Attachment versionnew

Specifies how the generated graph is persisted as an attachment.

  • New — creates a new version of the attachment.
  • Replace — replaces all previous versions of the attachment. To replace an existing attachment, the user must be authorized to remove attachments for the page specified.
  • Keep — only saves a new attachment if there is no existing attachment. An existing attachment will not be changed or updated.
attachmentVersion
Attachment comment

Specifies the comment on the attachment that is created or updated.

attachmentComment
Attachment versions to keep

Limits the number of attachment versions of a file that is attached to a page. If the maximum number of attachments exceeds the limit, then the oldest version is deleted.

This parameter is only applicable if you select New from the drop-down list under Attachment version, in the macro editor.

attachmentLimit

ThumbnailFalse

Used when an attachment is specified, and output is png, jpg, or gif. Renders graph as a thumbnail with default size 128x128px.

  • In some cases, the image and the thumbnail generated are of the same size. This is because the image is too small and fits the preview screen perfectly.
  • This parameter is not applicable for Graph macro.
thumbnail
Render wiki markup macros in bodyFalse

Set to true to render wiki markup macros found in the body before processing as Graphviz markup.

  • Only the following wiki markup macros are supported for processing as Graphviz markup:
    • noformat
    • code
    In other words, the output of any other wiki markup macro (that is not available on Cloud), is not a valid input to Graphviz macros. Though you can insert such macros in the Graphviz macro body, you are likely to encounter a rendering error in the published page.
  • This parameter is not available in Graph from table and Space graph macros.
macros
Layoutdot

Specifies which default layout algorithm to use.

  • dot− filter for drawing directed graphs
  • neato − filter for drawing undirected graphs
  • twopi− filter for radial layouts of graphs
  • circo− filter for a circular layout of graphs
  • fdp− filter for drawing undirected graphs
layout

URL to 'macro' file

(macro ~ Graphviz/ Diagraph/ Graph)


Specifies the URL link to the Graphviz file. Administrators may restrict use.

  • The URLs are restricted to the whitelisted URLs.
  • This parameter is not available in Graph from table and Space graph macros.
URL
URL user (Removed)

Specifies the user name for URL access via basic authentication.

Removal notice

Please note that the URL user and URL user password parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data.

user
URL user password  (Removed)

Specifies the user password for URL access via basic authentication. 

Removal notice

Please note that the URL user and URL user password parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data.

password
URL connection timeout
Used to increase the wait time for URL access on slower connections. timeout
File encoding

Allows the user to specify the encoding if it is different from the Confluence default (like Windows-1252, UTF-8, MacRoman). 

encoding

Screenshots

There are no images attached to this page.

  • No labels


Find answers from the community.

Ask a question to the community.

Log a request with our support team.

Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.