basis/unicode/categories/categories-docs.factor

   1 ! Copyright (C) 2009 Daniel Ehrenberg
   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 alphanumeric characters." } ;
  14
  15 HELP: math
  16 { $class-description "The class of Unicode math characters." } ;
  17
  18 HELP: blank
  19 { $class-description "The class of whitespace characters." } ;
  20
  21 HELP: character
  22 { $class-description "The class of pre-defined Unicode code points." } ;
  23
  24 HELP: control
  25 { $class-description "The class of control characters." } ;
  26
  27 HELP: digit
  28 { $class-description "The class of digits." } ;
  29
  30 HELP: letter
  31 { $class-description "The class of lower-cased letters." } ;
  32
  33 HELP: printable
  34 { $class-description "The class of characters which are printable, as opposed to being control or formatting characters." } ;
  35
  36 HELP: uncased
  37 { $class-description "The class of letters which don't have a case." } ;
  38
  39 ARTICLE: "unicode.categories" "Character classes"
  40 "The " { $vocab-link "unicode.categories" } " vocabulary implements 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. Each character class has an associated predicate word."
  41 { $subsection blank }
  42 { $subsection blank? }
  43 { $subsection letter }
  44 { $subsection letter? }
  45 { $subsection LETTER }
  46 { $subsection LETTER? }
  47 { $subsection Letter }
  48 { $subsection Letter? }
  49 { $subsection digit }
  50 { $subsection digit? }
  51 { $subsection printable }
  52 { $subsection printable? }
  53 { $subsection alpha }
  54 { $subsection alpha? }
  55 { $subsection control }
  56 { $subsection control? }
  57 { $subsection uncased }
  58 { $subsection uncased? }
  59 { $subsection character }
  60 { $subsection character? }
  61 { $subsection math }
  62 { $subsection math? } ;
  63
  64 ABOUT: "unicode.categories"