Firefox Translations is a webextension that enables client side translations for web browsers.
Перейти к файлу
Andre Natal 62de416eb2
Release 1.1.4 (#471)
* Release 1.1.4

* Update manifest changes

* Adding skip of contenteditable
2022-07-28 14:22:03 -07:00
.github Submit commits to Glean probe-scraper (#412) 2022-06-23 13:50:06 -07:00
docs Update sequence diagram (#345) 2022-05-24 11:02:42 -07:00
extension Release 1.1.4 (#471) 2022-07-28 14:22:03 -07:00
scripts Explicitly provide a charset on the changelog (#464) 2022-07-26 05:46:32 -07:00
.eslintrc.js Removed bergamot translator's wormhole artifacts (#353) 2022-06-07 12:03:54 +02:00
.gitignore Iframe support (#148) 2022-03-24 11:33:59 -07:00
.gitmodules More taskcluster implementations (#248) 2022-04-12 14:14:28 -07:00
.taskcluster.yml Update .taskcluster.yml 2022-04-12 10:06:56 -07:00
CHANGELOG.md Release 1.1.4 (#471) 2022-07-28 14:22:03 -07:00
CODE_OF_CONDUCT.md Tooling for signing (#244) 2022-04-11 17:27:25 -07:00
LICENSE Initial commit 2021-09-07 12:56:03 -07:00
README.md Add English to Dutch (#448) 2022-07-18 17:24:21 -07:00
package-lock.json Issue383 (#445) 2022-07-14 22:00:44 -07:00
package.json Release 1.1.4 (#471) 2022-07-28 14:22:03 -07:00
update.json Fix tests and clear update.json (#317) 2022-05-06 14:39:06 -07:00

README.md

Build CodeQL End-to-End Tests Firefox Translations - Install Nightly CODE OF CONDUCT LICENSE Mozilla Add-on

Firefox Translations

Firefox Translations is a WebExtension that enables client side in-page translations for web browsers.

Firefox Translations was developed with The Bergamot Project Consortium, coordinated by the University of Edinburgh with partners Charles University in Prague, the University of Sheffield, University of Tartu, and Mozilla. This project has received funding from the European Unions Horizon 2020 research and innovation programme under grant agreement No 825303. 🇪🇺

Release version

The current release version is available for installation on Mozilla Add-ons

AMO

Supported languages

Production

  • Spanish
  • Estonian
  • English
  • German
  • Czech
  • Bulgarian
  • Portuguese
  • Italian
  • French
  • Polish

Development

  • Russian
  • Persian (Farsi)
  • Icelandic
  • Norwegian Nynorsk
  • Norwegian Bokmål
  • Ukrainian
  • Dutch

Testing

Nightly builds

You can test nightly builds of the extension in Firefox Nightly or Developer Edition in one of the supported languages by following the steps below:

  • Type about:config in the navigation bar and set the following preferences:
    xpinstall.signatures.required to false
    extensions.experiments.enabled to true
  • Then install the extension by clicking here Firefox Translations - Install Nightly
  • You may need to restart your browser and Firefox Translations will be ready to use. Just browse to a website in one of the supported languages and the option to translate should be displayed.

Development

3rd party dependencies

The extension does not utilize any npm modules, and the only vendored dependencies within are:

  • Bergamot Translator

    • A WebAssembly wrapper around the actual Neural Machine Translator, Marian. The code to build the WASM module can be found on its repository
  • Fasttext

    • We bundle the WebAssembly port of fasttext along its compressed model in order to detect the page's language. Instructions to build the WebAssembly module can be found here
  • Sentry

  • serialize-error

    • code of serialize-error npm package is bundled for serialization of exceptions to report errors from content scripts to background script

How to run

  • Install Firefox Nightly
  • Clone this repo and run npm install
  • Run npm run once and wait until Nightly starts
  • Go to about:config and set extensions.experiments.enabled to true
  • Browse to a page in any of the supported languages to have the translation option to appear

Updating telemetry schema

After adding new metrics to extension/model/telemetry/metrics.yaml or pings to extension/model/telemetry/pings.yaml, run

bash scripts/update-telemetry-schema.sh

to regenerate JS telemetry schema.

Updating bergamot-translator WASM module

Replace

  • extension/controller/translation/bergamot-translation-worker.js
  • extension/model/static/translation/bergamot-translator-worker.wasm

with the new artifacts and then execute:

bash scripts/update-bergamot-translator.sh

to regenerate JS version file. This version is reported in telemetry.

Discussions

Firefox translations channel on Matrix