Notes, tips, and warnings

A documentation call-out (Important, Note, Tip, or Warning) is used to highlight content aside from the main text.

Important

Important notes describe a fact that must be considered before using the related feature.

Important: This feature is not supported on mobile platforms.

Notes

Simple notes describe informative content that does not represent any risk.

Note: MONITOR control rules will be ignored by the standalone dispatcher (httpdispatch).

Tips

Tip notes suggest a helpful tidbit that can make a task easier, or an option or programming pattern to be used.

Tip: On Linux® and macOS™, you can check the available fonts using the fc-list tool.

Warnings

Warning notes highlight an action that might cause something to break or otherwise be catastrophic.

Warning: Using a high cost value for the salt is very CPU consuming, and can really slow down the application depending on the system it is running.