Carousel Macro

Last modified by Admin on 2024/07/08 00:10

cogCreates a carousel displaying the images attached to the current page in a customized order and with optional captions.
TypeXAR
CategoryMacro
Developed by

slauriere

Active Installs7
Rating
1 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

Creates a carousel displaying the images attached to the current page in a customized order and with optional captions. The macro uses the Bootstrap Carousel component. It is an alternative to the XCarousel Application and to the Attachment Gallery Macro. It was created in order to harness the provided Bootstrap Carousel JavaScript library.

Features

  • Display caption around images using the figcaption HTML tag
  • Control the image display order
  • Switch to full screen view
  • Stores additional metadata about an image in a dedicated field, such as its license, its source, etc.

Usage

  • Attach images to a page
  • Use the macro as follows:
{{carousel/}}

Optionally, the caption and the order used for displaying the images can be customized by adding instances of XWiki.ResourceMetadataClass to the page.

carousel-example.jpg

Carousel example with image caption

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). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Dependencies

Dependencies for this extension (org.xwiki.contrib:xwiki-carousel 1.1):

Get Connected