Document toolboxDocument toolbox

User Guide for CQL Navigation Macro

Owned by Cao Liang
Last updated: May 31, 2021 by Hua Soon SIM [Akeles]
2 min read

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.

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)

  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.

Configuration

Field Name

Required

Default Value

Explanation

Additional Information

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