basis/help/definitions/definitions.factor

   1 ! Copyright (C) 2007, 2008 Slava Pestov.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: accessors definitions help help.topics help.syntax
   4 prettyprint.backend prettyprint.custom prettyprint words kernel
   5 effects ;
   6 IN: help.definitions
   7
   8 ! Definition protocol implementation
   9
  10 M: link definer drop \ ARTICLE: \ ; ;
  11
  12 M: link where name>> article loc>> ;
  13
  14 M: link set-where name>> article (>>loc) ;
  15
  16 M: link forget* name>> remove-article ;
  17
  18 M: link definition article-content ;
  19
  20 M: link synopsis*
  21     dup definer.
  22     dup name>> pprint*
  23     article-title pprint* ;
  24
  25 M: word-link definer drop \ HELP: \ ; ;
  26
  27 M: word-link where name>> "help-loc" word-prop ;
  28
  29 M: word-link set-where name>> swap "help-loc" set-word-prop ;
  30
  31 M: word-link definition name>> "help" word-prop ;
  32
  33 M: word-link synopsis*
  34     dup definer.
  35     name>> dup pprint-word
  36     stack-effect. ;
  37
  38 M: word-link forget* name>> remove-word-help ;