basis/vocabs/hierarchy/hierarchy-docs.factor

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