Overview
Past functionality
Whenever you needed to upload customised JavaScripts or Style Sheets for use in CMS, you would need to navigate to the File Manager menu and upload the files into the relevant folder, 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 upload the amended files to your 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 new CMS Style Sheet Editor functionality allows you to create and edit scripts and styles from within CMS, and, because the widget functions to run scripts or apply styles only, you know at a glance if a page is using customised JavaScript or Style Sheets. The Scripts & Styles widget allows you to 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. Ticking the checkbox next to the widget in the page layout turns them on or off when needed.
How does it work?
When you create a customised script or style sheet in CMS, the system will add 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.
Step-by-step guide
To start using the widget, you don’t have to do anything other than upgrade to or be running a version 4.13.02 or higher.
To best explain the functionality, we will execute 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-hand side of the browser.
5. You can choose to create a JavaScript or a Style Sheet. We will select Style Sheet and type in an appropriate name that follows the naming conventions of our site.
6. Select
7. The system will open a blank editing window for you to type in your custom style sheet, or you can paste the text from a file you already created.
8. Click Save when complete.
9. If you hover over Options at the top right of your browser, next to Cancel and Save, you will see File History. Use the file history to monitor changes to the script and revert to an older version if needed by clicking on the version and selecting Restore this version.
10. Click Cancel to exit out of the script editor.
Now we will apply that style sheet to our Store Locator page (or the Page that you have chosen).
11. In your CMS, select Content → Pages & Templates
12. 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.
13. Click to edit the page.
14. Click
15. Search for Scripts & Styles—the system will auto-fill the results.
16. Make sure you have highlighted Scripts & Styles, click
17. In the window that opens up, type in a meaningful description.
18. Click Edit next to Scripts & Styles.
19. The system will display customised script and style files. Select the one you created from the dropdown list and click
20. Click Edit if you want to make some last minute changes to the Style Sheet, otherwise, click
Apply
The CMS will now show you have 1 applied Script & Style. You can add multiple scripts or styles to the same widget.
21. “Enable widget on Save” is selected by default, disable it if you don’t want it taking effect yet. Otherwise, click Save.
22. You can now see, at a glance, that the Store Locator page has a script or style applied to it.
23. Select Publish (top right of the screen) to effect the changes.
24. Go to your site and open the Store Locator page (or the page to which you made changes).
Deleting a Script or Style
1. In the CMS, navigate to Advanced Content → Scripts & Styles.
2. Click on the Style Sheets tab.
3. You will notice that some files have an Edit and an Options button. The System ones have an Edit only, and the theme.css is Readonly.
4. If you hover over the Options button, you will see those files have two options: Where it's Used and Delete.
5. Click on Where it's Used for the cv.css.background.css file.
6. The system tells us what we already know: cv.css.background.css is used on the Store Locator template.
7. Let's try and delete that file. Hover over the Options button and select Delete.
8. The system asks us if we want to delete the file. Click OK.
9. The system will not delete the file because, as it already told us, and what we already knew, that file is in use.
10. We realise our mistake and hover over the Options button for the cv.css.h1.blog.css file and select Delete.
11. Confirm the deletion, and the system removes the file.
Additional Information
If you'd like to take advantage of the new search capabilities for your site, please contact our Support Team.
| Minimum Version Requirements | 4.13.02 |
|---|---|
| Prerequisites | Upgrade to version 4.13.02 |
| Self Configurable | Yes |
| Business Function | BPD Structure |
| BPD Only? | Yes |
| B2B/B2C/Both | Both |
| Ballpark Hours From CV (if opting for CV to complete self config component) | Contact CV Support |
| Ballpark Hours From CV (in addition to any self config required) | Contact CV Support |
| Third Party Costs | N/A |
| CMS Category | Advanced Content |
Related articles
