factor: clean up whitespace in -docs files

db4
Doug Coleman 2015-07-02 10:31:22 -07:00
parent d47f9447c3
commit e3cb325040
154 changed files with 378 additions and 415 deletions

View File

@ -27,4 +27,4 @@ ARTICLE: "alien.destructors" "Alien destructors"
"The " { $vocab-link "alien.destructors" } " vocabulary defines a utility parsing word for defining new disposable classes."
{ $subsections POSTPONE: DESTRUCTOR: } ;
ABOUT: "alien.destructors"
ABOUT: "alien.destructors"

View File

@ -36,7 +36,7 @@ ABOUT: "bit-arrays"
HELP: ?{
{ $syntax "?{ elements... }" }
{ $values { "elements" "a list of booleans" } }
{ $description "Marks the beginning of a literal bit array. Literal bit arrays are terminated by " { $link POSTPONE: } } "." }
{ $description "Marks the beginning of a literal bit array. Literal bit arrays are terminated by " { $link POSTPONE: } } "." }
{ $examples { $code "?{ t f t }" } } ;
HELP: bit-array

View File

@ -35,6 +35,5 @@ HELP: >bit-vector
HELP: ?V{
{ $syntax "?V{ elements... }" }
{ $values { "elements" "a list of booleans" } }
{ $description "Marks the beginning of a literal bit vector. Literal bit vectors are terminated by " { $link POSTPONE: } } "." }
{ $description "Marks the beginning of a literal bit vector. Literal bit vectors are terminated by " { $link POSTPONE: } } "." }
{ $examples { $code "?V{ t f t }" } } ;

View File

@ -39,4 +39,3 @@ HELP: set-abp
HELP: get-abp
{ $values { "bitstream" bit-reader } { "abp" integer } }
{ $description "Returns the current position of the bit-reader's read cursor as a number of bits from the start of the stream. The position of the cursor in terms of bytes and bits can be read directly from the bit-reader tuple using " { $link byte-pos>> } " and " { $link bit-pos>> } "." } ;

View File

@ -30,7 +30,7 @@ HELP: from
{ "value" object }
}
{ $description "Receives an object from a channel. The operation is synchronous."
" It will block the calling thread until there is data in the channel."
" It will block the calling thread until there is data in the channel."
}
{ $see-also <channel> to } ;

View File

@ -6,7 +6,7 @@ IN: channels.remote
HELP: <remote-channel>
{ $values { "node" "a node object" }
{ "id" "the id of the published channel on the node" }
{ "id" "the id of the published channel on the node" }
{ "remote-channel" remote-channel }
}
{ $description "Create a remote channel that acts as a proxy for a "
@ -14,7 +14,7 @@ HELP: <remote-channel>
"published using " { $link publish } " and the id should be the id "
"returned by " { $link publish }
}
{ $examples
{ $examples
{ $code "\"localhost\" 9000 <node> \"ID123456\" <remote-channel> \"foo\" over to" }
}
{ $see-also publish unpublish } ;
@ -25,7 +25,7 @@ HELP: unpublish
{ $description "Stop a previously published channel from being "
"accessible by remote nodes."
}
{ $examples
{ $examples
{ $code "<channel> publish unpublish" }
}
{ $see-also <remote-channel> publish } ;
@ -35,10 +35,10 @@ HELP: publish
{ "id" string }
}
{ $description "Make a channel accessible via remote Factor nodes. "
"An id is returned that can be used by another node to use "
"An id is returned that can be used by another node to use "
{ $link to } " and " { $link from } " to access the channel."
}
{ $examples
{ $examples
{ $code "<channel> publish" }
}
{ $see-also <remote-channel> unpublish } ;
@ -48,7 +48,7 @@ ARTICLE: { "remote-channels" "remote-channels" } "Remote Channels"
$nl
"To start a remote node, distributed concurrency must have been started. This can be done using " { $link start-server } "."
$nl
{ $snippet "\"myhost.com\" 9001 start-server" }
{ $snippet "\"myhost.com\" 9001 start-server" }
$nl
"Once the node is started, channels can be published using " { $link publish }
" to be accessed remotely. " { $link publish } " returns an id which a remote node "
@ -58,7 +58,7 @@ $nl
$nl
"Given the id from the snippet above, a remote node can put items in the channel (where 123456 is the id):"
$nl
{ $snippet "\"myhost.com\" 9001 <node> 123456 <remote-channel>\n\"hello\" over to" }
{ $snippet "\"myhost.com\" 9001 <node> 123456 <remote-channel>\n\"hello\" over to" }
;
ABOUT: { "remote-channels" "remote-channels" }

View File

@ -33,7 +33,7 @@ HELP: STRUCT:
{ $description "Defines a new " { $link struct } " type. The syntax is nearly identical to " { $link POSTPONE: TUPLE: } "; however, there are some additional restrictions on struct types:"
{ $list
{ "Struct classes cannot have a superclass defined." }
{ "The slots of a struct must all have a type declared. The type must be a C type." }
{ "The slots of a struct must all have a type declared. The type must be a C type." }
{ { $link read-only } " slots on structs are not enforced, though they may be declared." }
}
"Additionally, structs may use bit fields. A slot specifier may use the syntax " { $snippet "bits: n" } " to specify that the bit width of the slot is " { $snippet "n" } ". Bit width may be specified on signed or unsigned integer slots. The layout of bit fields is not guaranteed to match that of any particular C compiler." } ;

View File

@ -18,7 +18,7 @@ HELP: SUPER->
HELP: IMPORT:
{ $syntax "IMPORT: name" }
{ $description "Makes an Objective C class available for use." }
{ $description "Makes an Objective C class available for use." }
{ $examples
{ $code "IMPORT: QTMovie" "QTMovie \"My Movie.mov\" <NSString> f -> movieWithFile:error:" }
} ;

View File

@ -7,10 +7,10 @@ HELP: load-nib
HELP: nib-named
{ $values { "nib-name" string } { "anNSNib" "an instance of NSNib" } }
{ $description "Looks up the " { $snippet ".nib" } " in the main bundle with the given name, instantiating an autoreleased NSNib object. Useful when combined with the " { $link nib-objects } " word. " { $snippet "f" } " is returned in case of error." }
{ $description "Looks up the " { $snippet ".nib" } " in the main bundle with the given name, instantiating an autoreleased NSNib object. Useful when combined with the " { $link nib-objects } " word. " { $snippet "f" } " is returned in case of error." }
{ $see-also nib-objects } ;
HELP: nib-objects
{ $values { "anNSNib" "an instance of NSNib" } { "objects/f" { $maybe sequence } } }
{ $description "Instantiates the top-level objects of the " { $snippet ".nib" } " file loaded by anNSNib. First create an NSNib instance using " { $link nib-named } "." }
{ $description "Instantiates the top-level objects of the " { $snippet ".nib" } " file loaded by anNSNib. First create an NSNib instance using " { $link nib-named } "." }
{ $see-also nib-named } ;

View File

@ -30,4 +30,4 @@ ARTICLE: "colors.constants" "Standard color database"
POSTPONE: COLOR:
} ;
ABOUT: "colors.constants"
ABOUT: "colors.constants"

View File

@ -8,4 +8,4 @@ ARTICLE: "colors.gray" "Grayscale colors"
<gray>
} ;
ABOUT: "colors.gray"
ABOUT: "colors.gray"

View File

@ -12,4 +12,4 @@ ARTICLE: "colors.hsv" "HSV colors"
}
{ $see-also "colors" } ;
ABOUT: "colors.hsv"
ABOUT: "colors.hsv"

View File

