README

Translated plugin for Craft CMS 3.x

Website Internationalisation is fine until you need to suddenly need to speak 10 different languages and fluently enough to translate technical content. This is where the fabulous Translated plugin steps in. Select a page. Click the Translate button. Send it to the Translated translation service. Approve the quote. Receive the translated content back directly in Craft and sync it to the original Craft entry. Et voilà!

There are no nasty surprises. The Translated plugin displays a quote from Translated, so you know what the translation will cost in advance!*

With Translated's tiered service levels (Economy, Premium or Professional) it is easy to control costs. Use the Economy level for the less important pages and Professional for key pages where the translation needs to be spot on.

The Translated plugin puts content authors in full control. Translate what you want, when you want. Whether that's an entire website or a single page. With 195 languages covered and 40 areas of expertise, the Translated plugin is perfect for maintaining the content for multi-language websites on an ongoing basis.

*The estimate is based on word count, which the plugin automatically generates from the extracted content. This should be accurate; however, it is possible that the invoiced amount differs lightly from the estimate due to a final word count. This could be slightly lower or higher than the estimated amount.

Requirements

This plugin requires Craft CMS 3.1.0 or later.

Before you begin

The Translated plugin requires a Translated account. If you do not already have a Translated account, ensure you have requested one at https://translated.com/contact-us. Translated accounts are provided on a request basis.

Installing the Translated plugin

To install the plugin, follow these instructions.

Open your terminal and go to your Craft project:
```
cd /path/to/project
```

Then tell Composer to load the plugin:

composer require scaramangagency/translated

In the Control Panel, go to Settings → Plugins and click the “Install” button for Translated.

You can also visit the Craft Plugin Store, search for Translated and click install.

Configuring Translated

Assigning user permissions

The Translated plugin offers granular user permission, which you must add to existing and new user groups.

Define whether a user and/or user group has permission to:

View Orders
Request quotes
Authorise quotes
Sync translated data

Plugin settings

The following options are available under the Settings tab:

Translated username — Your Translated username.
Translated password — Your Translated password.
Translate slugs — Do you want entry slugs to be translated?
Asset volume — Assign a volume to store autogenerated and manually uploaded files.
Sandbox mode — Enable the Sandbox mode for testing. Any files submitted with Sandbox mode enabled will not be translated and no transaction will occur. You will be returned the initial file you have supplied.

The Translated plugin can be configured to send a notification email every time a new translation is delivered by translated under the the Notifications tab:

Send notifications — Send a notification when a translation file is delivered by translated.
Notification email(s) — A comma separated list of email addresses to whom the notification email will be sent.

For enhanced security, the Translated username and Translated password can be set as environment variables. All other settings can be configured using a plugin config file, which should be placed in the Config folder. A sample file is included with the plugin.

Using Translated

Translate from Entry

Go to an entry and hit the Translate button. A CSV file will be automatically created from the translatable fields assigned to the entry that match the following field types:
- Plain Text
- Redactor
Fill in the Generate a new quote form and hit Request Quote. The plugin will best-guess a word count from the generated CSV.
Review the order and click the Approve quote or Reject Quote buttons.

Please note that the Translated plugin also works with the following nestable field types:

Matrix
Supertable
Neo

Important notes

A Section must be assigned to more than one Site before the Translate button appears. If the button is not visible on the Entry then check your Section settings.
Only fields assigned as translatable (using the Translation Method select menu for each field) will be included in the file sent to Translated.
When you click Translate,the autogenerated file will source the content from the currently selected site. So, for example, the autogenerated file will contain the English content if you are on the English site or French content if you are on the French site.

Translate from a file

Most translations will be generated via the Entry form, however, if you find you have content you wish to be translated that is not contained within an Entry then it is possible to upload a file via the plugin.

The procedure is virtually the same as requesting a translation via an Entry form.

Go to Orders > Place New Order and fill out the Generate a new quote form. You can paste in plain text into the Content field or upload a file. Please note that manual orders will not show the Sync to Entry button on the delivered quote page.
Review the order and click the Approve quote or Reject Quote buttons.

Generate a new quote

The order form contains the following fields:

