Include registry data from external files #326
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Use Respec's `data-oninclude` mechanism to write the table header and table body rows, using functions added for the purpose. This allows the table caption to be specified locally without being in the data file. Add registries/ directory and the two registry data files as JSON. Add a README.md file to explain the JSON structure. Move the `<content-descriptor>` and `daptm:descType` registry entries into JSON files.
nigelmegitt
changed the title
cconcolato
approved these changes
Oct 9, 2025
Member
|
The Timed Text Working Group just discussed
The full IRC log of that discussion<nigel> Subtopic: Include registry data from external files #326<nigel> github: https://github.com//pull/326 <nigel> Nigel: I was implementing validation code and noticed that the registry data was only in HTML <nigel> .. in the spec, not useful for using programmatically elsewhere. <nigel> .. [shows the pull request data] <nigel> .. Any issues with this? <nigel> .. Different format for example? <nigel> Cyril: Thank you for this, it's good to isolate the data from the spec HTML <nigel> .. Regarding the format, GitHub renders CSV as a table, and makes it easy to edit. <nigel> Nigel: Interesting, I haven't thought about CSV. <nigel> Cyril: It's good as it is, but it would be easier to prepare pull requests if you can <nigel> .. see the proposed changes formatted nicely in GitHub. It's minor. <nigel> .. It's already great to separate the registry from the main spec. <nigel> Nigel: In the spirit of agility and iteration we could merge this now and change it in the future <nigel> .. if we need to. <nigel> Cyril: I like that idea. <nigel> Nigel: Thank you, any other points? <nigel> Atsushi: I somehow wonder about these functions and whether a single JSON file will be dynamically loaded two times. <nigel> .. Also if we want to include the registry table we may want to include the caption within the JSON <nigel> .. data. For content using table might it be better to be generic from the JSON file? <nigel> .. I'm actually not totally sure about this JSON file being used, but having some caption or title <nigel> .. could have a benefit for the users of the JSON file by itself. <nigel> Nigel: That is interesting. At the moment the caption text includes links to other places in the <nigel> .. specification, and they would not make sense in isolation. <nigel> .. I'm not worried about loading the data twice. Even if the browser doesn't cache it, the files <nigel> .. are small, and when we publish to TR the scripts are run in advance to produce the final <nigel> .. HTML so it's not an issue on /TR. <nigel> SUMMARY: Review to continue, early merge okay, further comments or suggestions welcome |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Use Respec's
data-onincludemechanism to write the table header and table body rows, using functions added for the purpose. This allows the table caption to be specified locally without being in the data file.Add
registries/directory and the two registry data files as JSON. Add aREADME.mdfile to explain the JSON structure.Move the
<content-descriptor>anddaptm:descTyperegistry entries into JSON files and describe their location in the specification so that implementers can find them.Closes #325.
Preview | Diff