From 6845473224a4fceb27a8717b573e1a09484d4ec3 Mon Sep 17 00:00:00 2001 From: Nigel Megitt Date: Thu, 9 Feb 2023 18:07:13 +0000 Subject: [PATCH 1/9] WIP first draft boilerplate text --- .pr-preview.json | 4 ++ boilerplate/registry/README.md | 7 +++ boilerplate/registry/index.html | 105 ++++++++++++++++++++++++++++++++ 3 files changed, 116 insertions(+) create mode 100644 .pr-preview.json create mode 100644 boilerplate/registry/README.md create mode 100644 boilerplate/registry/index.html diff --git a/.pr-preview.json b/.pr-preview.json new file mode 100644 index 0000000..12cc336 --- /dev/null +++ b/.pr-preview.json @@ -0,0 +1,4 @@ +{ + "src_file": "index.html", + "type": "respec" +} \ No newline at end of file diff --git a/boilerplate/registry/README.md b/boilerplate/registry/README.md new file mode 100644 index 0000000..8223edd --- /dev/null +++ b/boilerplate/registry/README.md @@ -0,0 +1,7 @@ +See https://github.com/w3c/ttwg/discussions/241 for +the motivation and discussion of this boilerplate registry document +for TTWG use. + +The boilerplate is a Respec document, +though the text content can be reused +within any other document. diff --git a/boilerplate/registry/index.html b/boilerplate/registry/index.html new file mode 100644 index 0000000..16c1f6f --- /dev/null +++ b/boilerplate/registry/index.html @@ -0,0 +1,105 @@ + + + + + TTWG Registry Boilerplate + + + + +
+

This is a boilerplate Registry Definition as required for Registries by [[w3c-process]].

+

The intent is that this boilerplate can form the basis of [=w3c registries=] for + the W3C Timed Text Working Group (TTWG).

+

See discussion w3c/ttwg#241 for + details of the assumptions made to generate this document.

+
+
+

This document is intended to be the basis of other Registry documents + published by TTWG and is not intended to be published as a Registry itself. + The following SOTD text is auto-generated by the Respec tool to reflect + what an actual Registry Definition document would contain.

+
+
+

Introduction

+

Some informative introductory text about this Registry.

+
+
+

Registry Definition

+

Insert sections on custodianship and change process.

+

Registry Table(s)

+

This section defines constraints on Registry Tables. Each Registry Table consists of a the set of Registry Entries.

+
+

Registry Entries

+

Each registry entry has a status, a unique key, and + if appropriate, other fields, for example any notes, + a description, or a reference to some other + defining entity. +

+ +
+
Status
+

The registry entry status field reflects the maturity of that entry. Permitted values are:

+ 
+            Provisional
+            Final
+            Deprecated
+
+

No other values are permitted.

+
+
Provisional
+

Registry entries with a status of Provisional MAY be changed, made final, deprecated or deleted.

+

Registry entry keys in Provisional entries that were deleted MAY be reused.

+
+
+
Final
+

Registry entries with a status of Final MAY be deprecated and MUST NOT be deleted or changed.

+

Registry entry keys in Final entries MUST NOT be reused.

+
+
+
Deprecated
+

Registry entries with a status of Deprecated MAY be reinstated to Final, and MUST NOT be deleted or changed.

+

Registry entry keys in Deprecated entries that were previously Provisional and never Final MAY be reused.

+

Registry entry keys in Provisional entries that were previously Final MUST NOT be reused.

+
+
+
+
+
+

Registry Table(s)

+

This section contains the Registry Table, i.e. the set of registry entries.

+

Insert empty example table here.

+
+
+

+ No conformance requirements are permitted in Registries. + If there are conformance requirements associated with + registry entries, then they must be defined in the + referencing specification. +

+
+

Referencing Specifications

+

Although the formal definition of a Registry includes + the referencing specifications, + there is no need to list those referencing specifications + in the Registry itself; doing so is optional. +

