Best Practices and Accessibility

Use rich text headings as indicators for sections and sub-sections in your guide. This not only provides hierarchical organization and formatting but also makes it easy for screen readers to scan and jump to different content areas.

• SpringShare uses Heading 1 (<h1> tag in HTML) for the guide title and Heading 2 (<h2> tag in HTML) for box titles. Don't use them in other places. SpringShare has removed <h1> and <h2> tags in the box editor. 
• Always use Heading 3 (<h3> tag in HTML) for sub-headings and Heading 4 (<h4> tag in HTML) for sub-sub-headings. In other words, keep the numbers in order of hierarchy. 
• Make each heading unique. Remember that screen readers will use them for navigation.
• Don't skip levels. Only use Heading 4 for sections under a Heading 3. 
• Don't use headings just for formatting; make sure they are actually headings. 

• Don't use color as a way to convey meaning or importance. Colorblind users and screenreaders may not pick up on color changes.
• Don't mix different font types. Stick to the default font. 
• Do not change the font size unless you have good reason. If you need headers within a text box, use Heading 3 and Heading 4 in the rich text editor, or use <h3> and <h4> tags in the HTML.
• Do not underlinine text that is not a hyperlink.
• Use bold or italics in the rich text editor (or <strong> or <em> tags in HTML) to indicate emphasis. Use these tags sparingly. 
• When using HTML, avoid older-style bold <b> or italics <i> tags as they denote style rather than importance.
• Avoid relying on non-HTML content that may not be accessible, like PDF or PowerPoint documents.

• Only use tables for tabular data that fits well into rows and columns.
• Don't use tables to format links or other information. 
• Use table headers to describe the contents of the table columns.
• Avoid spanned rows as screen readers may not properly parse them.
• Tables have special styling to make them work well with responsive design. No need to manually change the table's width or cell padding in LibGuides.

Here is an example default 2x2 table with a header created within the rich text editor.

Take caution when copying & pasting content from any source. Many times hidden style code will also be copied along that could break with best practices and introduce inaccessible content.

There are a few ways to avoid hidden style code from being placed into your guide. The rich text editor has a few useful tools to use. 

•  This button will show a popup box that will strip out all text formatting and leave behind plain text. Best for simple text.
•  This button will show a popup box that will keep a lot of the original formatting from the Word document source. This is also the default behavior when pasting directly into the rich text editor. This does not follow best practices so try not to use this feature unless you plan to go through the source and clean up the formatting by hand!
•  This button will remove all formatting from selected text inside the rich text editor. This will generally solve strange formatting issues you may find from copied text. This button will also remove hard-coded widths from tables that may overflow your guide.

• All Images need to have Alternate text (ALT tags) included. You can check this by double-clicking the image when in the rich text edit mode.
• If the image is only decorative, use the "null" ALT tag which is "" (open and close quotation marks, no space). 
• If the image links to a resource make sure the image ALT tag also describes the destination. 
• Alt tags should be very brief and descriptive but not redundant. Don't repeat the same content from the image into the alt text.
• Avoid using "Image of..." since this is understood to be an image.
• WebAIM is a good starting resource for alt tags principles.

• Make sure link and database assets display their description below the link. Don't hide the description behind a hover-over button as this breaks accessibility. 
• Break up a long list of links into logical groups so that groups can be skipped by screen readers.
• Links in rich text sections are not recommended, but if you use them, be sure the linked text makes sense out of context. Ambiguous phrasing obscures what the link is about.
  • Bad: Click here for directions.
  • Good: Directions to the Meramec campus are available online.