w3c / publ-a11y

Accessibility related discussions of the Publishing@W3C Groups
Other
25 stars 6 forks source link

Note regarding the use of "compact" vs. "descriptive" #409

Closed clapierre closed 3 weeks ago

GeorgeKerscher commented 2 months ago

Should you explain that the ID in the JSON file takes you to a group that has both the compact and the descriptive, and it is here that you are free to choose?

clapierre commented 2 months ago

I can @GeorgeKerscher , would this come at the bottom of the note, and what exactly should it say?

Currently after the example I have:

The option is yours to provide either the "compact" or "descriptive" versions to the end user or perhaps even allow the user to choose what they wish to see.

GeorgeKerscher commented 2 months ago

I think the only thing you need to add is that the ID linking mechanism thakes you to both the compact and descriptive, and then you choose, i.e. the ID is the same.

gregoriopellegrino commented 1 month ago

For me a good starting point. Perhaps in the example we could use an excerpt from the JSON instead of the principles?

We could also mention that there is JSON and to refer to the Localization section in the Principles document.

clapierre commented 3 weeks ago

Hello all, Ok, I have updated the Example to use the real JSON, and added the editors note as requested by @mattgarrish. If this looks good We can merge this and @gregoriopellegrino can copy this into the ONIX techniques.

gregoriopellegrino commented 3 weeks ago

In this same branch I added the note to the ONIX techniques.