Versions Compared

Key

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


Document Properties Marker
doctypemacro
overridefalse


Doctypemacrohide
NameInfo Box Macro 
Short DescriptionRenders a box containing an info 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, Extra
 
Iteration
Iteration
valueproduction
hide
Sort Keyhide



Section
indextrue
show-titlefalse
titleDescription

Provides a short information for the reader.

Consider if using the Tip Box or the Note Box is more appropriate, since those boxes are industry standards.


Section
titleProperties

The macro provides the following properties for configuration.

Section
titleTitle

The title is an optional parameter.

Here is an example with title:

Info Box
titleThe title of Info Box

This is an informative note for the reader.



Section
titleShow Icon

The checkbox allows to remove the icon from the box.

Info Box
titleThe title of Info Box
show-iconfalse

This is an informative note for the reader.



Section
titleTags

Tag the box to use for transclusion.

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



Section
indextrue
titleRelated macros

Here is a list of alternative boxes to use for your texts:

Display Table
doctypemacro
selectName, Short Description, Tags
whereCategories = "Box / Reader"
exclude-selftrue


Section
indextrue
titleSub-Macros
Display Table
doctypemacro
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name


Section
titleNotes


Section
titleReferences


Section
titleResources



Piwik Set Multiple Custom Variables


NameValue
Departmentprojectdoc
Categoryprojectdoc-macro
Typedocument