Transcribe Documentation

Caching with Transcribe

It's important to note, that Transcribe should NOT be used in conjunction with the native ExpressionEngine Caching. This being said, Transcribe has several different caching options built in, and works well with the popular third party CE Cache plugin.

Note: The following caching options can all be used in conjunction with each other.

Option 1: Transcribe Route Loop Up Cache

The Transcribe route loop up cache can be used to cache database queries that can be pretty resource intensive on larger sites. Transcribe needs to be able to write to the directory: system/user/cache/transcribe/

$config['transcribe_file_cache_route_lookup'] = "y";

The default cache time will cache the query results for 900 seconds (15 minutes). To change this, add this setting to your config file:

$config['transcribe_file_cache_route_lookup_time'] = 900; // In seconds3.0.0

Option 2: Cache Structure Related URLs

Transcribe's Cache Structure Related URLs is designed to cache the language specific URL's that get checked when using Structure in conjunction with Transcribe. This cache should be considered on sites with large Structure trees. The cache lasts 900 seconds before refreshing.

$config['transcribe_file_cache_structure_related_urls'] = "y";

The default cache time will cache for 900 seconds (15 minutes). To change this, add this setting to your config file:

$config['transcribe_file_cache_structure_related_urls_time'] = 900; // In seconds3.0.0

Option 3: Cache Site Pages

The Transcribe Site Pages cache should also be considered with larger Structure trees. It will cache the language specific versions of the Site Pages array.

$config['transcribe_file_cache_site_pages'] = "y";

The default cache time will cache for 900 seconds (15 minutes). To change this, add this setting to your config file:

$config['transcribe_file_cache_site_pages_time'] = 900; // In seconds3.0.0

Caching with CE Cache

When further caching is needed, we recommend using CE Cache. It's important to note that you will need to add the {transcribe:language_abbreviation} tag to the id parameter on CE Cache tags.