Skip to content
This repository was archived by the owner on Dec 29, 2025. It is now read-only.

Add inline examples

Nicole Fenton edited this page Nov 14, 2017 · 1 revision

The plainlanguage.gov website uses several types of inline examples, each with their own unique style.

Side by side table

To make a side by side table of Do's and Don'ts use the following markdown syntax:

Don't say | Say
--------- | ---
a number of | several, a few, or many
a sufficient number of | enough
at this point in time | now
is able to | can
on a monthly basis | monthly
on the ground that | because
an amount of X | X
be responsible for | must
in order to | to
{:.example-table}
  • It is important to make sure that {:.example-table} is added immediately after the table. There cannot be any line breaks otherwise the CSS class will not be applied to the table properly.
  • This style will only work properly with two column tables, do not use with single column tables, or tables with more than two columns.

Single side by side comparison

To make a single side by side comparison of two small to medium sized examples use the following markdown syntax:

* ### Long, dense paragraph
  #### Before

  Title I of the CARE Act creates a program of formula and supplemental competitive grants to help metropolitan areas with 2,000 or more reported AIDS cases meet emergency care needs of low-income HIV patients. Title II of the Ryan White Act provides formula grants to States and territories for operation of HIV service consortia in the localities most affected by the epidemic, provision of home and community-based care, continuation of insurance coverage for persons with HIV infection...

* ### Material divided paragraphs
  #### After

  Low income people living with HIV/AIDS gain, literally, years, through the advanced drug treatments and ongoing care supported by HRSA's Ryan White Comprehensive AIDS Resources Emergency (CARE) Act.
{: .example-side-by-side}
  • It is important to make sure that {: .example-side-by-side} is added immediately after the list. There cannot be any line breaks otherwise the CSS class will not be applied to the list properly.
  • This style will only work properly with a two item list, do not use with a list containing more that two items.
  • Please note that all of the content within each list item is indented by two spaces, and the final {: .example-side-by-side} is not.

Standalone example

Sometimes examples don't follow a Before and After syntax, they can be sometimes be standalone snippets to help demonstrate a specific writing guideline. To setup a standalone example, use the following markdown syntax:

<div class="example-container">

### Qualifications of permittees and lessees

- Who may hold leases and permits?
- Can foreign citizens hold permits or leases?
- How do I file evidence of my qualifications?
- Can I amend my qualifications statement?

</div>
  • Do not indent the content within the <div> tags.
  • Normal Markdown formatting can be used within the <div> tags

Clone this wiki locally