Translation plugin

You can test the Plugin in the Plugin demo.

Full documentation available in the documentation.

This bundle allows you to modify most translated contents in Kimai to your business needs.

You can replace messages, form labels, menu items and many more into one or multiple language. It comes with a new “Translation” view to manage these changed translations.

Often companies want to change some wordings in Kimai to better match it to their industry or usage of Kimai. One of the most requested modifications in Kimai is to change “Customers” to something else (eg. “Client”, “Construction site”, “Family”). With this bundle it is as simple as searching the text to replace and then setting your preferred replacement.

What can be changed

Visible elements like form labels, headings, menu items, error messages, and many more can be changed.

Only the text from the following “domains” cannot be changed:

• Security (Login, Password forgotten)
• Names of export templates, invoice number-generators, invoice calculators and invoice renderer

Permissions

The plugin creates this new permission:

• edit_translation - access the translation screen and allow all actions: create, edit and delete translations

Compatibility

Plugins should always be compatible with higher Kimai versions, the following list contains the plugin version and the required minimum Kimai version.

Copy files

Extract the ZIP file and upload the included directory and all files to your Kimai installation to the new directory:

var/plugins/TranslationBundle/

The file structure needs to like like this afterwards:

var/plugins/
├── TranslationBundle
│   ├── TranslationBundle.php
|   └ ... more files and directories follow here ...

Clear cache

After uploading the files, Kimai needs to know about the new plugin. It will be found once the cache was re-built. Call these commands from the Kimai directory:

bin/console kimai:reload --env=prod

rm -r var/cache/prod/*

You might have to set file permissions afterwards:

chown -R :www-data .
chmod -R g+r .
chmod -R g+rw var/
chmod -R g+rw public/avatars/

Create database

Run the following command:

bin/console kimai:bundle:translation:install

This will create the required database tables and update them to the latest version.

Updating the plugin works exactly like the installation:

• Delete the directory var/plugins/TranslationBundle/
• Execute all installation steps again:
  • Copy files
  • Clear cache
  • Update database with bin/console kimai:bundle:translation:install