extra/help/topics/topics-docs.factor

   1 USING: help.markup help.syntax help.topics help.crossref help io
   2 hashtables ;
   3
   4 HELP: articles
   5 { $var-description "Hashtable mapping article names to " { $link article } " instances." } ;
   6
   7 HELP: no-article
   8 { $values { "name" "an article name" } }
   9 { $description "Throws a " { $link no-article } " error." }
  10 { $error-description "Thrown by " { $link help } " if the given help topic does not exist, or if the help topic being dispayed links to a help topic which does not exist." } ;
  11
  12 HELP: article
  13 { $values { "name" "an article name" } { "article" "an " { $link article } " object" } }
  14 { $description "Outputs a named " { $link article } " object." } ;
  15
  16 HELP: article-title
  17 { $values { "article" "an article name or a word" } { "title" "a string" } }
  18 { $description "Outputs the title of a specific help article." } ;
  19
  20 HELP: article-content
  21 { $values { "article" "an article name or a word" } { "content" "a markup element" } }
  22 { $description "Outputs the content of a specific help article." } ;
  23
  24 HELP: all-articles
  25 { $values { "seq" "a sequence" } }
  26 { $description "Outputs a sequence of all help article names, and all words with documentation." } ;
  27
  28 HELP: elements
  29 { $values { "elt-type" "a word" } { "element" "a markup element" } { "seq" "a new sequence" } }
  30 { $description "Outputs a sequence of all elements of type " { $snippet "elt-type" } " found by traversing " { $snippet "element" } "." } ;
  31
  32 HELP: collect-elements
  33 { $values { "element" "a markup element" } { "seq" "a sequence of words" } { "elements" "a new sequence" } }
  34 { $description "Collects the arguments of all sub-elements of " { $snippet "element" } " whose markup element type occurs in " { $snippet "seq" } "." }
  35 { $notes "Used to implement " { $link article-children } "." } ;
  36
  37 HELP: link
  38 { $class-description "Class of help article presentations. Instances can be passed to " { $link write-object } " to output a clickable hyperlink. Also, instances of this class are valid definition specifiers; see " { $link "definitions" } "." } ;
  39
  40 HELP: related-words
  41 { $values { "seq" "a sequence of words" } }
  42 { $description "Defines a set of related words. Each word's documentation will contain links to all other words in the set." } ;