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

Add metadata rules for braille codes #287

Merged
merged 2 commits into from
Oct 15, 2024
Merged

Conversation

wfree-aph
Copy link
Collaborator

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.

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.
Copy link
Collaborator

@clapierre clapierre left a 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.

@mattgarrish
Copy link
Contributor

MUST, SHOULD, MAY vs. Required & Optional

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
@mattgarrish
Copy link
Contributor

Here's a quick summary of the changes I made in the last commit:

  • moved the document to /registries/code
  • reorganized the sections so the list of codes is separate from the rules. I also added a placeholder for explaining the registration process, which we'll need to document
  • I added an EBNF definition for the codes. We can look at maybe turning it into something simpler later, but at least we get a formalized definition right at the top this way.
  • I updated the brailleSystem property definition in the specification to recommend using values from the registry. I don't think we can make it stronger since that would make it an error to use values that haven't yet been registered.

Registry:

eBraille specification:

@mattgarrish mattgarrish merged commit b691bc5 into main Oct 15, 2024
@mattgarrish mattgarrish deleted the braille-code-metadata branch October 15, 2024 17:38
@bertfrees
Copy link
Member

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:

Afrikaans grade2
Afrikaans contracted

instead of

Afrikaans contracted
Afrikaans grade2

"Afrikaans grade2" is the code, "Afrikaans contracted" is the description of the code.

@wfree-aph
Copy link
Collaborator Author

@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.

<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>
Copy link
Member

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 ... ?"

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

Successfully merging this pull request may close these issues.

4 participants