+
+
+ + From 7b611a4de80ffa7be9a62b57cfa67478a672062e Mon Sep 17 00:00:00 2001 From: Nigel Megitt Date: Mon, 20 Feb 2023 10:49:57 +0000 Subject: [PATCH 2/9] Create boilerplate/registry/.pr-preview.json --- boilerplate/registry/.pr-preview.json | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 boilerplate/registry/.pr-preview.json diff --git a/boilerplate/registry/.pr-preview.json b/boilerplate/registry/.pr-preview.json new file mode 100644 index 0000000..12cc336 --- /dev/null +++ b/boilerplate/registry/.pr-preview.json @@ -0,0 +1,4 @@ +{ + "src_file": "index.html", + "type": "respec" +} \ No newline at end of file From b47e458c4aff69a83dc983e7b1e37e35ac4034e6 Mon Sep 17 00:00:00 2001 From: Nigel Megitt Date: Mon, 27 Feb 2023 17:20:27 +0000 Subject: [PATCH 3/9] More WIP * Link from TTWG to its home page * Add Custodianship section * Add Change Process section * Improve definitions and links * Editorial clarification of registry entry status changes * Include index of defined terms * Add appendix with checklist for applying the boilerplate --- boilerplate/registry/index.html | 149 +++++++++++++++++++++++++++++--- 1 file changed, 136 insertions(+), 13 deletions(-) diff --git a/boilerplate/registry/index.html b/boilerplate/registry/index.html index 16c1f6f..a336bc2 100644 --- a/boilerplate/registry/index.html +++ b/boilerplate/registry/index.html @@ -18,6 +18,13 @@ edDraftURI: "https://w3c.github.io/ttwg/boilerplate/registry", group: "wg/timed-text", wgPublicList: "public-tt", + xref: ["w3c-process"], + localBiblio: { + ttwg: { + title: "Timed Text Working Group", + href: "https://www.w3.org/AudioVideo/TT/" + } + } }; @@ -25,7 +32,7 @@

This is a boilerplate Registry Definition as required for Registries by [[w3c-process]].

The intent is that this boilerplate can form the basis of [=w3c registries=] for - the W3C Timed Text Working Group (TTWG).

+ the W3C Timed Text Working Group.

See discussion w3c/ttwg#241 for details of the assumptions made to generate this document.

@@ -39,22 +46,112 @@

Introduction

Some informative introductory text about this Registry.

-
+

Registry Definition

Insert sections on custodianship and change process.

+
+

Custodianship

+

The custodian of this Registry is the TTWG. + If the TTWG is unable to fulfil the role of custodian, + for example if it has been closed, + the custodian in lieu is the W3C Team. +

+

+
+
+

Change Process

+
+

Requesting a change

+

Changes to this [=W3C Registry=] MUST be requested (the change request) using any one of the following options:

+
    +
  • Open an issue on the Registry Table's version control system;
    • +
  • Send an email to the TTWG's public email reflector + public-tt@w3.org
    • +
+

The change request MUST include enough information for the custodian + to be able to identify all of:

+
    +
  • The Registry Table;
    • +
  • The Entries being proposed for addition;
    • +
  • The Provisional Entries for which changes are being proposed;
    • +
  • The Entries being proposed for a Status change;
    • +
  • Details of the requested changes for each Entry;
    • +
  • The motivation for making the requested changes;
    • +
  • Any other supporting information, for example real world usage statistics;
    • +
+

The proposer of the change MAY open a pull request (or equivalent) on + the Registry Table's version control system, with that pull request + containing the proposed changes. If a pull request is opened then + a corresponding issue MUST also be opened and + the pull request MUST be linked to that issue.

+ +
+
+

Change request assessment process

+

The process for assessing a change request depends on the custodian.

+
+
Custodian is TTWG
+

If the custodian is the TTWG:

