basis/vocabs/metadata/resources/resources-docs.factor

   1 ! (c)2010 Joe Groff bsd license
   2 USING: help.markup help.syntax strings ;
   3 IN: vocabs.metadata.resources
   4
   5 HELP: copy-vocab-resources
   6 { $values { "dir" string } { "vocab" string } }
   7 { $description "Copies all the vocabs resource files to the given directory." } ;
   8
   9 HELP: match-patterns
  10 { $values
  11   { "patterns" "a sequence of glob patterns" }
  12   { "filenames" "a sequence of filenames" }
  13   { "filenames'" "a filtered sequence of filenames" }
  14 }
  15 { $description "Matches all the glob patterns in " { $snippet "patterns" } " to the sequence of files in " { $snippet "filenames" } ". If a pattern doesn't match anything, then a " { $link resource-missing } " error will be thrown containing that pattern." } ;
  16
  17 HELP: vocab-resource-files
  18 { $values
  19     { "vocab" "a vocabulary specifier" }
  20     { "filenames" "a sequence of filenames" }
  21 }
  22 { $description "Outputs a sequence containing the individual resource files and directories that match the patterns specified in " { $snippet "vocab" } "'s " { $snippet "resources.txt" } " file. Any matching directories will also have their contents recursively included in the output. The paths in the output will be relative to " { $snippet "vocab" } "'s directory." } ;
  23
  24 ARTICLE: "vocabs.metadata.resources" "Vocabulary resource metadata"
  25 "The " { $vocab-link "vocabs.metadata.resources" } " vocabulary contains words to retrieve the full list of files that match the patterns specified in a vocabulary's " { $snippet "resources.txt" } " file."
  26 { $subsections
  27   match-patterns
  28   vocab-resource-files
  29 } ;
  30
  31 ABOUT: "vocabs.metadata.resources"