Box Macro
 | Render wiki content in a graphical box which can contain a title and an image |
| Type | JAR |
| Category | |
| Developed by | |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Bundled With | XWiki Standard |
Table of contents
Description
Usage
See example below
Parameters definition
| Name | Optional | Allowed values | Default value | Description |
|---|---|---|---|---|
| cssClass | yes | a string | none | A 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". |
| title | yes | a string | none | The title which is to be displayed in the message box (ordinary text or Wiki 2.0 syntax). XWiki 16.7+ The title is now bold by default. |
| image | yes | a string | none | The image which is to be displayed in the message box (absolute URL) |
| width | yes | a string | none | The width of the box, the supported format is the one defined by CSS width attribute |
Example
* cheese
* omelet
* milk
{{/box}}
Result
Messages
The message macro and all its descendants (Info, Success, Warning, Error) rely on this macro.
Parameters definition
All the parameters from the box macro are used by the message macro. In addition to those, the message macros also support:
| Name | Optional | Allowed values | Default value | Description |
|---|---|---|---|---|
| status | yes | boolean | false | XWiki 17.1.0-+ Use this if your message is generated dynamically or contains information about the current status of a process. E.g. after form submission, your message provides feedback to the user about the status of their request. This will make sure even assistive technology users are notified of the content of your message. |
XWiki 16.7+ All the message macros now contain a different icon and a style that is a bit more polished than a default box.
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 17.1.0):
