Skip to main content

Tables

Use consistent table formatting to help users identify the information they need.

tip

For instructions on implementing this guidance with Markdown, refer to Confluence: Formatting documentation.

Each column of a table must have a descriptive name, given in bold in the top row of that column.

Use the same standards for formatting as the rest of the documentation.

If your table describes the various properties of a module or list of features in a screenshot, then list all the relevant properties in the same order as they appear in the screenshot.

UI reference tables

Each UI reference page has a table that documents the functions in the UI and their behavior.

For guidance on UI reference pages and the types of information to include in the table, refer to UI reference pages.

For guidance on structuring UI reference tables in Markdown, refer to the Tables section of User manual formatting.

Lists​

To create lists inside a table, use the following HTML list elements:

  • <ul> for unordered lists (bullet points)
  • <ol> for ordered lists (numbered lists)

Using the proper HTML elements creates lists with the same styling as regular lists outside of tables.

List typeOutputInput
Unordered
  • List item 1
  • List item 2
 <ul> <li>List item 1 </li> <li>List item 2 </li> </ul>
Ordered
  1. List item 1
  2. List item 2
 <ol> <li>List item 1 </li> <li>List item 2 </li> </ol>

Manually creating list formatting using symbols and line breaks is bad for accessibility. Screen readers can't parse this text as a list. Instead, the items are read out as separate, unrelated paragraphs.

Footnotes​

Adding footnotes to table entries is not supported. If you need to add more context to a table entry, add the information within the cell itself. If the information applies to several items, clarify the point in the text before or after the table.

Don't add footnotes manually. For example, don't add an asterisk to content in a table cell, then start the paragraph that immediately follows the table with an asterisk to add additional context. Adding footnotes manually is a problem for accessibility because screenreaders and other aids don't detect the relationship between the asterisks.