Soliloquy Documentation

Documentation, Reference Materials, and Tutorials for Soliloquy

Configuring Your Slider

The following tables describe the available options when configuring your Soliloquy sliders. Some options are available only with the relevent Addon, in which case that will be indicated in the table details.


Slider Tab

When creating a basic Soliloquy slider populated with image, video or HTML slides, the Slider tab will display all the slides contained in your slider. You can edit or delete your slides from the Slider tab view.

Choosing a slide to edit will provide you with the following metadata configuration options for each slide:

Metadata Item Description License Required Addon Required
Title The title for your slide. Personal or greater. None
Alt Alt text describes the image slide for search engines and screen readers. Important for SEO and accessibility. Personal or greater. None
Caption Caption text to be displayed over the slidde image. Field accepts any valid HTML. Personal or greater. None
URL Hyperlink to link the slide image to another page. Personal or greater. None
Open URL in New Window? Personal or greater. None
Status Set individual slide to Published or Draft status. Personal or greater. None
Load in Lightbox? Developer or greater. Lightbox Addon
Schedule Slide? Enable or disable scheduling for the individual slide. Multi or greater. Schedule Addon
Start Date Date to start displaying the slide, relevant only if scheduling is enabled for the individual slide. Multi or greater. Schedule Addon
End Date Date to stop displaying the slide, relevant only if scheduling is enabled for the individual slide. Multi or greater. Schedule Addon
Ignore Date? Enable this option to use recurring schedule based on the Start and End time. Multi or greater. Schedule Addon
Ignore Year? Enable this option to use recurring schedule with no regard for the Year. Multi or greater. Schedule Addon
Thumbnail The URL of an image to display as a thumbnail, use to manually specify a different image to be displayed as the thumbnail associated with this slide. Developer or greater. Thumbnails Addon

Featured Content Slider Tab

Note: The following is relevant only if you’re using the Featured Content Addon.

When configuring a Featured Content Slider, the Slider tab will provide you with the following options to determine which content from your site should populate your slider and how it will be displayed.

Item Description
QUERY SETTINGS
Post Type(s) The post types to query.
Taxonomy Term(s) The taxonomy terms that should be queried based on post type selection.
Taxonomy Term(s) Relation Determines whether all or any taxonomy terms must be present in the above Posts. Available Options: Posts must have ALL of the above taxonomy terms (AND), Posts must have ANY of the above taxonomy terms (IN)
Include/Exclude Will include or exclude ONLY the selected post(s).
Include Sticky Posts Controls if and how Sticky Posts are displayed within the slider. Available Options: Include Sticky Posts, Exclude Sticky Posts, Only Include Sticky Posts (ignores all other settings)
Sort Posts By Determines how the posts are sorted in the slider. Available Options: Date, ID, Author, Title, Menu Order, Random, Comment Count, Post Name, Modified Date, Meta Value, Meta Value (Numeric)
Meta Key The meta key to use when ordering Posts. Used when Sort Posts By = Meta Value.
Orders Posts By Determines how the posts are ordered in the slider. Available Options: Ascending Order, Descending Order
Number of Slides The number of slides in your Featured Content slider.
Posts Offset The number of posts to offset in the query.
Post Status The post status to use for the query. Available Options: Published, Draft, Pending, Private
Post Start Date Optionally define a start date and time. Posts must be published on or after this date and time for inclusion in the slider.
Post End Date Optionally define an end date and time. Posts must be published on or before this date and time for inclusion in the slider.
Post Age (Hours) Optionally define the maximum age of Posts, in hours. Posts must not be older than the given number of hours to be included in the slider.
CONTENT SETTINGS
Link Image to Post URL? Links the image to the post URL.
Display Post Title? Displays the post title over the image.
Link Post Title to Post URL? Links the post title to the post URL.
Post Content to Display Determines the type of content to retrieve and output in the caption. Available Options: No Content, Post Content, Post Excerpt
Number of Words in Content Sets the number of words for trimming the post content.
Append Ellipses to Post Content? Places an ellipses at the end of the post content.
Output Content as HTML? If enabled, retrieves the Post Content as HTML, to allow for formatting to be included in the caption. Uncheck this option if you just want to get the Post Content as plain text.
Display Read More Link? Displays a “read more” link after the post content.
Read More Text Sets the read more link text.
Fallback Image URL This image URL is used if no image URL can be found for a post.
Disable get_post_classes()? If enabled, disables appending CSS classes generated by get_post_classes() for each Post’s slide. Use this if your Posts have a large number of taxonomy terms, taxonomies, etc, for better performance.

Instagram Slider Tab

Note: The following is relevant only if you’re using the Instagram Addon.

When configuring an Instagram Slider, the Slider tab will provide you with the following options to determine which images from Instagram should populate your slider.

