Module advtrains_doc_integration.hypertext
Utilities for hypertext used in Minetest formspecs.
Functions
| escape (str) | Escapes the given hypertext. |
| plain (str[, noescape]) | Create a plain text hypertext element. |
| mono (str[, noescape]) | Create a hypertext element with monospace text. |
| bold (str[, noescape]) | Create a hypertext element with bold text. |
| italic (str[, noescape]) | Create a hypertext element with italic text. |
| header (str[, noescape]) | Create a hypertext element with text formatted as header. |
| listitem (str[, noescape]) | Create a hypertext element with text formatted as an item in a list. |
| action (action, str[, noescape]) | Create a hypertext element with an action. |
| describe_sound ([action], soundspec) | Describe a soundspec. |
| describe_coupler (coupler) | Describe a coupler type. |
| describe_item (item) | Describe an item. |
| describe_function (f) | Describe a function. |
Functions
- escape (str)
-
Escapes the given hypertext.
Parameters:
- str string The text to escape.
Returns:
-
string
The escaped text.
- plain (str[, noescape])
-
Create a plain text hypertext element.
Parameters:
- str string The content of the element.
- noescape boolean Whether to avoid escaping the content. (optional)
Returns:
-
string
The hypertext element containing the text.
- mono (str[, noescape])
-
Create a hypertext element with monospace text.
Parameters:
- str string The content of the element.
- noescape boolean Whether to avoid escaping the content. (optional)
Returns:
-
string
The hypertext element containing the text.
- bold (str[, noescape])
-
Create a hypertext element with bold text.
Parameters:
- str string The content of the element.
- noescape boolean Whether to avoid escaping the content. (optional)
Returns:
-
string
The hypertext element containing the text.
- italic (str[, noescape])
-
Create a hypertext element with italic text.
Parameters:
- str string The content of the element.
- noescape boolean Whether to avoid escaping the content. (optional)
Returns:
-
string
The hypertext element containing the text.
- header (str[, noescape])
-
Create a hypertext element with text formatted as header.
Parameters:
- str string The content of the element.
- noescape boolean Whether to avoid escaping the content. (optional)
Returns:
-
string
The hypertext element containing the text.
- listitem (str[, noescape])
-
Create a hypertext element with text formatted as an item in a list.
Parameters:
- str string The content of the element.
- noescape boolean Whether to avoid escaping the content. (optional)
Returns:
-
string
The hypertext element containing the text.
- action (action, str[, noescape])
-
Create a hypertext element with an action.
Parameters:
- action string The name of the action.
- str string The content of the element.
- noescape boolean Whether to avoid escaping the content. (optional)
Returns:
-
string
The hypertext element containing the text.
- describe_sound ([action], soundspec)
-
Describe a soundspec.
Parameters:
- action string The name of the action. (optional)
- soundspec SimpleSoundSpec The soundspec to describe.
Returns:
-
string
The hypertext element describing the soundspec.
- describe_coupler (coupler)
-
Describe a coupler type.
Parameters:
- coupler string The name of the coupler.
Returns:
-
string
The hypertext element describing the coupler.
- describe_item (item)
-
Describe an item.
Parameters:
- item ItemStack The item to describe
Returns:
-
string
The hypertext element describing the item.
- describe_function (f)
-
Describe a function.
Parameters:
- f function The function to describe.
Returns:
-
string or nil
The hypertext element describing the function if a sufficiently informative description is available.