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 { $subsections
  42     blank
  43     blank?
  44     letter
  45     letter?
  46     LETTER
  47     LETTER?
  48     Letter
  49     Letter?
  50     digit
  51     digit?
  52     printable
  53     printable?
  54     alpha
  55     alpha?
  56     control
  57     control?
  58     uncased
  59     uncased?
  60     character
  61     character?
  62     math
  63     math?
  64 } ;
  65
  66 ABOUT: "unicode.categories"