aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorv-rob <robinsonvincent89@gmail.com>2020-03-28 13:54:19 -0700
committerGitHub <noreply@github.com>2020-03-28 21:54:19 +0100
commit9953145a4efe5d2487ec8f5edc76cf8e418b7b41 (patch)
tree2c741a30f4bdfe67345bf82d58775e97a5c0e512 /doc
parent13b228513e5bafafb78924cf301dae873d5d93f6 (diff)
downloadminetest-9953145a4efe5d2487ec8f5edc76cf8e418b7b41.tar.gz
minetest-9953145a4efe5d2487ec8f5edc76cf8e418b7b41.tar.bz2
minetest-9953145a4efe5d2487ec8f5edc76cf8e418b7b41.zip
Formspec: Mark `hypertext` and markup language as unstable
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index c94af6125..86e8d6575 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -2255,9 +2255,10 @@ Elements
### `hypertext[<X>,<Y>;<W>,<H>;<name>;<text>]`
* 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
* `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>]`
* 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.
* textcolor - color. Default white.
-Markup language
+Markup Language
---------------
-Markup language used in `hypertext[]` elements uses tag that look like HTML tags. Some
-tags can enclose text, they open with `<tagname>` and close with `</tagname>`.
+Markup language used in `hypertext[]` elements uses tags that look like HTML tags.
+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
form of a key/value separated with equal signs. Attribute values should not be quoted.