+
    +
  • If the change proposer did not open a pull request + on the Registry Table's version control system, + then assessment is paused until a TTWG member + has opened such a pull request, + which MUST represent the requested changes + and MUST be linked to a related issue.
    • +
  • The TTWG follows its Decision Policy to review + the proposal in the pull request.
    • +
  • At the end of the Decision Review Period + if a TTWG Chair declares that there is consensus to approve, + the change request is approved.
    • +
  • In the absence of consensus to approve the expectation is + that a discussion will happen, to include the + change requester. + The result of this discussion can be any one of: +
      +
    1. the change request is abandoned;
      2. +
    2. the change request is modified for another review;
      3. +
    3. if the discussion resolves the objections, + and a TTWG Chair declares consensus to approve, + the change request can be approved.
      4. +
    +
    • +
+

An approved change request is enacted by merging its + related pull request into the Registry Table's version control system + and publishing the updated version of the Registry Table.

+
+
+
Custodian is the W3C Team
+

If the custodian is the W3C Team, + the Team MUST seek wide review of the change request and + offer a review period of at least 4 weeks, + before assessing from the responses received + if there is consensus amongst the respondents.

+

The Team MAY require a pull request on the Registry Table's + version control system to be + opened as the basis of the review. +

+

If there is such consensus, + the Team MUST make the proposed changes.

+
+
+

Registry Table(s)

This section defines constraints on Registry Tables. Each Registry Table consists of a the set of Registry Entries.

Registry Entries

-

Each registry entry has a status, a unique key, and - if appropriate, other fields, for example any notes, +

Each registry entry has a status, a unique key, and + if appropriate, other fields, for example any notes, a description, or a reference to some other defining entity.

+

The Registry Table definition MUST define the fields and the key to be used in each Registry entry.

Status
-

The registry entry status field reflects the maturity of that entry. Permitted values are:

+

The registry entry status field reflects the maturity of that entry. Permitted values are:

             Provisional
             Final
@@ -63,26 +160,31 @@ 
Status

           
No other values are permitted.

           

             
Provisional

-            
Registry entries with a status of Provisional MAY be changed, made final, deprecated or deleted.

-            
Registry entry keys in Provisional entries that were deleted MAY be reused.

+            
Registry entries with a status of Provisional MAY be changed or deleted.
+              Their status may be changed to Final or Deprecated.

+            
Registry entry keys in Provisional entries that were deleted MAY be reused.

           

           

             
Final

-            
Registry entries with a status of Final MAY be deprecated and MUST NOT be deleted or changed.

-            
Registry entry keys in Final entries MUST NOT be reused.

+            
Registry entries with a status of Final MUST NOT be deleted or changed.
+              Their status MAY be changed to Deprecated.

+            
Registry entry keys in Final entries MUST NOT be reused.

           

           

             
Deprecated

-            
Registry entries with a status of Deprecated MAY be reinstated to Final, and MUST NOT be deleted or changed.

-            
Registry entry keys in Deprecated entries that were previously Provisional and never Final MAY be reused.

-            
Registry entry keys in Provisional entries that were previously Final MUST NOT be reused.

+            
Registry entries with a status of Deprecated MUST NOT be deleted or changed.
+              Their status MAY be changed to Final.

+            
Registry entry keys in Deprecated entries that were previously Provisional and never Final MAY be reused.

+            
Registry entry keys in Provisional entries that were previously Final MUST NOT be reused.
-
+

Registry Table(s)

This section contains the Registry Table, i.e. the set of registry entries.

+

The Registry Table MUST provide a link to the version control system against + which any issues and pull requests can be opened.

Insert empty example table here.

@@ -98,8 +200,29 @@

Referencing Specifications

the referencing specifications, there is no need to list those referencing specifications in the Registry itself; doing so is optional. + Listing referencing specifications carries an + additional maintenance overhead.

+ +
+ +
+ +
+

Checklist for applying this boilerplate to a real Registry

+

When adopting this boilerplate for use in a Registry, + the following checklist may be helpful:

+
    +
  • Make a copy of this boilerplate and work on it in the appropriate repository;
    • +
  • Write introductory text explaining the Registry, it's purpose and expected usage;
    • +
  • Check that the custodianship rules are correct;
    • +
  • Check that the change process is correct;
    • +
  • Define the key and other registry entry fields;
    • +
  • Create a table and populate it with any known values;
    • +
  • Update any referencing specifications to link to it.
    • +
