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

Lower case vs. CamelCase #459

Open
rickj opened this issue Nov 5, 2024 · 6 comments
Open

Lower case vs. CamelCase #459

rickj opened this issue Nov 5, 2024 · 6 comments
Labels
a11y-display-guide Issue with the UX Guide principles or techniques

Comments

@rickj
Copy link
Collaborator

rickj commented Nov 5, 2024

In the "detailed-Conformance" section of https://github.com/w3c/publ-a11y/blob/main/a11y-meta-display-guide/2.0/draft/localizations/en-US/display_guide_vocabulary_w3c_en-US.json the word 'Conformance' is upper cased in the heading "detailed-Conformance".

My developers are asking if this is intentional (as all the others are lower case), or will it be changing?

@bvandorn
Copy link

bvandorn commented Nov 5, 2024

Similarly, conformance-not-EPUB should maybe be conformance-not-epub (though I can see how that one might be treated differently)

@GeorgeKerscher
Copy link
Collaborator

In the guidelines (was principles) the heading reads "Detailed Conformance Information" According to our editing guidelines, The first letter of a heading should be capatolized and the other words in the heading are lower case. This is a violation of this editing guideline.

The same problem occurs in the ONIX techniques and in the EPUB techniques.

In the comparison spreadsheet, tthey are marked as true, because it is wrong everywhere.
I can do a PR that resolves this problem.

I believe the JSON should be corrected to read "Detailed conformance information".

@gregoriopellegrino
Copy link
Collaborator

@GeorgeKerscher the problem I think is with the IDs, not the text content

@GeorgeKerscher
Copy link
Collaborator

Right, I see the problem. I will fix both the id and the text in all places.

@GeorgeKerscher
Copy link
Collaborator

I just submitted a PR that fixes some of the problems. It is:
#463

The cammel case @rickj reported must be in the JSON file, because I cannot find it anywhere else.

@mattgarrish
Copy link
Member

The cammel case @rickj reported must be in the JSON file, because I cannot find it anywhere else.

Yes, this issue is about the naming of the variables in the file. The fixes you made to the text are in keeping with W3C style, but are not the root of this issue.

@mattgarrish mattgarrish added the a11y-display-guide Issue with the UX Guide principles or techniques label Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a11y-display-guide Issue with the UX Guide principles or techniques
Projects
None yet
Development

No branches or pull requests

5 participants