References Box Macro

...

Document Properties Marker

doctype	macro
override	false

Doctype

macro

hide

Name

References Box Macro

Short Description

Renders a box with references to further information.

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
render-list-as-comma-separated-values	true
names	Author

Tags

Tag List

names	Box, Extra

Iteration


value	production

hide

Sort Key

hide

Section

index	true
show-title	false
title	Description

Further information to a given topic is usually rendered at the end of the page. In case the document author wants to add the references next to the text, this box highlights this references.

Here is an example:

References Box
Macros Doctypes

...

Section

title	Properties

The macro provides the following properties for configuration.

Section

title	Title

The title is an optional parameter.

Here is an example with title:

References Box

title	The title of the Reference Box

Section

title	Show Icon

The checkbox allows to remove the icon from the box.

References Box

title	The title of the Reference Box
show-icon	false

Section

title	Tags

Tag the box to use for transclusion.

By default the tag reference-box is added.

Version Box

since	2.3

Transclusion for boxes is supported since version 2.3.

Section

title	Details

Transclusion

document	print-quirk-modes Hint for Box Macros
ids	Content

...

Section

title	References

Section

title	Resources

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-macro
Type	document

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 3

New Version Current

Key

About

Keep up-to-date!

Powered by