+
From adbd27137dd0cd5a0865967c309ea73ea5d83408 Mon Sep 17 00:00:00 2001 From: Nigel Megitt Date: Tue, 28 Feb 2023 11:34:00 +0000 Subject: [PATCH 4/9] Clarify key reuse and requirements on status of new entries --- boilerplate/registry/index.html | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/boilerplate/registry/index.html b/boilerplate/registry/index.html index a336bc2..6e84794 100644 --- a/boilerplate/registry/index.html +++ b/boilerplate/registry/index.html @@ -162,20 +162,29 @@
Status
Provisional

Registry entries with a status of Provisional MAY be changed or deleted. Their status may be changed to Final or Deprecated.

-

Registry entry keys in Provisional entries that were deleted MAY be reused.

+

Registry entry keys in Provisional entries + that were later deleted MAY be reused.

+

Newly created registry entries SHOULD have status Provisional.

Final

Registry entries with a status of Final MUST NOT be deleted or changed. Their status MAY be changed to Deprecated.

Registry entry keys in Final entries MUST NOT be reused.

+

Newly created registry entries MAY have status Final.

Deprecated

Registry entries with a status of Deprecated MUST NOT be deleted or changed. - Their status MAY be changed to Final.

-

Registry entry keys in Deprecated entries that were previously Provisional and never Final MAY be reused.

-

Registry entry keys in Provisional entries that were previously Final MUST NOT be reused.

+ Their status MAY be changed to Final + unless that would result in a duplicate key within the set of entries whose + status is either Provisional or Final.

+

Registry entry keys in Deprecated entries + that were previously Provisional and never Final + MAY be reused.

+

Registry entry keys in Provisional entries + that were previously Final MUST NOT be reused.

+

Newly created registry entries MUST NOT have status Deprecated.

From d093d143e32436611eae615430d705fb9a215b0a Mon Sep 17 00:00:00 2001 From: Nigel Megitt Date: Tue, 28 Feb 2023 14:48:36 +0000 Subject: [PATCH 5/9] Fix up links to defined terms, add introduction text. --- boilerplate/registry/index.html | 110 +++++++++++++++++++------------- 1 file changed, 67 insertions(+), 43 deletions(-) diff --git a/boilerplate/registry/index.html b/boilerplate/registry/index.html index 6e84794..c62c720 100644 --- a/boilerplate/registry/index.html +++ b/boilerplate/registry/index.html @@ -30,28 +30,46 @@
-

This is a boilerplate Registry Definition as required for Registries by [[w3c-process]].

+

This is a boilerplate Registry Definition as required by [[w3c-process]] for [=w3c registries=].

The intent is that this boilerplate can form the basis of [=w3c registries=] for the W3C Timed Text Working Group.

See discussion w3c/ttwg#241 for details of the assumptions made to generate this document.

-

This document is intended to be the basis of other Registry documents - published by TTWG and is not intended to be published as a Registry itself. +

This document is intended to be the basis of other [=w3c registry=] documents + published by TTWG and is not intended to be published as a [=w3c registry=] itself. The following SOTD text is auto-generated by the Respec tool to reflect - what an actual Registry Definition document would contain.

+ what an actual registry definition document would contain.

Introduction

-

Some informative introductory text about this Registry.

+

Replace the text in this section with some + informative introductory text about this Registry.

+

This document is intended to be used as the basis for [=w3c registries=] for + the W3C TTWG. + The [[w3c-process]] sets out requirements for such [=w3c registries=], + and defines core concepts like + registry definition + and registry table.

+

Registry definitions need to fulfil certain criteria, + including specifying custodianship, the change process, + and defining the registry table itself.

+

The text in the section can be + used to meet those criteria and allow more rapid creation of + registries without having to create new text each time.

+

This document also includes appendix + to facilitate adoption.

