basis/help/vocabs/vocabs-docs.factor

   1 USING: help help.topics help.markup help.syntax io strings ;
   2 IN: help.vocabs
   3
   4 ARTICLE: "vocab-tags" "Vocabulary tags"
   5 { $all-tags } ;
   6
   7 ARTICLE: "vocab-authors" "Vocabulary authors"
   8 { $all-authors } ;
   9
  10 ARTICLE: "vocab-index" "Vocabulary index"
  11 { $subsections
  12     "vocab-tags"
  13     "vocab-authors"
  14 }
  15 { $vocab "" } ;
  16
  17 HELP: words.
  18 { $values { "vocab" "a vocabulary name" } }
  19 { $description "Printings a listing of all the words in a vocabulary, categorized by type." } ;
  20
  21 HELP: about
  22 { $values { "vocab" "a vocabulary specifier" } }
  23 { $description
  24     "Displays the main help article for the vocabulary. The main help article is set with the " { $link POSTPONE: ABOUT: } " parsing word."
  25 } ;
  26
  27 ARTICLE: "browsing-help" "Browsing documentation"
  28 "Help topics are instances of a mixin:"
  29 { $subsections topic }
  30 "Most commonly, topics are article name strings, or words. You can display a specific help topic:"
  31 { $subsections help }
  32 "You can also display the help for a vocabulary:"
  33 { $subsections about }
  34 "To list a vocabulary's words only:"
  35 { $subsections words. }
  36 { $examples
  37   { $code "\"evaluator\" help" }
  38   { $code "\\ + help" }
  39   { $code "\"io.files\" about" }
  40 } ;