5.8 Style Property Datatypes

9.0.0.6

5.8 Style Property Datatypes🔗ℹ

veneer

Used as a part_style to implement a section number that increment separately from the default numbering style and that can be rendered differently than as Arabic numerals.

The Style.Numberer veneer recognizes the same values as the Racket Scribble library’s numberer?.

veneer

veneer Style.DocumentVersion

Used as a style property for a part to indicate a version number.

The Style.DocumentVersion veneer recognizes the same values as the Racket Scribble library’s document-version?.

veneer

veneer Style.DocumentDate

Latex/PDF: Used as a style property for a part to indicate a date.

The Style.DocumentDate veneer recognizes the same values as the Racket Scribble library’s document-date?.

veneer

veneer Style.DocumentSource

Used as a style property to associate a module path with a part.

The Style.DocumentSource veneer recognizes the same values as the Racket Scribble library’s document-source?.

veneer

veneer Style.Color

function

fun Style.Color(color :: String) :: Style.Color

function

fun Style.Color(red :: Byte, green :: Byte, blue :: Byte)

:: Style.Color

Used as a style property in an element_style to set the content’s color. Recognized string names for color depend on the renderer, but at the recognized set includes at least "white", "black", "red", "green", "blue", "cyan", "magenta", and "yellow".

HTML: A Style.Color is also recognized for a flow block, part (and used for the title in the latter case) or cell in a table

The Style.Color veneer recognizes the same values as the Racket Scribble library’s color-property?.

veneer

veneer Style.BackgroundColor

function

fun Style.BackgroundColor(color :: String)

:: Style.BackgroundColor

function

fun Style.BackgroundColor(red :: Byte, green :: Byte, blue :: Byte)

:: Style.BackgroundColor

Like Style.Color, but for a background color.

The Style.BackgroundColor veneer recognizes the same values as the Racket Scribble library’s background-color-property?.

veneer

veneer Style.TargetURL

function

fun Style.TargetURL(~path: path :: PathString) :: Style.TargetURL

function

fun Style.TargetURL(~url: url :: String) :: Style.TargetURL

Used as a element_style to link content to a specific URL.

The Style.TargetURL veneer recognizes the same values as the Racket Scribble library’s target-url?.

veneer

veneer Style.BoxMode

Latex/PDF: Used as a paragraph_style, nested_flow_style, table_style, itemization_style, compound_paragraph_style.

The Style.BoxMode veneer recognizes the same values as the Racket Scribble library’s box-mode?.

veneer

veneer Style.LinkRenderStyle

Used as a style property in a part_style.

The Style.LinkRenderStyle veneer recognizes the same values as the Racket Scribble library’s link-render-style?.

veneer

veneer Style.RenderConvertibleAs

HTML: Used as a style property in a part_style.

The Style.RenderConvertibleAs veneer recognizes the same values as the Racket Scribble library’s render-convertible-as?.

veneer

veneer Style.HTML.BodyId

function

fun Style.HTML.BodyId(str :: String):: Style.HTML.BodyId

HTML: Used as a style property in a part_style.

The Style.HTML.BodyId veneer recognizes the same values as the Racket Scribble library’s body-id?.

veneer

veneer Style.HTML.AltTag

function

fun Style.HTML.AltTag(

str :: String && matching(rx'[alpha digit]+')

):: Style.HTML.AltTag

HTML: Used as a style property in a element_style, paragraph_style, nested_flow_style, compound_paragraph_style.

The Style.HTML.AltTag veneer recognizes the same values as the Racket Scribble library’s alt-tag?.

veneer

veneer Style.HTML.Attributes

function

fun Style.HTML.Attributes(

attribs :: Map.of(Symbol, String) || List.of([Symbol, String])

) :: Style.HTML.Attributes

HTML: Used as a style property in a style to add attibutes to an HTML tag.

The Style.HTML.Attributes veneer recognizes the same values as the Racket Scribble library’s attributes?.

veneer

veneer Style.HTML.HeadExtra

HTML: Used as a style property in a part_style.

The Style.HTML.HeadExtra veneer recognizes the same values as the Racket Scribble library’s head-extra?.

veneer

veneer Style.HTML.HeadAddition

HTML: Used as a style property in a part_style.

The Style.HTML.HeadAddition veneer recognizes the same values as the Racket Scribble library’s head-addition?.

veneer

veneer Style.HTML.Hover

HTML: Used as a style property in a part_style or element_style.

The Style.HTML.Hover veneer recognizes the same values as the Racket Scribble library’s hover-property?.

veneer

veneer Style.HTML.URLAnchor

function

fun Style.HTML.URLAnchor(str :: String):: Style.HTML.URLAnchor

HTML: Used as a style property in an element_style.

The Style.HTML.URLAnchor veneer recognizes the same values as the Racket Scribble library’s url-anchor?.

veneer

veneer Style.HTML.PartTitleAndContentWrapper

HTML: Used as a style property in a part_style.

The Style.HTML.PartTitleAndContentWrapper veneer recognizes the same values as the Racket Scribble library’s part-title-and-content-wrapper.

veneer

veneer Style.HTML.PartLinkRedirect

HTML: Used as a style property in a part_style.

The Style.HTML.PartLinkRedirect veneer recognizes the same values as the Racket Scribble library’s part-link-redirect?.

veneer

veneer Style.HTML.Script

function

fun Style.HTML.Script(

script :: PathString || List.of(String)

):: Style.HTML.Script

HTML: Used as a style property in an element_style to supply a script alternative to the element content.

The Style.HTML.Script veneer recognizes the same values as the Racket Scribble library’s script-property?.

veneer

veneer Style.HTML.Xexpr

HTML: Used as a style property in an element_style to supply literal HTML that is rendered before and after element content.

The Style.HTML.Xexpr veneer recognizes the same values as the Racket Scribble library’s xexpr-property?.

veneer

veneer Style.Latex.CommandExtras

function

fun Style.Latex(extras :: List.of(String))

:: Style.Latex.CommandExtras

Latex/PDF: Used as a style property in an element_style to to add extra arguments to the element’s command in Latex output.

The Style.Latex.CommandExtras veneer recognizes the same values as the Racket Scribble library’s command-extras?.

1	Getting Started
2	Overview
3	Core Scribble
4	Documentation Scribble
5	Styles and Style Properties
6	Scribble Libraries

5.1	Element Styles
5.2	Part and Section Styles
5.3	Paragraph Styles
5.4	Table, Column, and Cell Styles
5.5	Itemization Styles
5.6	Nested Flow Styles
5.7	Compound Paragraph Styles
5.8	Style Property Datatypes