Item Description
Feed Type The type of images to pull from Instagram. Available Options: My Instagram Photos
Tag Pulls images that match the given tag.
Number of Instagram Photos The number of images to pull from your Instagram feed.
Image Resolution Determines the image resolution and size to use from Instagram. Available Options: Thumbnail (150×150), Medium (306×306), Large (640×640)
Link to Instagram Location? Links the photo to its original location on Instagram.
Use Photo Caption? Displays the photo caption from Instagram on the slide.
Cache Data from Instagram? Caches the data from Instagram to improve performance (recommended).

WooCommerce Slider Tab

Note: The following is relevant only if you’re using the WooCommerce Addon.

When configuring a WooCommerce Slider, the Slider tab will provide you with the following options to determine which WooCommerce products should populate your slider and how it will be displayed.

Item Description
QUERY SETTINGS
Taxonomy Term(s) The taxonomy terms that should be queried based on available WooCommerce products.
Taxonomy Term(s) Relation Determines whether all or any taxonomy terms must be present in the above WooCommerce products. Available Options: Posts must have ALL of the above taxonomy terms (AND), Posts must have ANY of the above taxonomy terms (IN)
Include/Exclude Will include or exclude ONLY the selected WooCommerce products.
Display sale products only? Displays products on sale only.
Display featured products only? Displays featured products only.
Display products in stock only? Displays products in stock only.
Filter by price range? Filters products by price range.
Min Price Minimum price range.
Max Price Maximum price range.
Sort Products By Determines how the products are sorted in the slider. Available Options: Date, ID, Author, Title, Menu Order, Random, Comment Count, Post Name, Modified Date, Meta Value, Meta Value (Numeric)
Meta Key The meta key to use when ordering products. Used when Sort Products By = Meta Value.
Orders Products By Determines how the products are ordered in the slider. Available Options: Ascending Order, Descending Order
Number of Slides The number of slides in your WooCommerce slider.
Products Offset The number of products to offset in the query.
Product Status The product status to use for the query. Available Options: Published, Draft, Pending, Private
Post Start Date Optionally define a start date and time. Posts must be published on or after this date and time for inclusion in the slider.
Post End Date Optionally define an end date and time. Posts must be published on or before this date and time for inclusion in the slider.
Post Age (Hours) Optionally define the maximum age of Posts, in hours. Posts must not be older than the given number of hours to be included in the slider.
CONTENT SETTINGS
Link Image to Post URL? Links the image to the post URL.
Display Post Title? Displays the post title over the image.
Link Post Title to Post URL? Links the post title to the post URL.
Post Content to Display Determines the type of content to retrieve and output in the caption. Available Options: No Content, Post Content, Post Excerpt
Number of Words in Content Sets the number of words for trimming the post content.
Append Ellipses to Post Content? Places an ellipses at the end of the post content.
Output Content as HTML? If enabled, retrieves the Post Content as HTML, to allow for formatting to be included in the caption. Uncheck this option if you just want to get the Post Content as plain text.
Display Read More Link? Displays a “read more” link after the post content.
Read More Text Sets the read more link text.
Fallback Image URL This image URL is used if no image URL can be found for a post.
Disable get_post_classes()? If enabled, disables appending CSS classes generated by get_post_classes() for each Post’s slide. Use this if your Posts have a large number of taxonomy terms, taxonomies, etc, for better performance.


Config Tab

The following options are available within the Config tab when configuring your slider:

