Skip to content

Equalify Iris for WordPress 0.2.0

Choose a tag to compare

View all tags
@bbertucc bbertucc released this 04 Oct 15:34
· 19 commits to main since this release
v0.2.0
9c137e3
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Download

Download equalify-iris.zip from the Assets list below.

Do not use the "Source code" downloads. GitHub adds those automatically, and they contain the whole repository rather than an installable plugin.

What's new

0.2.0 is a rewrite. Instead of an HTML version next to each PDF, Equalify Iris now adds accessibility tags to the PDF itself, saves it next to the original as name-accessible.pdf, and points the site's links at it.

  • Only public PDFs. A PDF is listed, and ever sent, only when something visitors can see links to it: published pages, posts and custom post types (content, excerpt, custom fields, ACF), menus, widgets, block templates and navigation, category and tag descriptions, ACF options pages.
  • Links switch back by themselves when a tagged copy is deleted or the plugin is deactivated or deleted. Nothing in the database is rewritten.
  • Each PDF shows where it is up to: waiting, converting at Iris, adding tags, since when, and Iris's reason if something goes wrong. Filters for Being tagged and Could not be tagged.
  • Built for large networks and Pantheon: one network-wide background job, 90-second runs, at most 4 PDFs at Iris at once.

Install

Needs a WordPress multisite network, WordPress 6.4 or later, and PHP 8.0 or later.

Coming from 0.1.0: network-deactivate and delete 0.1.0 first. Nothing is carried over, and deleting it removes its HTML versions.

  1. Go to Network Admin → Plugins → Add New Plugin → Upload Plugin.
  2. Choose equalify-iris.zip and select Install Now.
  3. Select Network Activate.
  4. Open Network Admin → Equalify Iris to see every site, and Equalify Iris in any site's admin for its PDFs.

Nothing is sent to Iris until someone chooses Send to Iris for Tagging on a PDF, or turns on automatic tagging.

On Pantheon (or anywhere WP-Cron does not run reliably), run the background job every five minutes from a scheduler:

terminus wp <site>.<env> -- equalify-iris run

Before you send anything

PDFs go to the Equalify Iris deployment set on the network screen, the public one by default. Iris reports conversion problems as public GitHub issues that can include extracts of the document, and this cannot be turned off. Only test with PDFs that are fine to make public.

What to try

  • Send to Iris for Tagging on a PDF: it shows Being tagged, then Tagged within a few minutes. Reload to see it move.
  • Logged out, links to it on the site, including in menus and widgets, open the -accessible.pdf copy. Clear any page cache first.
  • Delete Iris-Tagged Version, or network-deactivate the plugin: the links open the original again.
  • Unpublish the only page linking to a PDF: it leaves the list.
  • A PDF over 25 pages shows Could not be tagged with the reason.

Known limits

  • Iris builds a tagged PDF in a single request. A PDF that takes Iris longer than the job can wait (about 80 seconds on Pantheon) is tried three times, then shown as could not be tagged.
  • Links written into a theme's PHP files, and page builders that store their layout outside the post content and custom fields, are not found.

Full documentation: README.md. Problems: docs/TROUBLESHOOTING.md.

Assets 3
Loading