2006-06-19 20:14:33 -04:00
USING: help ;
2006-08-17 23:08:04 -04:00
HELP: HELP:
{ $syntax "HELP: word content... ;" }
2006-08-16 21:55:53 -04:00
{ $values { "word" "a word" } { "content" "markup elements" } }
2006-06-19 20:14:33 -04:00
{ $description "Defines documentation for a word." }
{ $examples
{ $code
": foo 2 + ;"
2006-08-17 23:08:04 -04:00
"HELP: foo"
2006-06-19 20:14:33 -04:00
"{ $values { \"m\" \"an integer\" } { \"n\" \"an integer\" } }"
"{ $description \"Increments a value by 2.\" } ;"
"\ foo help"
}
} ;
2006-08-17 23:08:04 -04:00
HELP: ARTICLE:
{ $syntax "ARTICLE: topic title content... ;" }
2006-06-23 00:06:53 -04:00
{ $values { "topic" "an object" } { "title" "a string" } { "content" "markup elements" } }
{ $description "Defines a help article. String topic names are reserved for core documentation. Contributed modules should name articles by arrays, where the first element of an array identifies the module; for example, " { $snippet "{ \"httpd\" \"intro\" }" } "." }
2006-06-19 20:14:33 -04:00
{ $examples
{ $code
"ARTICLE: \"example\" \"An example article\""
"\"Hello world.\" ;"
}
} ;