Versions Compared

Old Version 11

changes.mady.by.user Sireesha Dugginapeddi [Appfire] (Inactive)

Saved on

compared with

New Version 12

changes.mady.by.user Smita Nair

Saved on

Key

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

...


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.

Note

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 will be 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.
Note

Graphviz recognizes the commands only when you nest the commands under "noformat", or "code" macro, for the sources mentioned below:

  • global page template name 
  • space:page template name
Note

Files and templates are not applicable for Confluence Cloud. Refer to the Migration guide for more details.


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, create or update. 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.
  • Spacespace: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

The 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.

Note

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.

Note
  • 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.

Note
  • 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. Inspite of being able to 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 dot− filter for drawing directed graphs
  • neato − filter for drawing undirected graphs
  • twopi twopi− filter for radial layouts of graphs
  • circo circo− filter for a circular layout of graphs
  • fdp 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.

Note
  • The URLs are restricted to the whitelisted URLs.
  • This parameter is not available in Graph from table and Space graph macros.


URL
URL user

The Specifies the user name for URL access via basic authentication.

user
URL user password
User Specifies the user password for URL access via basic authentication. 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
NoteIt is recommended to publish the page to view the changes made to any of the Graphviz macros. Your changes may not be reflected as expected when you preview the macro or page because the ability to preview the changes is not available currently.