πŸ“¦ EqualifyEverything / equalify-iris-wp

A WordPress plugin for Equalify Iris

β˜… 0 stars β‘‚ 0 forks πŸ‘ 0 watching
πŸ“₯ Clone https://github.com/EqualifyEverything/equalify-iris-wp.git
HTTPS git clone https://github.com/EqualifyEverything/equalify-iris-wp.git
SSH git clone git@github.com:EqualifyEverything/equalify-iris-wp.git
CLI gh repo clone EqualifyEverything/equalify-iris-wp
Blake Bertuccelli-Booth Blake Bertuccelli-Booth Initial commit: Equalify Iris for WordPress 177df86 5 days ago πŸ“ History
πŸ“‚ 177df867bb92de99d270abddaf9db23a7aaa6e6e View all commits β†’
πŸ“ docs
πŸ“ plugin
πŸ“ test-site
πŸ“„ .gitignore
πŸ“„ PRD.md
πŸ“„ README.md
πŸ“„ README.md

Equalify Iris for WordPress

A WordPress multisite plugin that gives every PDF on the network an accessible HTML version, automatically, using Equalify Iris.

A screen reader user clicks a PDF link and often finds nothing usable. This plugin finds the PDFs linked from published pages across the network, converts them, publishes the result as a real web page, and adds a small icon next to every PDF link that opens it. Editors do nothing and never see the plugin. One super admin turns it on once, from the network dashboard.


What is in this repo

PRD.md                    The product requirements this was built from
docs/                     Documentation β€” start here
plugin/equalify-iris/     The plugin. This is the thing that ships.
test-site/                A disposable WordPress multisite for testing it (gitignored)

Where to start

If you want to…Read
Install it and convert a first PDFdocs/README.md
Understand how it worksdocs/HOW-IT-WORKS.md
Look up a termdocs/GLOSSARY.md
Fix something that is not workingdocs/TROUBLESHOOTING.md
Change the codedocs/DEVELOPING.md
Know why it is built this waydocs/DECISIONS.md

Running it locally

cd test-site && ./setup.sh

Needs DDEV and a running Docker engine. Everything else is in the containers. Details in test-site/README.md.

Two things to know before pointing this at real content

  • PDFs over 25 pages or 50 MB are not converted. Those are Equalify Iris's limits. The plugin
detects them before uploading, says so in the dashboard, and does not pretend otherwise.
  • Equalify Iris reports conversion problems as public GitHub issues, which can include extracts
of the document. This cannot be turned off. Do not point this plugin at confidential documents.