basis/prettyprint/stylesheet/stylesheet-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 words ;
   4 IN: prettyprint.stylesheet
   5
   6 HELP: effect-style
   7 { $values
   8     { "effect" "an effect" }
   9     { "style" "a style assoc" }
  10 }
  11 { $description "The styling hook for stack effects" } ;
  12
  13 HELP: string-style
  14 { $values
  15     { "str" "a string" }
  16     { "style" "a style assoc" }
  17 }
  18 { $description "The styling hook for string literals" } ;
  19
  20 HELP: vocab-style
  21 { $values
  22     { "vocab" "a vocabulary specifier" }
  23     { "style" "a style assoc" }
  24 }
  25 { $description "The styling hook for vocab names" } ;
  26
  27 HELP: word-style
  28 { $values
  29     { "word" "a word" }
  30     { "style" "a style assoc" }
  31 }
  32 { $description "The styling hook for word names" } ;
  33
  34 ARTICLE: "prettyprint.stylesheet" "Prettyprinter Formatted Output"
  35 { $vocab-link "prettyprint.stylesheet" }
  36 $nl
  37 "Control the way that the prettyprinter formats output based on object type. These hooks form a basic \"syntax\" highlighting system."
  38 { $subsections
  39     word-style
  40     string-style
  41     vocab-style
  42     effect-style
  43 }
  44 ;
  45
  46 ABOUT: "prettyprint.stylesheet"