Registry Definition

-

Insert sections on custodianship and change process.

+

This section specifies the registry definition, consisting of + the custodianship, change process and + the core requirements of a registry table. +

Custodianship

-

The custodian of this Registry is the TTWG. +

The custodian of this [=w3c registry=] is the TTWG. If the TTWG is unable to fulfil the role of custodian, for example if it has been closed, the custodian in lieu is the W3C Team. @@ -62,25 +80,26 @@

Custodianship

Change Process

Requesting a change

-

Changes to this [=W3C Registry=] MUST be requested (the change request) using any one of the following options:

+

Changes to this [=W3C Registry=] MUST be requested (the change request) + using any one of the following options:

    -
  • Open an issue on the Registry Table's version control system;
    • +
  • Open an issue on the registry table's version control system;
  • Send an email to the TTWG's public email reflector public-tt@w3.org

The change request MUST include enough information for the custodian to be able to identify all of:

    -
  • The Registry Table;
    • -
  • The Entries being proposed for addition;
    • -
  • The Provisional Entries for which changes are being proposed;
    • -
  • The Entries being proposed for a Status change;
    • -
  • Details of the requested changes for each Entry;
    • +
  • The registry table;
    • +
  • The registry entries being proposed for addition;
    • +
  • The provisional registry entries for which changes are being proposed;
    • +
  • The registry entries being proposed for a status change;
    • +
  • Details of the requested changes for each registry entry;
  • The motivation for making the requested changes;
  • Any other supporting information, for example real world usage statistics;

The proposer of the change MAY open a pull request (or equivalent) on - the Registry Table's version control system, with that pull request + the registry table's version control system, with that pull request containing the proposed changes. If a pull request is opened then a corresponding issue MUST also be opened and the pull request MUST be linked to that issue.

@@ -95,7 +114,7 @@
Custodian is TTWG

If the custodian is the TTWG:

  • If the change proposer did not open a pull request - on the Registry Table's version control system, + on the registry table's version control system, then assessment is paused until a TTWG member has opened such a pull request, which MUST represent the requested changes @@ -119,17 +138,17 @@
    Custodian is TTWG

An approved change request is enacted by merging its - related pull request into the Registry Table's version control system - and publishing the updated version of the Registry Table.

+ related pull request into the registry table's version control system + and publishing the updated version of the registry table.

Custodian is the W3C Team

If the custodian is the W3C Team, - the Team MUST seek wide review of the change request and + the Team MUST seek [=wide review=] of the change request and offer a review period of at least 4 weeks, before assessing from the responses received if there is consensus amongst the respondents.

-

The Team MAY require a pull request on the Registry Table's +

The Team MAY require a pull request on the registry table's version control system to be opened as the basis of the review.

@@ -139,19 +158,26 @@
Custodian is the W3C Team

Registry Table(s)

-

This section defines constraints on Registry Tables. Each Registry Table consists of a the set of Registry Entries.

+

This section defines constraints on registry tables. + Each registry table consists of a set of + registry entries.

+

The registry table MUST provide a link to the version control system against + which any issues and pull requests can be opened.

Registry Entries

-

Each registry entry has a status, a unique key, and +

Each registry entry has a status, a unique key, and if appropriate, other fields, for example any notes, a description, or a reference to some other defining entity.

-

The Registry Table definition MUST define the fields and the key to be used in each Registry entry.

+

The registry table definition MUST define + the fields and the key to be used + in each registry entry.

Status
-

The registry entry status field reflects the maturity of that entry. Permitted values are:

+

The registry entry status field reflects the maturity of that entry. + Permitted values are:

             Provisional
             Final
@@ -160,47 +186,45 @@ 
Status

           
No other values are permitted.

           

             
Provisional

-            
Registry entries with a status of Provisional MAY be changed or deleted.
-              Their status may be changed to Final or Deprecated.

-            
Registry entry keys in Provisional entries
+            
Registry entries with a status of Provisional MAY be changed or deleted.
+              Their status may be changed to Final or Deprecated.

