28 lines
1.2 KiB
Plaintext
28 lines
1.2 KiB
Plaintext
IN: help
|
|
USING: definitions io prettyprint inspector ;
|
|
|
|
HELP: $title
|
|
{ $values { "topic" "a help article name or a word" } }
|
|
{ $description "Prints a help article's title, or a word's " { $link summary } ", depending on the type of " { $snippet "topic" } "." } ;
|
|
|
|
HELP: help
|
|
{ $values { "topic" "an article name or a word" } }
|
|
{ $description
|
|
"Displays a help article or documentation associated to a word on the " { $link stdio } " stream."
|
|
} ;
|
|
|
|
HELP: $subsection
|
|
{ $values { "element" "a markup element of the form " { $snippet "{ topic }" } } }
|
|
{ $description "Prints a large clickable link to the help topic named by the first string element of " { $snippet "element" } "." }
|
|
{ $examples
|
|
{ $code "{ $subsection \"sequences\" }" }
|
|
} ;
|
|
|
|
HELP: $index
|
|
{ $values { "element" "a markup element containing one quotation with stack effect " { $snippet "( quot -- )" } } }
|
|
{ $description "Calls the quotation to generate a sequence of help topics, and outputs a " { $link $subsection } " for each one." } ;
|
|
|
|
HELP: ($index)
|
|
{ $values { "seq" "a sequence of help article names and words" } { "quot" "a quotation with stack effect " { $snippet "( topic -- )" } } }
|
|
{ $description "Writes a list of " { $link $subsection } " elements to the " { $link stdio } " stream." } ;
|