extra/tools/browser/browser-docs.factor

   1 USING: help.markup help.syntax io strings ;
   2 IN: tools.browser
   3
   4 ARTICLE: "tools.browser" "Vocabulary browser"
   5 "Getting and setting vocabulary meta-data:"
   6 { $subsection vocab-summary }
   7 { $subsection set-vocab-summary }
   8 { $subsection vocab-tags }
   9 { $subsection set-vocab-tags }
  10 { $subsection add-vocab-tags } ;
  11
  12 HELP: vocab-summary
  13 { $values { "vocab" "a vocabulary specifier" } { "summary" "a string or " { $link f } } }
  14 { $description "Outputs a one-line string description of the vocabulary's intended purpose from the " { $snippet "summary.txt" } " file in the vocabulary's directory. Outputs " { $link f } " if the file does not exist." } ;
  15
  16 HELP: set-vocab-summary
  17 { $values { "string" "a string or " { $link f } } { "vocab" "a vocabulary specifier" } }
  18 { $description "Stores a one-line string description of the vocabulary to the " { $snippet "summary.txt" } " file in the vocabulary's directory." } ;
  19
  20 HELP: vocab-tags
  21 { $values { "vocab" "a vocabulary specifier" } { "tags" "a sequence of strings" } }
  22 { $description "Outputs a list of short tags classifying the vocabulary from the " { $snippet "tags.txt" } " file in the vocabulary's directory. Outputs " { $link f } " if the file does not exist." } ;
  23
  24 HELP: set-vocab-tags
  25 { $values { "tags" "a sequence of strings" } { "vocab" "a vocabulary specifier" } }
  26 { $description "Stores a list of short tags classifying the vocabulary to the " { $snippet "tags.txt" } " file in the vocabulary's directory." } ;
  27
  28 HELP: all-vocabs
  29 { $values { "assoc" "an association list mapping vocabulary roots to sequences of vocabulary specifiers" } }
  30 { $description "Outputs an association list of all vocabularies which have been loaded or are available for loading." } ;