English: Documentation Page Tree Visualization (Cloud version)

Visualize Your Confluence Page Tree with Ease

Our app provides a simple and effective way to create a diagram or process map of your Confluence page tree hierarchy. By placing our macro on a page, you can quickly generate a visual representation of your page tree.

Our macro can be used with all content types, including comments, blogs, and space home pages, making it a versatile tool for all your Confluence needs.

Side note: As blogs and comments do not have a hierarchy, the macro can be configured to display external page tree hierarchy

 

 

Page Tree Visualization diagram

 

Usage

To add the Page Tree Visualization macro into your Confluence pages, you can insert it via the macro browser, which can be opened by clicking the + (Insert) button > View more option in the main toolbar or by typing a forward slash “/“and selecting the macro from the dropdown.

You can also type a few letters of the macro’s name after the slash to quickly search for it.

After inserting the macro, you can click its containing box to reveal its floating toolbar. The toolbar contains buttons which will allow you to Edit the macro's configuration, change its size or remove it from the page. The Edit button will expand the macro configuration drawer, where you will be able to customize many aspects of your diagram's appearance, which will be discussed in the following sections.

Changes in the macro configuration drawer will be automatically applied and saved as you make them. Changes to text fields will only register after the field loses focus (i.e. when you click anywhere outside of it). Hitting Publish before all settings are saved may cause you to lose your last change.

Inserting the macro

 

How to Select Pages Displayed in Page Tree Visualization Macro

The children of the root page will be used to construct the visualization. You may leave this field empty to use the current page or enter the ID of any other page.

Macro automatically visualize subpages of the page where it is placed. Maximum subpages depth is 3.

 

Customizing the Layout

By default, children will be displayed in rows. To display them in a column, you can add a “children-vertical” label to their parent page.

Horizontal layout:

 

Vertical layout:

 

Order of Visualized Pages

The order of cells in the diagram follows the order of the pages in the confluence page tree.

 

 

Display Options

The left side of the macro configuration window contains all available options for customization.

Predefined color themes

Predefined color theme enable you to add Page tree visualization macro easily as there is no need to define colors for each page level. Color themes ensure consistency in the use throughout your Confluence Space.

You can create your own space-specific color themes directly within the Space tools administration page. For detailed guidance on creating color templates, please refer to the Space tools administration section for more information.

Predefined color themes preview:

Summer Sky

Deep Dive

Firestorm

Zen Garden

 

Color customization

On the top of predefined color themes, you can customize the colors used in your diagram by Customize option and selecting colors. Selecting the Customize option in the Theme field will reveal fields which can be used to choose colors for the macro. The fields accept valid color names, hex color codes or colors using the rgb() notation.

Custom colors configuration:

 

Chevrons

You can choose to display the third level of subpages with chevrons by using the checkbox in the macro configuration panel.

Labels

You may add labels to the left and right sides of the diagram by filling in the Start Label (left) and Goal Label (right) fields in the macro configuration dialog.

 

Additional features

Toolbar

Hovering your mouse pointer above a diagram will reveal a toolbar below it. The toolbar contains several useful functions.

Toolbar lock

Toggling the toolbar lock will cause toolbars of all diagrams to be revealed until it's disabled.

Print

Clicking the print button will bring up the browser print dialog, enabling you to print the diagram.

Fullscreen

Clicking the fullscreen button will display your diagram in fullscreen mode. To exit, press the Esc key or click within the body of the diagram.

 

Space Tools Administration

On this page, Space administrator can adjust setting for Page Tree Visualization macro. There are two options availible: Set default theme for space and Create custom color theme

 

Theme administration

You can find the Theme administration by going to your Space settings and clicking Page Tree Visualization in the Integrations section.

Default Space theme

In the theme administration, you may choose predefined or one of your custom themes as the space's default theme. All newly inserted macros will use this theme as a default, but you may still choose other themes in the macro configuration panel.

Custom themes

Theme administration also allows you to create, modify and delete custom themes.

To create a new theme select the New custom theme option from the Select a theme to edit dropdown. Choose a name and colors for your new theme and click the Save button.

After your theme has been saved, it will become available to be chosen as the space default theme or in any macro within the same space.

To edit or delete your custom theme, select it from the Select a theme to edit dropdown, then make any necessary changes and save it, or delete it by pressing the Delete button.