Skip to content

Utils

The utils macro contains different utility macros to create more complex stuff more easily.

Available variants

There currently exists 1 variant.


{{ utils.table(entries) }}

The utils.table macro adds a table not unlike the game.history table, meaning multiple collumns on the right side can belong to the same column on the left side.
Do note that the entries option can/should be treated like JSON with each string holding an array of entries. See the Example for how it may look.

Options

Option Required Default Description
entries Yes (Empty list) List of Entry Strings containing entries of their changes.

Example

{{ utils.table({
    'Added': [
        'Something'
    ],
    'Fixed': [
        'A bug',
        'Something else'
    ]
}) }}
Added Something
Fixed A bug
Something else

{{ utils.removed(version, type) }}

The utils.removed macro adds a simple admonition box with the text <type> got removed in <version> to inform about a feature, command, etc. being removed.

Options

Option Required Default Description
version Yes (Empty) The version in which the mentioned type got removed.
type No Feature The type that got removed (e.g. Command, Tile, etc.)

Example

{{ utils.removed(version="1.0") }}

Feature removed in 1.0

{{ utils.removed(version="1.0", type="Command") }}

Command removed in 1.0