From 249e571d77c976a25226a62fb11316da46b00007 Mon Sep 17 00:00:00 2001 From: Mark Kittisopikul Date: Thu, 17 Apr 2025 10:28:27 -0400 Subject: [PATCH 1/3] Reserve characters in names This reserves characters in registered names. The intention is to reserve characters to allow for namespace or a specific URI schemes in the future. --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8c4659a..e63b096 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,29 @@ The review will be done largely based on avoiding confusing extension names and Extension maintainers are responsible for their extensions. Updates to the extensions will also be reviewed by the steering council. +## Name conventions + +Registered extensions SHOULD use alphanumeric characters or underscore, `_`. + +Registered extensions MUST NOT use reserved characters. The following characters are reserved. + +``` +reserved = uri-gen-delims / uri-sub-delims / namespace-delims + +uri-gen-delims = ":" / "/" / "?" / "#" / "[" / "]" / "@" + +uri-sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "=" + +namespace-delims = "." / "-" / "~" +``` + +The reserved characters are a superset of reserved in [RFC3986]. + +[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", STD 66, RFC 3986, DOI 10.17487/RFC3986, January 2005, +https://tools.ietf.org/html/rfc3986. + +[RFC3986]: +https://tools.ietf.org/html/rfc3986 ## Document conventions @@ -49,7 +72,8 @@ introduced with the words "for example". Requirement Levels. March 1997. Best Current Practice. URL: https://tools.ietf.org/html/rfc2119 -[RFC2119]: https://tools.ietf.org/html/rfc2119 +[RFC2119]: +https://tools.ietf.org/html/rfc2119 ## License From 39239bd40efe0f9e28823f632a6b99eb0527c05a Mon Sep 17 00:00:00 2001 From: Mark Kittisopikul Date: Thu, 17 Apr 2025 10:33:49 -0400 Subject: [PATCH 2/3] Grammar --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e63b096..6fdea1a 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ uri-sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "=" namespace-delims = "." / "-" / "~" ``` -The reserved characters are a superset of reserved in [RFC3986]. +The reserved characters are a superset of those reserved in [RFC3986]. [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", STD 66, RFC 3986, DOI 10.17487/RFC3986, January 2005, https://tools.ietf.org/html/rfc3986. From 0d8a16308d343d0709973c8d8a59f1e8091c6aff Mon Sep 17 00:00:00 2001 From: Mark Kittisopikul Date: Sun, 27 Apr 2025 13:02:21 -0400 Subject: [PATCH 3/3] Add section about namespaces, remove `-` as a delim --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6fdea1a..80124b9 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ uri-gen-delims = ":" / "/" / "?" / "#" / "[" / "]" / "@" uri-sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "=" -namespace-delims = "." / "-" / "~" +namespace-delims = "." / "~" ``` The reserved characters are a superset of those reserved in [RFC3986]. @@ -53,6 +53,10 @@ https://tools.ietf.org/html/rfc3986. [RFC3986]: https://tools.ietf.org/html/rfc3986 +## Namespaces + +Namespaces MAY precede an extension name or other namespace prefixes. The character `.` MUST be used to delimit namespaces from each other and from the extension names. The primary use of namespaces is to disambiguate extensions with similar names which may differ in implementation or metadata. Extensions SHOULD register without a namespace if there is no amibiguity or difference in implementation from another extension of a similar name or use an existing namespace if applicable. + ## Document conventions These conventions are used for all extension specification documents in this repository.