Config Item Description License Required Addon Required
Slider Theme Sets the theme for the slider display. Available Options: Base, Classic. Additional Options with Themes Addon: Karisma, Metro, Karma Personal or greater, Multi or greater for additional options. Optional: Themes Addon
Image Size Define the maximum image size for the slider. Default will use the below Image Dimensions. Personal or greater. None
Slider Dimensions Sets the width and height dimensions for the slider (value in pixels). Personal or greater. None
Slider Transition Sets the type of transition for the slider. Note: The Ticker transition is designed for image slides only, and does not provide interactive functionality (thumbnails, navigation arrows etc). It’s designed as a basic, continuous scrolling slideshow.
Available Options: Fade, Scroll Horizontal, Scroll Vertical, Ticker (Continuous) Scroll Horizontal
Personal or greater. None
Slider Transition Duration Sets the amount of time between each slide transition (in milliseconds). Personal or greater. None
Slider Transition Speed Sets the transition speed when moving from one slide to the next (in milliseconds). Personal or greater. None
Slider Position Sets the position of the slider on the page. Available Options: Center, Left, Right, None Personal or greater. None
Slide Gutter Sets the gutter between the slider and your content based on slider position (value in pixels). Personal or greater. None
Caption Position The position of the caption for each slide, if specified. Available Options: Top, Bottom, Left, Right Personal or greater. None
Caption Transition Delay The amount of time to delay displaying the caption after the slide has appeared (in milliseconds). Set to zero for caption to display immediately. Personal or greater. None
Autostart Slider? If disabled, visitors will need to manually progress through the slider. Personal or greater. None
Show Slider Arrows? Enables or disables slider navigation arrows. Personal or greater. None
Show Slider Control Nav? Enables or disables slider control (typically circles) navigation. Personal or greater. None
Show Pause/Play Controls? Enables or disables slider play/pause elements. Personal or greater. None
Pause on Hover? Pauses the slider (if set to autostart) when a visitor hovers over the slider. Personal or greater. None
Pause on Navigation? To resume autoplay after arrows/control nav are used, disable this option. Personal or greater. None
Enable Mousewheel Navigation? Enables or disables mousewheel navigation in the slider. Personal or greater. None
Loop Slider? Enables or disables slider looping. Personal or greater. None
Randomize Slider Randomizes slides in the slider. Personal or greater. None
Enable Keyboard Navigation Enables or disables keyboard navigation for the slider. Personal or greater. None
Use CSS Transitions? Enables hardware accelerated transitions via CSS. Personal or greater. None
Use Adaptive Height? Allows the slider to adapt smoothly to slides with different sizes. Personal or greater. None
Set Dimensions on Images? Enables or disables the width and height attributes on the img element. Only needs to be enabled if you need to meet Google Pagespeeds requirements, or if you’re using Photon CDN and having issues with slider images displaying. Personal or greater. None
Crop Images in Slider? Enables or disables image cropping based on slider dimensions (recommended). Personal or greater. None
Slider Delay If autostarting, this sets a delay before the slider should begin transitioning (in milliseconds). Personal or greater. None
Start on Slide The starting slide number (index based, starts at 0). Personal or greater. None
Autoplay Video? Enables or disables autoplay on videos. Personal or greater. None
ARIA Live Value Accessibility: Defines the priority with which screen readers should treat updates to this slider. Available Options: Off, Polite, Assertive Personal or greater. None


Mobile Tab

Mobile Item Description License Required Addon Required
Create Mobile Slider Images? Enables or disables creating specific images for mobile devices. Personal or greater. None
Mobile Dimensions These will be the sizes used for images displayed on mobile devices (value in pixels). Personal or greater. None
Show Captions on Mobile? Enables or disables captions to be displayed on mobile. Personal or greater. None
Enable Slider Carousel? Enables or disables the slider carousel feature on mobile devices. Developer or greater. Carousel Addon
Enable Lightbox on Mobile? Enables or disables the slider lightbox on mobile devices. Developer or greater. Lightbox Addon
Enable Slider Thumbnails? Enables or disables the slider thumbnails feature on mobile devices. Developer or greater. Thumbnails Addon


Carousel Tab

Note: The following is relevant only if you’re using the Carousel Addon.

Carousel Item Description License Required Addon Required
Enable Slider Carousel? Enables or disables the slider carousel feature. Developer or greater. Carousel Addon
Carousel Slide Width The width of each slide inside of the carousel (acts as max width and adjusts dynamically) (value in pixels). Developer or greater. Carousel Addon
Carousel Slide Height The height of each slide inside of the carousel (acts as max height and adjusts dynamically) (value in pixels). Developer or greater. Carousel Addon
Carousel Slide Margin The margin between each carousel slide within the slider (value in pixels). Developer or greater. Carousel Addon
Carousel Slides Minimum The minimum number of slides that should be visible within the carousel. If this value is lower than the Carousel Slides Maximum setting the slider will gradually show fewer whole slides as the browser width is reduced. Developer or greater. Carousel Addon
Carousel Slides Maximum The maximum number of slides that should be visible within the carousel. Developer or greater. Carousel Addon
Number of Slides to Move The number of slides to move when navigating through the carousel. Developer or greater. Carousel Addon


Lightbox Tab

Note: The following is relevant only if you’re using the Lightbox Addon.

