extra/help/crossref/crossref-docs.factor

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