Links Component

Show a list of links in your Related Content Container.

Using This Component

The component as it is first displayed on the page.

The component as it is first displayed on the page.

Add the component to an existing Related Content Container. There are two associated sections, an upper title area (with a Related Links tab), and a lower list (with a standard List Builder component).

Related Links Tab (title setting)

To change the title, double click/right-click the upper component area.

Headline: Provide a descriptive title. By default 'Related Links' will be shown.

The component opened for editing displaying the title setting.

The component opened for editing displaying the title setting.

To add links, double-click in the lower component area. This is a standard List Builder component.

List Settings

Here you will choose the type of list, as well as additional advanced settings.

Build list using: This drop-down menu asks how you want to build your list. You have the option to build it using:

  • Advanced search: Do not choose Advanced Search unless you are familiar with writing queries. Build a list using Java API and REST API. Advanced search accepts a query description, and creates and runs an XPath query.
    • An Advanced Search tab will automatically appear.
    • If desired, the XPath query will filter the result set and extract facets.
    • Query descriptions are made up from a set of predicates.
    • For each predicate type, there is an evaluator component that handles that specific predicate for XPath, filtering and facet extraction.
    • The REST API provides access to these features through HTTP with responses sent in JSON.
  • Child pages: Populate the content of the list with the pages found in a segment of a website.
    • A Child Pages tab will automatically appear. Click the magnifying glass icon to the right of the Parent Page field to select a folder from which to display pages in your list. (If you build your list with child pages you do not have the option of displaying them in the order of your choice.)

Be careful not to list the parent page here by mistake--it can create a loop.
> read more in this Known Issue: Do Not Link to a Child's Parent Page in a List

Do not link to DAM assets using a relative path (/content/dam/...). For these you must use a File Download component. > read more about this Known Issue: Having Trouble Linking Downloadable Files in the DAM

  • Curated list: Build a list with selected choices. Requires you to manually add pages to the list (and maintain).
    • A Curated List tab will automatically appear. Click the magnifying glass icons to select Web pages to be displayed.
    • Use the Up and Down buttons to specify the order that the web pages will be displayed in the list. The minus (-) buttons allow you to delete web pages while the + button enables you to add Web pages.
  • Another list: Populate your list using another previously created list. This is useful if you want to mirror items displayed on another page, while perhaps limiting the amount of items displayed.
    • An Another List tab will automatically appear. Click the arrow at the right of the List Reference field to select another page from which to pull a list to imitate:
      • Click on the field to pull up a browser window of all the pages in your UBCMS.
      • Select the page containing the list you want to use.
      • The browser will display all usable components on the right hand side of the browser. Choose the desired list and click OK.
  • Search: Use a particular word or phrase to build a list. Any page that contains the searched-for term will be included in the list. Meta-data including tags can also be found in this way -- read more about searching for tagged pages.
    • Search query: Enter a predetermined unique keyword or phrase; e.g. "ubgreen-event" in our example.
      This is optional, but with no keyword you will display ALL events in the calendar. More complex queries are possible. (See Tips for Building a List Search Query.)
    • Start in: Click the magnifying glass icon to select which page, and subsequent child pages, the search is confined to. Leave the field blank to search all pages in the UBCMS.
  • Tags: Build a list using the tag words assigned to certain pages. (Read more about Tagging Your Shared Content.)
    • A Tags tab will automatically appear. In the Tags field, type the tags you would like to use or select the tags from a drop-down menu by clicking on the downward arrow sign to the right of the field.
      • In the Limit to path field, choose the scope of the list by selecting the page, and subsequent child pages, to which you wish to limit the list. Leave this field blank to populate the list using the content of your entire UBCMS. Web pages with tags matching your selections will then be displayed in your list.
      • Be advised, items in lists built using tags are not sorted in the normal default order even if they all originate in one folder. If you want the items to appear in a specific order, specify that in the Order by field.
    • Tagged pages can also be listed using the Search option, which allows more advanced control. (Read more about building a list query using search.)

New window: Select so each clicked page is displayed in a new browser window.

