basis/vocabs/hierarchy/hierarchy-docs.factor

   1 USING: help.markup help.syntax strings vocabs.loader
   2 sequences vocabs ;
   3 IN: vocabs.hierarchy
   4
   5 ARTICLE: "vocabs.hierarchy" "Vocabulary hierarchy tools"
   6 "These tools operate on all vocabularies found in the current set of " { $link vocab-roots } ", loaded or not. A prefix is the first part of a vocabulary name."
   7 $nl
   8 "Loading vocabulary hierarchies:"
   9 { $subsections
  10     load
  11     load-all
  12     load-root
  13     load-from-root
  14 }
  15 "Getting all vocabularies from disk:"
  16 { $subsections
  17     all-disk-vocabs-by-root
  18     all-disk-vocabs-recursive
  19 }
  20 "Getting all vocabularies from disk whose names which match a string prefix:"
  21 { $subsections
  22     disk-vocabs-for-prefix
  23     disk-vocabs-recursive-for-prefix
  24 }
  25 "Words for modifying output:"
  26 { $subsections
  27     no-roots
  28     no-prefixes
  29     filter-vocabs
  30 }
  31 "Getting " { $link "vocabs.metadata" } " for all vocabularies from disk:"
  32 { $subsections
  33     all-tags
  34     all-authors
  35 } ;
  36
  37 ABOUT: "vocabs.hierarchy"
  38
  39 HELP: load
  40 { $values { "prefix" string } }
  41 { $description "Load all vocabularies that match the provided prefix." }
  42 { $notes "This word differs from " { $link require } " in that it loads all subvocabularies, not just the given one." } ;
  43
  44 HELP: load-all
  45 { $description "Load all vocabularies in the source tree." } ;
  46
  47 HELP: load-from-root
  48 { $values
  49     { "root" "a vocaulary root" } { "prefix" string }
  50 }
  51 { $description "Attempts to load all of the vocabularies with a certain prefix from a vocabulary root." } ;
  52
  53 HELP: load-root
  54 { $values
  55     { "root" "a vocabulary root" }
  56 }
  57 { $description "Attempts to load all of the vocabularies in a vocabulary root." } ;