Style Guide for this Space (User Guides)

Owned by Cathy Allison
Last updated: Jul 26, 2019
2 min read

This is a temporary page that includes the basic layout that we are standardizing across all User Guide pages.

For all guides, the basic section should be a panel within a panel.  

At the top of every page should be a live search inside a panel.  This search should be restricted to the User Guide space.


This is a section panel.

Labs Example Header Panel

This is a header panel in the style of Header 2, with a solid green border and a background of #ACF5D2

The contents of the section go underneath the header, using the style of Paragraph.  Contents can include images, bullet points, and other Confluence macros. 

Example Labs Subsection

Subsections should use Header 3 or lower.

Hospital Example Header Panel

This is a header panel in the style of header 2, with a solid blue border and a background of #B3D4FF

Example Hospital Subsection

Subsections should use Header 3 or lower.

Admin Example Header Panel

This is a header panel in the style of header 2, with a solid orange border and a background of yellow.

Example Admin Subsection

Subsections should use Header 3 or lower.

Page Labels

The page should be tagged with appropriate labels.  This includes the guide that it belongs to (labs, hospital, setup, admin) and the type of page (glossary, how-to, screen)

Incomplete pages should use the incomplete label, to mark that they will need additional work.  Updated pages should include the version number for which they were updated as a label.

This is the side bar.  On every page, the layout should be 2/3 body and 1/3 right side panel (to create this section.)

At the top, using an Excerpt Include from the Setup & Admin Guide main page to display the most recent released version.  Check "remove surrounding panel" to clear out the frame of the excerpt.

VetView Wiki

Most recent releases of VetView:  Version 4.2.5 Hotfix (Released 10/31/2024)

Each page should then display a Table of Contents or a Child Page tree, as appropriate.  Table of Contents will read the headers to build hyperlinks within the page.

Child pages should be used on any screen that has multiple tabs.