8fold/html-spec-structured

This package is abandoned and no longer maintained. The author suggests using the 8fold/php-html-spec package instead.

The HTML and ARIA-HTML specifications as structured data

0.0.5 2021-09-19 18:37 UTC

Requires

• php: ^7|^8.0
• 8fold/php-shoop: ^0.10.19

Requires (Dev)

• phpunit/phpunit: ^9.5.9

MIT

README

The mission here is to present the Living HTML Specification as structured, and interconnected data.

The structured data is placed in a folder for the type of structured data used (json, for example). It's important to note that everything withing the folder for the structured data is automatically generated; therefore, no guarantee is provided regarding the accuracy and correcting the issue may require correcting an issue in the specification itself.

The information architecture of the html directory matches the URL of the documentation provided in w3c/elements-of-html.

Installation

composer require 8fold/html-spec-structured

Usage

Raw data

The compiled data from the writer scripts is stored in the /json directory, giving users direct access to the raw data using whatever interface they deem suitable.

PHP Reader classes

The reader classes provide an API and lightweight ORM solution for retrieving data and are regularly refined to improve and ensure performance.

HtmlIndex::all()->elementNamed("h1");

PHP Writer classes

Because the data are collected across multiple documents, in multiple repositories, across multiple organizations, the writing scripts are very utilitarian and considered "throw away." They are minimally optimized for querying the documents and saving the subsequent data to files. Further, they inherit from the reader classes and are, therefore, completely decoupled from the user-oriented capabilties.

Details

Project data structure

• html.json: Index of HTML elements.
• html-attributes.json: Index of defined attributes, events, and ARIA attributes.
• html-aria-roles.json: Index of defined role attribute values. Debating.

Data collection

• The list of HTML elements is pulled from the w3c Elements of HTML repositiory. Note: If the element is not listed here, will not be listed anywhere else, even if referenced in other resources.
• The list of non-ARIA HTML attributes and element details are pulled from the WHATWG HTML Living Standard.
  • Note: role is not considered an attribute in that it is not listed in the attributes table; therefore, it is injected as a global attribute after the initial set is complete.
• The list of ARIA attributes and HTML element roles is pulled from the w3c HTML ARIA documentation.
• The ATRIA attribute categories are pulled from a local copy of the w3c HTML ARIA 1.1 recommendation available in the local folder of this repository.

ARIA seems to be the least consolidated and most volatile from a format perspective; however, it may become easier to aggregate and compile as time progresses.

Other

Versioning

As this package relays on time-sensitive, not functionality-sensitive details, versioning is time based using an ISO standard; therefore, semantic versioning [major].[minor].[patch] becomes [year].[month].[day].

• year: represents the four-digit year the compiling scripts were run.
• month: representing the two-digit month the compiling scripts were run.
• day: represents the two-digit day the compiling scripts were run.