Best Practices and Accessibility

Creating Links

Add links as assets rather than in-text. (Use the Add menu and select Link). This is important for link checking and accessibility.

• Give each link a meaningful, concise name. 
• Give each link a description. Shorter descriptions are generally better and in keeping with the goal of less text-heavy guides.
• Always have the description display beneath item title. Never have it hidden behind a pop up button as this isn't accessible.
• Don't add the EZProxy prefix to the URL. Instead, click the proxy button and the proxy address will automatically be added. Use the STLCC icon to indicate if a link will require an STLCC login.
• Reuse link assets as often as possible. This makes it easier to batch update.

Lists of Links

• Order by relevance rather than alphabetically. 
• Break up a long list of links into logical groups using appropriate heads. This will enable screen readers to navigate more efficiently to specific groups. 

Links in rich text sections are not recommended. If you must use them, make sure they are accessible.

Context

Make sure the linked text makes sense out of context. Links should make sense if the linked text is read by itself. Screen reader users may choose to read only the links on a web page. Avoid phrases like “click here” and “more”.

Link Targets

Check that these links open in a separate page or tab.

• If using the link button in the rich text editor be sure to set the target to Same Window (_self) on the target tab.
• Check link code in the Source view and make sure all anchor tags have target="_self" inside.

Examples

• Unclear link text: Go to this US Government source for comprehensive homeowner data by clicking here.
• Clear link text: The US Government provides comprehensive homeowner data. 

• Bad: Click here for directions.
• Better: Directions to the Meramec campus are available online.

Best practice is to use link assets: