From 5b1bdf03b7146a322b89e753cd41c726bc9079f0 Mon Sep 17 00:00:00 2001 From: Rahim Abdi Date: Thu, 6 Feb 2025 10:13:43 -0800 Subject: [PATCH] Editorial: Add ReSpec aliasing guidance in README (#2421) Co-authored-by: Rahim Abdi --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index e68ee64be..dcb38fc54 100644 --- a/README.md +++ b/README.md @@ -203,6 +203,8 @@ type”](https://respec.org/xref/?term=nullable+type) and ``` +In this example, "nullable" will show up in the spec text as a [ReSpec alias](https://respec.org/docs/#aliases-and-synonyms) for "nullable type" in the WebIDL spec. Aliases can only be provided for [concepts in spec](https://respec.org/docs/#concept-shorthands) (such as terms) and are helpful when you'd like the visible text for a ReSpec link to be different than the term being linked. Please note that it is not currently possible to provide an alias for an interface (e.g., #element in the DOM spec). + In some cases, a term may be defined in multiple specifications with the same `xref` syntax. For example, [“`[=range=]`” is defined in both the DOM and Internationalization Glossary specs](https://respec.org/xref/?term=range). The