Canned Search for Confluence Cloud
Canned Search for Confluence Cloud
Breadcrumbs

User Guide for CQL Navigation Macro

Introduction

The CQL Navigation Macro will generate the links to the Previous and Next pages automatically. This allows the user to navigate the pages chronologically with ease.


Choose the page sequence

Insert or edit CQL Navigation Macro, then use the Navigation tab.

Field

Required

Default

Description

Notes

Navigate By

Yes

Same parent page

Defines which pages can appear before and after the current page.

Options are Same parent page, Label across different parent pages, and Label within the same parent page.

Labels

Conditional

Empty

Provides the comma-separated labels used by either label-based navigation mode.

Required for Label across different parent pages and Label within the same parent page. Example: documentation, release-notes.

Order By

Yes

Title

Defines the sequence used to determine the previous and next pages.

Options are Position, Creation Date, Last Modified Date, and Title. All date and title ordering is ascending.

The Navigate By options include:

Option

Included pages

Same parent page

Sibling pages under the current page's parent

Label across different parent pages

Pages in the current space that have any configured label

Label within the same parent page

Sibling pages that have any configured label

For a label-based mode, enter one or more comma-separated labels, such as documentation, release-notes.

Choose Order By:

  • Position follows the Confluence page-tree order and is available only for Same parent page.

  • Creation Date, Last Modified Date, and Title use ascending CQL order.

The current page must belong to the configured sequence. If it is first or last, the unavailable Previous or Next button is disabled.

Configure the buttons

Use the Display tab to configure the navigation controls.

Field

Required

Default

Description

Notes

Position

No

Side

Aligns the navigation controls within the macro area.

Options are Left, Center, Right, and Side. Side places Previous and Next at opposite sides.

Size

No

Medium

Sets the navigation button size.

Options are Small, Medium, and Large.

Button Icon

No

None

Sets the icon displayed on the Previous and Next buttons.

Options are None, Basic arrow, Circle arrow, and Chevron. The Previous icon appears before its text; the Next icon appears after its text.

Previous Button Text

No

$title

Sets the label of the Previous button.

Use $title to show the destination page title, or enter fixed text such as Back.

Next Button Text

No

$title

Sets the label of the Next button.

Use $title to show the destination page title, or enter fixed text such as Continue.

Background Color

No

Blue

Sets the navigation button color.

Options are Blue, Green, Navy, Yellow, Orange, Purple, and Red.

Show table of contents

No

Off

Adds a button that opens the complete configured page sequence.

Existing macro instances remain off until an author enables this option.

Review the live preview to confirm the layout and text before saving.

Use the table of contents

When enabled, select Table of contents to open the page sequence.

  • The current page is marked and scrolled into view.

  • Select any page to open it.

  • For long sequences, scroll toward the start or end to load more pages.

  • Press Escape, click outside the navigation area, or move focus to another window to close the panel.

The table of contents is opt-in. Existing navigation macros remain unchanged until an author enables it.






Below are contents from the old version

Introduction

The CQL Navigation Macro will generate the links to the Previous and Next pages automatically. This allows the user to navigate the pages chronologically with ease.

image-20210531-021708.png

Usage

Adding the macro

Type /CQL Navigation in the editor and select CQL Navigation Macro

Editing the parameters

  1. Click on the macro to bring up the Edit button ( 🖊 icon below)

    image-20210531-021045.png

  2. Click on the Edit button. A panel will load to the right of the page.

  3. Update the parameters on the panel as shown.

    image-20210429-091248.png

Configuration

Field Name

Required

Default Value

Explanation

Additional Information

Navigate By


Same parent page

Select the navigation mode:

  • Same parent page (default)

  • Label across different parent page

  • Label within same parent page

This is to select a set of pages.

Label



Enter valid labels

  • Note: then this value will be used only when user selected

    • Label across different parent page OR

    • Label within same parent page


Order By

 

Created Date

Select the order of the next / previous page.

  • Created Date

  • Last Modified Date

  • Title (alphabetical order)

This is to sort the selected pages

Eg. Created Date is selected, then

  • Click on Next button will navigate to the page with a created date > current page creation date.

  • Click on Previous button will navigate to the page with a created date < current page creation date.

Previous Button Text

 

Previous

Enter Previous button text. Use $title to display page title.

 

Next Button Text

 

Next

Enter Next button text. Use $title to display page title.

 

Background Color

 

Blue

Select the button background colour:

  • Blue

  • Emerald

  • Green

  • Navy

  • Orange

  • Peach

  • Red

  • Yellow

 

Demo