Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

Table of Contents
maxLevel2

When to use a Heading

Headings are one of the most important elements of structure. When headings are properly used they create hierarchical data structures; which are leveraged by web browsers, screen reader software, and this particular documentation framework to organize headings. 

How to Create a Heading

  • Once in editing mode, Headings can be specified by changing the 'Paragraph' formatting of text to the appropriate Heading. This button is shown below.

    Selecting a Heading from the drop down menu on the editing toolbar.Image RemovedSelecting a Heading from the drop down menu on the editing toolbar.Image Added

Design Guidelines

  • Sections, such as 'Design Guidelines', should be stylized with an appropriate heading. 

  • In this case 'Headings', 'Design Guidelines', and 'An Example' are formatted as a Heading 2, because the title of the page 'Headings' defaults to a Heading 1.

An Example

Below there are a number of formatted headings with a Table of Contents inserted into this document rendering headings to depict how the nest appropriately. 

...

Example Table of Contents

Table of Contents
minLevel3

More about Page Structures

Child pages (Children Display)
alltrue
pageStructuring Pages