Figure Macro
 | Tag content as an illustration and with an optional caption |
| Type | JAR |
| Category | Macro |
| Developed by | |
| Active Installs | 287 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Compatibility | XWiki 10.2+ |
Table of contents
Description
Equivalent of the HTML5 <figure> element. Allows to tag content as containing an illustration, with an optional caption.
Usage
Without caption:
... any content here...
{{/figure}}
With caption before the illustration:
{{figureCaption}}...caption content here{{/figureCaption}}
... any content here...
{{/figure}}
With caption after the illustration:
... any content here...
{{figureCaption}}...caption content here{{/figureCaption}}
{{/figure}}
14.9+
The figure macro allows to define its type using the type parameter. Three values are allowed:
- Automatic: (default value) The type of the figure is based on the content of the figure (i.e., if the figure contains a single table, the "table" type is used, the "figure" type is used otherwise).
- Figure: Forces the figure to the "figure" type.
- Table: Forces the figure to the "table" type.
Examples
{{figure}}
[[An image>>image:http://www.clker.com/cliparts/3/m/v/Y/E/V/small-red-apple-md.png||width="100"]]
{{/figure}}
{{figure type="figure"}}{{/figure}}
Type "table":
{{figure}}
|a|b
|c|d
{{/figure
{{figure type="table"}}{{/figure}}
Examples
Image figure
[[image:macaque.jpg||alt="Macaque in the trees"]]
{{figureCaption}}A cheeky macaque, Lower Kintaganban River, Borneo. Original by [[Richard Clark>>http://www.flickr.com/photos/rclark/]]{{/figureCaption}}
{{/figure}}
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque tincidunt at nunc lobortis vulputate. Phasellus tempus, urna eget commodo lacinia, sapien orci elementum nibh, ac condimentum metus quam vel mauris. Aliquam vehicula vehicula fermentum. In sodales augue eu ex accumsan tincidunt. Sed pellentesque nunc sit amet accumsan posuere. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Pellentesque congue rhoncus tortor vel tincidunt. Nunc tortor nisi, efficitur non nunc vitae, semper tincidunt libero. Suspendisse diam augue, euismod quis molestie nec, consequat sollicitudin mi. Phasellus sit amet sapien ante. Suspendisse ac nulla in orci efficitur porttitor sed nec mi.
Generates:
And if you apply some custom CSS you can get:
Table figure
|= Headcell1 |= Headcell2
| cell1 | cell2
{{figureCaption}}Table caption{{/figureCaption}}
{{/figure}}
Figure Type Identification
14.6+ A data-xwiki-rendering-figure-type property is added to the rendered figures. Its value is table if the figure contains a single table, and figure otherwise.
Related
- See the Numbered Reference Macro
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).
You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.
Dependencies
Dependencies for this extension (org.xwiki.rendering:xwiki-rendering-macro-figure 15.1):
