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

   1 ! Copyright (C) 2009 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.utf32
   5
   6 ARTICLE: "io.encodings.utf32" "UTF-32 encoding"
   7 "The UTF-32 encoding is a fixed-width encoding. Unicode code points are encoded as 4 byte sequences. There are three encoding descriptor classes for working with UTF-32, depending on endianness or the presence of a BOM:"
   8 { $subsection utf32 }
   9 { $subsection utf32le }
  10 { $subsection utf32be } ;
  11
  12 ABOUT: "io.encodings.utf32"
  13
  14 HELP: utf32le
  15 { $class-description "The encoding descriptor for UTF-32LE, that is, UTF-32 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: utf32be
  19 { $class-description "The encoding descriptor for UTF-32BE, that is, UTF-32 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: utf32
  23 { $class-description "The encoding descriptor for UTF-32, that is, UTF-32 with a byte order mark. This is the most useful for general input and output in UTF-32. Streams can be made which read or write wth this encoding." }
  24 { $see-also "encodings-introduction" } ;
  25
  26 { utf32 utf32le utf32be } related-words
  27