Classical Overrides

 

Important: This topic is for advanced users with very specific needs that should be handled in coordination with the ISL Online support team to avoid issues - if you simply want to replace company logo, adjust colors and the general look of pages, please proceed to the following topic: Templating


Override pages are used when there is need for editing, changing or customizing a specific web page. This approach is not recommended for development of new web content or changing all user web pages.

If you would like to change whole outlook of ICP's pages please read Templating section first and then Export web pages section.


Warning: Please note, that ICP will use overrides even when/if you upgrade ICP or any of the modules. So in case you prepared override for ISL Light module page(s), be sure to remove or rename them after you upgrade the module or your overrides will be displayed.


Example

The best way to explain how overrides work is if take a look at an example.

Default session join page on ICP looks like this:

Let's say we do not want to allow users to join via the join page, so we will create override page for /users/main/join.html.

Let's create new HTML file with new join page content. For test purposes we will just add notification, that joining via join page is not allowed.

<div class="content">

 <h3>You are not allowed to join sessions via this page</h3>

 <p>Please contact our support team at: support@example.com</p>

</div>

As you can see, this is HTML file is not in the usual HTML format, it does not have any of the main html tags like: <html>, <head> and <body>. That is because the page is wrapped inside the default ICP template, which adds these sections to HTML web page. For more information on customizing the template, see Templating section.

Now rename this file to: web_content___users__main__join__1.html and upload it to your private storage on ICP. Your private storage should look similar to this:

Now if you visit the link: http://localhost/users/main/join.html, the page should look like this:


File naming

To make it active you need to name it in the correct fashion:

web_content___<folder1>__<folder2>__<folder3>...<filename>__<web_ui_version>.<file_type>

Explanation; take any URL on ICP (/users/main/join.html):

 - web_content is required prefix followed by 3 underscores,

 - any / in url must be replaced with 2 underscores,

 - version of basic ICP pages is 1, so we add 2 underscores and number 1,

 - now we add .html suffix.

So for our URL, file gets the name: web_content___users__main__join__1.html. We can do the same for any page on ICP.

With this method you can change any existing web page or even add new content to ICP. For more changing or editing of ICP pages, please look at the Export web pages section.


Escape commands

You can use server side escape commands in any override files. For more information about escape commands, please check Templating section.


Supported version

Overrides are supported in these versions:

- ICP version 3.5.6+

- ISL AlwaysOn 4.1+

- ISL Light

- ISL Groop

- ISL Pronto

If you want to create overrides in older versions, only module overrides are/were supported. In that case file naming is changed:

ISL LIGHT: light_<filename>.<filetype>

ISL ALWAYSON: islaon_<filename>.<filetype>

ISL PRONTO: islpronto_<filename>.<filetype>

ISL GROOP: islgroop_<filename>.<filetype>

If you are using older version of modules, you cannot create new content using overrides. Only existing files from module(s) can be overridden.

Tags: isl conference proxy, web customization

Was this article helpful?