@ -3,7 +3,7 @@ IN: concurrency.count-downs
HELP: <count-down>
{ $values { "n" "a non-negative integer" } { "count-down" count-down } }
{ $description "Creates a new count-down latch." }
{ $description "Creates a new count-down latch." }
{ $errors "Throws an error if the count is lower than zero." } ;
HELP: count-down

View File

@ -8,4 +8,3 @@ HELP: CF>array
HELP: <CFArray>
{ $values { "seq" "a sequence of " { $link alien } " instances" } { "alien" "a " { $snippet "CFArray" } } }
{ $description "Creates a Core Foundation array from a Factor array." } ;

View File

@ -8,4 +8,3 @@ HELP: <CFBundle>
HELP: load-framework
{ $values { "name" "a pathname string" } }
{ $description "Loads a Core Foundation framework." } ;

View File

@ -9,4 +9,4 @@ ARTICLE: "definitions.icons" "Definition icons"
"Defining new icons:"
{ $subsections POSTPONE: ICON: } ;
ABOUT: "definitions.icons"
ABOUT: "definitions.icons"

View File

@ -19,13 +19,13 @@ HELP: define-consult
HELP: CONSULT:
{ $syntax """CONSULT: group class
code ;""" }
code ;""" }
{ $values { "group" "a protocol, generic word or tuple class" } { "class" "a class" } { "code" "code to get the object to which the method should be forwarded" } }
{ $description "Declares that objects of " { $snippet "class" } " will delegate the generic words contained in " { $snippet "group" } " to the object returned by executing " { $snippet "code" } " with the original object as an input." { $snippet "CONSULT:" } " will overwrite any existing methods on " { $snippet "class" } " for the members of " { $snippet "group" } ", but new methods can be added after the " { $snippet "CONSULT:" } " to override the delegation." } ;
HELP: BROADCAST:
{ $syntax """BROADCAST: group class
code ;""" }
code ;""" }
{ $values { "group" "a protocol, generic word or tuple class" } { "class" "a class" } { "code" "code to get the object to which the method should be forwarded" } }
{ $description "Declares that objects of " { $snippet "class" } " will delegate the generic words contained in " { $snippet "group" } " to every object in the sequence returned by executing " { $snippet "code" } " with the original object as an input." { $snippet "BROADCAST:" } " will overwrite any existing methods on " { $snippet "class" } " for the members of " { $snippet "group" } ", but new methods can be added after the " { $snippet "BROADCAST:" } " to override the delegation. Every generic word in " { $snippet "group" } " must return no outputs; otherwise, a " { $link broadcast-words-must-have-no-outputs } " error will be raised." } ;

View File

