Skip to content

Sub-list in 4.7.1 should be unordered #591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
clapierre opened this issue Jan 9, 2025 · 4 comments
Closed

Sub-list in 4.7.1 should be unordered #591

clapierre opened this issue Jan 9, 2025 · 4 comments
Assignees
Labels
a11y-display-techniques-onix Issue with the onix accessibility metadata display techniques

Comments

@clapierre
Copy link
Collaborator

The sub-list in
4.7.3 Instructions

should be unordered.
ie.

  • IF flashing_hazard:
    THEN display "Flashing content".
  • IF motion_simulation_hazard:
    THEN display "Motion simulation".
  • IF sound_hazard:
    THEN display "Loud sounds".
@clapierre clapierre added the a11y-display-techniques-onix Issue with the onix accessibility metadata display techniques label Jan 9, 2025
@gregoriopellegrino
Copy link
Collaborator

Hi, I'm not clear on the request, in all cases where we have instructions, they are always inside <ol> tags...

@clapierre
Copy link
Collaborator Author

There is a difference now between EPUB and ONIX where in the instructions for 4.3.3 and 4.7.3 the inner lists are unordered but in the ONIX they are ordered lists.
If they really should be ordered we need new CSS so that the numbers just doesn't restart at 1, 2, 3 etc. but really should be 1.1, 1.2, 1.3 etc.

If we can make that happen it will help with the readability if we stick with ordered lists for the sub list.
eg.

1. IF no_hazards_or_warnings_confirmed OR (no_flashing_hazards AND no_motion_hazards AND no_sound_hazards):
 THEN display "No hazards".

2. ELSE IF flashing_hazard OR motion_simulation_hazard OR sound_hazard:
THEN
     2.1 IF flashing_hazard: THEN display "Flashing content".
     2.2 IF motion_simulation_hazard: THEN display "Motion simulation".
     2.3 IF sound_hazard: THEN display "Loud sounds".

@mattgarrish Is this possible Matt to be fixed in the CSS to make that happen for an ordered list within an ordered list?

@mattgarrish
Copy link
Member

Looking the sublists over, the application of styling is inconsistent in a few places. I'm not sure bullets are the answer here because these are still ordered sets of instructions, but reusing numbers for the sublists is also confusing to read.

From what I've seen, there appear to be three types of lists we should standardize:

  • variable setup lists - these are marked as ordered lists but there's no inherent order to them. The numbers aren't really even useful reference points since each already can be discussed by what variable it sets up. I'd change these to ul.
  • condition lists - these are the instructions. Having the top-level be numbers is fine, but for the next level I'd set them to be lower-alpha so that it's less confusing which level you're at (we could also set a third level to upper-roman, but I didn't spot nesting going this deep)
  • display lists - there are a couple of multi-output display lists. While it's good to keep these semantically as ordered, they're more readable with bullets.

If no one has an issue with this, I can push a change to fix the lists in both documents.

@mattgarrish
Copy link
Member

Closing as this was fixed with #667

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a11y-display-techniques-onix Issue with the onix accessibility metadata display techniques
Projects
None yet
Development

No branches or pull requests

3 participants