extra/help/crossref/crossref-docs.factor

   1 USING: help.crossref help.topics help.syntax help.markup ;
   2
   3 HELP: article-children
   4 { $values { "topic" "an article name or a word" } { "seq" "a new sequence" } }
   5 { $description "Outputs a sequence of all subsections of " { $snippet "topic" } "." } ;
   6
   7 HELP: article-parent
   8 { $values { "topic" "an article name or a word" } { "parent" "an article name or a word" } }
   9 { $description "Outputs a help topic which contains " { $snippet "topic" } " as a subsection, or " { $link f } "." } ;
  10
  11 HELP: help-path
  12 { $values { "topic" "an article name or a word" } { "seq" "a new sequence" } }
  13 { $description "Outputs a sequence of all help articles which contain " { $snippet "topic" } " as a subsection, traversing all the way up to the root." }
  14 { $examples
  15     { $example "USE: help.crossref" "\"sequences\" help-path ." "{ \"collections\" \"handbook\" }" }
  16 } ;
  17
  18 HELP: xref-article
  19 { $values { "topic" "an article name or a word" } }
  20 { $description "Sets the " { $link article-parent } " of each child of this article." }
  21 $low-level-note ;
  22
  23 HELP: unxref-article
  24 { $values { "topic" "an article name or a word" } }
  25 { $description "Clears the " { $link article-parent } " of each child of this article." }
  26 $low-level-note ;