Slideshow Module

created

After creating a slideshow and adding slides to the slideshow, do the following to display the slideshow on your site:

  1. Go to Extensions > Module Manager
  2. Click New
  3. In the list that appears, click Soapbox Slideshow
  4. In the Title field of the Module [Edit] page, enter a title for the module

    sbxss-module-detail.png
  5. For Show Title, select No or Yes, depending on whether you want to show the Title on the front end
  6. In the Enabled field, select No, if you do not wish the module to be displayed on the front end. If you do, leave the default to Yes.
  7. In the Position drop down, choose the module position in which you wish the slideshow to appear. NOTE: The slideshow can appear in any module position. Many module positions will be unique to your site. Module content-top, however, is directly above the article and below the site header and could be an appropriate choice, depending on your needs. Not sure what module positions you have?  Take a moment to view a map overlay of your module positions.
  8. In the Order drop down, select where the slideshow module should be placed in relation to other modules in this module position
  9. If you wish to restrict access to the slideshow module to registered, logged in users of your site, select Registered. Otherwise, leave the default to Public.
  10. Under Menu Assignment, choose if you would like the module to appear on All, None, or Select Menu Items. If Select Menu Items, choose the menu item(s) from the Menu Selection select box.
  11. In the right column under Parameters > Module Parameters, select the slideshow to display from the Slideshow drop down
    sbxss-module-params-top.png
  12. In the Template drop down, select a template for the slideshow. NOTE: The default template of "simple" is shown below with our intrepid penguin for demonstration purposes as the slide image. For customization of the look and feel of your slideshow, contact us to discuss details and pricing.

    sbxss-example.png
  13. In Slideshow Width and Slideshow Height, set the pixel dimensions of the slideshow module. NOTE: Any slide images larger than these dimensions will be cropped to fit the module size. Any slide images smaller than these dimensions will display the background color of the slideshow in the empty space. After you set the width and height, you may wish to review your slides to confirm that they are the appropriate size.
  14. For Sidebar Width (applies to certain templates only), leave the field blank, if using the default sbxss template
  15. For Hide Navigation, select No to display the slide navigation for end users to pause, start, or advance the slideshow manually
  16. For Slideshow Speed, enter the number of milliseconds a slide should be displayed. Want help converting? Use any seconds to milliseconds converter on the web, such as this one.
  17. For Slide Transition Speed, enter the number of milliseconds from the transition between slides
  18. For Slide Transition, select Fade to have images fade in and out or Wipe to have images move into the frame from right to left.
  19. For Autoplay Slideshow, select Yes or No
  20. For Random Slide Order, select Yes or No
  21. For Slide Limit, enter a maximum number of slides you wish to display. If you wish all published slides for a given slideshow to display, leave this field blank.

    sbxss-module-params-middle-2.png
  22. Content Position, Content Width, and Content Height can be used in combination with each other to set the quadrant of the slideshow area where the slide text should appear and how big of an area it should use
  23. Control Layout with its drop down options of Default, Grouped, or Separate dictates how the slideshow controls are positioned in relation to one another
  24. For Thumbnail Pagination, selecting No displays the default image with the number of the slide in it, as shown in the example "Penguin launch" screenshot above. Selecting Yes replaces the default image with thumbnails of the individual slide images.
  25. For Hide Pagination, choose No to display the pagination elements or Yes to hide them
  26. For Hide Navigation, choose No to display the Previous and Next buttons used by visitors to advance the slideshow manually. Choose Yes to hide them.
  27. For Hide Play/Pause Button, choose No to display the Play and Pause buttons used by visitors to control whether or not the slideshow advances automatically or not. Choose Yes to hide them.
  28. For Previous Title, Next Title, Play Title, and Pause Title, enter the text you wish to display for each button, if you wish to customize it. In the example, the text has been changed to say Back, Forward, Go!, and Stop!, respectively.

    sbxss-module-params-bottom.png
  29. For Show Title, select Yes, No, or Inherit. Selecting Inherit will cause the slideshow module to defer to the parameters for each slide contained in the slideshow. Choosing Yes or No will override the parameters for the individual slides.
  30. For Show Caption, select Yes, No, or Inherit. Selecting Inherit will cause the slideshow module to defer to the parameters for each slide contained in the slideshow. Choosing Yes or No will override the parameters for the individual slides.
  31. For Show Readmore Link, select Yes, No, or Inherit. Selecting Inherit will cause the slideshow module to defer to the parameters for each slide contained in the slideshow. Choosing Yes or No will override the parameters for the individual slides.
  32. For Disable Slide Links, choose Yes or No to determine if the hyperlinks for slides will be active
  33. Click Save
  34. Go to the front end of the site
  35. Go to the page on the front end where the module has been published confirm that the module is appearing
Have more questions? Submit a request
Article is closed for comments.