@ -31,19 +31,19 @@ $nl
"If a quotation does not contain any fry specifiers, then " { $link POSTPONE: '[ } " behaves just like " { $link POSTPONE: [ } ":"
{ $code "{ 10 20 30 } '[ . ] each" }
"Occurrences of " { $link _ } " on the left map directly to " { $link curry } ". That is, the following three lines are equivalent:"
{ $code
{ $code
"{ 10 20 30 } 5 '[ _ + ] map"
"{ 10 20 30 } 5 [ + ] curry map"
"{ 10 20 30 } [ 5 + ] map"
}
"Occurrences of " { $link _ } " in the middle of a quotation map to more complex quotation composition patterns. The following three lines are equivalent:"
{ $code
{ $code
"{ 10 20 30 } 5 '[ 3 _ / ] map"
"{ 10 20 30 } 5 [ 3 ] swap [ / ] curry compose map"
"{ 10 20 30 } [ 3 5 / ] map"
}
"Occurrences of " { $link @ } " are simply syntax sugar for " { $snippet "_ call" } ". The following four lines are equivalent:"
{ $code
{ $code
"{ 10 20 30 } [ sq ] '[ @ . ] each"
"{ 10 20 30 } [ sq ] [ call . ] curry each"
"{ 10 20 30 } [ sq ] [ . ] compose each"

View File

@ -63,7 +63,7 @@ HELP: validate-params
} ;
{ validate-params validate-values } related-words
HELP: validation-failed
{ $description "Stops processing the current request and takes action depending on the type of the current request:"
{ $list
@ -107,7 +107,7 @@ ARTICLE: "furnace.actions.validation" "Form validation with actions"
$nl
"A word to validate parameters and make them available as HTML form values (see " { $link "html.forms.values" } "); typically this word is invoked from the " { $slot "init" } " and " { $slot "validate" } " quotations:"
{ $subsections validate-params }
"The above word expects an association list mapping parameter names to validator quotations; validator quotations can use the words in the "
"The above word expects an association list mapping parameter names to validator quotations; validator quotations can use the words in the "
"Custom validation logic can invoke a word when validation fails; " { $link validate-params } " invokes this word for you:"
{ $subsections validation-failed }
"If validation fails, no more action code is executed, and the client is redirected back to the originating page, where validation errors can be displayed. Note that validation errors are rendered automatically by the " { $link "html.components" } " words, and in particular, " { $link "html.templates.chloe" } " use these words." ;

View File

@ -118,11 +118,11 @@ HELP: -nrot
HELP: ndip
{ $values { "n" integer } }
{ $description "A generalization of " { $link dip } " that can work "
{ $description "A generalization of " { $link dip } " that can work "
"for any stack depth. The quotation will be called with a stack that "
"has 'n' items removed first. The 'n' items are then put back on the "
"stack. The quotation can consume and produce any number of items."
}
}
{ $examples
{ $example "USING: arrays generalizations kernel prettyprint ;" "1 2 [ dup ] 1 ndip 3array ." "{ 1 1 2 }" }
{ $example "USING: arrays generalizations kernel prettyprint ;" "1 2 3 [ drop ] 2 ndip 2array ." "{ 2 3 }" }
@ -136,10 +136,10 @@ HELP: ndip
HELP: nkeep
{ $values { "n" integer } }
{ $description "A generalization of " { $link keep } " that can work "
{ $description "A generalization of " { $link keep } " that can work "
"for any stack depth. The first " { $snippet "n" } " items after the quotation will be "
"saved, the quotation called, and the items restored."
}
}
{ $examples
{ $example
"USING: generalizations kernel prettyprint"
@ -159,7 +159,7 @@ HELP: nkeep
HELP: ncurry
{ $values { "n" integer } }
{ $description "A generalization of " { $link curry } " that can work for any stack depth."
}
}
{ $examples
"Some core words expressed in terms of " { $link ncurry } ":"
{ $table
@ -172,7 +172,7 @@ HELP: ncurry
HELP: nwith
{ $values { "n" integer } }
{ $description "A generalization of " { $link with } " that can work for any stack depth."
}
}
{ $examples
"Some core words expressed in terms of " { $link nwith } ":"
{ $table
@ -183,7 +183,7 @@ HELP: nwith
HELP: napply
{ $values { "quot" quotation } { "n" integer } }
{ $description "A generalization of " { $link bi@ } " and " { $link tri@ } " that can work for any stack depth."
}
}
{ $examples
"Some core words expressed in terms of " { $link napply } ":"
{ $table
@ -196,7 +196,7 @@ HELP: napply
HELP: ncleave
{ $values { "quots" "a sequence of quotations" } { "n" integer } }
{ $description "A generalization of " { $link cleave } " and " { $link 2cleave } " that can work for any quotation arity."
}
}
{ $examples
"Some core words expressed in terms of " { $link ncleave } ":"
{ $table

View File

@ -23,7 +23,7 @@ HELP: add-vertex
HELP: remove-vertex
{ $values { "vertex" object } { "edges" sequence } { "graph" "an assoc mapping vertices to sequences of edges" } }
{ $description "Removes a vertex from a graph, using the given edges sequence." }
{ $description "Removes a vertex from a graph, using the given edges sequence." }
{ $notes "The " { $snippet "edges" } " sequence must equal the value passed to " { $link add-vertex } ", otherwise some vertices of the graph may continue to refer to the removed vertex." }
{ $side-effects "graph" } ;

View File

@ -5,4 +5,4 @@ HELP: apropos
{ $values { "str" string } }
{ $description "Lists all words, vocabularies and help articles whose name contains a subsequence equal to " { $snippet "str" } ". Results are ranked using a simple distance algorithm." } ;
TIP: "Use " { $link apropos } " to search for words, vocabularies and help articles." ;
TIP: "Use " { $link apropos } " to search for words, vocabularies and help articles." ;

View File

@ -37,4 +37,4 @@ ARTICLE: "browsing-help" "Browsing documentation"
{ $code "\"evaluator\" help" }
{ $code "\\ + help" }
{ $code "\"io.files\" about" }
} ;
} ;

View File

@ -77,7 +77,7 @@ ARTICLE: "html.templates.chloe.tags.component" "Component Chloe tags"
{ { $snippet "t:link" } { $link link } }
{ { $snippet "t:password" } { $link password } }
{ { $snippet "t:textarea" } { $link textarea } }
} ;
} ;
ARTICLE: "html.templates.chloe.tags.boilerplate" "Boilerplate Chloe tags"
"The following Chloe tags interface with the HTML templating " { $link "html.templates.boilerplate" } "."

View File

@ -73,4 +73,4 @@ ARTICLE: "http.server.rewrite" "URL rewrite responders"
<vhost-rewrite>
} ;
ABOUT: "http.server.rewrite"
ABOUT: "http.server.rewrite"

View File

@ -35,7 +35,7 @@ HELP: inspector-stack
{ $var-description "If the inspector is running, this variable holds previously-inspected objects." } ;
HELP: &push
{ $values { "obj" object } }
{ $values { "obj" object } }
{ $description "If the inspector is running, outputs the object currently being inspected." } ;
HELP: inspector

View File

@ -12,7 +12,7 @@ HELP: with-directory-tree-files
HELP: delete-tree
{ $values { "path" "a pathname string" } }
{ $description "Deletes a file or directory, recursing into subdirectories." }
{ $errors "Throws an error if the deletion fails." }
{ $errors "Throws an error if the deletion fails." }
{ $warning "Misuse of this word can lead to catastrophic data loss." } ;
HELP: copy-tree

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.arabic
HELP: latin/arabic
{ $var-description "This is the ISO-8859-6 encoding, also called Latin/Arabic. It is an 8-bit superset of ASCII and provides the characters necessary for Arabic, though not other languages which use Arabic script." }
{ $var-description "This is the ISO-8859-6 encoding, also called Latin/Arabic. It is an 8-bit superset of ASCII and provides the characters necessary for Arabic, though not other languages which use Arabic script." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.arabic" "Arabic encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.cyrillic
HELP: latin/cyrillic
{ $var-description "This is the ISO-8859-5 encoding, also called Latin/Cyrillic. It is an 8-bit superset of ASCII and provides the characters necessary for most languages which use Cyrilic, including Russian, Macedonian, Belarusian, Bulgarian, Serbian, and Ukrainian. KOI8-R is used much more commonly." }
{ $var-description "This is the ISO-8859-5 encoding, also called Latin/Cyrillic. It is an 8-bit superset of ASCII and provides the characters necessary for most languages which use Cyrilic, including Russian, Macedonian, Belarusian, Bulgarian, Serbian, and Ukrainian. KOI8-R is used much more commonly." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.cyrillic" "Cyrillic encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.ebcdic
HELP: ebcdic
{ $var-description "EBCDIC is an 8-bit legacy encoding designed for IBM mainframes like System/360 in the 1960s. It has since fallen into disuse. It contains large unallocated regions, and the version included here (code page 37) contains auxiliary characters in this region for English- and Portugese-speaking countries." }
{ $var-description "EBCDIC is an 8-bit legacy encoding designed for IBM mainframes like System/360 in the 1960s. It has since fallen into disuse. It contains large unallocated regions, and the version included here (code page 37) contains auxiliary characters in this region for English- and Portugese-speaking countries." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.ebcdic" "EBCDIC encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.greek
HELP: latin/greek
{ $description "This is the ISO-8859-7 encoding, also called Latin/Greek. It is an 8-bit superset of ASCII and provides the characters necessary for Greek written in modern monotonic orthography, or ancient Greek without accent marks." }
{ $description "This is the ISO-8859-7 encoding, also called Latin/Greek. It is an 8-bit superset of ASCII and provides the characters necessary for Greek written in modern monotonic orthography, or ancient Greek without accent marks." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.greek" "Greek encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.koi8-r
HELP: koi8-r
{ $var-description "KOI8-R is an 8-bit superset of ASCII which encodes the Cyrillic alphabet, as used in Russian and Bulgarian. Characters are in such an order that, if the eight bit is stripped, text is still interpretable as ASCII. Block-building characters also exist." }
{ $var-description "KOI8-R is an 8-bit superset of ASCII which encodes the Cyrillic alphabet, as used in Russian and Bulgarian. Characters are in such an order that, if the eight bit is stripped, text is still interpretable as ASCII. Block-building characters also exist." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.koi8-r" "KOI8-R encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.latin1
HELP: latin1
{ $var-description "This is the ISO-8859-1 encoding, also called Latin-1: Western European. It is an 8-bit superset of ASCII which is the default for a mimetype starting with 'text' and provides the characters necessary for most western European languages." }
{ $var-description "This is the ISO-8859-1 encoding, also called Latin-1: Western European. It is an 8-bit superset of ASCII which is the default for a mimetype starting with 'text' and provides the characters necessary for most western European languages." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.latin1" "Latin1 encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.latin10
HELP: latin10
{ $var-description "This is the ISO-8859-16 encoding, also called Latin-10: South-Eastern European. It is an 8-bit superset of ASCII." }
{ $var-description "This is the ISO-8859-16 encoding, also called Latin-10: South-Eastern European. It is an 8-bit superset of ASCII." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.latin10" "Latin10 encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.latin2
HELP: latin2
{ $var-description "This is the ISO-8859-2 encoding, also called Latin-2: Eastern European. It is an 8-bit superset of ASCII and provides the characters necessary for most eastern European languages." }
{ $var-description "This is the ISO-8859-2 encoding, also called Latin-2: Eastern European. It is an 8-bit superset of ASCII and provides the characters necessary for most eastern European languages." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.latin2" "Latin2 encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.latin3
HELP: latin3
{ $var-description "This is the ISO-8859-3 encoding, also called Latin-3: South European. It is an 8-bit superset of ASCII and provides the characters necessary for Turkish, Maltese and Esperanto." }
{ $var-description "This is the ISO-8859-3 encoding, also called Latin-3: South European. It is an 8-bit superset of ASCII and provides the characters necessary for Turkish, Maltese and Esperanto." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.latin3" "Latin3 encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.latin4
HELP: latin4
{ $description "This is the ISO-8859-4 encoding, also called Latin-4: North European. It is an 8-bit superset of ASCII and provides the characters necessary for Latvian, Lithuanian, Estonian, Greenlandic and Sami." }
{ $description "This is the ISO-8859-4 encoding, also called Latin-4: North European. It is an 8-bit superset of ASCII and provides the characters necessary for Latvian, Lithuanian, Estonian, Greenlandic and Sami." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.latin4" "Latin4 encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.latin5
HELP: latin5
{ $var-description "This is the ISO-8859-9 encoding, also called Latin-5: Turkish. It is an 8-bit superset of ASCII and provides the characters necessary for Turkish, similar to Latin-1 but replacing the spots used for Icelandic with characters used in Turkish." }
{ $var-description "This is the ISO-8859-9 encoding, also called Latin-5: Turkish. It is an 8-bit superset of ASCII and provides the characters necessary for Turkish, similar to Latin-1 but replacing the spots used for Icelandic with characters used in Turkish." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.latin5" "Latin5 encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.latin6
HELP: latin6
{ $var-description "This is the ISO-8859-10 encoding, also called Latin-6: Nordic. It is an 8-bit superset of ASCII containing the same characters as Latin-4, but rearranged to be of better use to nordic languages." }
{ $var-description "This is the ISO-8859-10 encoding, also called Latin-6: Nordic. It is an 8-bit superset of ASCII containing the same characters as Latin-4, but rearranged to be of better use to nordic languages." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.latin6" "Latin6 encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.latin7
HELP: latin7
{ $var-description "This is the ISO-8859-13 encoding, also called Latin-7: Baltic Rim. It is an 8-bit superset of ASCII containing all characters necessary to represent Baltic Rim languages, as previous character sets were incomplete." }
{ $var-description "This is the ISO-8859-13 encoding, also called Latin-7: Baltic Rim. It is an 8-bit superset of ASCII containing all characters necessary to represent Baltic Rim languages, as previous character sets were incomplete." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.latin7" "Latin7 encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.latin8
HELP: latin8
{ $var-description "This is the ISO-8859-14 encoding, also called Latin-8: Celtic. It is an 8-bit superset of ASCII designed for Celtic languages like Gaelic and Breton." }
{ $var-description "This is the ISO-8859-14 encoding, also called Latin-8: Celtic. It is an 8-bit superset of ASCII designed for Celtic languages like Gaelic and Breton." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.latin8" "Latin8 encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.mac-roman
HELP: mac-roman
{ $var-description "Mac Roman is an 8-bit superset of ASCII which was the standard encoding on Mac OS prior to version 10. It is incompatible with Latin-1 in all but a few places and ASCII, and it is suitable for encoding many Western European languages." }
{ $var-description "Mac Roman is an 8-bit superset of ASCII which was the standard encoding on Mac OS prior to version 10. It is incompatible with Latin-1 in all but a few places and ASCII, and it is suitable for encoding many Western European languages." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.mac-roman" "Mac Roman encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.thai
HELP: latin/thai
{ $var-description "This is the ISO-8859-11 encoding, also called Latin/Thai. It is an 8-bit superset of ASCII containing the characters necessary to represent Thai. It is basically identical to TIS-620." }
{ $var-description "This is the ISO-8859-11 encoding, also called Latin/Thai. It is an 8-bit superset of ASCII containing the characters necessary to represent Thai. It is basically identical to TIS-620." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.thai" "Thai encoding"

View File

@ -4,7 +4,7 @@ USING: help.markup help.syntax ;
IN: io.encodings.8-bit.windows-1252
HELP: windows-1252
{ $var-description "Windows 1252 is an 8-bit superset of ASCII which is closely related to Latin-1. Control characters in the 0x80 to 0x9F range are replaced with printable characters such as the Euro symbol." }
{ $var-description "Windows 1252 is an 8-bit superset of ASCII which is closely related to Latin-1. Control characters in the 0x80 to 0x9F range are replaced with printable characters such as the Euro symbol." }
{ $see-also "encodings-introduction" } ;
ARTICLE: "io.encodings.8-bit.windows-1252" "Windows 1252 encoding"

View File

@ -5,7 +5,7 @@ HELP: binary
{ $class-description "Encoding descriptor for binary I/O." } ;
ARTICLE: "io.encodings.binary" "Binary encoding"
"Making an encoded stream with the binary encoding is a no-op; streams with this encoding deal with byte-arrays, not strings."
"Making an encoded stream with the binary encoding is a no-op; streams with this encoding deal with byte-arrays, not strings."
{ $subsections binary } ;
ABOUT: "io.encodings.binary"

View File

@ -10,4 +10,4 @@ HELP: euc-kr
ARTICLE: "io.encodings.euc-kr" "EUC-KR encoding"
{ $subsections euc-kr } ;
ABOUT: "io.encodings.euc-kr"
ABOUT: "io.encodings.euc-kr"

View File

@ -5,7 +5,7 @@ ABOUT: "io.encodings.iana"
ARTICLE: "io.encodings.iana" "IANA-registered encoding names"
"The " { $vocab-link "io.encodings.iana" } " vocabulary provides words for accessing the names of encodings and the encoding descriptors corresponding to names." $nl
"Most text encodings in common use have been registered with IANA. There is a standard set of names for each encoding. Simple conversion functions:"
"Most text encodings in common use have been registered with IANA. There is a standard set of names for each encoding. Simple conversion functions:"
{ $subsections
name>encoding
encoding>name

View File

@ -9,4 +9,4 @@ HELP: johab
ARTICLE: "io.encodings.johab" "Korean Johab encoding"
{ $subsections johab } ;
ABOUT: "io.encodings.johab"
ABOUT: "io.encodings.johab"

View File

@ -23,7 +23,7 @@ B{ 230 136 145 231 136 177 228 189 160 } utf8 decode ."""
}
} ;
HELP: encode
HELP: encode
{ $values { "string" string } { "encoding" "an encoding descriptor" } { "byte-array" byte-array } }
{ $description "Converts a string into a byte array, interpreting that string with the given encoding." }
{ $examples

View File

@ -26,4 +26,3 @@ HELP: utf32
{ $see-also "encodings-introduction" } ;
{ utf32 utf32le utf32be } related-words

View File

@ -54,17 +54,17 @@ $low-level-note ;
HELP: <buffered-port>
{ $values { "handle" "a native handle identifying an I/O resource" } { "class" class } { "port" "a new " { $link port } } }
{ $description "Creates a new " { $link port } " using the specified native handle and a default-sized I/O buffer." }
{ $description "Creates a new " { $link port } " using the specified native handle and a default-sized I/O buffer." }
$low-level-note ;
HELP: <input-port>
{ $values { "handle" "a native handle identifying an I/O resource" } { "input-port" "a new " { $link input-port } } }
{ $description "Creates a new " { $link input-port } " using the specified native handle and a default-sized input buffer." }
{ $description "Creates a new " { $link input-port } " using the specified native handle and a default-sized input buffer." }
$low-level-note ;
HELP: <output-port>
{ $values { "handle" "a native handle identifying an I/O resource" } { "output-port" "a new " { $link output-port } } }
{ $description "Creates a new " { $link output-port } " using the specified native handle and a default-sized input buffer." }
{ $description "Creates a new " { $link output-port } " using the specified native handle and a default-sized input buffer." }
$low-level-note ;
HELP: (wait-to-read)

View File

@ -82,4 +82,3 @@ ARTICLE: "network-icmp" "ICMP"
} ;
ABOUT: "network-icmp"

View File

@ -29,4 +29,4 @@ $nl
with-null-reader
} ;
ABOUT: "io.streams.null"
ABOUT: "io.streams.null"

View File

@ -6,13 +6,13 @@ IN: io.streams.throwing
HELP: stream-exhausted
{ $values
{ "n" integer } { "stream" "an input stream" } { "word" word }
{ "n" integer } { "stream" "an input stream" } { "word" word }
}
{ $description "The exception that gets thrown when a stream is exhausted." } ;
HELP: stream-throw-on-eof
{ $values
{ "stream" "an input stream" } { "quot" quotation }
{ "stream" "an input stream" } { "quot" quotation }
}
{ $description "Wraps a stream in a " { $link <throws-on-eof-stream> } " tuple and calls the quotation with this stream as the " { $link input-stream } " variable. Causes a " { $link stream-exhausted } " exception to be thrown upon stream exhaustion. The stream is left open after this combinator returns." }
"This example will throw a " { $link stream-exhausted } " exception:"

View File

@ -5,7 +5,7 @@ IN: json.writer
HELP: >json
{ $values { "obj" object } { "string" "the object converted to JSON format" } }
{ $description "Serializes the object into a JSON formatted string." }
{ $description "Serializes the object into a JSON formatted string." }
{ $see-also json-print } ;
HELP: json-print

View File

@ -22,4 +22,4 @@ $nl
<linked-assoc>
} ;
ABOUT: "linked-assocs"
ABOUT: "linked-assocs"

View File

@ -4,19 +4,19 @@ USING: help.markup help.syntax namespaces assocs sequences
kernel combinators ;
IN: match
HELP: match
HELP: match
{ $values { "value1" object } { "value2" object } { "bindings" assoc }
}
{ $description "Pattern match value1 against value2. These values can be any Factor value, including sequences and tuples. The values can contain pattern variables, which are symbols that begin with '?'. The result is a hashtable of the bindings, mapping the pattern variables from one sequence to the equivalent value in the other sequence. The '_' symbol can be used to ignore the value at that point in the pattern for the match. " }
{ $examples
{ $description "Pattern match value1 against value2. These values can be any Factor value, including sequences and tuples. The values can contain pattern variables, which are symbols that begin with '?'. The result is a hashtable of the bindings, mapping the pattern variables from one sequence to the equivalent value in the other sequence. The '_' symbol can be used to ignore the value at that point in the pattern for the match. " }
{ $examples
{ $unchecked-example "USE: match" "MATCH-VARS: ?a ?b ;\n{ ?a { 2 ?b } 5 } { 1 { 2 3 } _ } match ." "H{ { ?a 1 } { ?b 3 } }" }
}
{ $see-also match-cond POSTPONE: MATCH-VARS: replace-patterns match-replace } ;
HELP: match-cond
{ $values { "assoc" "a sequence of pairs" } }
{ $description "Calls the second quotation in the first pair whose first sequence yields a successful " { $link match } " against the top of the stack. The second quotation, when called, has the hashtable returned from the " { $link match } " call bound as the top namespace so " { $link get } " can be used to retrieve the values. To have a fallthrough match clause use the '_' match variable." }
{ $examples
{ $description "Calls the second quotation in the first pair whose first sequence yields a successful " { $link match } " against the top of the stack. The second quotation, when called, has the hashtable returned from the " { $link match } " call bound as the top namespace so " { $link get } " can be used to retrieve the values. To have a fallthrough match clause use the '_' match variable." }
{ $examples
{ $code "USE: match" "MATCH-VARS: ?value ;\n{ increment 346126 } {\n { { increment ?value } [ ?value do-something ] }\n { { decrement ?value } [ ?value do-something-else ] }\n { _ [ no-match-found ] }\n} match-cond" }
}
{ $see-also match POSTPONE: MATCH-VARS: replace-patterns match-replace } ;
@ -26,25 +26,25 @@ HELP: MATCH-VARS:
{ $syntax "MATCH-VARS: var ... ;" }
{ $values { "var" "a match variable name beginning with '?'" } }
{ $description "Creates a symbol that can be used in " { $link match } " and " { $link match-cond } " for binding values in the matched sequence. The symbol name is created as a word that is defined to get the value of the symbol out of the current namespace. This can be used in " { $link match-cond } " to retrive the values in the quotation body." }
{ $examples
{ $examples
{ $code "USE: match" "MATCH-VARS: ?value ;\n{ increment 346126 } {\n { { increment ?value } [ ?value do-something ] }\n { { decrement ?value } [ ?value do-something-else ] }\n { _ [ no-match-found ] }\n} match-cond" }
}
{ $see-also match match-cond replace-patterns match-replace } ;
HELP: replace-patterns
{ $values { "object" object } { "result" object } }
{ $description "Copy the object, replacing each occurrence of a pattern matching variable with the actual value of that variable." }
{ $description "Copy the object, replacing each occurrence of a pattern matching variable with the actual value of that variable." }
{ $see-also match-cond POSTPONE: MATCH-VARS: match-replace } ;
HELP: match-replace
{ $values { "object" object } { "pattern1" object } { "pattern2" object } { "result" object } }
{ $description "Matches the " { $snippet "object" } " against " { $snippet "pattern1" } ". The pattern match variables in " { $snippet "pattern1" } " are assigned the values from the matching " { $snippet "object" } ". These are then replaced into the " { $snippet "pattern2" } " pattern match variables." }
{ $description "Matches the " { $snippet "object" } " against " { $snippet "pattern1" } ". The pattern match variables in " { $snippet "pattern1" } " are assigned the values from the matching " { $snippet "object" } ". These are then replaced into the " { $snippet "pattern2" } " pattern match variables." }
{ $examples
{ $example
"USING: match prettyprint ;"
"IN: scratchpad"
"MATCH-VARS: ?a ?b ;"
"{ 1 2 } { ?a ?b } { ?b ?a } match-replace ."
"{ 1 2 } { ?a ?b } { ?b ?a } match-replace ."
"{ 2 1 }"
}
}

View File

@ -42,4 +42,3 @@ HELP: c>q
HELP: euler
{ $values { "phi" number } { "theta" number } { "psi" number } { "q" "a quaternion" } }
{ $description "Convert a rotation given by Euler angles (phi, theta, and psi) to a quaternion." } ;

View File

@ -24,5 +24,5 @@ $nl
"Computing the factorial of 100 with a descending range:"
{ $code "100 1 [a,b] product" }
"A range can be converted into a concrete sequence using a word such as " { $link >array } ". In most cases this is unnecessary since ranges implement the sequence protocol already. It is necessary if a mutable sequence is needed, for use with words such as " { $link set-nth } " or " { $link map! } "." ;
ABOUT: "math.ranges"

View File

@ -48,4 +48,3 @@ HELP: >fraction
HELP: 2>fraction
{ $values { "a/b" rational } { "c/d" rational } { "a" integer } { "c" integer } { "b" "a positive integer" } { "d" "a positive integer" } }
{ $description "Extracts the numerator and denominator of two rational numbers at once." } ;

View File

@ -73,7 +73,7 @@ HELP: sample-var
{ $example "USING: math.statistics prettyprint ;" "{ 1 2 3 } sample-var ." "1" }
{ $example "USING: math.statistics prettyprint ;" "{ 1 2 3 4 } sample-var ." "1+2/3" } } ;
HELP: population-cov
HELP: population-cov
{ $values { "{x}" sequence } { "{y}" sequence } { "cov" "a real number" } }
{ $description "Computes the covariance of two sequences, " { $snippet "{x}" } " and " { $snippet "{y}" } "." } ;

View File

@ -5,7 +5,7 @@ IN: mime.types
HELP: mime-db
{ $values
{ "seq" sequence } }
{ $description "Outputs an array where the first element is a MIME type and the rest of the array is file extensions that have that MIME type." } ;
@ -17,13 +17,13 @@ HELP: mime-type
HELP: mime-types
{ $values
{ "assoc" assoc } }
{ $description "Outputs an " { $snippet "assoc" } " made from the data in the " { $link mime-db } " word where the keys are file extensions and the values are the corresponding MIME types." } ;
HELP: nonstandard-mime-types
{ $values
{ "assoc" assoc } }
{ $description "A list of Factor-specific MIME types that are added to the MIME database loaded from disk." } ;

View File

@ -23,7 +23,7 @@ $nl
"Mirrors are created by calling " { $link <mirror> } " or " { $link make-mirror } "." } ;
HELP: <mirror>
{ $values { "object" object } { "mirror" mirror } }
{ $values { "object" object } { "mirror" mirror } }
{ $description "Creates a " { $link mirror } " reflecting an object." }
{ $examples
{ $example

View File

@ -113,17 +113,17 @@ HELP: range-max-value*
HELP: set-range-value
{ $values { "value" object } { "model" model } }
{ $description "Sets the current value of a range model." }
{ $description "Sets the current value of a range model." }
{ $side-effects "model" } ;
HELP: set-range-page-value
{ $values { "value" object } { "model" model } }
{ $description "Sets the page size of a range model." }
{ $description "Sets the page size of a range model." }
{ $side-effects "model" } ;
HELP: set-range-min-value
{ $values { "value" object } { "model" model } }
{ $description "Sets the minimum value of a range model." }
{ $description "Sets the minimum value of a range model." }
{ $side-effects "model" } ;
HELP: set-range-max-value

View File

@ -59,8 +59,8 @@ ARTICLE: "range-model-protocol" "Range model protocol"
range-max-value*
set-range-value
set-range-page-value
set-range-min-value
set-range-max-value
set-range-min-value
set-range-max-value
} ;
ABOUT: "models-range"

View File

@ -40,4 +40,4 @@ ARTICLE: "opengl.annotations" "OpenGL error reporting"
reset-gl-functions
} ;
ABOUT: "opengl.annotations"
ABOUT: "opengl.annotations"

View File

@ -87,5 +87,3 @@ ARTICLE: "opengl-modeling-transformations" "Modeling transformations"
{ glTranslatef glTranslated glRotatef glRotated glScalef glScaled }
related-words

View File

@ -69,7 +69,7 @@ HELP: gl-program
} ;
HELP: <gl-program>
{ $values { "shaders" "A sequence of " { $link gl-shader } " objects." } { "program" "a new " { $link gl-program } } }
{ $values { "shaders" "A sequence of " { $link gl-shader } " objects." } { "program" "a new " { $link gl-program } } }
{ $description "Creates a new GLSL program object, attaches all the shader objects in the " { $snippet "shaders" } " sequence, and attempts to link them. The returned object can be checked for validity by " { $link check-gl-program } " or " { $link gl-program-ok? } ". Errors and warnings generated by the GLSL linker will be collected in the info log, available from " { $link gl-program-info-log } ".\n\nWhen the program object and its attached shaders are no longer needed, it should be deleted using " { $link delete-gl-program } "." } ;
HELP: <simple-gl-program>

View File

@ -12,4 +12,3 @@ HELP: delete-texture
HELP: make-texture
{ $values { "image" image } { "id" "an OpenGL texture ID" } }
{ $description "Creates a new OpenGL texture from a pixmap image whose dimensions are equal to " { $snippet "dim" } "." } ;

View File

@ -173,7 +173,7 @@ HELP: range-pattern
"of characters separated with a dash (-) represents the "
"range of characters from the first to the second, inclusive."
{ $examples
{ $example "USING: peg peg.parsers prettyprint strings ;" "\"a\" \"_a-zA-Z\" range-pattern parse 1string ." "\"a\"" }
{ $code "USING: peg peg.parsers prettyprint ;\n\"0\" \"^0-9\" range-pattern parse => exception"}
{ $example "USING: peg peg.parsers prettyprint strings ;" "\"a\" \"_a-zA-Z\" range-pattern parse 1string ." "\"a\"" }
{ $code "USING: peg peg.parsers prettyprint ;\n\"0\" \"^0-9\" range-pattern parse => exception"}
}
} ;

View File

@ -41,4 +41,3 @@ HELP: replace
}
{ $example "USING: math math.parser peg peg.parsers peg.search prettyprint ;" "\"one 123 two 456\" 'integer' [ 2 * number>string ] action replace ." "\"one 246 two 912\"" }
{ $see-also search } ;

View File

@ -14,7 +14,7 @@ HELP: force
HELP: LAZY:
{ $syntax "LAZY: word ( stack -- effect ) definition... ;" }
{ $values { "word" "a new word to define" } { "definition" "a word definition" } }
{ $description "Creates a lazy word in the current vocabulary. When executed the word will return a " { $link promise } " that when forced, executes the word definition. Any values on the stack that are required by the word definition are captured along with the promise." }
{ $description "Creates a lazy word in the current vocabulary. When executed the word will return a " { $link promise } " that when forced, executes the word definition. Any values on the stack that are required by the word definition are captured along with the promise." }
{ $examples
{ $example "USING: arrays sequences prettyprint promises ;" "IN: scratchpad" "LAZY: zeroes ( -- pair ) 0 zeroes 2array ;" "zeroes force second force first ." "0" }
} ;

View File

@ -39,7 +39,7 @@ HELP: random-32
HELP: random-bytes
{ $values { "n" integer } { "byte-array" "a random integer" } }
{ $description "Outputs an integer with n bytes worth of bits." }
{ $examples
{ $examples
{ $unchecked-example "USING: prettyprint random ;"
"5 random-bytes ."
"B{ 135 50 185 119 240 }"
@ -49,7 +49,7 @@ HELP: random-bytes
HELP: random-integers
{ $values { "length" integer } { "n" integer } { "sequence" array } }
{ $description "Outputs an array with " { $snippet "length" } " random integers from [0,n)." }
{ $examples
{ $examples
{ $unchecked-example "USING: prettyprint random ;"
"10 100 random-integers ."
"{ 32 62 71 89 54 12 57 57 10 19 }"
@ -63,7 +63,7 @@ HELP: random-unit
HELP: random-units
{ $values { "length" integer } { "sequence" array } }
{ $description "Outputs an array with " { $snippet "length" } " random uniform floats from [0,1]." }
{ $examples
{ $examples
{ $unchecked-example "USING: prettyprint random ;"
"7 random-units ."
"{

View File

@ -94,7 +94,7 @@ HELP: var-ref
HELP: <var-ref>
{ $values { "var" object } { "var-ref" var-ref } }
{ $description "Creates a reference to the given variable. Note that this reference behaves just like any variable when it comes to dynamic scope. For example, if you use " { $link set-ref } " in an inner scope and then leave that scope, then calling " { $link get-ref } " may not return the expected value. If this is not what you want, try using an " { $link obj-ref } " instead." } ;
HELP: global-var-ref
{ $class-description "Instances of this class reference a global variable. New global references are created by calling " { $link <global-var-ref> } "." } ;
@ -108,7 +108,7 @@ HELP: slot-ref
HELP: <slot-ref>
{ $values { "tuple" tuple } { "slot" integer } { "slot-ref" slot-ref } }
{ $description "Creates a reference to the value in a particular slot of the given tuple. The slot must be given as an integer, where the first user-defined slot is number 2. This is mostly just a proof of concept until we have a way of generating this slot number from a slot name." } ;
HELP: key-ref
{ $class-description "Instances of this class identify a key in an associative structure. New key references are created by calling " { $link <key-ref> } "." } ;
@ -124,7 +124,7 @@ HELP: <value-ref>
{ $description "Creates a reference to the value associated with " { $snippet "key" } " in " { $snippet "assoc" } "." } ;
{ get-ref set-ref delete-ref set-ref* } related-words
{ <obj-ref> <var-ref> <global-var-ref> <slot-ref> <key-ref> <value-ref> } related-words
HELP: set-ref*
@ -150,7 +150,7 @@ HELP: ref-dec
HELP: take
{ $values { "ref" ref } { "obj" object } }
{ $description "Retrieve the value of the ref and then delete it, returning the value." } ;
{ ref-on ref-off ref-inc ref-dec take } related-words
{ take delete-ref } related-words
{ on ref-on } related-words

View File

@ -7,7 +7,7 @@ HELP: >roman
{ $values { "n" integer } { "str" string } }
{ $description "Converts a number to its lower-case Roman Numeral equivalent." }
{ $notes "The range for this word is 1-3999, inclusive." }
{ $examples
{ $examples
{ $example "USING: io roman ;"
"56 >roman print"
"lvi"
@ -18,7 +18,7 @@ HELP: >ROMAN
{ $values { "n" integer } { "str" string } }
{ $description "Converts a number to its upper-case Roman numeral equivalent." }
{ $notes "The range for this word is 1-3999, inclusive." }
{ $examples
{ $examples
{ $example "USING: io roman ;"
"56 >ROMAN print"
"LVI"
@ -29,7 +29,7 @@ HELP: roman>
{ $values { "str" string } { "n" integer } }
{ $description "Converts a Roman numeral to an integer." }
{ $notes "The range for this word is i-mmmcmxcix, inclusive." }
{ $examples
{ $examples
{ $example "USING: prettyprint roman ;"
"\"lvi\" roman> ."
"56"
@ -41,7 +41,7 @@ HELP: roman>
HELP: roman+
{ $values { "x" string } { "y" string } { "z" string } }
{ $description "Adds two Roman numerals." }
{ $examples
{ $examples
{ $example "USING: io roman ;"
"\"v\" \"v\" roman+ print"
"x"
@ -51,7 +51,7 @@ HELP: roman+
HELP: roman-
{ $values { "x" string } { "y" string } { "z" string } }
{ $description "Subtracts two Roman numerals." }
{ $examples
{ $examples
{ $example "USING: io roman ;"
"\"x\" \"v\" roman- print"
"v"
@ -63,7 +63,7 @@ HELP: roman-
HELP: roman*
{ $values { "x" string } { "y" string } { "z" string } }
{ $description "Multiplies two Roman numerals." }
{ $examples
{ $examples
{ $example "USING: io roman ;"
"\"ii\" \"iii\" roman* print"
"vi"
@ -73,7 +73,7 @@ HELP: roman*
HELP: roman/i
{ $values { "x" string } { "y" string } { "z" string } }
{ $description "Computes the integer division of two Roman numerals." }
{ $examples
{ $examples
{ $example "USING: io roman ;"
"\"v\" \"iv\" roman/i print"
"i"
@ -83,7 +83,7 @@ HELP: roman/i
HELP: roman/mod
{ $values { "x" string } { "y" string } { "z" string } { "w" string } }
{ $description "Computes the quotient and remainder of two Roman numerals." }
{ $examples
{ $examples
{ $example "USING: kernel io roman ;"
"\"v\" \"iv\" roman/mod [ print ] bi@"
"i\ni"
@ -94,7 +94,7 @@ HELP: roman/mod
HELP: ROMAN:
{ $description "A parsing word that reads the next token and converts it to an integer." }
{ $examples
{ $examples
{ $example "USING: prettyprint roman ;"
"ROMAN: v ."
"5"

View File

@ -17,7 +17,7 @@ HELP: object>bytes
{ $description "Serializes the object to a byte array." } ;
HELP: bytes>object
{ $values { "bytes" byte-array } { "obj" "deserialized object" }
{ $values { "bytes" byte-array } { "obj" "deserialized object" }
}
{ $description "Deserializes an object from a byte array." } ;

View File

@ -30,7 +30,7 @@ HELP: push-new
{ $code """foo <struct>
5 >>a
6 >>b
foo-vector{ } clone push""" }
foo-vector{ } clone push""" }
"By using " { $snippet "push-new" } ", the new struct can be allocated directly from the vector and the intermediate copy can be avoided:"
{ $code """foo-vector{ } clone push-new
5 >>a

View File

@ -3,4 +3,4 @@ USING: help.markup help.syntax ;
HELP: break
{ $description "A breakpoint. When this word is executed, the walker tool opens with execution suspended at the breakpoint's location." }
{ $see-also "ui-walker" } ;
{ $see-also "ui-walker" } ;

View File

@ -9,11 +9,11 @@ HELP: <coverage-state>
{ "executed?" boolean }
{ "coverage-state" coverage-state }
}
{ $description "Makes a coverage tuple. Users should not call this directly." } ;
{ $description "Makes a coverage tuple. Users should not call this directly." } ;
HELP: each-word
{ $values
{ "string" string } { "quot" quotation }
{ "string" string } { "quot" quotation }
}
{ $description "Calls a quotation on every word in the vocabulary and its private vocabulary, if there is one." } ;
@ -39,7 +39,7 @@ HELP: coverage-on
HELP: coverage.
{ $values
{ "object" object }
{ "object" object }
}
{ $description "Calls the coverage word on all the words in a vocabalary or on a single word and prints out a report." } ;
@ -52,7 +52,7 @@ HELP: %coverage
HELP: add-coverage
{ $values
{ "object" object }
{ "object" object }
}
{ $description "Recompiles a vocabulary with the coverage annotation. Note that the annotation tool is still disabled until you call " { $link coverage-on } "." } ;
@ -64,19 +64,19 @@ HELP: covered
HELP: flag-covered
{ $values
{ "coverage" object }
{ "coverage" object }
}
{ $description "A word that sets the " { $snippet "executed?" } " slot of the coverage tuple when the covered value is true." } ;
HELP: remove-coverage
{ $values
{ "object" object }
{ "object" object }
}
{ $description "Recompiles a vocabulary without the coverage annotation." } ;
HELP: reset-coverage
{ $values
{ "object" object }
{ "object" object }
}
{ $description "Sets the " { $snippet "execute?" } " slot of each coverage tuple to false." } ;

View File

@ -7,4 +7,3 @@ ARTICLE: "tools.coverage.testvocab" "Coverage tool dummy test vocabulary"
"The " { $vocab-link "tools.coverage.testvocab" } " vocabulary is just a dummy vocabulary to test " { $vocab-link "tools.coverage" } "." ;
ABOUT: "tools.coverage.testvocab"

View File

@ -47,4 +47,4 @@ $nl
{ $subsections errors. }
"Batch errors are reported in the " { $link "ui.tools.error-list" } "." ;
ABOUT: "tools.errors"
ABOUT: "tools.errors"

View File

@ -26,4 +26,4 @@ $nl
"T{ point f 1 2 }"
} ;
ABOUT: "tuple-arrays"
ABOUT: "tuple-arrays"

View File

@ -97,7 +97,7 @@ HELP: $command
{ $description "Prints the keyboard shortcut associated with " { $snippet "command" } " in the command map named " { $snippet "map" } " on the class " { $snippet "class" } "." } ;
HELP: define-command
{ $values { "word" word } { "hash" hashtable } }
{ $values { "word" word } { "hash" hashtable } }
{ $description "Defines a command. The hashtable can contain the following keys:"
{ $list
{ { $link +nullary+ } " - if set to a true value, the word must have stack effect " { $snippet "( -- )" } "; otherwise it must have stack effect " { $snippet "( target -- )" } }

View File

@ -16,4 +16,4 @@ ARTICLE: "ui.gadgets.grid-lines" "Grid lines"
<grid-lines>
} ;
ABOUT: "ui.gadgets.grid-lines"
ABOUT: "ui.gadgets.grid-lines"

View File

@ -34,4 +34,4 @@ $nl
y>line
} ;
ABOUT: "ui.gadgets.line-support"
ABOUT: "ui.gadgets.line-support"

View File

@ -21,11 +21,11 @@ HELP: invoke-presentation
{ invoke-presentation invoke-primary invoke-secondary } related-words
HELP: invoke-primary
{ $values { "presentation" presentation } }
{ $values { "presentation" presentation } }
{ $description "Invokes the " { $link primary-operation } " associated to the " { $snippet "object" } ". This word is executed when the presentation is clicked with the left mouse button." } ;
HELP: invoke-secondary
{ $values { "presentation" presentation } }
{ $values { "presentation" presentation } }
{ $description "Invokes the " { $link secondary-operation } " associated to the " { $snippet "object" } ". This word is executed when a list receives a " { $snippet "RET" } " key press." } ;
HELP: <presentation>

View File

@ -72,4 +72,4 @@ $nl
"ui.gadgets.tables.example"
} ;
ABOUT: "ui.gadgets.tables"
ABOUT: "ui.gadgets.tables"

View File

@ -120,4 +120,3 @@ $nl
"gl-utilities"
"text-rendering"
} ;

View File

@ -2,11 +2,11 @@ IN: ui.pens
USING: help.markup help.syntax kernel ui.gadgets ;
HELP: draw-interior
{ $values { "gadget" gadget } { "pen" object } }
{ $values { "gadget" gadget } { "pen" object } }
{ $contract "Draws the interior of a gadget by making OpenGL calls. The " { $snippet "interior" } " slot may be set to objects implementing this generic word." } ;
HELP: draw-boundary
{ $values { "gadget" gadget } { "pen" object } }
{ $values { "gadget" gadget } { "pen" object } }
{ $contract "Draws the boundary of a gadget by making OpenGL calls. The " { $snippet "boundary" } " slot may be set to objects implementing this generic word." } ;
ARTICLE: "ui-pen-protocol" "UI pen protocol"

View File

@ -26,7 +26,7 @@ HELP: clip
{ $var-description "The current clipping rectangle." } ;
HELP: draw-gadget*
{ $values { "gadget" gadget } }
{ $values { "gadget" gadget } }
{ $contract "Draws the gadget by making OpenGL calls. The top-left corner of the gadget should be drawn at the location stored in the " { $link origin } " variable." }
{ $notes "This word should not be called directly. To force a gadget to redraw, call " { $link relayout-1 } "." } ;

View File

@ -77,4 +77,4 @@ ARTICLE: "text-rendering" "Rendering text"
draw-string
} ;
ABOUT: "text-rendering"
ABOUT: "text-rendering"

View File

@ -13,4 +13,4 @@ ARTICLE: "ui-browser" "UI browser"
{ $command-map browser-gadget "multi-touch" }
"Browsers are instances of " { $link browser-gadget } "." ;
ABOUT: "ui-browser"
ABOUT: "ui-browser"

View File

@ -87,7 +87,7 @@ HELP: ?group-id
HELP: all-group-names
{ $values
{ "seq" sequence }
}
{ $description "Returns a sequence of group names as strings." } ;

View File

@ -5,28 +5,28 @@ IN: uuid
HELP: uuid1
{ $values { "string" "a UUID string" } }
{ $description
{ $description
"Generates a UUID (version 1) from the host ID, sequence number, "
"and current time."
} ;
HELP: uuid3
{ $values { "namespace" string } { "name" string } { "string" "a UUID string" } }
{ $description
{ $description
"Generates a UUID (version 3) from the MD5 hash of a namespace "
"UUID and a name."
} ;
HELP: uuid4
{ $values { "string" "a UUID string" } }
{ $description
"Generates a UUID (version 4) from random bits."
{ $description
"Generates a UUID (version 4) from random bits."
} ;
HELP: uuid5
{ $values { "namespace" string } { "name" string } { "string" "a UUID string" } }
{ $description
"Generates a UUID (version 5) from the SHA-1 hash of a namespace "
{ $description
"Generates a UUID (version 5) from the SHA-1 hash of a namespace "
"UUID and a name."
} ;
@ -34,7 +34,7 @@ HELP: uuid5
ARTICLE: "uuid" "UUID (Universally Unique Identifier)"
"The " { $vocab-link "uuid" } " vocabulary is used to generate UUIDs. "
"The below words can be used to generate version 1, 3, 4, and 5 UUIDs as specified in RFC 4122."
$nl
$nl
"If all you want is a unique ID, you should probably call " { $link uuid1 } " or " { $link uuid4 } "."
{ $subsections
uuid1
@ -45,5 +45,3 @@ $nl
;
ABOUT: "uuid"

View File

@ -40,7 +40,7 @@ HELP: v-max-value
{ $description "Throws an error if " { $snippet "x" } " is larger than " { $snippet "n" } "." } ;
HELP: v-min-value
{ $values { "x" integer } { "n" integer } }
{ $values { "x" integer } { "n" integer } }
{ $description "Throws an error if " { $snippet "x" } " is smaller than " { $snippet "n" } "." } ;
HELP: v-mode

View File

@ -24,4 +24,3 @@ HELP: wrap-string
HELP: wrap-indented-string
{ $values { "string" string } { "width" integer } { "indent" "string or integer" } { "newstring" string } }
{ $description "Given a " { $snippet "string" } ", alters the whitespace in the string so that each line has no more than " { $snippet "width" } " characters, unless there is a word longer than " { $snippet "width" } ". Linear whitespace between words is converted to a single space. The " { $snippet "indent" } " can be either a " { $link string } " or a number of spaces to prepend to each line." } ;

View File

@ -7,5 +7,5 @@ ABOUT: "wrap"
ARTICLE: "wrap" "Word wrapping"
"The " { $vocab-link "wrap" } " vocabulary implements word wrapping. Wrapping can take place based on simple strings, assumed to be monospace, or abstract word objects."
{ $vocab-subsection "String word wrapping" "wrap.strings" }
{ $vocab-subsection "String word wrapping" "wrap.strings" }
{ $vocab-subsection "Word object wrapping" "wrap.words" } ;

View File

@ -21,4 +21,3 @@ HELP: entities
HELP: with-entities
{ $values { "entities" "a hash table of strings to strings" } { "quot" "a quotation ( -- )" } }
{ $description "Calls the quotation using the given table of entity values (symbolizing, eg, that " { $snippet "&foo;" } " represents " { $snippet "\"a\"" } ") on top of the default XML entities" } ;

View File

@ -53,7 +53,7 @@ ARTICLE: { "xml.syntax" "interpolation" } "XML interpolation syntax"
"XML interpolation has two forms for each of the words " { $link POSTPONE: <XML } " and " { $link POSTPONE: [XML } ": a fry-like form and a locals form. To splice locals in, use the syntax " { $snippet "<-variable->" } ". To splice something in from the stack, in the style of " { $vocab-link "fry" } ", use the syntax " { $snippet "<->" } ". An XML interpolation form may only use one of these styles."
$nl
"These forms can be used where a tag might go, as in " { $snippet "[XML <foo><-></foo> XML]" } " or where an attribute might go, as in " { $snippet "[XML <foo bar=<->/> XML]" } ". When an attribute is spliced in, it is not included if the value is " { $snippet "f" } " and if the value is not a string, the value is put through " { $link present } ". Here is an example of the fry style of XML interpolation:"
{ $example
{ $example
"""USING: splitting xml.writer xml.syntax ;
"one two three" " " split
[ [XML <item><-></item> XML] ] map

View File

@ -36,5 +36,5 @@ HELP: >byte-vector
HELP: BV{
{ $syntax "BV{ elements... }" }
{ $values { "elements" "a list of bytes" } }
{ $description "Marks the beginning of a literal byte vector. Literal byte vectors are terminated by " { $link POSTPONE: } } "." }
{ $description "Marks the beginning of a literal byte vector. Literal byte vectors are terminated by " { $link POSTPONE: } } "." }
{ $examples { $code "BV{ 1 2 3 12 }" } } ;

Some files were not shown because too many files have changed in this diff Show More