...
Document Properties Marker |
---|
doctype | macro |
---|
override | false |
---|
|
Doctype | macro | hide |
---|
Name | Warning Box Macro | |
---|
Short Description | Renders a hint to warn the reader about something. |
|
---|
Name | Warning Box Macro |
|
---|
Parent | | |
|
---|
Audience | Name List |
---|
doctype | role |
---|
render-no-hits-as-blank | true |
---|
render-list-as-comma-separated-values | true |
---|
names | Author |
---|
|
| |
|
---|
Categories | Name List |
---|
doctype | category |
---|
render-no-hits-as-blank | true |
---|
names | Box / Reader |
---|
|
|
|
---|
Tags | | |
|
---|
Iteration | | hide |
---|
Sort Key | | hide |
---|
|
...
Section |
---|
index | true |
---|
show-title | false |
---|
title | Description |
---|
|
According to The version box macro allows to provide version-specific information in a visual box. |
projectdoc-section |
---|
|
The macro provides the following properties for configuration. Section |
---|
| The title is an optional parameter. If no title is provided, a standard title is constructed based on the values of Since and Until. Here is an example with title: Version Box |
---|
title | Title of the version box |
---|
| This is the text in a version box |
| cite |
template | $[Name] (${Authors}) |
---|
document | PDAC:Ament2003 |
---|
|
authors should stick to the industry standard of using note, tip, warning, and caution boxes.The warning box is used as follows:
Quote |
---|
source-wiki-page | PDAC:Ament2003 |
---|
|
Negative alert that a particular action can result in physical harm to users, or can result in damage to hardware
|
Properties | | Provide a version number since when the information of the box applies. Here is an example with since and no title: Version Box |
---|
| This is the text in a version box |
| The macro provides the following properties for configuration
Section |
---|
| Provide a version number until when the information of the box appliesThe title is an optional parameter. Here is an example with since and until (but no title): projectdoc-box-warning |
---|
title | The title of the Warning Box |
---|
| version |
---|
| This is the text in a version box This is a warning message. |
|
Section |
---|
| The checkbox allows to remove the icon from the box. projectdoc-box-warningversion |
---|
title | The title Title of the Warning Boxversion box |
---|
show-icon | false |
---|
| This This is a warning messagethe text in a version box. |
|
Section |
---|
| Tag the box to use for transclusion. By default the tag warningversion-box is is added. |
|
projectdoc- |
box-version |
Transclusion for boxes is supported since version 2.3. |
Section |
---|
|
Section |
---|
title | Example for a Version Box |
---|
| The version box in the page editor. Image Added The rendered version box in the page view mode. Image Added |
|
Section |
---|
title | Details
Transclusion |
---|
document | print-quirk-modes Hint for Box Macros |
---|
ids | Content |
---|
| |
|
---|
...