RichTextMark

On this page

Shape
Example
Good to know
In JSON
Details

A mark on some text: strong, emphasis, code, underline or strike_through.

Use it as part of a RichTextSpan.

Shape

One of these 5 values:

RichTextMark.strong, RichTextMark.emphasis, RichTextMark.code, RichTextMark.underline, RichTextMark.strike_through.

Example

example

RichTextMark.strong

text.parse(raw, as: RichTextMark) reads one from text that comes from outside. Text that isn't one at all fails malformed, such as bold, em or strike-through.

Good to know

== tells you whether two are the same. < and list.sort_by don't take it.

In JSON

A string, in a request, a response or json.write:

json

"strong""emphasis""code"

Details

Text form, storage, how it is shown, and operations

RichTextMark is in the group Text formats, and has been in Jadpo since 0.1.0.

Text form

text.from writes one standard text form, the same form text.parse reads back: strong, emphasis and code.

How it is stored

It is stored in one column named for the field, of type text. code is stored as 'code'.

How it is shown to people

text.format(value, locale:) shows it to people in their locale.

With locale: Locale.en_gb:

Value	Shown
`strong`	`strong`
`emphasis`	`emphasis`
`code`	`code`
`underline`	`underline`
`strike_through`	`strike_through`

Operations

It also takes text.parse, text.from, text.format, json.read, json.write and ==. How every standard type behaves says how they work.

Markdown for agents: /docs/types/type-rich-text-mark.md.Built from Jadpo main at aee2e8f.