basis/unicode/control-pictures/control-pictures-docs.factor

   1 ! Copyright (C) 2022 Alex Maestas.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax strings ;
   4 IN: unicode.control-pictures
   5
   6 HELP: control-pictures
   7 { $values
   8     { "string" string }
   9 }
  10 { $description "Transforms C0 control characters, excepting spaces, into their corresponding Control Picture block codepoints." } ;
  11
  12 HELP: control-pictures*
  13 { $values
  14     { "string" string }
  15 }
  16 { $description "Transforms C0 control characters, including spaces, into their corresponding Control Picture block codepoints." } ;
  17
  18
  19 ARTICLE: "unicode.control-pictures" "Control Pictures"
  20 "The " { $vocab-link "unicode.control-pictures" } " vocabulary provides utility words for transforming characters in the nonprintable " { $url "http://www.unicode.org/charts/PDF/U0000.pdf" "ASCII C0 block" } " to their representations in the " { $url "http://www.unicode.org/charts/PDF/U2400.pdf" "Control Pictures" } " block. It has no effect on any other characters."
  21 $nl
  22 "Two words are provided - " { $link control-pictures } " transforms control characters, excepting spaces, to their picture form. The variant " { $link control-pictures* } " also transforms spaces."
  23 ;
  24
  25 ABOUT: "unicode.control-pictures"