Lightbox Item Description License Required Addon Required
Enable Lightbox? Enables or disables the slider lightbox. Developer or greater. Lightbox Addon
Lightbox Theme Sets the theme for the lightbox display. Available Options: Base, Classic, Karisma, Metro Developer or greater. Lightbox Addon
Lightbox Caption Display Sets the display of the captions inside of the lightbox. Available Options: Float, Inside, Outside, Over Developer or greater. Lightbox Addon
Enable Lightbox Arrows? Enables or disables the lightbox navigation arrows. Developer or greater. Lightbox Addon
Enable Keyboard Navigation? Enables or disables keyboard navigation in the lightbox. Developer or greater. Lightbox Addon
Enable Mousewheel Navigation? Enables or disables mousewheel navigation in the lightbox. Developer or greater. Lightbox Addon
Keep Aspect Ratio? If enabled, images will always resize based on the original aspect ratio. Developer or greater. Lightbox Addon
Loop Lightbox Navigation? Enables or disables infinite navigation cycling of the lightbox. Developer or greater. Lightbox Addon
Lightbox Transition Effect Type of transition between images in the lightbox view. Available Options: Fade, Elastic, No Effect Developer or greater. Lightbox Addon
HTML5 Output? If enabled, uses data-soliloquy-lightbox instead of rel attributes for W3C HTML5 validation. Developer or greater. Lightbox Addon
Load Videos in Lightbox? Loads video slides in the lightbox on click instead of inside the slider itself. Developer or greater. Lightbox Addon
Enable Lightbox Thumbnails? Enables or disables lightbox thumbnails. Developer or greater. Lightbox Addon
Lightbox Thumbnails Width Sets the width of each lightbox thumbnail (value in pixels). Developer or greater. Lightbox Addon
Lightbox Thumbnails Height Sets the height of each lightbox thumbnail (value in pixels). Developer or greater. Lightbox Addon
Lightbox Thumbnails Position Sets the position of the lightbox thumbnails. Available Options: Top, Bottom Developer or greater. Lightbox Addon
Enable Pin It Button in Lightbox? Enables or disables the Pinterest “Pin It” button for lightbox images. Developer or greater. Pinterest Addon
Pinterest Position Sets the position of the Pinterest button on the lightbox images. Available Options: Top Left, Top Right, Bottom Left, Bottom Right Developer or greater. Pinterest Addon
Pinterest Button Color Sets the color of the Pin It button in the lightbox. Available Options: Gray, Red, White Developer or greater. Pinterest Addon


Pinterest Tab

Note: The following is relevant only if you’re using the Pinterest Addon.

Pinterest Item Description License Required Addon Required
Enable Pin It Button? Enables or disables the Pinterest “Pin It” button for slider images. Developer or greater. Pinterest Addon
Pinterest Position Sets the position of the Pinterest button on the slider images. Available Options: Top Left, Top Right, Bottom Left, Bottom Right Developer or greater. Pinterest Addon
Pinterest Button Color Sets the color of the Pin It button. Available Options: Gray, Red, White Developer or greater. Pinterest Addon


Schedule Tab

Note: The following is relevant only if you’re using the Schedule Addon.

Schedule Item Description License Required Addon Required
Enable Scheduling? Enables or disables scheduling for the slider. Multi or greater. Schedule Addon
Start Date Sets the start date for the slider. Multi or greater. Schedule Addon
End Date Sets the end date for the slider. Multi or greater. Schedule Addon


Thumbnails Tab

Note: The following is relevant only if you’re using the Thumbnails Addon.

Thumbnails Item Description License Required Addon Required
Enable Slider Thumbnails? Enables or disables the slider thumbnails feature. Developer or greater. Thumbnails Addon
Thumbnails Width The width of each slide thumbnail (acts as max width and adjusts dynamically) (value in pixels). Developer or greater. Thumbnails Addon
Thumbnails Height The height of each slide thumbnail (acts as max height and adjusts dynamically) (value in pixels). Developer or greater. Thumbnails Addon
Thumbnails Position Sets the thumbnail position relative to the slider. Available Options: Top, Bottom, Left, Right Developer or greater. Thumbnails Addon
Thumbnails Margin The margin between each thumbnail within the slider (value in pixels). Developer or greater. Thumbnails Addon
Number of Visible Thumbnails The number of thumbnails visible in the thumbnail container. Developer or greater. Thumbnails Addon
Crop Slider Thumbnails? Enables or disables thumbnail cropping. Developer or greater. Thumbnails Addon
Loop Slider Thumbnails? Enables or disables thumbnail looping. Developer or greater. Thumbnails Addon
Show Thumbnails Arrows? Enables or disables thumbnail arrows. Developer or greater. Thumbnails Addon


Misc Tab

Misc Item Description License Required Addon Required
Slider Title Internal slider title for identification in the admin. Personal or greater. None
Slider Slug Unique internal slider slug for identification and advanced slider queries. Personal or greater. None
Custom Slider Classes Adds custom CSS classes to this slider. Enter one class per line. Personal or greater. None
Import/Export Slider Options for importing and exporting this slider. Personal or greater. None
Enable RTL Support? Enables or disables RTL support in Soliloquy for right-to-left languages. Personal or greater. None
Enable Image Protection? Enables or disables image protection for slider images (display and lightbox). Multi or greater. Protection Addon
Custom Slider CSS Adds custom CSS styles to this slider. Personal or greater. CSS Addon
[i]
[i]