Documentation
Documentation macros are internal specific macros used to document elephant macros themselves and other BrightSide related macros.
Documentation
Macro parser
Shows content providers. Mainly used in newsletters' external sections (External macros).
{@
provider-macros
[
:
doc-properties
[
:
tmpl-root
[
:
template
]
]
]
}
| Attributes | Description | Options | Default |
|---|---|---|---|
| doc-properties | Properties file for documentation. | */documentation | |
| tmpl-root | Templates root. | documentation | |
| template | Template used to show the items. | providerMacros |
Contacts social groups (Social Groups).
{@
social-groups
[
:
doc-properties
[
:
tmpl-root
[
:
template
]
]
]
}
| Attributes | Description | Options | Default |
|---|---|---|---|
| doc-properties | Properties file for documentation. | */documentation | |
| tmpl-root | Templates root. | documentation | |
| template | Template used to show the items. | socialGroups |
Shows Elephant macros.
{@
elephant-macros
:
parser
[
:
headers
[
:
doc-properties
[
:
tmpl-root
[
:
template
]
]
]
]
}
| Attributes | Description | Options | Default |
|---|---|---|---|
| parser | Parser name. | all | |
| headers | true | ||
| doc-properties | Properties file for documentation. | */documentation | |
| tmpl-root | Templates root. | documentation | |
| template | Template used to show the items. | elephantMacros |
{@
elephant-emojis
[
:
tmpl-root
[
:
template
]
]
}
| Attributes | Description | Options | Default |
|---|---|---|---|
| tmpl-root | Templates root. | documentation | |
| template | Template used to show the items. | providerEmojis |
{@
elephant-icons
[
:
tmpl-root
[
:
template
]
]
}
| Attributes | Description | Options | Default |
|---|---|---|---|
| tmpl-root | Templates root. | documentation | |
| template | Template used to show the items. | providerIcons |
Shows Elephant indicators.
{@
elephant-indicators
:
indicator
[
:
headers
[
:
doc-properties
[
:
tmpl-root
[
:
template
]
]
]
]
}
| Attributes | Description | Options | Default |
|---|---|---|---|
| indicator | Indicator name. | all | |
| headers | true | ||
| doc-properties | Properties file for documentation. | */documentation | |
| tmpl-root | Templates root. | documentation | |
| template | Template used to show the items. | elephantIndicators |
| English | 03/25/20 09:49 | Lluís Turró Cutiller |
