Commit 58c4d561 authored by Craig Norris's avatar Craig Norris

Add table info to Docs Style Guide

parent 99450432
...@@ -565,6 +565,41 @@ to mix types, that is also possible, as long as you don't mix items at the same ...@@ -565,6 +565,41 @@ to mix types, that is also possible, as long as you don't mix items at the same
- Unordered list item three. - Unordered list item three.
``` ```
## Tables
Tables should be used to describe complex information in a straightforward
manner. Note that in many cases, an unordered list is sufficient to describe a
list of items with a single, simple description per item. But, if you have data
that is best described by a matrix, tables are the best choice for use.
### Creation guidelines
Due to accessibility and scanability requirements, tables should not have any
blank cells or areas. If a cell does not have a useable value, consider using
*none* as a value.
To help tables be easier to maintain, consider adding additional spaces to the
column widths to make them consistent. For example,
```markdown
| Header 1 | Header 2 |
| Item 1 | Description |
| Item 2 | Expanded description |
```
If you're using Visual Studio Code, consider installing and using the
[Markdown Table Prettifier](https://marketplace.visualstudio.com/items?itemName=darkriszty.markdown-table-prettify)
extension.
### Feature tables
When creating tables of lists of features (such as whether or not features are
available to certain roles on the [Permissions](../../user/permissions.md#project-members-permissions)
page), use the following phrases (based on the SVG icons):
* No: **{dotted-circle}** No
* Yes: **{checked-circle}** Yes
## Quotes ## Quotes
Valid for Markdown content only, not for frontmatter entries: Valid for Markdown content only, not for frontmatter entries:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment