Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
doctypemacro
overridefalse


Doctypemacrohide
NameCaution Box Macro
Short DescriptionRenders a box containing a caution message.
Parent
Parent Property
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAuthor

Categories
Name List
doctypecategory
namesBox / Reader

Tags
Tag List
namesBox, Standard

Iteration
Iteration
valueproduction
hide
Sort Keyhide



Section
indextrue
show-titlefalse
titleDescription

According to

Cite
template$[Name] (${Authors})
documentPDAC:Ament2003
authors should stick to the industry standard of using note, tip, warning, and caution boxes.

The caution box is used as follows:

Quote
source-wiki-pagePDAC:Ament2003

Negative alert that a particular action can result in data loss, data corruption, security problems, or performance problems.


...

Section
titleProperties

The macro provides the following properties for configuration.

Section
titleTitle

The title is an optional parameter.

Here is an example with title:

Caution Box
titleThe title of the Caution Box

This is a caution message.



Section
titleShow Icon

The checkbox allows to remove the icon from the box.

Caution Box
titleThe title of the Caution Box
show-iconfalse

This is a caution message.



Section
titleTags

Tag the box to use for transclusion.

By default the tag caution-box is added.

Version Box
since2.3

Transclusion for boxes is supported since version 2.3.




Section
titleDetails


Transclusion
documentprint-quirk-modes Hint for Box Macros
idsContent


...