jcs-elpa / define-it

Define, translate, wiki the word.

define-it

Define, translate, wiki the word.

Table of Contents

• define-it
  • 📌 Dependencies
  • 🛎️ Services
  • 🔨 Usage
  • 🔧 Customization
    • Showing/Displaying
    • Output
    • Google Translate
  • 🛠️ Contribute
    • 🔬 Development
  • ⚜️ License

P.S. Inspired by Amazon Kindle's reading experiences.

📌 Dependencies

• define-word
• google-translate
• wiki-summary

🛎️ Services

• Google Translate
• Wikipedia

🔨 Usage

These are the function calls available.

• define-it
• define-it-at-point

🔧 Customization

Showing/Displaying

You can customize these variables below for controlling the displayed on the menu.

• define-it-show-dictionary-definition
• define-it-show-google-translate
• define-it-show-wiki-summary

Output

There are two ways of outputing the menu. pop will output it in tooltip. view will output it in the another buffer.

(setq define-it-output-choice 'view)  ; Output with buffer.
(setq define-it-output-choice 'pop)   ; Output with tooltip.

Google Translate

If you don't want to select the source and destination every time, you should consider set these variables below like this.

(setq google-translate-default-source-language "auto")  ; Auto detect language.
(setq google-translate-default-target-language "en")    ; Set your target language.

🛠️ Contribute

If you would like to contribute to this project, you may either clone and make pull requests to this repository. Or you can clone the project and establish your own branch of this tool. Any methods are welcome!

🔬 Development

To run the test locally, you will need the following tools:

• Eask
• Make (optional)

Install all dependencies and development dependencies:

$ eask install-deps --dev

To test the package's installation:

$ eask package
$ eask install

To test compilation:

$ eask compile

🪧 The following steps are optional, but we recommend you follow these lint results!

The built-in checkdoc linter:

$ eask lint checkdoc

The standard package linter:

$ eask lint package

📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.

⚜️ License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See LICENSE for details.