Site Overview and Navigation Menus

At the top of the PAMMS site is the primary navigation bar. This part of the site is controlled by the user interface (UI) and the Antora playbook for the PAMMS site.

The name of the site, Policy and Manual Management System, is controlled by the Antora playbook in the Policy and Manual Management System - Site repository.

The site search box is also located in the primary navigation bar.

The component selector menu is the drawer located in the lower left corner of the site. It lists the components available on the PAMMS site.

Click the arrow to the right of Division of Family and Children Services to open the menu.

All of the components, currently the Division of Family and Children Services and PAMMS Help, are listed in the component selector menu. The names of the components are controlled by the title key in the antora.yml file for the component (or, in the case of DFCS, the primary antora.yml file stored in the DFCS Common repository).

To navigate to a component, such as Division of Family and Children Services, click on its name in the component selector menu.

When a component is clicked on from the component selector menu, the site loads the home page for that component. By default, Antora will automatically use a file named index.adoc stored in the pages folder of the ROOT module of a component as the home page for a component. Both the DFCS and PAMMS Help components use this convention.

Once a component has been selected and loaded by the site, the component menu for that component is displayed on the left side of every page that is part of that component.

This menu is created from the navigation files registered in the component’s antora.yml file. The order in which the files are registered is the order their contents are displayed in the component menu.

A page’s heading 2 and heading 3 section titles are displayed in the Contents sidebar located on the right side of the page.

When you want visitors to locate a page using the Component menu, you must add a cross reference (xref) to that page in the appropriate navigation file. A navigation file can also include links to external URLs and other content, such as icons and normal text.

The example below shows a portion of the navigation file for SNAP:

These entries are converted to the component menu links displayed under SNAP, as shown below.

To learn more about navigation file lists, see Navigation list titles and entries in the Antora documentation.