8000 Add inline Registry Section by nigelmegitt · Pull Request #196 · w3c/dapt · GitHub
[go: up one dir, main page]

Skip to content

Conversation

nigelmegitt
Copy link
Contributor
@nigelmegitt nigelmegitt commented Nov 3, 2023

Closes #195. Incorporates and modifies the TTWG boilerplate registry definition, and specifies starter tables for daptm:descType and daptm:eventType.


Preview | Diff

Previous workaround to replace the element entirely with an `<a>` is unnecessary - simply put an empty href on the `<a>` element and Respec no longer tries to find the link.
@nigelmegitt
Copy link
Contributor Author

Self-review: it would be much more helpful to readers if the registry tables were placed within the sections where they apply rather than in appendix G. I'll refactor to move them there.

@nigelmegitt
Copy link
Contributor Author

Still to do: a few styling tweaks, and a note about registry sections in the document conventions.

@nigelmegitt
Copy link
Contributor Author

Ready to review now @cconcolato and anyone else.

@nigelmegitt
Copy link
Contributor Author
nigelmegitt commented Nov 8, 2023

There will be some more tweaks to this based on https://lists.w3.org/Archives/Public/spec-prod/2023OctDec/0009.html from @jyasskin and a W3C Slack response from @dbaron:

  • rename Registry Tables Section to Registry Table Definitions
  • markup the Registry Definitions, which are not easily changeable without a review cycle, differently to the Registry Tables, whose entries are easily changeable.

There were other points, but I think they're less clear cut, and worth discussing more. In some cases it seems like this PR does what the Process says it should do, but the Process might need fixing.

* Rename Registry Tables section to Registry Table Definitions
* Don't mark up the Registry Section as having different update requirements to the rest of the document
* Do mark up registry tables as "Registry Table Section" and explain in the document conventions how they differ; similarly update the SOTD text to explain that the document normatively specifies the registry table update requirements.
* Add captions to the registry tables
* some related minor editorial tweaks
@nigelmegitt
Copy link
Contributor Author
nigelmegitt commented Nov 9, 2023

Those tweaks made in 20380b0.

One change made is to adjust the styling so the blue registry table section sidebar only appears on the left rather than on both sides, because data tables get "fixed up" by the W3C fixup.js script to be in a wrapper with the "overlarge" class, which means they can overlap the border on the right.

Copy link
Contributor
@cconcolato cconcolato left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
Do we need section G.1.2.2.2 given that TTWG is the custodian of the defined registries?

@nigelmegitt
Copy link
Contributor Author

LGTM Do we need section G.1.2.2.2 given that TTWG is the custodian of the defined registries?

Yes, see G.1.1 which allows for a path in case TTWG no longer exists.

@css-meeting-bot
Copy link
Member

The Timed Text Working Group just discussed Add inline Registry Section w3c/dapt#196, and agreed to the following:

  • SUMMARY: Please review!
The full IRC log of that discussion <nigel> Subtopic: Add inline Registry Section #196
<nigel> github: https://github.com//pull/196
<cpn> Nigel: Thank you Cyril for reviewing. Please take a look
<cpn> ... We wanted registry tables in a few places, so this uses new features in W3C Process. They can be updated outside the normal Rec track process
<cpn> ... I've based this on the boilerplate text in the TTWG repo
<cpn> ... In doing this, I've had to raise a Process issue, but it's probably acceptable now to meet process requirements
<cpn> ... Please look, to see if it has any issues
<nigel> SUMMARY: Please review!

@nigelmegitt
Copy link
Contributor Author

I plan to merge this on Nov 23 if there are no unresolved objections, since that will have been 2 weeks since this PR was properly ready for review.

@nigelmegitt nigelmegitt added the agenda Issue flagged for in-meeting discussion label Nov 21, 2023
@himorin
Copy link
Contributor
himorin commented Nov 22, 2023

Added some minor questions, but overall seems fine for me.
One note, it seems working for now, but we may need to turn postProcess function into Promise if timing issue (not replaced within streamline publication) occurred.

@nigelmegitt
Copy link
Contributor Author

we may need to turn postProcess function into Promise if timing issue (not replaced within streamline publication) occurred

How could there be a timing issue? As far as I can tell, everything else has already run beforehand, except maybe fixup.js which doesn't interact with this. I'd be more worried that making it async would cause a timing issue.

Define and reference "registry table definitions" instead of using "registry table" definitions.
@himorin
Copy link
Contributor
himorin commented Nov 23, 2023

we may need to turn postProcess function into Promise if timing issue (not replaced within streamline publication) occurred

How could there be a timing issue? As far as I can tell, everything else has already run beforehand, except maybe fixup.js which doesn't interact with this. I'd be more worried that making it async would cause a timing issue.

In respec processing, if promise returned for postProcess, respec will wait to be resolved before going to next task.
https://lists.w3.org/Archives/Public/spec-prod/2017JanMar/0006.html (around mid)

@nigelmegitt nigelmegitt removed the agenda Issue flagged for in-meeting discussion label Nov 23, 2023
@nigelmegitt nigelmegitt merged commit f112658 into main Nov 23, 2023
@nigelmegitt nigelmegitt deleted the issue-0195-registry-tables-and-definition branch November 23, 2023 17:04
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.

Create inline Registry Tables and Registry Definition
4 participants
0