CMS Scripts & Styles

Overview of Scripts & Styles

Past functionality

Previously, whenever you needed to upload customised JavaScripts or Style Sheets for use in CMS, you would use the File Manager function, then reference them in a HTML Snippet widget, and apply to a page(s).

If you had to change the scripts, you couldn’t edit them within CMS. Instead, you had to make your changes locally and then upload the amended files to CMS.

The HTML Snippet widget allows you to do so much more than applying styles or running scripts. Therefore, unless you added a meaningful description to the HTML widget, how would you know what it was doing? You couldn't.

New functionality

The CMS Scripts & Styles function allows you to create and edit scripts and styles as CMS widgets. And because these widgets are dedicated only to running scripts or applying styles, you will know at a glance if a page is using customised JavaScript or Style Sheets.

With the Scripts & Styles widget, you can bundle related scripts and styles into one widget, to function as a unit. Or you can load multiple Scripts and Style widgets to operate independently on a page. You can also easily turn them on and off by ticking the checkbox next to the widget in the page layout.

IMPORTANT - Access to CMS Scripts & Styles is automatically available for version 4.13.02 or higher. If your system needs to be upgraded, please contact us.

How does Scripts & Styles work?

When you create a customised script or style sheet in CMS, the system automatically adds them to the correct system folder. All files are minimised once you click Save to reduce load times.

The system retains historical versions of the files along with an audit trail of the date, time, and the user who made the changes. If the current version is not behaving as expected, then rollback to a previous one.

To see the scripts and styles that exist in your CMS, navigate to Advanced Content → Scripts & Styles.

Adding a script or style in CMS

To best explain the functionality, we will make a simple change to the background colour of our Store Locator page.

1. In your CMS, Go to Advanced Content.
   
   
2. Click Scripts & Styles.
   
   
   
3. Select Style Sheets.
   
   
4. Click + Add Script/Style at the top right corner of the browser.
   
   
5. You can choose to create a JavaScript or a Style Sheet. Select Style Sheet.
   
   
6. In File Name, enter an appropriate name that follows the naming conventions of our site.
   
   
   
   
7. Click the Add button. The system will open a blank editing window.
   
   
8. Type in your custom style sheet or you can paste text from a file you already created elsewhere.
   
   
   
   
9. When you have finished, click Save.
   
   
10. Click Cancel to exit out of the script editor.

Applying a script or style to a page/template

Now we will apply that style sheet to our Store Locator page (or the Page that you have chosen).

1.  In your CMS, select Content → Pages & Templates
   
   
2. At the top right of the screen, type Store Locator into the “Search for a page/template” prompt box. Your page name may be different.
   
   
   
3. Click Edit. for the page/template name.
   
   
4. Once in the page, click Add Widget.
   
   
5. In the search field, start typing 'Scripts & Styles' — the system will auto-fill the results.
   
   
   
6. Select 'Scripts & Styles' and click  to open the Scripts & Styles window.  
   
   
7. In Description, enter a meaningful description for the use of this style. This will display next to the style name when it is in use.
   
   
8. Add a Layer if required.  
   
   
9. From the Scripts & Styles dropdown list, select the style you created and click Add.
   
   
   
   
10. Click Edit if you want to make some last minute changes to the Style Sheet, otherwise, to apply the script or style, click Save.
    
    The CMS will now show you have applied that Script & Style. You can add multiple scripts or styles to the same widget.
    
    
    
11. To see the script or style applied on the page/template, select Publish (top right of the screen).
    
    
12. Go to your site and open the Store Locator page (or the page to which you made changes).

Reverting to an earlier version of a script or style

CMS maintains a file history of each script and style. The file history contains information on earlier versions, including the date and time the version was saved and who the user was. If you are not happy with the current version, you can revert to an earlier one.

1. In the CMS, navigate to Advanced Content → Scripts & Styles.
   
   
2. Depending on whether you want to access the file history of a javascript or style sheet file, click on the Javascript or Style Sheets tab.
   
   
3. Click the Edit button for to the script or style.
   
   
4. In the 'Edit' page, hover on Options and click File History.
   
   
5. Any earlier versions will be listed. Click on the earlier version you wish to revert to.
   
   
6. Click on the Restore this version button.
   
   
7. Click Save. The earlier version will be copied and  saved as the latest version.

Deleting a script or style

1. In the CMS, navigate to Advanced Content → Scripts & Styles.
   
   
2. Depending on whether you want to delete a javascript or style sheet file, click on the Javascript or Style Sheets tab.
   
   
   
   
3. Notice that System files have 'Edit' buttons only and cannot be deleted. User-created ones have 'Edit' and 'Option' buttons.
   
   
4. To delete the file, hover over its Options button and click Delete.
   
   
5. In the 'Delete widget' box, if you are sure you want to delete this file, click OK otherwise, click Cancel.

Checking where a script or style is currently used

1. In the CMS, navigate to Advanced Content → Scripts & Styles.
   
   
2. Depending on whether you want to check a javascript or style sheet file, click on the Javascript or Style Sheets tab.
   
   
3. Find the file name, hover over its Options button and click Where It's Used.
   

Additional Information

Related help

• Page:
  Style Sheet Editor
• Page:
  Scripts & Styles
• Page:
  .css Variables for Scripts & Styles .css editor
• Page:
  Scripts & Styles Widget