Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/condy0919/fanyi.el
Not only English-Chinese translator for Emacs.
https://github.com/condy0919/fanyi.el
dictionary emacs emacs-lisp emacs-plugin
Last synced: about 2 months ago
JSON representation
Not only English-Chinese translator for Emacs.
- Host: GitHub
- URL: https://github.com/condy0919/fanyi.el
- Owner: condy0919
- License: gpl-3.0
- Created: 2021-07-27T20:55:33.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-26T18:50:57.000Z (over 1 year ago)
- Last Synced: 2024-07-11T09:44:06.868Z (7 months ago)
- Topics: dictionary, emacs, emacs-lisp, emacs-plugin
- Language: Emacs Lisp
- Homepage:
- Size: 149 KB
- Stars: 77
- Watchers: 4
- Forks: 7
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/condy0919/fanyi.el/actions/workflows/build.yml)
[](LICENSE)
[](https://melpa.org/#/fanyi)
# fanyi.el
`fanyi.el` is a simple yet powerful multi-dictionaries interface for Emacs, currently it includes:
- [`海词`](https://dict.cn/)
- [`有道同义词`](https://dict.youdao.com/suggest?q=accumulate&doctype=json), **Unofficial** API
- [`etymonline`](https://www.etymonline.com/)
- [`Longman`](https://www.ldoceonline.com/).
`fanyi.el` has integrations with:
- `imenu`, M-x imenu to jump to dictionary section directly.
- `bookmark`, C-x r m to make a bookmark for current query word which turns `bookmark` into a vocabulary notebook.
- `outline-mode`, TAB to collapse on section.
- `ol` (aka `org-link`), `org-store-link` on a fanyi buffer, the link can be inserted later via `org-insert-link`. It's accomplished by introducing a `fanyi` link type.
e.g., C-c C-o on `[[fanyi:happy][description of happy]]` will invoke a fanyi search.
Since `ol` depends on `org` package, this integration needs an explicit `(require 'ol-fanyi)`.
## Installation
Install `fanyi.el` from [MELPA](https://melpa.org) with:
```
M-x package-install RET fanyi RET
```
## Usage
M-x `fanyi-dwim`, or `fanyi-dwim2` if you can confirm the word at
point is wanted. A new command `fanyi-from-history` is introduced to browse the
search history.
If you want M-x fanyi to list only `fanyi-dwim`, `fanyi-dwim2` and
`fanyi-from-history`, try
``` emacs-lisp
;; Emacs 28+
(setq read-extended-command-predicate #'command-completion-default-include-p)
```
**CAUTIOUS**: Don't customize `fanyi-providers` via `setq`, use the custom system instead.
``` emacs-lisp
;; If you want English-English dictionary only.
(use-package fanyi
:ensure t
:custom
(fanyi-providers '(fanyi-etymon-provider
fanyi-longman-provider)))
;; Default, comment out the providers you don't need.
(use-package fanyi
:ensure t
:custom
(fanyi-providers '(;; 海词
fanyi-haici-provider
;; 有道同义词词典
fanyi-youdao-thesaurus-provider
;; Etymonline
fanyi-etymon-provider
;; Longman
fanyi-longman-provider)))
;; For non-`use-package' users
(custom-set-variables
'(fanyi-providers '(fanyi-haici-provider
fanyi-youdao-thesaurus-provider
fanyi-etymon-provider
fanyi-longman-provider)))
```
By default, `M-x fanyi-dwim` will move the point to the new created `*fanyi* `buffer.
``` elisp
(setq fanyi-auto-select nil)
```
to keep the point.
For windows users,
``` emacs-lisp
(setq fanyi-sound-player-support-https t)
```
if your sound player can be launched with `your-sound-player url`. Otherwise it will be called like `your-sound-player - <(the voice file)`, where `-` is interpreted as `stdin` which is an UNIX convention.
## FAQ
1. Audio button icon displayed in tofu.
The icon is emoji, install the proper font to display it. If you use archlinux, `yay -S ttf-symbola` without additional settings. For MacOS users, add the following elisp to your Emacs config.
```elisp
;; "Apple Color Emoji" is bundled with MacOS.
;;
;; Emacs 29, 28
(set-fontset-font t 'emoji (font-spec :family "Apple Color Emoji") nil 'prepend)
;; Emacs 27
(set-fontset-font t 'symbol (font-spec :family "Apple Color Emoji") nil 'prepend)
```
2. Longman throws an `user-error`
It's expected. File an issue please.
## Screenshots
## Similar projects
- [youdao-dictionary](https://github.com/xuchunyang/youdao-dictionary.el)
- [bing-dict](https://github.com/cute-jumper/bing-dict.el)