Versions Compared

Old Version 1

changes.mady.by.user Harshitha Udayashankar (Inactive)

Saved on

compared with

New Version Current

changes.mady.by.user Harshitha Udayashankar (Inactive)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This macro is Deprecated and replaced by the new Image Slider Macro.

Use the Image Slider macro on a page to display all the image attachments of the current page in a nice-looking image slider. You can also specify a label to collect attachments from multiple pages or blogposts, even from different spaces.

Use attachment comments as image captions to display more information in the image slider. You can even link the images to the pages or blogposts they are attached to, e.g. to create a nice blogpost teaser on your dashboard. There are also multiple transition effects you can choose from and lots of configuration options like responsive width, different navigation types, slide numbers, etc. to adjust the image slider to your needs.

Tip: Make sure all images are of the same size. If the images have different sizes, the image slider will use the size of the smallest image for all images.

Parameters

Parameter

Default

Description

Width
width

None - size of the smallest image will be used

Width of the slider in pixels. Leave blank to let the slider automatically choose the best size.

Responsive Width
responsiveWidth

false

Enable to let the slider adapt to the available space. This will override any custom width.

Height
height

None - size of the smallest image will be used

Height of the slider in pixels. Leave blank to let the slider automatically choose the best size.

Attachment Labels
label

None - images of current page will be displayed

Filter images by one or more attachment labels. Leave blank to use images attached to current page. Example: blue,green,-redwill display all images with labels blue or green, excluding those labeled red.

Spaces
spaces

None - if any label is specified, images from all spaces will be displayed

Comma separated list of space keys to restrict searching of images, if any label is specified. Use @self for current space. Leave blank for all spaces.

Pages
pages

None - if any label is specified, images from all pages will be displayed, otherwise images of current page will be displayed

Comma separated list of pages to restrict searching of images. Use @self for current page. To specify a page in a different space, use the following syntax: SPACEKEY:Page Title

Sort Order
sort

creationDate

The order the images should be sorted by. Valid values are:

  • creationDate - Sort by creation date of attachment.

  • fileName - Sort by file name of attachment.

  • comment - Sort by attachment comment.

  • pageTitle - Sort by title of page, where the attachment is attached to.

  • pageCreationDate - Sort by creation date of page, where the attachment is attached to.

  • pageModificationDate - Sort by last modification date of page, where the attachment is attached to.

Reverse Order
reverseSort

false

Enable for reverse ordering.

Max Images
maxResults

None - no limit

Maximum number of images to be displayed. Leave blank for no limit.

Comment Usage
commentUsage

caption

Choose whether attachment comments should be used as image captions or external links. Valid values are:

  • caption - Comments are displayed as captions, if captions are enabled.

  • link - Comments are used as external links, if links are enabled.

  • captionAndLink - Comments are used as captions and external links. Use a vertical bar "|" in the comment to separate the caption from the link.
    Example: Caption|http://xyz.com

Show Captions
showCaptions

always

Choose whether you want to display attachment comments as image captions in the slider. Comment usage has to be set to "caption" or "captionAndLink". Valid values are:

  • always - Always display image captions.

  • onHover - Display image captions only on hover.

  • never - Never display image captions.

Enable Links
enableLinks

false

Enable to link the images to the pages or blogposts where they are attached to. To link to external urls set comment usage to "link" and specify the url in the attachment comment field.

Open Links in new Window
openLinksInNewWindow

true

Choose whether to open links in the same or in a new window, if image links are enabled.

Image Fitting
imageFitting

stretch

Choose whether images should be stretched to fit or scaled from the center and cropped to fit. Valid values are:

  • stretch - Stretch images to fit slider.

  • scaleAndCrop - Scale width of images from the center to fit slider, then crop height accordingly.

Effect
effect

fade

Choose between multiple transition effects. Valid values are:

  • fade

  • horizontal-push

  • horizontal-slide

  • vertical-push

  • vertical-slide

Auto Slide
autoSlide

true

Enable to automatically slide through images.

Display Time
delay

3000

Time (ms) how long each image will be shown.

Pause on Hover
pauseOnHover

true

Enable to stop animation while hovering over the image.

Show Timer
showTimer

false

Enable to show slide countdown timer, if auto slide is enabled. Not supported in Internet Explorer.

Reset Timer on Click
resetTimerOnClick

false

Enable to reset timer on click, if auto slide is enabled.

Show Navigation
showNavigation

onHover

Choose to show prev/next navigation:

  • always - Always display prev/next navigation.

  • onHover - Display prev/next navigation only on hover.

  • never - Hide prev/next navigation.

Show Bullets
showBullets

always

Choose to show navigation bullets below the slider:

  • always - Always display navigation bullets below the slider.

  • never - Hide navigation bullets.

Show Slide Numbers
showSlideNumbers

false

Enable to show slide numbers.