From 92ca3bbda07087acaac0f5130905df8b40e72747 Mon Sep 17 00:00:00 2001 From: Jean Mahoney Date: Wed, 6 Sep 2023 12:20:43 -0500 Subject: [PATCH] Update non-ascii-characters-in-rfcxml.md Updated with current guidance. Fixes #68 --- non-ascii-characters-in-rfcxml.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/non-ascii-characters-in-rfcxml.md b/non-ascii-characters-in-rfcxml.md index a51da5e..e23a5c7 100644 --- a/non-ascii-characters-in-rfcxml.md +++ b/non-ascii-characters-in-rfcxml.md @@ -12,15 +12,14 @@ The use of non-ASCII characters in RFCXML is detailed in RFC 7997. Your file enc # non-ASCII characters used directly -non-ASCII characters in RFCXML (and I-Ds in general) can be used directly in a restricted set of elements: +non-ASCII characters in RFCXML (and I-Ds in general) may appear within the body of the document. The **\** element is required for cases where the non-ASCII characters are needed for correct protocol operation. -* [**\**](/rfcxml-vocabulary#author) and [**\**](/rfcxml-vocabulary#contact) elements (using the **fullname**, **initials**, and **surname** attributes, while the **asciiFullname**, **asciiInitials**, and **asciiSurname** attributes hold the ASCII equivalents). If the non-ASCII characters are in the Unicode Latin blocks, then it's not necessary to use the attributes for ASCII equivalents. (For example, when a **surname** contains "ä" (LATIN SMALL LETTER A WITH DIAERESIS, U+00E4), it's not necessary to include **asciiSurname**.) -* [**\**](/rfcxml-vocabulary#organization) element -* author and contact's postal address using [**\**](/rfcxml-vocabulary#street), [**\**](/rfcxml-vocabulary#city), [**\**](/rfcxml-vocabulary#region), [**\**](/rfcxml-vocabulary#city), [**\**](/rfcxml-vocabulary#country) and * [**\**](/rfcxml-vocabulary#email) elements. Each of these elements has an ascii attribute to hold the ASCII equivalent, which will also appear in the output format. -* [**\**](/rfcxml-vocabulary#sourcecode) and [**\**](/rfcxml-vocabulary#artwork) elements +## Notes on ascii attributes +* For the [**\**](/rfcxml-vocabulary#author) and [**\**](/rfcxml-vocabulary#contact) elements, there exist both **fullname**, **initials**, and **surname** attributes that can hold non-ASCII characters and also the **asciiFullname**, **asciiInitials**, and **asciiSurname** attributes to hold the ASCII equivalents of non-ASCII characters that are not in the Unicode Latin blocks. +* Postal address elements [**\**](/rfcxml-vocabulary#street), [**\**](/rfcxml-vocabulary#city), [**\**](/rfcxml-vocabulary#region), [**\**](/rfcxml-vocabulary#city), [**\**](/rfcxml-vocabulary#country), and [**\**](/rfcxml-vocabulary#email) also have an ascii attribute to hold the ASCII equivalent, which will also appear in the output format. # non-ASCII characters wrapped in \ -Other than in the resricted elements, non-ASCII characters must be wrapped by the [**\**](/rfcxml-vocabulary#u) element with the **format** attribute specifying how it is represented. +When non-ASCII characters are needed for correct protocol operation, they must be wrapped by the [**\**](/rfcxml-vocabulary#u) element with the **format** attribute specifying how it is represented. The simplified **format** consists of dash-separated keywords, where each keyword represents a possible expansion of the Unicode character or string; use for example `foo` to expand the text to its literal value, code point values, and code point names. @@ -176,4 +175,4 @@ comes out as shown below: | 8 | \<♚\> | BLACK CHESS KING (U+265A) | | 9 | \ (U+2163) | \ | _Table 1: A Sample of Legal Nicknames_ -``` \ No newline at end of file +```