-
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
Recommendation: Twee 3 Specification: Adding IFID Rule #6
Comments
Notionally agreed, however, per my reply in the Twine 2 HTML Elements issue, I'd suggest something along the lines of:
EDIT: Updated for consistency with the rest of the document language and for specificity. |
This was part of a much large conversation from almost two days ago in the Slack channel. The recommended language was already put into another specification. If we decide to go with this new language, it will need to change in both places. This is still possible, of course, but it would need to be discussed about aligning all documents. |
If you're talking about The Treaty of Babel, then there are issues with simply copying the sentence you cherry picked:
Beyond that. If by "both places" you mean within the Twee 3 Specification and the Twine 2 HTML Output, then while I agree that the language should be similar—and I can certainly copy some of my edits here to my suggestion in the other issue—it does not need to be exactly the same, word-for-word. OTOH, if you meant within our documents and the TToB, then fixing the deficiencies within the TToB is a whole different kettle of suck that we shouldn't be worried about here and now. |
See my comment on the Twine 2 HTML Elements issue. I agree with the change for greater specificity, but think we should also include "capital letters" or "uppercase" somewhere within the text to match what Twine 2 actually does with the v4 UUIDs it generates. |
As I noted in issue #4 , the uppercase requirement is already spelled out, but it doesn't hurt to reiterate the point. Thus, how about the following:
Or, with firmer language—mirrored in the other issue:
And, streamlined—also mirrored in the other issue and explained there:
EDIT: Derp. Fixed a pronoun bobble in the language. |
I vote for the streamlined version. |
Updated Twee 3 specification. Resolves issue #6.
Resolved. |
To clarify for future developers implementing the specification, it is recommended to add the following.
"An IFID is a sequence of between 8 and 63 characters, each of which shall be a digit, a capital letter or a hyphen (see Treaty of Babel)."
This would be added to the StoryData section.
The text was updated successfully, but these errors were encountered: