Soliloquy Documentation

Documentation, Reference Materials, and Tutorials for Soliloquy

Debugging Soliloquy

Need some help debugging Soliloquy? Maybe you’re having some trouble and not sure what to do next? We can walk you some things to check first.

There are many WordPress themes and plugins out there for WordPress. We’re always working to improve Soliloquy’s compatibility with other products. In order to help us do this, there are some steps you can take before requesting support on an issue.

  1. Requirements
  2. Getting Started
  3. Known Issues – Admin
  4. Known Issues – Frontend
  5. Debugging

Requirements

Soliloquy requires a minimum PHP version of 5.6. We recommend PHP 7+ as it’s a faster PHP processor. Soliloquy recommends the same requirements that WordPress recommends.

Getting Started

Before submitting a support ticket you can complete the following debugging steps yourself to identify the cause of the issue and resolve it:

  1. BACKUP: It’s important to always make a backup of your site before debugging, in case you accidentally delete or remove something that you shouldn’t! This is good practice for any WordPress site. Learn how to backup your site.
  2. ENABLE DEBUGGING: You can enable debugging for your site to view any PHP errors output when reproducing the issue can help quickly identify the source of the problem. Learn how to enable debugging.
  3. THEME/PLUGIN CONFLICT: Checking for a possible theme or plugin conflict is a standard part of the debugging process and should be performed if you’re have any issues with not just Soliloquy but across your site in general. Learn how to check for a theme/plugin conflict.
  4. BROWSER DEBUGGING: You can use your browser to check for javascript errors that might show the specific cause of the issue you’re having. Learn how to browser debug.
  5. MOBILE COMPATIBILITY: Soliloquy only supports the last two versions of iOS for both iPhone and iPad devices.

If after completing the above steps and you’re unable to identify or solve the issue please proceed to our Getting Support guide.


Known Issues – Admin

Some errors can be specific and we’ve put together a few of the most common as shown below.


I can’t upload images

This can be due to a possible plugin or theme conflict.

Resolution:
Check for a plugin/theme conflict. If this resolves the issue, contact the support to report the conflict.


Image metadata won’t save

As with above, this is also likely caused by a possible theme or plugin conflict.

Resolution:
Check for a plugin/theme conflict. If this resolves the issue contact the support of the buggy plugin/theme to resolve the issue.


Unable to add video slide(s)

This issue typically happens when your WordPress installation runs out of available PHP Memory to create the thumbnail image that is automatically created for hosted videos.

Resolution:
Increase the available PHP Memory for your WordPress installation. However, some hosting companies may not allow you to manually change the PHP Memory.

You may need to contact your host to complete this process for you.


How to verify your license

We have just the article for you!
Resolution:
Click here to learn how to verify your Soliloquy license.


No settings menu

If you’re using the X Theme then you’ll need to follow their documentation for enabling the Settings menu before you can verify your Soliloquy license key and access the Addons menu screen.

Resolution:
Follow the X Theme documentation at https://community.theme.co/kb/integrated-plugins-soliloquy/ (Under the Bundled Version section).

Basically to enable the Settings menu, you’ll need to add this line of code in your child theme’s functions.php file:

function x_soliloquy_remove_license_functionality() { return true; }

Another reason could be that you still have Soliloquy Lite installed.

Please review our tutorial here on How to Upgrade from Soliloquy Lite to a Paid License.


Updates for Soliloquy aren’t showing

If you’re not seeing the updates for the Soliloquy plugin or addons try one of the following resolutions.

Resolution:

  1. Navigate to the WordPress Admin » Dashboard » Updates screen
  2. You may need to refresh the Updates page a couple of times to see the update active. Refreshing the Updates page causes WordPress to check for updates and Soliloquy will be added into those updates is there is an update available for the plugin (or Addons).

Frontend

We’ve also put together a list of frontend issues you may typically see.

Soliloquy doesn’t load on the page

This is likely due to a Javascript error caused by your theme or a third party plugin.
Resolution:

  1. Check for a plugin/theme conflict. If this resolves the issue contact the support of the buggy plugin/theme to resolve the issue.
  2. Flush out your browser’s cache. Sometimes browsers generate invalid cache pages that don’t serve Javascript correctly and this can resolve the issue.
  3. Make sure that your active theme contains the wp_footer(); tag, this is typically located just before the closing </body> tag in the footer.php template file.

