factor/doc/handbook/handbook.facts

USING: help inspector parser prettyprint ;

ARTICLE: "handbook" "Factor documentation"
"Welcome to Factor!"
$terpri
"The Factor user interface centers on the concept of a " { $emphasis "presentation" } ". A presentation is a graphical view of a live object."
$terpri
"Placing the mouse over a presentation highlights it with a border. Presentations are everywhere; help links, words, and code examples are all presentations. Clicking a presentation displays a browser window looking at the underlying object. A left click will reuse the current browser window; a right click always opens a new window."
$terpri
"Introductory material:"
{ $subsection "tutorial" }
{ $subsection "quickref" }
"Detailed reference documentation:"
{ $subsection "syntax" }
{ $subsection "dataflow" }
{ $subsection "words" }
{ $subsection "objects" }
{ $subsection "math" }
{ $subsection "collections" }
{ $subsection "streams" }
{ $subsection "parser" }
{ $subsection "prettyprint" }
{ $subsection "tools" } ;

ARTICLE: "quickref" "Quick reference"
"Loading source files:"
{ $subsection run-file }
"Displaying word documentation:"
{ $subsection help }
"Printing the top of the stack, and displaying the stack without popping:"
{ $subsection . }
{ $subsection .s }
"If you enter an invalid word name, you will get a \"not a number\" error:"
{ $example
    "fdafasfa"
    "An unhandled error was caught:\n\nParsing <interactive>:1\nfdafasfa\n        ^\n\"Not a number\"\n\n:s :r show stacks at time of error.\n:get ( var -- value ) inspects the error namestack."
}
"Sometimes, the word " { $emphasis "does" } " exist, but you might need to " { $link POSTPONE: USE: } " its vocabulary first. The " { $link apropos } " word can help locate the correct vocabulary:"
{ $example "\"<label>\" apropos" "IN: gadgets-labels : <label>\nIN: compiler-backend : <label>" }
$terpri
"A simple program:"
{ $code
    "USING: kernel math ;"
    ": factorial ( n -- n! )"
    "    dup zero? [ drop 1 ] [ dup 1- factorial * ] if ;"
} ;