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 { $subsection "vocab-tags" }
  12 { $subsection "vocab-authors" }
  13 { $vocab "" } ;
  14
  15 HELP: words.
  16 { $values { "vocab" "a vocabulary name" } }
  17 { $description "Printings a listing of all the words in a vocabulary, categorized by type." } ;
  18
  19 HELP: about
  20 { $values { "vocab" "a vocabulary specifier" } }
  21 { $description
  22     "Displays the main help article for the vocabulary. The main help article is set with the " { $link POSTPONE: ABOUT: } " parsing word."
  23 } ;
  24
  25 ARTICLE: "browsing-help" "Browsing documentation"
  26 "Help topics are instances of a mixin:"
  27 { $subsection topic }
  28 "Most commonly, topics are article name strings, or words. You can display a specific help topic:"
  29 { $subsection help }
  30 "You can also display the help for a vocabulary:"
  31 { $subsection about }
  32 "To list a vocabulary's words only:"
  33 { $subsection words. }
  34 { $examples
  35   { $code "\"evaluator\" help" }
  36   { $code "\\ + help" }
  37   { $code "\"io.files\" about" }
  38 } ;