62de416eb2
* Release 1.1.4 * Update manifest changes * Adding skip of contenteditable |
||
---|---|---|
.github | ||
docs | ||
extension | ||
scripts | ||
.eslintrc.js | ||
.gitignore | ||
.gitmodules | ||
.taskcluster.yml | ||
CHANGELOG.md | ||
CODE_OF_CONDUCT.md | ||
LICENSE | ||
README.md | ||
package-lock.json | ||
package.json | ||
update.json |
README.md
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 Union’s 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
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
- 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
- We bundle Sentry Javascript's SDK for error reporting.
-
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 setextensions.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.