Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Document clean process

...

Document Properties Marker
doctypemacro
overridefalse


Doctypemacrohide
NameNote Box Macro
 
Short DescriptionRenders something to note by 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, 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 note box is used as follows:

Quote
source-wiki-pagePDAC:Ament2003

Neutral or positive clarification that applies only in special cases, or that qualifies important points.


...

Section
titleProperties

The macro provides the following properties for configuration.

Section
titleTitle

The title is an optional parameter.

Here is an example with title:

Note Box
titleThe title of the Note Box

This a note for the reader.



Section
titleShow Icon

The checkbox allows to remove the icon from the box.

Note Box
titleThe title of the Note Box
show-iconfalse

This a note for the reader.



Section
titleTags

Tag the box to use for transclusion.

By default the tag note-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
render-no-hits-as-blanktrue
selectName, Short Description, Tags
sort-bySort Key, Name
whereCategories = "Box / Reader"
exclude-selftrue

...

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


Section
titleNotes


Section
titleReferences


Section
titleResources


Piwik Set Multiple Custom Variables


NameValue
Departmentprojectdoc
Categoryprojectdoc-macro
Typedocument