Project Name — This will be automatically generated from the entry title, but you can modify it or create your own.
Translation Level — Translated provides three levels of service, with different price points that will be reflected in the estimate:
- [£] Economy — Machine Translation with light human review.
- [££] Premium — Human Translation with quality control.
- [£££] Professional — Human Translation with specialist review and quality control.
Source Language — Please identify the language of the text to be translated.
Target Language — Please identify the language that you want to be supplied.
Genre — Select a category that best describes the subject matter of your text to help allocate this to the most appropriate translator.
Word Count — This will be automatically generated from the submitted entry, however, if you are uploading your own document then you will need to provide this information.
Notes — Provide additional notes to the translator. This will be automatically populated when requesting a translation from an Entry.
Select file to translate — Accepted formats include CSV, Word and Text. Your translation will be returned in the same file format.
Content — A free text field to provide content.

Translated Sections

Orders page

A list of all your orders, which can be filtered by status.

Deleting an order

On the Orders page, select the order by clicking the checkbox and then select Delete under the setting (cog icon) menu.

Please note that the Translated plugin will not delete any associated files relating to the order. We recommend taking a note of the file name (located under the Order information tab on the Orders Entry page) before deleting the Order and then locate and delete the file in the Assets section.

Order Entry page

Once a quote has been requested, the Orders Entry page will display the following Order information about your order:

Original entry — A link to the original entry.
Level — The service level requested for the translation.
Source Language
Target Language
Genre
Word Count — An estimate of the total word count.
Notes — Any notes added to the order.

You will also see either of the following three options, dependent on your inputted data:

Link — A link to the file generated by the plugin or manually uploaded by the user.
Content — A rendered output of the supplied content.

The meta panel contains the estimated total cost for the translation, the Entry's status and the estimated delivery date. Please note that the estimate price is always quoted in Euros and cannot be changed.

In addition, the following three action buttons are available:

Duplicate Quote (useful for re-submitting the quote for a different language)
Reject Quote
Approve Quote

You will need to either Reject or Approve the quote.

If you leave a quote for 24 hours, it automatically expires. Once a quote has expired, there is the option to refresh the quote.

Orders Entry page (post approval)

If you have configured the plugin to send notifications, you will be notified via email that your order has been fulfilled.

Revisiting the Orders Entry page will reveal an additional tab called Delivery where you can download a copy of the translated file and/or sync the content into the entry.

It is important to note that the translated content is not automatically synced to the entry. To complete the process, you must click the Sync to Entry button. On the next page, select the Site to which you wish to add the translated content and click Sync Content.

You will be redirected back to the Sync Entry page and see a success notification message.

You can now visit the entry to check everything has been applied correctly.

Order statuses

Pending — The order has been generated, but it still needs to be Rejected or Approved.
Processing — The order has been successfully submitted to Translated.
Delivered — The translation has been completed by Translated's translator and the file has been returned containing the translated content.
Rejected — Contains a list of quotes rejected by the user.
Expired — Contains a list of expired quotes that were not approved or rejected by the user within 24 hours.

Paying for your translation

An invoice will be sent directly from translated to the user assigned as the Administration contact on the translated account. It is therefore vital that the correct user is assigned to avoid any disputes.

All billing enquiries should be directed to Translated.

FAQs

Why does the data being returned not contain the same formatting?

The auto-generated file is sent as a CSV file, which does retain the text formatting. Translated.com returns the file as an XLSX file, again, a format that does not allow text formatting. Unfortunately, there isn't anything we can do about this.

Content authors will need to review the translated content and add the relevant formatting manually, however, at least they do not need to do the translation. Small wins!

Are there any hidden fees?

No. All payments are made directly between the client and Translated.com.

Disclaimer

The Translated plugin is essentially a connector between Craft and Translated. Scaramanga Agency Ltd has no affiliation with Translated and is not responsible for the quality of translation supplied by Translated or their service.

Your use of the Translated plugin acknowledges that Scaramanga Agency Ltd is not responsible for any disputes between the user and Translated.

Brought to you by Scaramanga Agency

scaramangagency / translated

Maintainers

Details