'Open links in new window' and 'Display as: Full content' are incompatible and will disable each other when selected.

Link Label Icons

When New Window is selected, an additional icon will follow the linked text, to alert visitors that they will be taken to a new browser window, or even leave the current website.

And if the hyperlink goes to a downloadable file, an document icon will instead be shown as well as the file size if the file is on the same server. (Read more about link labels.)

Display as: This drop-down menu asks how you would like your list to be displayed. Lists fall into the general categories of Links, Teasers and Content:

  • Links - Display the pages in the list as underlined links. Clicking on one of the links will redirect the user to the page selected. The types of links available are:
    • Plain (default): If no other option is selected, the list will automatically be displayed as a set of plain links. They are bulleted with the right angle bracket (>) symbol.
    • Medium Call to Action: The links are bulleted with the Call to Action component’s circular, exclamatory icon (medium size).
    • Large Call to Action: The links are bulleted with the Call to Action component’s circular, exclamatory icon (large size).
    • Compact: The links are shown in a simple comma-separated list.
    • Grouped by Date: The un-bulleted list will be displayed with emphasis on the separate entries' time of creation. The date appears as the heading for each entry while the exact time of the page's creation and the link to the page are placed beneath.
    • Grouped by Title: Links are grouped alphabetically by the first letter of their titles and that letter precedes each group; e.g.

      > Terminator
      > Trains, Planes and Automobiles
  • News (with dates): This option also displays an un-bulleted list with the date of creation. A simpler format than Links: Grouped by Date, the title of each entry is followed by the date of creation all on a single line.
  • Teasers - Display a preview of the information that's on the pages from your list. The types of teasers available are:
    • With Images: Instead of bullets, an image from each page appears to the left of the page’s title. The introductory text of each page is displayed beneath the title. (If no image is available, space will be left to ensure all teasers stay aligned.)
    • Without Images: Displays the title of the page with its introductory paragraph. Items are bulleted with the Call to Action component’s circular, exclamatory icon (large size).
    • With Dates: Instead of bullets, an image from each page appears to the left of each page’s title and its date of creation. The page’s introductory paragraph appears below.
    • Grid: Displays the list as a gallery of images. Each page is represented by an image with its name beneath the picture as the link.
    • Directory (with interests): Meant to be used with the Faculty Profile Template, it reveals each person's name, contact details, titles, and research interests.
  • Content:
    • Full Content Displays the full content of each page in the list.

'Display as: Full content' and 'Open links in new window' are incompatible and will disable each other when selected.

Settings available for Display As.

Settings available for Display As.

Order by: There are several ways in which you can order your list. Not all appear in the dropdown.

  • (blank): By default, the leaving the setting blank will sort the list by its natural arrangement in the folder.
  • cq:lastModified: The list will be ordered by the date of modification. The page most recently edited will appear on top.
  • cq:template: The order will be established according to its arrangement in the Page Tree, sorted by template type used on each page.
  • jcr:created: Order the list by the page date of creation, with the earliest date of creation beginning the list.This setting can be confusing. Author and live pages often will not match because your live site order is determined by the first activation date for each page on the publishers, not their original creation date in author. Subsequent reactivations have no impact, but a page that is deactivated and then reactivated will receive that latest activation date.
  • jcr:title: The list is ordered alphabetically by title.
  • navTitle: The list will be ordered alphabetically based on the Navigation Title in each page's Page Properties (see Page Properties Basic tab settings).
  • postDate: Arrange the list items by the date the pages were created for pages created using the News Article Template or for pages that include the Date Created component. Using postDate for other pages will result in a randomized order.
  • random: Each time someone views the page, they will see a random order to the list.
Settings available for Order By.

Settings available for Order By. Custom options can be type din manually.

Reverse order - Check the box to select whether you would like to inverse the order selected in the Order by field.


  • One of the two associated components cannot be deleted without deleting the other.

Was This Page Helpful?

(so we can thank you or request more details)
( addresses only please)

On this page:

See an Example:

Related Components:

Last Reviewed:

January 21, 2016