Translate a text and consult a dictionary from Atom.io
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
keymaps
lib
menus
pug
samples
spec
styles
.gitignore
.travis.yml
LICENSE.md
README.md
package.json

README.md

translator-plus-dictionary

This package enables you to translate a text and consult a dictionary. Currently, Microsoft Translator and Dejizo are supported. Other APIs can be added(see External APIs below).

Usage

Initial Settings

Opens the configuration panel to do this initial settings by using the translator-plus-dictionary:configure command.

1. Put your client ID and client secret of Microsoft Translator.

First, put your id and secret of Microsoft Translator API to Client ID of Microsoft Translator API and Client Secret of Microsoft Translator API in the Settings view of this package.

Please see this page to understand how to obtain the client ID and cliet secret.

2. Set the languages that you usually use.

Second, set languages used in this package. For example, I (Hiroaki Mikami) set "jpn" and "eng" because I'm Japanese and I have to use English.

3. Set the primary / secondary languages.

Finally, set the primary / secondary languages to decide the language used in translation. I recommend to set your native language to the primary language, and to set "eng"(English) to the secondary language.

Commands

translator-plus-dictionary:configure

Opens the configuration panel.

translator-plus-dictionary:translate (Ctrl-c Ctrl-t by default)

Opens views, translate a selected text, and consult a dictionary. If no text is selected, this package uses a word that the cursor of Atom.io is positioned in.

translator-plus-dictionary:close-all (Esc by default)

Close all views.

Features

Language Detection

This package recognizes the language by using franc. Thus, you do not have to select the languages when you translate a text or consult a dictionary.

External APIs

This package adds all translator/dictionary APIs declared in the .atom/dictionaries.js or ./atom/translators.js.

Example

Example of a .atom/translators.js file

module.exports = Translators = [
  {
    name: () => { return "Sample API" },
    canBeUsed: (from, to) => {
      return from.code === 'en'
    },
    translate: (text, from, to) => {
      // Use an API and return a Promise
    }
  }
]

Example of a .atom/dictionaries.js file

module.exports = Translators = [
  {
    name: () => { return "Sample API" },
    canBeUsed: (from, to) => {
      return from.code === 'en'
    },
    find: (text, from, to) => {
      // Use an API and return a Promise
      // Currently, translators and dictionaries are not
    }
  }
]

A sample directory contains simple examples of external APIs.

License

This software is released under the MIT License, see LICENSE.md.