1. What is the catalogue?

The catalogue is a old navigation structure that is used on some large UQ websites.

The catalogue arranges web topics into lists. When a user clicks on a topic, any sub-topics or links display in a new list.

Top-level topics remain visible when a user browses the catalogue. This functionality provides important contextual information and allows users to switch between topics.

The catalogue is no longer added to new sites. If you have a large site with many top-level sections, the compendium may be an appropriate navigation structure.

To have the catalogue removed from a website, submit an IT request.

Top of page

2. How to edit the catalogue

The catalogue uses taxonomy and tagging to group pages under categories and display them in listing pages. Your site's taxonomy will include a dedicated vocabulary for the catalogue.

Including pages in the catalogue

Pages can be added to the catalogue by:

  • editors
  • site coordinators.

To make sure a page is listed in the catalogue, you need to tag it with the taxonomy term for the relevant catalogue category.

Creating new categories in the catalogue

New catalogue categories can be created by:

  • site coordinators.

To create a new category within the catalogue, you need to add a new taxonomy term to the relevant vocabulary in your site's taxonomy.

When you create a term to be used in the catalogue you should:

  • use only letters and spaces in the term name – avoid other types of characters, such as punctuation
  • expand the 'Relations' box and select a 'parent term' to nest the term within the vocabulary's hierarchy.

Any text you add to the 'Description' field will display as an introduction on the catalogue page that lists content tagged with the taxonomy term. Keep this text to a brief overview of the topic.

Adding a catalogue page to the menu

Catalogue pages can be added to the menu by:

  • site coordinators
  • site builders.

So that users can navigate to catalogue pages and use them to access content pages on your site, you need to:

  • add a menu link for each term in the catalogue
  • add any pages tagged with that term to the menu as children of that item.

To add a catalogue term to the menu, follow the instructions for adding panel pages to the main menu. You may need to adjust the URL path if the one generated by the catalogue includes encoded special characters.

When the catalogue generates a URL path from a taxonomy term, it converts spaces to hyphens and either strips or encodes characters that aren't letters or numbers, such as punctuation. This ensures that tagging will work correctly.

Although the URL path generated by the catalogue may include encoded special characters, you can't add URLs with these characters to the main menu. For the menu to work, you'll need to replace any encoded special characters with the original un-encoded characters.

For example:

Taxonomy term: Classes, timetables and coursework

URL path generated by the catalogue: classes%2C-timetables-and-coursework
The spaces have been replaced with hyphens. The comma (,) is a special character and has been encoded as %2C

URL path to add to the main menu: classes,-timetables-and-coursework
Leave the hyphens in place of spaces. Replace the encoded comma (%2) with the original un-encoded equivalent (,)

Creating new catalogue vocabularies

Submit an IT request if you need a new vocabulary created for a catalogue.

Top of page

3. Best practice

  • Use the description on catalogue pages only to provide a brief overview of the topic, if required.
  • Only use letters and spaces in taxonomy term names for the catalogue.
Top of page