Download the PHP package bpmore/statamic-a11y-docs without Composer

On this page you can find all versions of the php package bpmore/statamic-a11y-docs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package statamic-a11y-docs

A11y Docs

Document accessibility checking for the Statamic asset library. PDF, Word, PowerPoint and Excel.

Every university, hospital and agency has thousands of PDFs and Office documents in its asset library, and no record of which of them are accessible. It is the first thing an external auditor counts, because it is the easiest thing to count. This tells you what is in there.

It inventories and triages. It does not remediate. Knowing that you have 890 untagged PDFs and exactly which ones is the hard part; fixing them is a different job.

What it does

Installing

That is the whole installation. There is no Java to install, no binary to configure, and nothing to sign up for.

To show a status badge in the asset browser, add one field to the container's asset blueprint — how.

Do I need veraPDF?

Almost certainly not. The long answer, the short one:

The built-in checks are pure PHP, run everywhere, and find the problems that are actually in your library — untagged files, scans with no text layer, missing titles and languages, undescribed figures. veraPDF is a Java program that performs formal PDF/UA validation. It is more authoritative and it is more work to install.

Install it if you have to certify PDF/UA conformance to somebody who will check. Otherwise skip it. Every report says which engine produced it, so nothing overstates itself either way.

The rest of the line

When A11y Report is installed too, document findings appear in its conformance report as their own appendix — never folded into the WCAG table, because document conformance is PDF/UA and Section 508 Chapter 5 territory and conflating the two is a category error an auditor will catch.

Documentation

Installing and configuring Including the asset-browser badge
What it checks All 36 rules, generated from the code
Commands docs:check, docs:report, docs:prune
The publish gate Grandfathering, thresholds, exemptions
Reports and exports HTML and tagged PDF
Do I need veraPDF? Short answer: no

Requirements

PHP 8.2+, Statamic 6, and a database. veraPDF and a browser (for PDF exports) are both optional and both degrade to a clear message rather than a failure.

Licence

Proprietary. One licence per production site; local development and CI are free. The source is published so it can be installed with Composer and inspected by the people who rely on it. See LICENCE — in particular what it says about the difference between a heuristic finding and PDF/UA validation.


All versions of statamic-a11y-docs with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
ext-dom Version *
ext-zip Version *
smalot/pdfparser Version ^2.12
statamic/cms Version ^6.0
symfony/process Version ^7.0 || ^8.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package bpmore/statamic-a11y-docs contains the following files

Loading the files please wait ...