Add-on Documentation from JCOGS Design

ConfigurationLast updated: 16 April 2022

Configuration of the add-on is required before it can be used.

Configuration is controlled using the add-on settings page which can be accessed from the ExpressionEngine Control Panel Add-ons page.

System Defaults

System Default settings are ones that primarily control how the add-on interacts with ExpressionEngine and its wider server environment.

Each of the System Defaults options are described below:

License and On/Off Control

JCOGS Auto-Translate License Key

Provides feedback on the current licensing status of the add-on, and an input box to enter a license key value. For more information about JCOGS Auto-Translate Licensing and how the license status affects how JCOGS Auto-Translate operates, see the separate section on this elsewhere in this documentation.

Enter License Key email address

Your license key is linked to the email address used when you purchased the license - you must enter both the license and the email for the key to be validated. Use this input box to enter the appropriate email.

Register a staging domain

You can enter here the domain name used by a staging server linked to the live EE site used to register the JCOGS Auto-Translate license. 

The staging server domain can be one open to the public internet. 

If copy of this add-on is installed on an EE server located at the domain entered into the staging domain field, that copy of JCOGS Auto-Translate will be automatically validated - you will not need (or be able) to enter your license details a second time.

Enable JCOGS Auto-Translate

Use this to turn JCOGS Auto-Translate processing on or off

Caching and System Options

Image Caching Report

A summary of the status of the Image cache: whether it is operational; and if so what is stored within it and when the cache was last manually reset.

Clear the Translations Cache

JCOGS Auto-Translate actively manages its translations cache - automatically replacing translations that have reached the end of their cache life as required, and (if enabled) periodically validating that all cache expired images are removed. However sometimes it is useful / helpful to be able to clear the translations cache - an action this button carries out.

Note: Manually clearing the tranaslations cache removes all the translations stored within the cache regardless of cache duration setting; the next time a JCOGS Auto-Translate tag is loaded it will need to regenerate the processed image.

Default image duration for cached images (in seconds)

The default value is the equivalent of one year and one day (366 days - so 366 x 24 x 60 x 60): a value which maximises cache operation while still allowing JCOGS Image's auto-cache clearing process to keep the cache tidy. Set the value to 0 to have a default where the cache is disabled. Can be overridden by the cache= parameter within a tag.

JCOGS License Server Domain

JCOGS Auto-Translate needs to contact a licensing server to validate your license key / email pair: this option allows you to change the domain used for this server. Changing this value unless directed to do so by JCOGS Design support is not recommended: doing so is likely to prevent the add-on from contacting the licensing server and lead to your software operating in demonstration mode.

Enable Debugging Messages in Template Log

When enabled this causes JCOGS Auto-Translate to add informative messages about its activities to the Template Log.

DeepL Settings

Auto-Translate provides a mechanism for accessing the DeepL Machine Translation Service. For this mechanism to work you will need to set up one or more account(s) with DeepL and provide the add-on with some information about such account(s). This panel captures some information about this/these accounts and also lets you set some default values for commonly used tag parameters.


DeepL API Key

This area contains a table into which you can add/remove/reorder your DeepL API key(s).

Each key you add will be validated with DeepL, and if valid a summary of the available translation capacity will be given.

If you enter more than one key JCOGS Auto-Translate will automatically rotate through the keys provided when generating translations: as one key is used up it will move on to using the next key in the table that has available translation capacity; it will progress through the keys in the order that they are placed in the table. To change the order simply drag / drop the rows to give the order that you prefer. 

To remove a key simply click on the trash icon on the RHS of the table.

Enable DeepL Translation

This slider controls whether a the DeepL machine translation service is to be used. If it is disabled in this settings panel, any EE Auto-Translate tags that are configured to use the service will have no function regardless of any parameters they may contain. Upon processing the EE Auto-Translate tags will simply return the specified text unchanged to the template.

Ignore HTML tags by default?

The DeepL machine translation services provides the option to exclude <HTML> tags from the translation being carried out; the text returned from a translation run retains whatever <html> tags it included unchanged. For web use this is normally a sensible option to enable, as it allows HTML tags included within the text to translate to remain unchanged - so the translated text can still be read by a browser as was the case prior to translation. Accordingly the default setting for this option is enabled.

If this option is disabled, the content of any <HTML> tags will be translated along with the text - so for example a <picture> tag would be returned from DeepL after translation to Green as <εικόνα>.

This setting determines the default option for {exp:jcogs_mts:translate} and  {exp:jcogs_mts:translate_all} tags.

Regardless of the default setting <html> processing can be determined on a per-tag basis by adding the html= parameter to a tag.