factor/extra/io/encodings/utf16/utf16-docs.factor

23 lines
1.2 KiB
Factor
Raw Normal View History

2008-02-11 00:14:42 -05:00
USING: help.markup help.syntax io.encodings strings ;
IN: io.encodings.utf16
ARTICLE: "utf16" "Working with UTF-16-encoded data"
"The UTF-16 encoding is a variable-width encoding. Unicode code points are encoded as 2 or 4 byte sequences. There are three encoding descriptor classes for working with UTF-16, depending on endianness or the presence of a BOM:"
{ $subsection utf16le }
{ $subsection utf16be }
{ $subsection utf16 }
"All of these conform to the " { $link "encodings-protocol" } "." ;
2008-02-11 00:14:42 -05:00
ABOUT: "utf16"
2008-02-11 00:14:42 -05:00
HELP: utf16le
{ $class-description "The encoding protocol for UTF-16LE, that is, UTF-16 in little endian, without a byte order mark. Streams can be made which read or write wth this encoding." } ;
2008-02-11 00:14:42 -05:00
HELP: utf16be
{ $class-description "The encoding protocol for UTF-16BE, that is, UTF-16 in big endian, without a byte order mark. Streams can be made which read or write wth this encoding." } ;
2008-02-11 00:14:42 -05:00
HELP: utf16
{ $class-description "The encoding protocol for UTF-16, that is, UTF-16 with a byte order mark. This is the most useful for general input and output in UTF-16. Streams can be made which read or write wth this encoding." } ;
2008-02-11 00:14:42 -05:00
{ utf16 utf16le utf16be } related-words