Skip to content
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

JSON missing title #654

Open
rickj opened this issue Feb 12, 2025 · 6 comments
Open

JSON missing title #654

rickj opened this issue Feb 12, 2025 · 6 comments

Comments

@rickj
Copy link
Collaborator

rickj commented Feb 12, 2025

The addition of the 'Ways of Reading" top level heading, while still wanting the three sub-headings to have 'top level status' requires some minor adjustments to the json formatting. We would like to suggest the following structure for the 'Ways of Reading" section to enable cleaner processing of visual adjustments, nonvisual reading, and prerecorded audio:

"ways-of-reading": {
  "ways-of-reading-title": "Ways of reading",
  "ways-of-reading-visual-adjustments": {
    "ways-of-reading-visual-adjustments-title": "Visual adjustments",
    "ways-of-reading-visual-adjustments-modifiable": {
        "compact": "Appearance can be modified",
        "descriptive": " Appearance of the text and page layout can be modified according to the capabilities of the reading system (font family and font size, spaces between paragraphs, sentences, words, and letters, as well as color of background and text)"
    },
    "ways-of-reading-visual-adjustments-unknown": {
        "compact": "No information about appearance modifiability is available",
        "descriptive": " No information about appearance modifiability is available"
    },
    "ways-of-reading-visual-adjustments-unmodifiable": {
        "compact": "Appearance cannot be modified",
        "descriptive": "Text and page layout cannot be modified as the reading experience is close to a print version, but reading systems can still provide zooming options"
    }
  },
  "ways-of-reading-nonvisual-reading": {
    "ways-of-reading-nonvisual-reading-title": "Support for Nonvisual Reading",
            "ways-of-reading-nonvisual-reading-alt-text": {
        "compact": "Has alternative text",
        "descriptive": "Has alternative text descriptions for images"
    },
    "ways-of-reading-nonvisual-reading-no-metadata": {
        "compact": "No information about nonvisual reading is available",
        "descriptive": "No information about nonvisual reading is available"
    },
    "ways-of-reading-nonvisual-reading-none": {
        "compact": "Not readable in read aloud or dynamic braille",
        "descriptive": "The content is not readable as read aloud speech or dynamic braille"
    },
    "ways-of-reading-nonvisual-reading-not-fully": {
        "compact": "Not fully readable in read aloud or dynamic braille",
        "descriptive": "Not all of the content will be readable as read aloud speech or dynamic braille"
    },
    "ways-of-reading-nonvisual-reading-readable": {
        "compact": "Readable in read aloud or dynamic braille",
        "descriptive": "All content can be read as read aloud speech or dynamic braille"
    }
  },
    "ways-of-reading-prerecorded-audio": {
    "ways-of-reading-prerecorded-audio-title": "Prerecorded Audio",
    "ways-of-reading-prerecorded-audio-complementary": {
        "compact": "Prerecorded audio clips",
        "descriptive": "Prerecorded audio clips are embedded in the content"
    },
    "ways-of-reading-prerecorded-audio-no-metadata": {
        "compact": " No information about prerecorded audio is available",
        "descriptive": " No information about prerecorded audio is available"
    },
    "ways-of-reading-prerecorded-audio-only": {
        "compact": "Prerecorded audio only",
        "descriptive": " Audiobook with no text alternative"
    },
    "ways-of-reading-prerecorded-audio-synchronized": {
        "compact": "Prerecorded audio synchronized with text",
        "descriptive": "All the content is available as prerecorded audio synchronized with text"
    }
  },
}
@mattgarrish
Copy link
Member

while still wanting the three sub-headings to have 'top level status'

Actually, they no longer have status beyond separating the logic of what goes under "Ways of reading" (i.e., they aren't expected to be output anymore).

@MJolin
Copy link

MJolin commented Feb 12, 2025

while still wanting the three sub-headings to have 'top level status'

Actually, they no longer have status beyond separating the logic of what goes under "Ways of reading" (i.e., they aren't expected to be output anymore).

@mattgarrish per https://w3c.github.io/publ-a11y/a11y-meta-display-guide/2.0/draft/guidelines/#ways-of-reading and your response, we should essentially ignore Prerecorded Audio, Support for Nonvisual Reading and Visual adjustments as sub headings / a title that should be displaying and just show Ways of reading as the heading and render the techniques as direct children to Ways of reading?

@mattgarrish
Copy link
Member

mattgarrish commented Feb 12, 2025

Right, "ways of reading" was introduced to replace the three individual headings as it was thought that they weren't conveying enough information to warrant having separate headings.

This is shown in the examples for the section: https://w3c.github.io/publ-a11y/a11y-meta-display-guide/2.0/draft/guidelines/#wr-examples

The subsections were retained in the guidelines as a means of speaking to each of the key areas, but I know the best structuring of that section was struggled with. I think it would be helpful if 3.1 started by speaking to why there are three subsections but headings for each are not expected. Having it immediately jump to 3.1.1 without any prose is probably going to confuse most people.

@MJolin
Copy link

MJolin commented Feb 12, 2025

Thanks @mattgarrish for the clarification. Ill let our team know and let @rickj know we can close this issue out.

@mattgarrish
Copy link
Member

Please keep the issue open as we can use it to address the lack of clarity.

@rickj
Copy link
Collaborator Author

rickj commented Feb 12, 2025

Wow.... that is all news to me... and I've been an active participant!! I'm sure it needs clarity for any new readers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants