Box Macro

Version 694.1 by Admin on 2022/07/06 10:39

cogRender wiki content in a graphical box which can contain a title and an image
TypeJAR
Category
Developed by

XWiki Development Team

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Standard

Installable with the Extension Manager

Description

Usage

See example bellow

Parameters definition

NameOptionalAllowed valuesDefault valueDescription
cssClassyesa stringnoneA custom HTML class parameter value to use when rendering the Box. The XHTML renderer for example uses it on the surrounding SPAN (in case the box is used inline) or on the surrounding DIV (in case the box is used standalone). This allows you to provide CSS to style the box according to your needs. Example: cssClass="mybox".
titleyesa stringnoneThe title which is to be displayed in the message box (ordinary text or Wiki 2.0 syntax).
imageyesa stringnoneThe image which is to be displayed in the message box (absolute URL)

Example

{{box title="==Quick breakfast== " image="http://farm4.static.flickr.com/3260/2894738978_ca0d3afd07_t_d.jpg"}}
* cheese
* omelet
* milk
{{/box}}

Result

breakfast.png

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-box 14.5):

Tags: presentation
    

Get Connected