-
Notifications
You must be signed in to change notification settings - Fork 5
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
Add metadata rules for braille codes #287
Conversation
I followed the same template as the other documents. I put it in Best Practices too. I don't think that's necessarily the best location but wasn't sure where to put it. It's not just a suggestion like the other Best Practice documents.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we be using the W3C's MUST, SHOULD, MAY vs. Required & Optional?
Just wondering if we already made this decision or not.
Required, recommended, and optional are the same as must, should, and may, so I think this is fine for now. We might want to add a conformance statements section. I don't think this belongs under the best practices, though. I'd create a /registries/codes directory and put the document there. I can make some tweaks for the above and adjust some of the respec metadata later this evening. |
add recommendation to use registry values to brailleSystem property definition
Here's a quick summary of the changes I made in the last commit:
Registry: eBraille specification: |
Oops, I was too slow :/ Sorry for the late review: I had a bit of a doubt about already adding the "Registered codes" section, because I imagine the process for registering new codes will involve proper reviewing, but this initial list hasn't been reviewed yet. Perhaps it would have been more appropriate to call them "Candidates". Also, it seems more logical to me to have the definition terms and descriptions swapped in the definition list. E.g:
instead of
"Afrikaans grade2" is the code, "Afrikaans contracted" is the description of the code. |
@bertfrees, those changes make sense. I'm out starting tomorrow. Would you be fine making issues for those changes? I can address them when I get back or if someone else wants to go in and make those changes, they are welcome to do so. |
I added three new issues:
and I'll make a PR to address the first. |
<h3>Code syntax</h3> | ||
|
||
<p>These rules intend to identify braille codes clearly using a single string. The goal is to have a | ||
unified system that makes it easier for software developers and braille library mantainers to </p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@wfree-aph Something went wrong here: "The goal is to have a unified system that makes it easier for software developers and braille library mantainers to ... ?"
I followed the same template as the other documents. I put it in Best Practices too. I don't think that's necessarily the best location but wasn't sure where to put it. It's not just a suggestion like the other Best Practice documents.