Compendium page
What is a compendium page?
The 'Compendium page' content type is part of the Compendium navigation structure.
The compendium arranges topics and sub-topics into columns. Compendium pages create the second, third and fourth levels of the compendium.
Use a compendium page when you:
- want to add new second and third levels to the compendium.
Don't use a compendium page:
- if there isn't a compendium on your site
- for pages that aren't included in the compendium.
How to create a compendium page
Compendium pages can be created, edited and deleted by:
- editors
- site coordinators.
The compendium needs to be added to your website before you can use the compendium page content type.
A compendium can have up to four levels.
Level 1
These are menu links which point to a location within the Compendium. The ITS web team will create the top level of your compendium for you. On non-central sites you can change the level 1 items yourself.
You will then have to use compendium pages to add second, third and fourth levels to the compendium.
Level 2 and Level 3
To link out at the second level in the compendium, edit the main menu.
To create a second-level topic that leads to the third-level of the compendium, you will have to:
- Hover over the Drupal 'Content' menu, then go to 'Add content' > 'Compendium page'.
- Enter a title – this will create the second level of the compendium.
- Select 'Link' under 'Link type'.
- Click the 'Add new link' button – this will sit on the third level of the compendium.
- Enter the link title and URL.
- Use the 'Add another link' button to add more links to the third level of the compendium.
- Click the 'Save' button to add your links to the compendium.
Level 4
To create a compendium page that leads to the fourth-level of the compendium:
- Hover over the Drupal 'Content' menu, then go to 'Add content' > 'Compendium page'.
- Enter a title – this will create the second level of the compendium.
- Select 'Link group' under 'Link type' and click the 'Add new link' button.
- Enter a title – this will sit on the third level of the compendium.
- Under 'Links' add a title and URL – this will sit on the fourth level of the compendium. Use the 'Add another item' button to add more fourth-level links.
- Click the 'Save' button to add the links to the compendium.
How to edit a compendium page
Once you log in to your website:
- Click 'Content' on the black Drupal menu.
- Select 'Compendium page' from the 'Type' drop-down menu and then click the 'Apply' button.
- Locate the page you're looking for in the list of results, and click 'edit' to make changes.
- Once you've made your changes, click 'Save'. If your site has a workflow process, you may need to change the moderation state to 'Published' or 'Ready to publish'.
Unfortunately, there is no way to preview changes to a compendium page.
Best practice
- Use relative paths for internal pages.
- Use the 'Search' button when adding links to find the relative path for internal pages.
- Use absolute paths for external pages.
Fields
Fill in all required fields and as many optional fields as possible to provide the best user experience.
Field name |
Required field? |
Notes |
---|---|---|
Title |
Yes |
Heading that displays in the second level of the compendium. |
Description |
No |
Short summary that displays under the heading in the third level of the compendium. Keep to 1-2 short sentences at most. |
Link type |
Yes |
Drop-down menu that lets you choose between a 'Link' or 'Link group'. |
Link > Title |
Yes |
Name of the link – displays in the third level of the compendium. |
Link > URL |
Yes |
URL of the link. Use the 'Search' button to find internal links. |
Link > Description |
No |
Short description that displays under a link in the third level of the compendium. |
Link group > Title |
Yes |
Name of the link group – displays in the third level of the compendium. |
Link group > Description |
No |
Short description of the link group – displays under the title in the third level of the compendium. |
Link group > Links > Title |
Yes |
Name of the link – displays in the fourth level of the compendium. |
Link group > Links > URL |
Yes |
URL of the link. Use the 'Search' button to find internal links. |