+            
Registry entry keys in Provisional entries
               that were later deleted MAY be reused.

-            
Newly created registry entries SHOULD have status Provisional.

+            
Newly created registry entries SHOULD have status Provisional.

           

           

             
Final

-            
Registry entries with a status of Final MUST NOT be deleted or changed.
-              Their status MAY be changed to Deprecated.

-            
Registry entry keys in Final entries MUST NOT be reused.

-            
Newly created registry entries MAY have status Final.

+            
Registry entries with a status of Final MUST NOT be deleted or changed.
+              Their status MAY be changed to Deprecated.

+            
Registry entry keys in Final entries MUST NOT be reused.

+            
Newly created registry entries MAY have status Final.

           

           

             
Deprecated

-            
Registry entries with a status of Deprecated MUST NOT be deleted or changed.
-              Their status MAY be changed to Final
+            
Registry entries with a status of Deprecated MUST NOT be deleted or changed.
+              Their status MAY be changed to Final
               unless that would result in a duplicate key within the set of entries whose
-              status is either Provisional or Final.

-            
Registry entry keys in Deprecated entries
+              status is either Provisional or Final.

+            
Registry entry keys in Deprecated entries
               that were previously Provisional and never Final
               MAY be reused.

-            
Registry entry keys in Provisional entries
+            
Registry entry keys in Provisional entries
               that were previously Final MUST NOT be reused.

-            
Newly created registry entries MUST NOT have status Deprecated.

+            
Newly created registry entries MUST NOT have status Deprecated.

Registry Table(s)

-

This section contains the Registry Table, i.e. the set of registry entries.

-

The Registry Table MUST provide a link to the version control system against - which any issues and pull requests can be opened.

+

This section contains the registry table, i.e. the set of registry entries.

Insert empty example table here.

- No conformance requirements are permitted in Registries. + No conformance requirements are permitted in registry tables. If there are conformance requirements associated with - registry entries, then they must be defined in the + registry entries, then they must be defined in the referencing specification.

From 4978e7fc46bad968a24e368f89c63010b3ef4d39 Mon Sep 17 00:00:00 2001 From: Nigel Megitt Date: Tue, 28 Feb 2023 15:22:33 +0000 Subject: [PATCH 6/9] Insert an example registry table. --- boilerplate/registry/index.html | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/boilerplate/registry/index.html b/boilerplate/registry/index.html index c62c720..d000c2e 100644 --- a/boilerplate/registry/index.html +++ b/boilerplate/registry/index.html @@ -218,7 +218,34 @@
Deprecated

Registry Table(s)

This section contains the registry table, i.e. the set of registry entries.

-

Insert empty example table here.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyStatusOther fieldsNotes
abc1ProvisionalThis key reuses one that was deprecated without being Final
abc2FinalThis entry cannot be changed, but it can be Deprecated.
abc1DeprecatedThis was never made Final, and now it cannot be, because its key has been reused.

From 05ef9ab16acc346a87bda1adf89f060efeeb49f4 Mon Sep 17 00:00:00 2001 From: Nigel Megitt Date: Tue, 28 Feb 2023 17:03:06 +0000 Subject: [PATCH 7/9] Address review comment --- boilerplate/registry/index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/boilerplate/registry/index.html b/boilerplate/registry/index.html index d000c2e..8887c57 100644 --- a/boilerplate/registry/index.html +++ b/boilerplate/registry/index.html @@ -37,7 +37,7 @@ details of the assumptions made to generate this document.

-

This document is intended to be the basis of other [=w3c registry=] documents +

This document is intended to be the basis of other [=registries=] published by TTWG and is not intended to be published as a [=w3c registry=] itself. The following SOTD text is auto-generated by the Respec tool to reflect what an actual registry definition document would contain.

@@ -208,7 +208,7 @@
Deprecated

Registry entry keys in Deprecated entries that were previously Provisional and never Final MAY be reused.

-

Registry entry keys in Provisional entries +

Registry entry keys in Deprecated entries that were previously Final MUST NOT be reused.

