Glossary about a11y-guidelines HOT 9 CLOSED

Merged!

from a11y-guidelines.

Or “explode” the abbr meaning for the first occurrence in the page
Perhaps in a guideline site, a glossary’ll be better ?! don't know...

from a11y-guidelines.

Yes, expand first occurrence seems easier to set up, somehow.

Any other opinions?

from a11y-guidelines.

Both of them?

Expand the meaning of the first occurrence on any page (which is, as far as I know, the rule: have a look at the associated RGAA criteria) and add a glossary, common to the entire guidelines.

Glossary might help and interest some people, since it's a way to apprehend guidelines from a tech view and learn jargon quickly.

from a11y-guidelines.

Assigning it to myself, will see to it later.

from a11y-guidelines.

I created a new Branch: https://github.com/Orange-OpenSource/a11y-guidelines/tree/iss1

I had the choice between:

1. linking to a new Glossary page
2. expanding abbreviations on the spot.

I chose 2 as it was easier for a POC, we'll discuss it among us.

For debugging purposes, abbreviations and expanded texts are highlighted with an ugly colour 😉.

@Lausselloic and @SylvainBzh can you validate:

1. Is the logic OK with you? Or would you like another behaviour?
2. Is the code OK with you?

TODO (me, after Loic's and Sylvain's feedback):

0. On Master: replace <abbr>HTML</abbr>5 with <abbr>HTML5</abbr>
1. Finish French version
   • Remove debug line 210 "// REMOVE THIS BEFORE MERGING"
   • Full inventory of abbreviations
   • remove style='background:#99ffff' 😜
2. English version
   • Copy the code in web_EN/theme/default/js/reco.js
   • Change Glossary to fit English version (span lang="fr" etc.)

from a11y-guidelines.

After meeting this afternoon:

• Glossary added to bottom of page
• Each abbr is wrapped in an a that links to the proper entry in the glossary.

@PigeardSylvain weird thing though, the glossary dl looks out of #content. I looked into the CSS but didn't find what's wrong.

from a11y-guidelines.

TODO @sdeschamps-orange : add a title attribute on all abbr tag that does not already have one.

from a11y-guidelines.

So? Merge iss1 with master and close this issue, anyone?

from a11y-guidelines.