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

   1 ! Copyright (C) 2010 Joe Groff.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax strings ;
   4 IN: vocabs.metadata.resources
   5
   6 HELP: copy-vocab-resources
   7 { $values { "dir" string } { "vocab" string } }
   8 { $description "Copies all the vocabs resource files to the given directory." } ;
   9
  10 HELP: match-patterns
  11 { $values
  12   { "patterns" "a sequence of glob patterns" }
  13   { "filenames" "a sequence of filenames" }
  14   { "filenames'" "a filtered sequence of filenames" }
  15 }
  16 { $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." } ;
  17
  18 HELP: vocab-resource-files
  19 { $values
  20     { "vocab" "a vocabulary specifier" }
  21     { "filenames" "a sequence of filenames" }
  22 }
  23 { $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." } ;
  24
  25 ARTICLE: "vocabs.metadata.resources" "Vocabulary resource metadata"
  26 "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."
  27 { $subsections
  28   match-patterns
  29   vocab-resource-files
  30 } ;
  31
  32 ABOUT: "vocabs.metadata.resources"