1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
|
<pre>Internet Architecture Board (IAB) H. Flanagan, Ed.
Request for Comments: 7997 RFC Editor
Updates: <a href="./rfc7322">7322</a> December 2016
Category: Informational
ISSN: 2070-1721
<span class="h1">The Use of Non-ASCII Characters in RFCs</span>
Abstract
In order to support the internationalization of protocols and a more
diverse Internet community, the RFC Series must evolve to allow for
the use of non-ASCII characters in RFCs. While English remains the
required language of the Series, the encoding of future RFCs will be
in UTF-8, allowing for a broader range of characters than typically
used in the English language. This document describes the RFC Editor
requirements and gives guidance regarding the use of non-ASCII
characters in RFCs.
This document updates <a href="./rfc7322">RFC 7322</a>. Please view this document in PDF
form to see the full text.
Status of This Memo
This document is not an Internet Standards Track specification; it is
published for informational purposes.
This document is a product of the Internet Architecture Board (IAB)
and represents information that the IAB has deemed valuable to
provide for permanent record. It represents the consensus of the
Internet Architecture Board (IAB). Documents approved for
publication by the IAB are not a candidate for any level of Internet
Standard; see <a href="./rfc7841#section-2">Section 2 of RFC 7841</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="http://www.rfc-editor.org/info/rfc7997">http://www.rfc-editor.org/info/rfc7997</a>.
<span class="grey">Flanagan Informational [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc7997">RFC 7997</a> Non-ASCII in RFCs December 2016</span>
Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document.
Table of Contents
<a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-3">3</a>
<a href="#section-2">2</a>. Basic Requirements . . . . . . . . . . . . . . . . . . . . . <a href="#page-3">3</a>
<a href="#section-3">3</a>. Rules for the Use of Non-ASCII Characters . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-3.1">3.1</a>. General Usage throughout a Document . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-3.2">3.2</a>. Person Names . . . . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a>
<a href="#section-3.3">3.3</a>. Company Names . . . . . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a>
<a href="#section-3.4">3.4</a>. Body of the Document . . . . . . . . . . . . . . . . . . <a href="#page-7">7</a>
<a href="#section-3.5">3.5</a>. Tables . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-9">9</a>
<a href="#section-3.6">3.6</a>. Code Components . . . . . . . . . . . . . . . . . . . . . <a href="#page-11">11</a>
<a href="#section-3.7">3.7</a>. Bibliographic Text . . . . . . . . . . . . . . . . . . . <a href="#page-11">11</a>
<a href="#section-3.8">3.8</a>. Keywords and Citation Tags . . . . . . . . . . . . . . . <a href="#page-11">11</a>
<a href="#section-3.9">3.9</a>. Address Information . . . . . . . . . . . . . . . . . . . <a href="#page-12">12</a>
<a href="#section-4">4</a>. Normalization Forms . . . . . . . . . . . . . . . . . . . . . <a href="#page-12">12</a>
<a href="#section-5">5</a>. XML Markup . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-12">12</a>
<a href="#section-6">6</a>. Internationalization Considerations . . . . . . . . . . . . . <a href="#page-13">13</a>
<a href="#section-7">7</a>. Security Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-13">13</a>
<a href="#section-8">8</a>. Informative References . . . . . . . . . . . . . . . . . . . <a href="#page-13">13</a>
IAB Members at the Time of Approval . . . . . . . . . . . . . . . <a href="#page-14">14</a>
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-14">14</a>
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-15">15</a>
<span class="grey">Flanagan Informational [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc7997">RFC 7997</a> Non-ASCII in RFCs December 2016</span>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
Please review the PDF version of this draft.
For much of the history of the RFC Series, the character encoding
used for RFCs has been ASCII [<a href="./rfc20" title=""ASCII format for network interchange"">RFC20</a>]. This was a sensible choice at
the time: the language of the Series has always been English, a
language that primarily uses ASCII-encoded characters (ignoring for a
moment words borrowed from more richly decorated alphabets); and,
ASCII is the "lowest common denominator" for character encoding,
making cross-platform viewing trivial.
There are limits to ASCII, however, that hinder its continued use as
the exclusive character encoding for the Series. The increasing need
for easily readable, internationalized content suggests it is time to
allow non-ASCII characters in RFCs where necessary. To support this
move away from ASCII, RFCs will switch to supporting UTF-8 as the
default character encoding and will allow support for a broad range
of Unicode characters [<a href="#ref-UnicodeCurrent">UnicodeCurrent</a>]. Note that the RFC Editor may
reject any code point that does not render adequately across all
formats or in enough rendering engines using the v3 tooling.
Given the continuing goal of maximum readability across platforms,
the use of non-ASCII characters should be limited to only where
necessary within the text. This document describes the rules under
which non-ASCII characters may be used in an RFC. These rules will
be applied as the necessary changes are made to submission checking
and editorial tools.
This document updates the RFC Style Guide [<a href="./rfc7322" title=""RFC Style Guide"">RFC7322</a>].
The details included in this document are expected to change based on
experience gained in implementing the new publication toolsets.
Revised documents will be published capturing those changes as the
toolsets are completed. Other implementers must not expect those
changes to remain backwards compatible with the details included in
this document.
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Basic Requirements</span>
Two fundamental requirements inform the guidance and examples
provided in this document. They are:
o Searches against RFC indexes and database tables need to return
expected results and support appropriate Unicode string matching
behaviors;
<span class="grey">Flanagan Informational [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc7997">RFC 7997</a> Non-ASCII in RFCs December 2016</span>
o RFCs must be able to be displayed correctly across a wide range of
readers and browsers. People whose systems do not have the fonts
needed to display a particular RFC need to be able to read the
various publication formats and the XML correctly in order to
understand and implement the information described in the
document.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Rules for the Use of Non-ASCII Characters</span>
This section describes the guidelines for the use of non-ASCII
characters in an RFC. If the RFC Editor identifies areas where the
use of non-ASCII characters negatively impacts the readability of the
text, they will request alternate text.
The RFC Editor may, in cases of entire words represented in non-ASCII
characters, ask for a set of reviewers to verify the meaning,
spelling, characters, and grammar of the text.
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. General Usage throughout a Document</span>
Where the use of non-ASCII characters is purely part of an example
and not otherwise required for correct protocol operation, escaping
the non-ASCII character is not required. Note, however, that as the
language of the RFC Series is English, the use of non-ASCII
characters is based on the spelling of words commonly used in the
English language following the guidance in the Merriam-Webster
dictionary [<a href="#ref-MerrWeb" title=""Merriam-Webster's Collegiate Dictionary, 11th Edition"">MerrWeb</a>].
The RFC Editor will use the primary spelling listed in that
dictionary by default.
Example of non-ASCII characters that do not require escaping (example
from <a href="./rfc4475#section-3.1.1.12">Section 3.1.1.12 of RFC 4475</a> [<a href="./rfc4475" title=""Session Initiation Protocol (SIP) Torture Test Messages"">RFC4475</a>], with a hex dump replaced
by the actual character glyphs):
This particular response contains unreserved and non-ASCII
UTF-8 characters.
This response is well formed. A parser must accept this message.
Message Details : unreason
SIP/2.0 200 = 2**3 * 5**2 (See PDF for non-ASCII character string)
Via: SIP/2.0/UDP 192.0.2.198;branch=z9hG4bK1324923
Call-ID: unreason.1234ksdfak3j2erwedfsASdf
CSeq: 35 INVITE
From: sip:user@example.com;tag=11141343
To: sip:user@example.edu;tag=2229 Content-Length: 154
Content-Type: application/sdp
<span class="grey">Flanagan Informational [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc7997">RFC 7997</a> Non-ASCII in RFCs December 2016</span>
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Person Names</span>
Person names may appear in several places within an RFC (e.g., the
header, Acknowledgements, and References). When a script outside the
Unicode Latin blocks [<a href="#ref-UNICODE-CHART">UNICODE-CHART</a>] is used for an individual name,
an author-provided, ASCII-only identifier will appear immediately
after the non-Latin characters, surrounded by parentheses. This will
improve general readability of the text.
Example header:
OLD:
Internet Engineering Task Force (IETF) J. Tong
Request for Comments: 7380 C. Bi, Ed.
Category: Standards Track China Telecom
ISSN: 2070-1721 R. Even
Q. Wu, Ed.
R. Huang
Huawei
November 2014
PROPOSED/NEW:
Internet Engineering Task Force (IETF) J. Tong
Request for Comments: 7380 C. Bi, Ed.
Category: Standards Track China Telecom
ISSN: 2070-1721 (See PDF for non-ASCII character string) (R. Even)
(See PDF for non-ASCII character string) (Q. Wu), Ed.
R. Huang
Huawei
November 2014
<span class="grey">Flanagan Informational [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc7997">RFC 7997</a> Non-ASCII in RFCs December 2016</span>
Example Acknowledgements section:
OLD:
The following people contributed significant text to early versions
of this draft: Patrik Faltstrom, William Chan, and Fred Baker.
PROPOSED/NEW:
The following people contributed significant text to early versions
of this draft: Patrik (See PDF for non-ASCII character string)
(Faltstrom), (See PDF for non-ASCII character string) (William Chan),
and Fred Baker.
Example reference entry:
OLD:
[<a id="ref-RFC6630">RFC6630</a>] Cao, Z., Deng, H., Wu, Q., and G. Zorn, Ed., "EAP
Re-authentication Protocol Extensions for Authenticated
Anticipatory Keying (ERP/AAK)", <a href="./rfc6630">RFC 6630</a>, June 2012.
NEW
[<a id="ref-RFC6630">RFC6630</a>] Cao, Z., Deng, H., (See PDF for non-ASCII character
string) (Wu, Q.), and G. Zorn, Ed., "EAP
Re-authentication Protocol Extensions for Authenticated
Anticipatory Keying (ERP/AAK)", <a href="./rfc6630">RFC 6630</a>, June 2012.
<span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>. Company Names</span>
Company names may appear in several places within an RFC. In all
cases, valid Unicode is required. For names that include characters
outside of the Unicode Latin and Latin Extended scripts, an author-
provided, ASCII-only identifier is required to assist in searching
and indexing of the document.
<span class="grey">Flanagan Informational [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc7997">RFC 7997</a> Non-ASCII in RFCs December 2016</span>
<span class="h3"><a class="selflink" id="section-3.4" href="#section-3.4">3.4</a>. Body of the Document</span>
When the mention of non-ASCII characters is required for correct
protocol operation and understanding, the characters' Unicode code
points must be used in the text. The addition of each character name
is encouraged.
o Non-ASCII characters will require identifying the Unicode code
point.
o Use of the actual UTF-8 character (e.g., (See PDF for non-ASCII
character string)) is encouraged so that a reader can more easily
see what the character is, if their device can render the text.
o The use of the Unicode character names like "INCREMENT" in
addition to the use of Unicode code points is also encouraged.
When used, Unicode character names should be in all capital
letters.
Examples:
OLD [<a href="./rfc7564" title=""PRECIS Framework: Preparation, Enforcement, and Comparison of Internationalized Strings in Application Protocols"">RFC7564</a>]:
However, the problem is made more serious by introducing the full
range of Unicode code points into protocol strings. For example,
the characters U+13DA U+13A2 U+13B5 U+13AC U+13A2 U+13AC U+13D2 from
the Cherokee block look similar to the ASCII characters
"STPETER" as they might appear when presented using a "creative"
font family.
NEW/ALLOWED:
However, the problem is made more serious by introducing the full
range of Unicode code points into protocol strings. For example,
the characters U+13DA U+13A2 U+13B5 U+13AC U+13A2 U+13AC U+13D2
((See PDF for non-ASCII character string)) from the Cherokee
block look similar to the ASCII characters "STPETER" as they might
appear when presented using a "creative" font family.
ALSO ACCEPTABLE:
However, the problem is made more serious by introducing the full
range of Unicode code points into protocol strings. For example,
the characters "(See PDF for non-ASCII character string)" (U+13DA
U+13A2 U+13B5 U+13AC U+13A2 U+13AC U+13D2) from the Cherokee block
look similar to the ASCII characters "STPETER" as they might
appear when presented using a "creative" font family.
<span class="grey">Flanagan Informational [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc7997">RFC 7997</a> Non-ASCII in RFCs December 2016</span>
Example of proper identification of Unicode characters in an RFC:
Acceptable:
o Temperature changes in the Temperature Control Protocol are
indicated by the U+2206 character.
Preferred:
1. Temperature changes in the Temperature Control Protocol are
indicated by the U+2206 character ("(See PDF for non-ASCII
character string)").
2. Temperature changes in the Temperature Control Protocol are
indicated by the U+2206 character (INCREMENT).
3. Temperature changes in the Temperature Control Protocol are
indicated by the U+2206 character ("(See PDF for non-ASCII
character string)", INCREMENT).
4. Temperature changes in the Temperature Control Protocol are
indicated by the U+2206 character (INCREMENT, "(See PDF for non-
ASCII character string)").
5. Temperature changes in the Temperature Control Protocol are
indicated by the "Delta" character "(See PDF for non-ASCII
character string)" (U+2206).
6. Temperature changes in the Temperature Control Protocol are
indicated by the character "(See PDF for non-ASCII character
string)" (INCREMENT, U+2206).
Which option of (1), (2), (3), (4), (5), or (6) is preferred may
depend on context and the specific character(s) in question. All are
acceptable within an RFC. "US-ASCII Escaping of Unicode Character"
[<a href="#ref-BCP137" title=""ASCII Escaping of Unicode Characters"">BCP137</a>] describes the pros and cons of different options for
identifying Unicode characters and may help authors decide how to
represent the non-ASCII characters in their documents.
<span class="grey">Flanagan Informational [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc7997">RFC 7997</a> Non-ASCII in RFCs December 2016</span>
<span class="h3"><a class="selflink" id="section-3.5" href="#section-3.5">3.5</a>. Tables</span>
Tables follow the same rules for identifiers and characters as in
"Body of the Document" (<a href="#section-3.4">Section 3.4</a>). If it is sensible (i.e., more
understandable for a reader) for a given document to have two tables,
-- one including the identifiers and non-ASCII characters and a
second with just the non-ASCII characters -- then that will be
allowed at the discretion of the authors.
Original text from "Preparation, Enforcement, and Comparison of
Internationalized Strings Representing Usernames and Passwords"
[<a href="./rfc7613" title=""Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords"">RFC7613</a>].
<span class="grey">Flanagan Informational [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc7997">RFC 7997</a> Non-ASCII in RFCs December 2016</span>
Table 3: A sample of legal passwords
+------------------------------------+------------------------------+
| # | Password | Notes |
+------------------------------------+------------------------------+
| 12| <correct horse battery staple> | ASCII space is allowed |
+------------------------------------+------------------------------+
| 13| <Correct Horse Battery Staple> | Different from example 12 |
+------------------------------------+------------------------------+
| 14| <&#x3C0;&#xDF;&#xE5;> | Non-ASCII letters are OK |
| | | (e.g., GREEK SMALL LETTER |
| | | PI, U+03C0) |
+------------------------------------+------------------------------+
| 15| <Jack of &#x2666;s> | Symbols are OK (e.g., BLACK |
| | | DIAMOND SUIT, U+2666) |
+------------------------------------+------------------------------+
| 16| <foo&#x1680;bar> | OGHAM SPACE MARK, U+1680, is |
| | | mapped to U+0020 and thus |
| | | the full string is mapped to |
| | | <foo bar> |
+------------------------------------+------------------------------+
Preferred text:
Table 3: A sample of legal passwords
+------------------------------------+------------------------------+
| # | Password | Notes |
+------------------------------------+------------------------------+
| 12| <correct horse battery staple> | ASCII space is allowed |
+------------------------------------+------------------------------+
| 13| <Correct Horse Battery Staple> | Different from example 12 |
+------------------------------------+------------------------------+
| 14| <(See PDF for non-ASCII | Non-ASCII letters are OK |
| | character string)> | (e.g., GREEK SMALL LETTER |
| | | PI, U+03C0; LATIN SMALL |
| | | LETTER SHARP S, U+00DF; THAI |
| | | DIGIT SEVEN, U+0E57) |
+------------------------------------+------------------------------+
| 15| <Jack of (See PDF for non- | Symbols are OK (e.g., BLACK |
| | ASCII character string)s> | DIAMOND SUIT, U+2666) |
+------------------------------------+------------------------------+
| 16| <foo(See PDF for non-ASCII | OGHAM SPACE MARK, U+1680, is |
| | character string)bar> | mapped to U+0020 and thus |
| | | the full string is mapped to |
| | | <foo bar> |
+------------------------------------+------------------------------+
<span class="grey">Flanagan Informational [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc7997">RFC 7997</a> Non-ASCII in RFCs December 2016</span>
<span class="h3"><a class="selflink" id="section-3.6" href="#section-3.6">3.6</a>. Code Components</span>
The RFC Editor encourages the use of the U+ notation except within a
code component where one must follow the rules of the programming
language in which the code is being written.
Code components are generally expected to use fixed-width fonts.
Where such fonts are not available for a particular script, the best
script-appropriate font will be used for that part of the code
component.
<span class="h3"><a class="selflink" id="section-3.7" href="#section-3.7">3.7</a>. Bibliographic Text</span>
The reference entry must be in English; whatever subfields are
present must be available in ASCII-encoded characters. For
references to RFCs and Internet-Drafts, the author's name will be
formatted in the reference as per current RFC Style Guide
recommendations. As long as good sense is used, the reference entry
may also include non-ASCII characters at the author's discretion and
as provided by the author. The RFC Editor may request that a third
party, such as a language specialist or subject matter expert, review
of any non-ASCII reference. This applies to both normative and
informative references.
Example:
[<a id="ref-GOST3410">GOST3410</a>] "Information technology. Cryptographic data security.
Signature and verification processes of [electronic]
digital signature.", GOST R 34.10-2001, Gosudarstvennyi
Standard of Russian Federation, Government Committee of
Russia for Standards, 2001. (In Russian)
Allowable addition to the above citation:
(See PDF for non-ASCII character strings)
Alternatively:
[<a href="#ref-GOST3410">GOST3410</a>] "Information technology. Cryptographic data security.
Signature and verification processes of [electronic]
digital signature.", GOST R 34.10-2001, Gosudarstvennyi
Standard of Russian Federation, (See PDF for non-ASCII
character strings) (Government Committee of
Russia for Standards), 2001. (In Russian)
<span class="h3"><a class="selflink" id="section-3.8" href="#section-3.8">3.8</a>. Keywords and Citation Tags</span>
Keywords (as tagged with the <keyword> element in XML) and citation
tags (as defined in the anchor attributes of <reference> elements)
must contain only ASCII characters.
<span class="grey">Flanagan Informational [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc7997">RFC 7997</a> Non-ASCII in RFCs December 2016</span>
<span class="h3"><a class="selflink" id="section-3.9" href="#section-3.9">3.9</a>. Address Information</span>
The purpose of providing address information, either postal or email,
is to assist readers of an RFC in contacting the author or authors.
Authors may include the official postal address as recognized by
their company or local postal service without additional non-ASCII
character escapes. If the email address includes non-ASCII
characters and is a valid email address at the time of publication,
non-ASCII character escapes are not required.
Example:
Qin Wu (editor)
Huawei
101 Software Avenue, Yuhua District
Nanjing, Jiangsu 210012
China
Additional contact information:
(See PDF for non-ASCII character strings)
------
Roni Even
Huawei
14 David Hamelech
Tel Aviv 64953
Israel
Additional contact information:
(See PDF for non-ASCII character strings)
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Normalization Forms</span>
Authors should not expect normalization forms [<a href="#ref-UNICODE-NORM">UNICODE-NORM</a>]to be
preserved. If a particular normalization form is expected, note that
in the text of the RFC.
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. XML Markup</span>
As described above, use of non-ASCII characters in areas such as
email, company name, address, and name is allowed. In order to make
it easier for code to identify the appropriate ASCII alternatives,
authors must include an "ascii" attribute to their XML markup when an
ASCII alternative is required. See [<a href="./rfc7991" title=""The "">RFC7991</a>] for more detail on how
to tag ASCII alternatives.
<span class="grey">Flanagan Informational [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc7997">RFC 7997</a> Non-ASCII in RFCs December 2016</span>
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Internationalization Considerations</span>
The ability to use non-ASCII characters in RFCs in a clear and
consistent manner will improve the ability to describe
internationalized protocols and will recognize the diversity of
authors. However, the goal of readability will override the use of
non-ASCII characters within the text.
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Security Considerations</span>
Valid Unicode that matches the expected text must be verified in
order to preserve expected behavior and protocol information.
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Informative References</span>
[<a id="ref-BCP137">BCP137</a>] Klensin, J., "ASCII Escaping of Unicode Characters",
<a href="https://www.rfc-editor.org/bcp/bcp137">BCP 137</a>, <a href="./rfc5137">RFC 5137</a>, February 2008,
<<a href="http://www.rfc-editor.org/info/bcp137">http://www.rfc-editor.org/info/bcp137</a>>.
[<a id="ref-MerrWeb">MerrWeb</a>] Merriam-Webster, Inc., "Merriam-Webster's Collegiate
Dictionary, 11th Edition", 2009.
[<a id="ref-RFC20">RFC20</a>] Cerf, V., "ASCII format for network interchange", STD 80,
<a href="./rfc20">RFC 20</a>, DOI 10.17487/RFC0020, October 1969,
<<a href="http://www.rfc-editor.org/info/rfc20">http://www.rfc-editor.org/info/rfc20</a>>.
[<a id="ref-RFC4475">RFC4475</a>] Sparks, R., Ed., Hawrylyshen, A., Johnston, A., Rosenberg,
J., and H. Schulzrinne, "Session Initiation Protocol (SIP)
Torture Test Messages", <a href="./rfc4475">RFC 4475</a>, DOI 10.17487/RFC4475,
May 2006, <<a href="http://www.rfc-editor.org/info/rfc4475">http://www.rfc-editor.org/info/rfc4475</a>>.
[<a id="ref-RFC7322">RFC7322</a>] Flanagan, H. and S. Ginoza, "RFC Style Guide", <a href="./rfc7322">RFC 7322</a>,
DOI 10.17487/RFC7322, September 2014,
<<a href="http://www.rfc-editor.org/info/rfc7322">http://www.rfc-editor.org/info/rfc7322</a>>.
[<a id="ref-RFC7564">RFC7564</a>] Saint-Andre, P. and M. Blanchet, "PRECIS Framework:
Preparation, Enforcement, and Comparison of
Internationalized Strings in Application Protocols",
<a href="./rfc7564">RFC 7564</a>, DOI 10.17487/RFC7564, May 2015,
<<a href="http://www.rfc-editor.org/info/rfc7564">http://www.rfc-editor.org/info/rfc7564</a>>.
[<a id="ref-RFC7613">RFC7613</a>] Saint-Andre, P. and A. Melnikov, "Preparation,
Enforcement, and Comparison of Internationalized Strings
Representing Usernames and Passwords", <a href="./rfc7613">RFC 7613</a>,
DOI 10.17487/RFC7613, August 2015,
<<a href="http://www.rfc-editor.org/info/rfc7613">http://www.rfc-editor.org/info/rfc7613</a>>.
<span class="grey">Flanagan Informational [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc7997">RFC 7997</a> Non-ASCII in RFCs December 2016</span>
[<a id="ref-RFC7991">RFC7991</a>] Hoffman, P., "The "xml2rfc" Version 3 Vocabulary",
<a href="./rfc7991">RFC 7991</a>, DOI 10.17487/RFC7991, December 2016,
<<a href="http://www.rfc-editor.org/info/rfc7991">http://www.rfc-editor.org/info/rfc7991</a>>.
[<a id="ref-UNICODE-CHART">UNICODE-CHART</a>]
The Unicode Consortium, "The Unicode Standard",
<<a href="http://www.unicode.org/charts">http://www.unicode.org/charts</a>>.
[<a id="ref-UNICODE-NORM">UNICODE-NORM</a>]
The Unicode Consortium, "Unicode Standard Annex #15:
Unicode Normalization Forms", 2016,
<<a href="http://www.unicode.org/reports/tr15/">http://www.unicode.org/reports/tr15/</a>>.
[<a id="ref-UnicodeCurrent">UnicodeCurrent</a>]
The Unicode Consortium, "The Unicode Standard",
<<a href="http://www.unicode.org/versions/latest/">http://www.unicode.org/versions/latest/</a>>.
IAB Members at the Time of Approval
The IAB members at the time this memo was approved were (in
alphabetical order):
Jari Arkko
Ralph Droms
Ted Hardie
Joe Hildebrand
Russ Housley
Lee Howard
Erik Nordmark
Robert Sparks
Andrew Sullivan
Dave Thaler
Martin Thomson
Brian Trammell
Suzanne Woolf
Acknowledgements
With many thanks to the members of the IAB i18n program. Also, many
thanks to the RFC Format Design Team for their efforts in making this
transition successful: Nevil Brownlee (ISE), Tony Hansen, Joe
Hildebrand, Paul Hoffman, Ted Lemon, Julian Reschke, Adam Roach,
Alice Russo, Robert Sparks (Tools Team liaison), and Dave Thaler.
<span class="grey">Flanagan Informational [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc7997">RFC 7997</a> Non-ASCII in RFCs December 2016</span>
Author's Address
Heather Flanagan (editor)
RFC Editor
Email: rse@rfc-editor.org
URI: <a href="http://orcid.org/0000-0002-2647-2220">http://orcid.org/0000-0002-2647-2220</a>
Flanagan Informational [Page 15]
</pre>
|