How Do I Work with Editoria11y?

Purpose

Editoria11y is a tool that helps content editors find and fix accessibility issues on web pages. It works like a spellchecker but for accessibility, flagging problems like missing alt text, incorrect heading structure, and poorly formatted lists. The goal is to make sure web content is easy to read and navigate for everyone, including people using screen readers.

This tool helps editors catch and fix issues before publishing, making websites more accessible without needing to edit code.

When to Use Editoria11y

  • Creating or updating content on a webpage.
  • Reviewing pages with images, lists, headings, or links to ensure accessibility.
  • Checking for repeated errors, such as missing alt text or incorrect heading levels.
  • Needing a quick, real-time check alongside other accessibility tools like WAVE or Lighthouse.
  • Editoria11y is most effective when used regularly during content creation to prevent issues before they go live.

Elements of Editoria11y

Editoria11y checks for common accessibility problems, including:

  • Alt Text Issues – Flags images with missing or unclear alt text and allows marking decorative images correctly.
  • Heading Structure – Identifies skipped heading levels (e.g., jumping from H1 to H3) and empty headings.
  • List Formatting – Ensures that lists are properly formatted for screen readers.
  • Link Descriptions – Checks if link text is clear and descriptive.
  • Text Formatting – Identifies issues like all-uppercase text that can be difficult to read.
  • Dismiss and Review Options –If Editoria11y flags an issue that does not need fixing, click "Mark as Checked." This removes the flag for future reviews but keeps a record of it.
"decorative"

Follow these steps to review and fix accessibility issues using Editoria11y:

1

Log in to Your Site

You can login to your site from login.iowa.gov

how to login to DX website

Each person on your agency team has a specific user role for the website. These roles set permissions. They control who can edit, review, and publish content. You can ask for a role change or remove a role. Just submit a ServiceNow support ticket if you need help.

Login using login.iowa.gov
2

Run Editoria11y Accessibility Check

When you are signed in to your agencies site, Editoria11y will automatically scan each page that you open up for issues. 

This also includes any pages that are saved as drafts, review, or archived.

"decorative"

Within the bottom right corner of the screen, you will see the Editoria11y icon where you can toggle the accessibility check icon to turn on or off.

"decorative"
3

How do I know if there are accessibility issues?

Click on an indicator icon that appears in the bottom right-hand corner of the screen to open up the dropdown list to see a description of the issue. 

"decorative"

Editoria11y scans the page and highlights issues with color-coded indicators:

  • Red: Critical issues that must be fixed.
  • Yellow: Warnings that may need attention.
  • Green: Areas that are accessible.
4

What should I do to fix the issues?

Click on suggested fixes and make changes directly in the content editor.

"decorative"
  • Images: Ensure alt text is clear. If the image is decorative, mark it as such.
  • Headings: Check for correct order (e.g., H1 should not jump to H3). Adjust as needed.
  • Lists: Make sure items that look like lists are properly formatted.
  • Links: Edit link text to make it clear and descriptive.