Macros to render information in a visually appealing format.

Audience
Level of Experience
Type

The macros listed in this document help to render information in a visually appealing format. The information is easier to understand or quicker to find.

Contents

 

Boxes

Boxes highlight information for the reader.

Reader Boxes

The information of the boxes is provided for the reader.

Standard Boxes

Boxes that are an industry standard.

Extra Boxes

Extra boxes that may be useful in special contexts.

Collaboration Boxes

The information of the boxes is provided for authors. This is a collaboration tool to create documentation with a team.

Generic Box

The Generic Box Macro helps to define boxes using CSS.

Definition List

Definition lists allow a compact representation of key value pairs. Definition lists are also often used for glossaries.

Code Renderer

Code render allow to pretty print code snippets.

Project Quotes

Projects often reference quotes and cite information. These macros help to render them similarly.

Extension Add-on Macros

The following macros are provided by extensions to render information visually appealing.