Loading icon gets stuck & slider doesn’t load

It’s possible there is an error loading the Soliloquy script.
Resolution:

  1. Check for a plugin/theme conflict. If this resolves the issue contact the support of the buggy plugin/theme to resolve the issue.
  2. Flush out your browser’s cache. Sometimes browsers generate invalid cache pages that don’t serve Javascript correctly and this can resolve the issue.

The slider displays incorrectly (position)

This is typically caused by a CSS conflict.
Resolution:

  1. Open up the site in Google Chrome browser.
  2. Right-click on any element that is not displaying correctly and select the Inspect option from the pop over menu. This will open the Dev Tools window for Chrome.
  3. Highlight the element with the incorrect display in the Dev Tools window and check the CSS to see if your theme’s styles are overwriting Soliloquy’s styles.
  4. You can test edit the CSS directly from the debugging console to see what clears up the issue, then apply fixes to the style.css file of your active theme, or wherever you store your CSS customizations, as necessary.

Slide transitions seem jerky

As with above, this could also be a CSS conflict with the theme or a plugin.

Resolution:

Add the following to your theme’s style.css file:

.soliloquy-slides, .soliloquy-item { margin: 0 !important; padding: 0 !important; }

My slider isn’t centered

You can control the positioning of your slider from the slider edit screen.

Resolution:
Edit the slider to confirm the Slider Position that is set from the Configuration tab.

Before continuing with debugging steps, be sure to check the slider position


Why aren’t my slider images cropping?

This will happen if you’re using JetPack’s Performance &amp; Speed (formerly called Photon) module and Media Settings which loads the original, full-size, image instead of the image cropped to the specified dimensions.

Resolution

Disable JetPack’s global Content Delivery Network JetPack » Settings » Performance &amp; Speed.

JetPack Serve Images from Our Servers

When using any CDN to serve your images, Envira will not have the correct permission to create any cropped images for you.


The lightbox isn’t working

Check the URL field of the slider image to make sure there is a URL on the image.

You can see our Creating Your First Soliloquy slider doc for the best way to create sliders.

Resolution

To correct the issue for any images already added to sliders where they’re not loading in lightbox view:

Lightbox Edit Screen

  1. In the slider edit screen, select the blue pencil at the top of the image thumbnail.
  2. This will open the Edit Item screen, where you can see the URL field.
  3. If this field is empty, select the Media File button to automatically populate the URL field with the URL of the image file.
  4. Check the Load in Lightbox?
  5. Select the Save Metadata button at the bottom of this screen before navigating to the next item or closing the Edit Item screen.
  6. Update your slider and check that this resolves the issue.

The slider image lightbox is opening twice

Previously you may have been using a different plugin for your lightbox so this plugin and Soliloquy Lightbox Addon are both trying to open the same image.

Resolution

Turn off any plugins on your site previously used for your lightbox.

In Avada, for example, you can disable the theme’s lightbox by navigating to Avada Theme Options » Lightbox and turning the lightbox feature off.


Debugging

Backing up the site

A: If you’re needing some help on how to back up your site, please read through How to Backup & Restore Your WordPress Site with UpdraftPlus to get started.


How to enable debug

A: Add the following to your wp-config.php file:

ini_set('log_errors', 'On'); 
ini_set('display_errors', 1); 
ini_set('display_startup_errors', 1); 
error_reporting(E_ALL);  
define( 'WP_DEBUG', true ); 
define( 'WP_DEBUG_LOG', true ); 
define( 'WP_DEBUG_DISPLAY', false );

Go to http://mysite.com/wp-content/debug.log to see the error log.  Be sure to send it through as part of your support request — it can be useful to help fix more technical issues.


Checking for a theme or plugin conflict

A: Check for a plugin or theme conflict please follow these steps:

  1. Disable all other plugins.
  2. Activate the Twenty-Sixteen theme.

Enabling debug in the browser

A: When debugging in Google Chrome, do the following:

  1. Visit the webpage where the error is occurring.
  2. Right-click on the page and select the Inspect Element option from the screen popup.
  3. Once the debugging window has appeared, click on the Console tab to the right.
  4. Make a note of any red errors that appear, and include them in your support request.

Now that you’ve covered our debugging guide, it’s time to check out our Getting Support guide.


[i]
[i]