Versions Compared

Key

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

...

Document Properties Marker
doctypemacro
overridefalse


Doctypemacrohide
NameDeprecated Box Macro 
Short DescriptionRenders a box containing a deprecation warning for the reader. 
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, Extra
 
Iteration
Iteration
valueproduction
hide
Sort Keyhide



Section
indextrue
show-titlefalse
titleDescription
A deprecation message signals the reader that the information provided is already deprecated.

...

Section
titleProperties

The macro provides the following properties for configuration.

Section
titleTitle

The title is an optional parameter.

Here is an example with title:

Deprecated Box
titleThe title of the Deprecated Box

 This is a deprecation warning for the reader.



Section
titleShow Icon

The checkbox allows to remove the icon from the box.

Deprecated Box
titleThe title of the Deprecated Box
show-iconfalse

 This is a deprecation warning for the reader.



Section
titleTags

Tag the box to use for transclusion.

By default the tag deprecated-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


...