extra/io/encodings/8-bit/8-bit-docs.factor

   1 ! Copyright (C) 2008 Daniel Ehrenberg
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.syntax help.markup io.encodings.8-bit.private
   4 strings ;
   5 IN: io.encodings.8-bit
   6
   7 ARTICLE: "io.encodings.8-bit" "8-bit encodings"
   8 "Many encodings are a simple mapping of bytes onto characters. The " { $vocab-link "io.encodings.8-bit" } " vocabulary implements these generically using existing resource files. These encodings should be used with extreme caution, as fully general Unicode encodings like UTF-8 are nearly always more appropriate. The following 8-bit encodings are already defined:"
   9 { $subsection latin1 }
  10 { $subsection latin2 }
  11 { $subsection latin3 }
  12 { $subsection latin4 }
  13 { $subsection latin/cyrillic }
  14 { $subsection latin/arabic }
  15 { $subsection latin/greek }
  16 { $subsection latin/hebrew }
  17 { $subsection latin5 }
  18 { $subsection latin6 }
  19 { $subsection latin/thai }
  20 { $subsection latin7 }
  21 { $subsection latin8 }
  22 { $subsection latin9 }
  23 { $subsection latin10 }
  24 { $subsection koi8-r }
  25 { $subsection windows-1252 }
  26 { $subsection ebcdic }
  27 { $subsection mac-roman } ;
  28
  29 ABOUT: "io.encodings.8-bit"
  30
  31 HELP: 8-bit
  32 { $class-description "Describes an 8-bit encoding, including its name (a symbol) and a table used for encoding and decoding." } ;
  33
  34 HELP: latin1
  35 { $description "This is the ISO-8859-1 encoding, also called Latin-1: Western European. It is an 8-bit superset of ASCII which is the default for a mimetype starting with 'text' and provides the characters necessary for most western European languages." }
  36 { $see-also "encodings-introduction" } ;
  37
  38 HELP: latin2
  39 { $description "This is the ISO-8859-2 encoding, also called Latin-2: Eastern European. It is an 8-bit superset of ASCII and provides the characters necessary for most eastern European languages." }
  40 { $see-also "encodings-introduction" } ;
  41
  42 HELP: latin3
  43 { $description "This is the ISO-8859-3 encoding, also called Latin-3: South European. It is an 8-bit superset of ASCII and provides the characters necessary for Turkish, Maltese and Esperanto." }
  44 { $see-also "encodings-introduction" } ;
  45
  46 HELP: latin4
  47 { $description "This is the ISO-8859-4 encoding, also called Latin-4: North European. It is an 8-bit superset of ASCII and provides the characters necessary for Latvian, Lithuanian, Estonian, Greenlandic and Sami." }
  48 { $see-also "encodings-introduction" } ;
  49
  50 HELP: latin/cyrillic
  51 { $description "This is the ISO-8859-5 encoding, also called Latin/Cyrillic. It is an 8-bit superset of ASCII and provides the characters necessary for most languages which use Cyrilic, including Russian, Macedonian, Belarusian, Bulgarian, Serbian, and Ukrainian. KOI8-R is used much more commonly." }
  52 { $see-also "encodings-introduction" } ;
  53
  54 HELP: latin/arabic
  55 { $description "This is the ISO-8859-6 encoding, also called Latin/Arabic. It is an 8-bit superset of ASCII and provides the characters necessary for Arabic, though not other languages which use Arabic script." }
  56 { $see-also "encodings-introduction" } ;
  57
  58 HELP: latin/greek
  59 { $description "This is the ISO-8859-7 encoding, also called Latin/Greek. It is an 8-bit superset of ASCII and provides the characters necessary for Greek written in modern monotonic orthography, or ancient Greek without accent marks." }
  60 { $see-also "encodings-introduction" } ;
  61
  62 HELP: latin/hebrew
  63 { $description "This is the ISO-8859-8 encoding, also called Latin/Hebrew. It is an 8-bit superset of ASCII and provides the characters necessary for modern Hebrew without explicit vowels. Generally, this is interpreted in logical order, making it ISO-8859-8-I, technically." }
  64 { $see-also "encodings-introduction" } ;
  65
  66 HELP: latin5
  67 { $description "This is the ISO-8859-9 encoding, also called Latin-5: Turkish. It is an 8-bit superset of ASCII and provides the characters necessary for Turkish, similar to Latin-1 but replacing the spots used for Icelandic with characters used in Turkish." }
  68 { $see-also "encodings-introduction" } ;
  69
  70 HELP: latin6
  71 { $description "This is the ISO-8859-10 encoding, also called Latin-6: Nordic. It is an 8-bit superset of ASCII containing the same characters as Latin-4, but rearranged to be of better use to nordic languages." }
  72 { $see-also "encodings-introduction" } ;
  73
  74 HELP: latin/thai
  75 { $description "This is the ISO-8859-11 encoding, also called Latin/Thai. It is an 8-bit superset of ASCII containing the characters necessary to represent Thai. It is basically identical to TIS-620." }
  76 { $see-also "encodings-introduction" } ;
  77
  78 HELP: latin7
  79 { $description "This is the ISO-8859-13 encoding, also called Latin-7: Baltic Rim. It is an 8-bit superset of ASCII containing all characters necesary to represent Baltic Rim languages, as previous character sets were incomplete." }
  80 { $see-also "encodings-introduction" } ;
  81
  82 HELP: latin8
  83 { $description "This is the ISO-8859-14 encoding, also called Latin-8: Celtic. It is an 8-bit superset of ASCII designed for Celtic languages like Gaelic and Breton." }
  84 { $see-also "encodings-introduction" } ;
  85
  86 HELP: latin9
  87 { $description "This is the ISO-8859-15 encoding, also called Latin-9 and unoffically as Latin-0. It is an 8-bit superset of ASCII designed as a modification of Latin-1, removing little-used characters in favor of the Euro symbol and other characters." }
  88 { $see-also "encodings-introduction" } ;
  89
  90 HELP: latin10
  91 { $description "This is the ISO-8859-16 encoding, also called Latin-10: South-Eastern European. It is an 8-bit superset of ASCII." }
  92 { $see-also "encodings-introduction" } ;
  93
  94 HELP: windows-1252
  95 { $description "Windows 1252 is an 8-bit superset of ASCII which is closely related to Latin-1. Control characters in the 0x80 to 0x9F range are replaced with printable characters such as the Euro symbol." }
  96 { $see-also "encodings-introduction" } ;
  97
  98 HELP: ebcdic
  99 { $description "EBCDIC is an 8-bit legacy encoding designed for IBM mainframes like System/360 in the 1960s. It has since fallen into disuse. It contains large unallocated regions, and the version included here (code page 37) contains auxiliary characters in this region for English- and Portugese-speaking countries." }
 100 { $see-also "encodings-introduction" } ;
 101
 102 HELP: mac-roman
 103 { $description "Mac Roman is an 8-bit superset of ASCII which was the standard encoding on Mac OS prior to version 10. It is incompatible with Latin-1 in all but a few places and ASCII, and it is suitable for encoding many Western European languages." }
 104 { $see-also "encodings-introduction" } ;
 105
 106 HELP: koi8-r
 107 { $description "KOI8-R is an 8-bit superset of ASCII which encodes the Cyrillic alphabet, as used in Russian and Bulgarian. Characters are in such an order that, if the eight bit is stripped, text is still interpretable as ASCII. Block-building characters also exist." }
 108 { $see-also "encodings-introduction" } ;