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

   1 ! Copyright (C) 2008 Daniel Ehrenberg
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax io.encodings strings ;
   4 IN: io.encodings.utf16
   5
   6 ARTICLE: "io.encodings.utf16" "UTF-16 encoding"
   7 "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:"
   8 { $subsection utf16 }
   9 { $subsection utf16le }
  10 { $subsection utf16be } ;
  11
  12 ABOUT: "io.encodings.utf16"
  13
  14 HELP: utf16le
  15 { $class-description "The encoding descriptor 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." }
  16 { $see-also "encodings-introduction" } ;
  17
  18 HELP: utf16be
  19 { $class-description "The encoding descriptor 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." }
  20 { $see-also "encodings-introduction" } ;
  21
  22 HELP: utf16
  23 { $class-description "The encoding descriptor 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." }
  24 { $see-also "encodings-introduction" } ;
  25
  26 { utf16 utf16le utf16be } related-words