commit 8a4c07ac431e8b389c7a8314757d83cab73a700e
parent f0d99fdb224ea76d0d1a94103db4d2547b7883ac
Author: Wolfgang Corcoran-Mathe <wcm@sigwinch.xyz>
Date: Wed, 31 Jan 2024 13:06:44 -0500
Format escape sequence lists with @itemize or @example.
Why did they use two different styles?
TODO: the @lambda{} and @iota{} macros.
Diffstat:
1 file changed, 45 insertions(+), 51 deletions(-)
diff --git a/doc/r7rs-small/r7rs-small.texinfo b/doc/r7rs-small/r7rs-small.texinfo
@@ -5362,48 +5362,28 @@ The following character names must be supported by all implementations with the
values. Implementations may add other names provided they cannot be interpreted as
hex scalar values preceded by x.
- #\alarm ; U+0007
- #\backspace ; U+0008
- #\delete ; U+007F
- #\escape ; U+001B
- #\newline ; the
- linefeed
- character,
- U+000A
- #\null ; the null
- character,
- U+0000
- #\return ; the
- return
- character,
- U+000D
- #\space ; the
- preferred
- way to
- write a
- space
- #\tab ; the tab
- character,
- U+0009
+@example
+#\alarm ; U+0007
+#\backspace ; U+0008
+#\delete ; U+007F
+#\escape ; U+001B
+#\newline ; the linefeed character, U+000A
+#\null ; the null character, U+0000
+#\return ; the return character, U+000D
+#\space ; the preferred way to write a space
+#\tab ; the tab character, U+0009
+@end example
Here are some additional examples:
- #\a ; lower case
- letter
- #\A ; upper case
- letter
- #\( ; left
- parenthesis
- #\ ; the space
- character
- #\x03BB ; λ (if
- character is
- supported)
- #\iota ; ι (if
- character
- and name
- are
- supported)
+@example
+#\a ; lower case letter
+#\A ; upper case letter
+#\( ; left parenthesis
+#\ ; the space character
+#\x03BB ; @lambda{} (if character is supported)
+#\iota ; @iota{} (if character and name are supported)
+@end example
Case is significant in #\@svar{character}, and in #\⟨character name⟩, but not in #\x<hex scalar
value>. If @svar{character} in #\@svar{character} is alphabetic, then any character immediately
@@ -5519,29 +5499,43 @@ Note that many Unicode lowercase characters do not have uppercase equivalents.
@section Strings
Strings are sequences of characters. Strings are written as sequences of characters
-enclosed within quotation marks ("). Within a string literal, various escape
+enclosed within quotation marks (@code{"}). Within a string literal, various escape
sequencesrepresent characters other than themselves. Escape sequences always start
-with a backslash (\):
+with a backslash (@code{\}):
-* \a : alarm, U+0007
+@itemize
+@item
+@code{\a} : alarm, U+0007
-* \b : backspace, U+0008
+@item
+@code{\b} : backspace, U+0008
-* \t : character tabulation, U+0009
+@item
+@code{\t} : character tabulation, U+0009
-* \n : linefeed, U+000A
+@item
+@code{\n} : linefeed, U+000A
-* \r : return, U+000D
+@item
+@code{\r} : return, U+000D
-* \" : double quote, U+0022
+@item
+@code{\"} : double quote, U+0022
-* \\ : backslash, U+005C
+@item
+@code{\\} : backslash, U+005C
-* \| : vertical line, U+007C
+@item
+@code{\|} : vertical line, U+007C
-* \@svar{intraline whitespace}*@svar{line ending} @svar{intraline whitespace}* : nothing
+@item
+@code{\}@svar{intraline whitespace}*@svar{line ending}
+@svar{intraline whitespace}* : nothing
-* \x@svar{hex scalar value}; : specified character (note the terminating semi-colon).
+@item
+@code{\x}@svar{hex scalar value}@code{;} : specified character
+(note the terminating semi-colon).
+@end itemize
The result is unspecified if any other character in a string occurs after a backslash.
