diff --git a/library/io/styles.facts b/library/io/styles.facts new file mode 100644 index 0000000000..77b371444b --- /dev/null +++ b/library/io/styles.facts @@ -0,0 +1,100 @@ +USING: help styles io ; + +HELP: plain f +{ $description "A value for the " { $link font-style } " character style denoting plain text." } ; + +HELP: bold f +{ $description "A value for the " { $link font-style } " character style denoting boldface text." } ; + +HELP: italic f +{ $description "A value for the " { $link font-style } " character style denoting italicized text." } ; + +HELP: bold-italic f +{ $description "A value for the " { $link font-style } " character style denoting boldface italicized text." } ; + +HELP: foreground f +{ $description "Character style. Text color, denoted by a sequence of four numbers between 0 and 1 (red, green, blue and alpha)." } +{ $examples + { $code + "\"Hello world\" 10 [" + " { 0.1 0.1 0.2 1 } n*v { 1 1 1 1 } vmin" + " foreground associate format terpri" + "] each-with" + } +} ; + +HELP: background f +{ $description "Character style. Background color, denoted by a sequence of four numbers between 0 and 1 (red, green, blue and alpha)." } +{ $examples + { $code + "\"Hello world\" 10 [" + " { 0.1 0.4 0.1 } n*v { 1 1 1 } vmin { 1 } append" + " background associate format terpri" + "] each-with" + } +} ; + +HELP: font f +{ $description "Character style. Font family named by a string." } +{ $examples + "This example outputs some different font sizes:" + { $code "{ \"Monospaced\" \"Serif\" \"Sans Serif\" }\n[ dup font associate format terpri ] each" } +} ; + +HELP: font-size f +{ $description "Character style. Font size, an integer." } +{ $examples + "This example outputs some different font sizes:" + { $code "\"Bigger\" { 12 18 24 72 }\n[ font-size associate format terpri ] each-with" } +} ; + +HELP: font-style f +{ $description "Character style. Font style, one of " { $link plain } ", " { $link bold } ", " { $link italic } ", or " { $link bold-italic } "." } +{ $examples + "This example outputs text in all three styles:" + { $code "{ plain bold italic bold-italic }\n[ [ word-name ] keep font-style associate format terpri ] each" } +} ; + +HELP: presented f +{ $description "Character and paragraph style. An object associated with the text. In the Factor UI, this is shown as a clickable presentation of the object; left-clicking invokes a default command, and right-clicking shows a menu of commands." } +{ $see-also simple-object write-object } ; + +HELP: file f +{ $description "Character style. A pathname associated with the text. In the Factor HTTP server, this is rendered as a link to this path on the server." } ; + +HELP: word-break f +{ $description "Character style. Denotes that this text is a point in the text where the line can be wrapped." } +{ $see-also bl } ; + +HELP: page-color f +{ $description "Paragraph style. Background color of the paragraph block, denoted by a sequence of four numbers between 0 and 1 (red, green, blue and alpha)." } +{ $examples + { $code "H{ { page-color { 1 0.8 0.5 1 } } }\n[ \"A background\" write ] with-nesting terpri" } +} ; + +HELP: border-color f +{ $description "Paragraph style. Border color of the paragraph block, denoted by a sequence of four numbers between 0 and 1 (red, green, blue and alpha)." } +{ $examples + { $code "H{ { border-color { 1 0 0 1 } } }\n[ \"A border\" write ] with-nesting terpri" } +} ; + +HELP: border-width f +{ $description "Paragraph style. Pixels between edge of text and border color, an integer." } +{ $examples + { $code "H{ { border-width 10 } }\n[ \"Some inset text\" write ] with-nesting terpri" } +} ; + +HELP: wrap-margin f +{ $description "Paragraph style. Pixels between left margin and right margin where text is wrapped, an integer." } +{ $see-also bl } ; + +HELP: outline f +{ $description "Paragraph style. In the Factor UI, a quotation executed to produce outliner content when the outliner widget next to the paragraph block is expanded." } +{ $see-also simple-outliner write-outliner } ; + +HELP: input f +{ $description "A wrapper class. In the Factor UI, presentations of this class are output as blocks of text which insert themselves in the listener's input area when clicked." } +{ $examples + "This presentation class is used for the code examples you see in the online help:" + { $code "\"2 3 + .\" dup simple-object terpri" } +} ;