Formspec: Mark hypertext and markup language as unstable

This commit is contained in:
v-rob 2020-03-28 13:54:19 -07:00 committed by GitHub
parent 13b228513e
commit 9953145a4e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -2255,9 +2255,10 @@ Elements
### `hypertext[<X>,<Y>;<W>,<H>;<name>;<text>]` ### `hypertext[<X>,<Y>;<W>,<H>;<name>;<text>]`
* Displays a static formatted text with hyperlinks. * Displays a static formatted text with hyperlinks.
* **Note**: This element is currently unstable and subject to change.
* `x`, `y`, `w` and `h` work as per field * `x`, `y`, `w` and `h` work as per field
* `name` is the name of the field as returned in fields to `on_receive_fields` in case of action in text. * `name` is the name of the field as returned in fields to `on_receive_fields` in case of action in text.
* `text` is the formatted text using `markup language` described below. * `text` is the formatted text using `Markup Language` described below.
### `vertlabel[<X>,<Y>;<label>]` ### `vertlabel[<X>,<Y>;<label>]`
* Textual label drawn vertically * Textual label drawn vertically
@ -2643,11 +2644,12 @@ Some types may inherit styles from parent types.
* noclip - boolean, set to true to allow the element to exceed formspec bounds. * noclip - boolean, set to true to allow the element to exceed formspec bounds.
* textcolor - color. Default white. * textcolor - color. Default white.
Markup language Markup Language
--------------- ---------------
Markup language used in `hypertext[]` elements uses tag that look like HTML tags. Some Markup language used in `hypertext[]` elements uses tags that look like HTML tags.
tags can enclose text, they open with `<tagname>` and close with `</tagname>`. The markup language is currently unstable and subject to change. Use with caution.
Some tags can enclose text, they open with `<tagname>` and close with `</tagname>`.
Tags can have attributes, in that case, attributes are in the opening tag in Tags can have attributes, in that case, attributes are in the opening tag in
form of a key/value separated with equal signs. Attribute values should not be quoted. form of a key/value separated with equal signs. Attribute values should not be quoted.