Newly created registry entries MUST NOT have status Deprecated.

From ed31515f5de1b8d6d1fd9143fa07418d34085398 Mon Sep 17 00:00:00 2001 From: Nigel Megitt Date: Tue, 28 Feb 2023 17:11:39 +0000 Subject: [PATCH 8/9] Use consistent style for refs, and fix W3C Team ref Addresses review feedback regarding the reference to W3C Team. --- boilerplate/registry/index.html | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/boilerplate/registry/index.html b/boilerplate/registry/index.html index 8887c57..cafc627 100644 --- a/boilerplate/registry/index.html +++ b/boilerplate/registry/index.html @@ -30,15 +30,15 @@
-

This is a boilerplate Registry Definition as required by [[w3c-process]] for [=w3c registries=].

-

The intent is that this boilerplate can form the basis of [=w3c registries=] for +

This is a boilerplate Registry Definition as required by [[w3c-process]] for w3c registries.

+

The intent is that this boilerplate can form the basis of w3c registries for the W3C Timed Text Working Group.

See discussion w3c/ttwg#241 for details of the assumptions made to generate this document.

-

This document is intended to be the basis of other [=registries=] - published by TTWG and is not intended to be published as a [=w3c registry=] itself. +

This document is intended to be the basis of other w3c registries + published by TTWG and is not intended to be published as a w3c registry itself. The following SOTD text is auto-generated by the Respec tool to reflect what an actual registry definition document would contain.

@@ -46,9 +46,9 @@

Introduction

Replace the text in this section with some informative introductory text about this Registry.

-

This document is intended to be used as the basis for [=w3c registries=] for +

This document is intended to be used as the basis for w3c registries for the W3C TTWG. - The [[w3c-process]] sets out requirements for such [=w3c registries=], + The [[w3c-process]] sets out requirements for such w3c registries, and defines core concepts like registry definition and registry table.

@@ -69,10 +69,10 @@

Registry Definition

Custodianship

-

The custodian of this [=w3c registry=] is the TTWG. +

The custodian of this w3c registry is the TTWG. If the TTWG is unable to fulfil the role of custodian, for example if it has been closed, - the custodian in lieu is the W3C Team. + the custodian in lieu is the W3C Team.

@@ -80,7 +80,7 @@

Custodianship

Change Process

Requesting a change

-

Changes to this [=W3C Registry=] MUST be requested (the change request) +

Changes to this W3C Registry MUST be requested (the change request) using any one of the following options:

  • Open an issue on the registry table's version control system;
    • @@ -144,7 +144,7 @@
    Custodian is TTWG
    Custodian is the W3C Team

    If the custodian is the W3C Team, - the Team MUST seek [=wide review=] of the change request and + the Team MUST seek wide review of the change request and offer a review period of at least 4 weeks, before assessing from the responses received if there is consensus amongst the respondents.

    From 04651292b0f61deca6a1c490057ba928e0915db5 Mon Sep 17 00:00:00 2001 From: Nigel Megitt Date: Mon, 6 Mar 2023 15:33:39 +0000 Subject: [PATCH 9/9] Clarify that one or more fields are used as the key --- boilerplate/registry/index.html | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/boilerplate/registry/index.html b/boilerplate/registry/index.html index cafc627..8d820ab 100644 --- a/boilerplate/registry/index.html +++ b/boilerplate/registry/index.html @@ -173,6 +173,14 @@

    Registry Entries

    The registry table definition MUST define the fields and the key to be used in each registry entry.

    +
    Status
    @@ -279,7 +287,8 @@

    Checklist for applying this boilerplate to a real Registry

  • Write introductory text explaining the Registry, it's purpose and expected usage;
  • Check that the custodianship rules are correct;
  • Check that the change process is correct;
    • -
  • Define the key and other registry entry fields;
    • +
  • Define the registry entry fields;
    • +
  • Define which of the fields is/are used as the key;
  • Create a table and populate it with any known values;
  • Update any referencing specifications to link to it.