Highlights on a Page

Highlights are part of both landing pages and structured documentation pages. For the topic landing pages the Documentation Team is usually handling the Highlights, but you may propose changes. For the documentation pages you create, Highlights are recommended once the page has more than 15 child pages, and should follow the criteria for selecting highlighted pages. A maximum of 6 highlights is allowed, on both documentation pages and landing pages, to maintain a clean and visually appealing page layout.

Highlights Syntax

The Highlights field is a two-level list: the first level is the link to the highlighted page, and the second level is a one-line description of it.

* [[Page Title 1>>reference.to.page1.WebHome]]
** Description of the first page
* [[Page Title 2>>reference.to.page2.WebHome]]
** Description of the second page

Highlight only a subset of the page's child pages. The "More" section already lists every child page, so highlighting all of them defeats the purpose.

Proposing Changes to the Highlights

Anyone who wants to propose a change to the Highlights can edit and save with Change Request or ask on the #xwiki Matrix chat. The Documentation Manager will review and update the Highlights.

Criteria for Selecting Highlighted Pages

There are some common criteria that can guide the selection of which pages to highlight:

• Relevant pages to newcomers
• Use Pages that are frequently accessed as a reference
• Pages that address common issues
• Pages that cover essential topics (useful for many situations, containing a lot of important information).