Fix documentation typos

slava 2006-12-14 06:50:50 +00:00
parent 14778affb6
commit 072ba70d47
8 changed files with 16 additions and 7 deletions

View File

@ -1,5 +1,5 @@
USING: gadgets-panes hashtables help io kernel namespaces
prettyprint sequences test threads words ;
prettyprint sequences errors threads words test ;
[
all-articles [

View File

@ -23,4 +23,5 @@ PROVIDE: core/handbook
"tools.facts"
"words.facts"
"ui/tools.facts"
"ui/ui.facts"
} } ;

View File

@ -90,7 +90,7 @@ ARTICLE: "ui-completion-words" "Word completion popup"
{ $operations word compound } ;
ARTICLE: "ui-completion-vocabs" "Vocabulary completion popup"
"Clicking a vocabulary in the vocabulary completion popup displays a list of words in the vocabulary in another " { $link "ui-completion-word" } ". Pressing " { $snippet "RETURN" } " adds the vocabulary to the current search path, just as if you invoked " { $link POSTPONE: USE: } "."
"Clicking a vocabulary in the vocabulary completion popup displays a list of words in the vocabulary in another " { $link "ui-completion-words" } ". Pressing " { $snippet "RETURN" } " adds the vocabulary to the current search path, just as if you invoked " { $link POSTPONE: USE: } "."
{ $operations vocab-link } ;
ARTICLE: "ui-completion-modules" "Module completion popup"

View File

@ -0,0 +1,7 @@
ARTICLE: "models" "Models" ;
ARTICLE: "clipboard-protocol" "Clipboard protocol" ;
ARTICLE: "timers" "Timers" ;
ARTICLE: "keyboard-gestures" "Keyboard gestures" ;

View File

@ -1,7 +1,8 @@
IN: help
USING: gadgets kernel arrays ;
: $ui-frame-constant
: $ui-frame-constant ( element -- )
drop
{ $description "Symbolic constant for a common input to " { $link grid-add } "." } print-element ;
IN: gadgets

View File

@ -33,7 +33,7 @@ HELP: build-grid
{ $description "Constructs gadgets and adds them to the grid by interpreting " { $snippet "spec" } ", which is an array of quadruples of the form " { $snippet "{ quot setter post loc }" } ". The quadruples break down as follows:"
{ $list
{ { $snippet "quot" } " - a quotation which pushes a new gadget on the stack. The quotation is permitted to consume values from the stack, and it is up to the caller of " { $link build-grid } " to prove the correct amount." }
{ { $snippet "setter" } " - a word with stack effect " { $link "( gadget grid -- )" } ". If " { $snippet "grid" } " is a tuple delegating to a " { $link grid } ", this can be used to store the new gadget in a tuple slot." }
{ { $snippet "setter" } " - a word with stack effect " { $snippet "( gadget grid -- )" } ". If " { $snippet "grid" } " is a tuple delegating to a " { $link grid } ", this can be used to store the new gadget in a tuple slot." }
{ { $snippet "post" } " - a quotation with stack effect " { $snippet "( gadget -- newgadget )" } ", applied to the gadget before it is added to the grid" }
{ { $snippet "loc" } " - a word with stack effect " { $snippet "( -- i j )" } " which pushes the grid location where to add the new gadget, for example " { $link @center } "." }
}

View File

@ -1,5 +1,5 @@
IN: gadgets-tracks
USING: help gadgets ;
USING: help gadgets arrays kernel ;
HELP: track
{ $class-description "A track is like a " { $link pack } " except each child is resized to a fixed multiple of the track's dimension in the direction of " { $link gadget-orientation } ". Tracks are created by calling " { $link <track> } "." }
@ -10,7 +10,7 @@ HELP: build-track
{ $description "Constructs gadgets and adds them to the track by interpreting " { $snippet "spec" } ", which is an array of quadruples of the form " { $snippet "{ quot setter post ratio }" } ". The quadruples break down as follows:"
{ $list
{ { $snippet "quot" } " - a quotation which pushes a new gadget on the stack. The quotation is permitted to consume values from the stack, and it is up to the caller of " { $link build-grid } " to prove the correct amount." }
{ { $snippet "setter" } " - a word with stack effect " { $link "( gadget grid -- )" } ". If " { $snippet "track" } " is a tuple delegating to a " { $link track } ", this can be used to store the new gadget in a tuple slot." }
{ { $snippet "setter" } " - a word with stack effect " { $snippet "( gadget grid -- )" } ". If " { $snippet "track" } " is a tuple delegating to a " { $link track } ", this can be used to store the new gadget in a tuple slot." }
{ { $snippet "post" } " - a quotation with stack effect " { $snippet "( gadget -- newgadget )" } ", applied to the gadget before it is added to the grid" }
{ { $snippet "ratio" } " - a rational number between 0 and 1 which determines the space allocation received by the child." }
}

View File

@ -1,5 +1,5 @@
IN: gadgets-viewports
USING: help gadgets ;
USING: help gadgets gadgets-scrolling models ;
HELP: viewport
{ $class-description "A viewport is a " { $link control } " which positions a child gadget translated by the " { $link control-value } " vector. Viewports are used in the implementation of " { $link scroller } " gadgets and can be created directly by calling " { $link <viewport> } "." } ;