Hughes Guides

Skip to Content You are on the Technical Description Page

eGuide - Technical Description

Accessibility

Details concerning accessibility can be found here can be found here

Language

This eGuide web app uses hand coded HTML5 markup and CSS3 layout.

A small amount of javascript (ECMA-262 v3 1999) is used :-

  1. to initiate and run the service worker,
  2. to permit smooth scrolling between links and anchors on the same page,
  3. to add a jscript javascript library.

The eGuide will still function if javascript is disabled however the guide will not load in the off-line cache (service worker will be disabled) and smooth scrolling will no longer function.

If CSS is disabled the text will display correctly and navigation remains enabled however the pages may no longer auto resize to fit the screen.


Semantics

Use is made of HTML5 semantics as well as additional aria roles and access keys in order to enable assistive access for keyboard users and those with impaired vision. All modern browsers contain additional accessibility features which compliment those incorporated in this eGuide.

 

W3C Standards

The guide complies wherever possible with W3C-AAA standards.

 

Compliance Testing

This guide has been tested for compliance with the above standards. Most symbols used within the guide are web-font icons not images - automated colour tests give false contrast errors on the web fonts despite the colours used complying with, and in most cases exceeding, the standard.

 

Responsive

The eGuide is responsive and will adjust layout to suit a wide variety of screens from smart-phones to tablets and desktops.

 

Service Worker

This eGuide uses a Service Worker script which sits between the web page and the network, providing cached versions of the site when no network connectivity is available. The service worker runs in the background making the decision to serve network or cached content based on availability. The older form of browser caching, AppCache is no longer supported.

The service worker will install and subsequently update the eGuide in the background without any user intervention. When an update is detected the service worker will load the new cache which will remain dormant until the following session when it will become active and replace the older stored data held in the cache.

The eGuide, despite consisting of over 1400 files, only takes up around 12mB in storage space. Once the service worker has installed all subsequent browsing within the guide with the exception of the news page will use the stored cache data.

The eNews page (approx 50kb) is not cached although its supporting assets are. It can be used to check that the eGuide is running on the most up to date version by comparing the version numbers between the eNews page and the Index (Home) page.

The entire eGuide can be accessed off-line with any internet connection which is only required periodically to check for updates, access the eNews page and for all external links.

The guide will run perfectly well without service worker being installed providing a network connection to the internet is maintained.

Service workers support is available in the latest version of the following browsers - Google Chrome, Chrome for Android, Mozilla Firefox, Samsung Internet, Opera, Microsoft Edge, Apple Safari (OSX and iOS from version 11.3), UC Browser for Android, Android WebView. It is expected more mobile browsers will soon also be supporting the technology - see Is service worker ready?


 

Licence

Our standard licence is based on usage by an individual on all his or her devices. In other words the licence permits a single person to access the eGuide on a desktop as well as a smart phone or tablet.

A multi-user licence is available for purchase by organisations. Licences are issued and discounts provided based upon the total number of individual users permitted access to the guide. It is not based on the number of simultaneous users. This also means that a force or company can purchase a licence for an individual or group of individuals for use on their own devices as well as or instead of the force or company's equipment.

Because the guide uses cached data it is not possible for us to provide any meaningful usage statistics.

 

Minimum Requirements

This eGuide will work on older versions of browsers (IE v8 upwards) however in order to get the best out of the guide we recommend updating to one which fully supports Service Workers and HTML5.

We recommend Firefox or Chrome.

Service workers support is available in the latest version of the following browsers - Google Chrome, Chrome for Android, Mozilla Firefox, Samsung Internet, Opera, Microsoft Edge, Apple Safari (OSX and iOS from version 11.3), UC Browser for Android, Android WebView. It is expected other mobile browsers will soon also be supporting the technology - see Is service worker ready?
If your browser does not yet support service workers the guide will still function online.



The Paperless Logo

 

eGuides