Conventions

This section explains several conventions used in this documentation.

Symbols

This documentation use some symbols for illustration purposes. Before you read on, please make sure you've made yourself familiar with the following list of conventions:

– Version

The tag symbol in conjunction with a version number denotes when a specific feature or behavior was added. Make sure you're at least on this version if you want to use it.

– Default value

Some params of the functions have default values for when the user does not explicitly define them. The default value of the property is always included.

– Default value is empty

Some properties do not contain default values. This means that the functionality that is associated with them is not available unless explicitly enabled.

– Experimental

Some newer features are still considered experimental, which means they might (although rarely) change at any time, including their complete removal.

– Required value

Some properties or settings are required, which means the user must explicitly define them.

– Customization

This symbol denotes that the thing described is a customization that must be added by the user.

– Utility

There are some utilities that build on top of Apep in order to provide extended functionality