cogDisplays a message in a styled floating box format
TypeDoc (Velocity Macro)
Developed by

XWiki Development Team

Rating
Rate!
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Enterprise, XWiki Enterprise Manager

Description

This macro was originally designed to be used with XWiki Syntax 1.0 which is now deprecated. In XWiki Syntax 2.0+ you should use the Box Macro instead, which is simpler to use. However, this macro is still useful, for example if you're writing an XWiki velocity template (*.vm files).

The floatingbox macro usage actually can take two forms:

  • a single call to #floatingbox(text)
  • a call to #startfloatingbox(), followed by some wiki content, ending with a call to #endfloatingbox()

Usage

#floatingbox($text) or #startfloatingbox() wiki content #endfloatingbox()

Parameters definition

NameOptionalAllowed valuesDefault valueDescription
textnoa stringnoneThe text message that will be displayed in a floating box

Example

#floatingbox("This text is displayed in a styled floating box")

and

#startfloatingbox()
This wiki content will be displayed in a styled floating box
* list item 1
* list item 2
#endfloatingbox()

Results

This text is displayed in a styled floating box

This wiki content will be displayed in a styled floating box

  • list item 1
  • list item 2
Tags:
Created by LuisArias on 2007/04/08 11:17
    

Get Connected