basis/unicode/categories/categories-docs.factor

   1 ! Copyright (C) 2009 Your name.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax kernel ;
   4 IN: unicode.categories
   5
   6 HELP: LETTER
   7 { $class-description "The class of upper cased letters" } ;
   8
   9 HELP: Letter
  10 { $class-description "The class of letters" } ;
  11
  12 HELP: alpha
  13 { $class-description "The class of code points which are alphanumeric" } ;
  14
  15 HELP: blank
  16 { $class-description "The class of code points which are whitespace" } ;
  17
  18 HELP: character
  19 { $class-description "The class of numbers which are pre-defined Unicode code points" } ;
  20
  21 HELP: control
  22 { $class-description "The class of control characters" } ;
  23
  24 HELP: digit
  25 { $class-description "The class of code coints which are digits" } ;
  26
  27 HELP: letter
  28 { $class-description "The class of code points which are lower-cased letters" } ;
  29
  30 HELP: printable
  31 { $class-description "The class of characters which are printable, as opposed to being control or formatting characters" } ;
  32
  33 HELP: uncased
  34 { $class-description "The class of letters which don't have a case" } ;
  35
  36 ARTICLE: "unicode.categories" "Character classes"
  37 { $vocab-link "unicode.categories" } " is a vocabulary which provides predicates for determining if a code point has a particular property, for example being a lower cased letter. These should be used in preference to the " { $vocab-link "ascii" } " equivalents in most cases. Below are links to classes of characters, but note that each of these also has a predicate defined, which is usually more useful."
  38 { $subsection blank }
  39 { $subsection letter }
  40 { $subsection LETTER }
  41 { $subsection Letter }
  42 { $subsection digit }
  43 { $subsection printable }
  44 { $subsection alpha }
  45 { $subsection control }
  46 { $subsection uncased }
  47 { $subsection character } ;
  48
  49 ABOUT: "unicode.categories"