basis/vocabs/metadata/metadata-docs.factor

   1 USING: help.markup help.syntax strings ;
   2 IN: vocabs.metadata
   3
   4 ARTICLE: "vocabs.metadata" "Vocabulary metadata"
   5 "Vocabulary summaries:"
   6 { $subsections
   7     vocab-summary
   8     set-vocab-summary
   9 }
  10 "Vocabulary authors:"
  11 { $subsections
  12     vocab-authors
  13     set-vocab-authors
  14 }
  15 "Vocabulary tags:"
  16 { $subsections
  17     vocab-tags
  18     set-vocab-tags
  19     add-vocab-tags
  20 }
  21 "Getting and setting arbitrary vocabulary metadata:"
  22 { $subsections
  23     vocab-file-contents
  24     set-vocab-file-contents
  25 } ;
  26
  27 ABOUT: "vocabs.metadata"
  28
  29 HELP: vocab-file-contents
  30 { $values { "vocab" "a vocabulary specifier" } { "name" string } { "seq" "a sequence of lines, or " { $link f } } }
  31 { $description "Outputs the contents of the file named " { $snippet "name" } " from the vocabulary's directory, or " { $link f } " if the file does not exist." } ;
  32
  33 HELP: set-vocab-file-contents
  34 { $values { "seq" "a sequence of lines" } { "vocab" "a vocabulary specifier" } { "name" string } }
  35 { $description "Stores a sequence of lines to the file named " { $snippet "name" } " from the vocabulary's directory." } ;
  36
  37 HELP: vocab-summary
  38 { $values { "vocab" "a vocabulary specifier" } { "summary" "a string or " { $link f } } }
  39 { $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." } ;
  40
  41 HELP: set-vocab-summary
  42 { $values { "string" "a string or " { $link f } } { "vocab" "a vocabulary specifier" } }
  43 { $description "Stores a one-line string description of the vocabulary to the " { $snippet "summary.txt" } " file in the vocabulary's directory." } ;
  44
  45 HELP: vocab-tags
  46 { $values { "vocab" "a vocabulary specifier" } { "tags" "a sequence of strings" } }
  47 { $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." } ;
  48
  49 HELP: set-vocab-tags
  50 { $values { "tags" "a sequence of strings" } { "vocab" "a vocabulary specifier" } }
  51 { $description "Stores a list of short tags classifying the vocabulary to the " { $snippet "tags.txt" } " file in the vocabulary's directory." } ;
  52