anki-word-query/README.md

106 lines
2.3 KiB
Markdown
Raw Normal View History

2018-07-01 10:13:48 +08:00
# FastWordQuery Addon For Anki
2018-07-10 14:12:32 +08:00
2018-07-10 08:38:23 +08:00
[Supported Dictionaries](docs/services.md)
2018-07-10 14:12:32 +08:00
[单词添加真人发音(朗文mdx词典)](docs/get_mdx_ldoce6_sounds.md)
2018-07-09 17:24:49 +08:00
2018-07-01 10:13:48 +08:00
## Features
2018-07-02 10:53:17 +08:00
This addon looks up words in local dictionary or web dictionary and pasting the explanations to anki.
2018-07-09 23:11:54 +08:00
It forks from WordQuery, added **multi-thread feature**, and some other features.
2018-07-01 10:13:48 +08:00
2018-07-02 10:53:17 +08:00
- See [WordQuery](https://github.com/finalion/WordQuery) Addon Project.
- Querying Words and Making Cards, IMMEDIATELY!
- Support querying in mdx and stardict dictionaries.
- Support querying in web dictionaries.
- Support **Multi-Thread** to query faster.
2018-07-01 10:13:48 +08:00
## Install
2018-07-02 10:53:17 +08:00
1. Place src folder of this repository to anki addon folder.
2018-07-02 10:54:50 +08:00
2018-07-02 10:56:42 +08:00
**OR**
2018-07-02 10:54:50 +08:00
2018-07-02 10:53:17 +08:00
2. Use the installation code: 1807206748
2018-07-02 10:38:20 +08:00
2018-07-01 10:13:48 +08:00
2018-07-02 10:23:16 +08:00
## Setting
### Shortcut
2018-07-02 10:50:22 +08:00
1. Click Menu **"Tools -> Add-ons -> FastWQ -> Edit..."**
2018-07-02 10:23:16 +08:00
2018-07-02 10:50:22 +08:00
![](screenshots/setting_menu.png)
2018-07-02 10:23:16 +08:00
2018-07-02 10:50:22 +08:00
2. Edit the code and click **Save**
2018-07-02 10:23:16 +08:00
2018-07-02 10:50:22 +08:00
```python
# shortcut
shortcut = 'Ctrl+Q'
```
2018-07-02 10:23:16 +08:00
2018-07-02 10:50:22 +08:00
![](screenshots/setting_shortcut.png)
2018-07-02 10:23:16 +08:00
### Config
2018-07-02 10:50:22 +08:00
1. In Browser window click menu **"FastWQ -> Options"**
2018-07-02 10:23:16 +08:00
2018-07-02 10:50:22 +08:00
![](screenshots/setting_config_01.png)
2018-07-02 10:23:16 +08:00
2018-07-02 10:50:22 +08:00
2. Click **Settings** button in the Options window
2018-07-02 10:23:16 +08:00
2018-07-02 10:50:22 +08:00
![](screenshots/setting_config_02.png)
2018-07-02 10:23:16 +08:00
2018-07-02 10:56:42 +08:00
- **Force Update** : Update all fields even if it's None
- **Thread** : The number of threads running at the same time
2018-07-02 10:23:16 +08:00
2018-07-06 15:56:53 +08:00
## Usage
2018-07-02 10:23:16 +08:00
### Set the query fields
2018-07-02 10:50:22 +08:00
1. Click menu **"Tools -> FastWQ"**, or in Browser window click menu **"FastWQ -> Options"**
2018-07-02 10:23:16 +08:00
2018-07-02 10:50:22 +08:00
2. Select note type
2018-07-02 10:23:16 +08:00
2018-07-02 10:50:22 +08:00
![](screenshots/options_01.png)
2018-07-02 10:23:16 +08:00
2018-07-02 10:50:22 +08:00
3. Select Dictionary
2018-07-02 10:23:16 +08:00
2018-07-02 10:50:22 +08:00
![](screenshots/options_02.png)
2018-07-02 10:23:16 +08:00
2018-07-02 10:50:22 +08:00
4. Select Fields
2018-07-02 10:23:16 +08:00
2018-07-02 10:50:22 +08:00
![](screenshots/options_03.png)
2018-07-02 10:23:16 +08:00
2018-07-02 10:50:22 +08:00
5. Click **OK** button
2018-07-02 10:23:16 +08:00
### 'Browser' Window
2018-07-02 11:18:27 +08:00
1. Select single or multiple words, click menu **"FastWQ -> Query Selected"** or press shortcut Default is **Ctrl+Q**.
2018-07-02 10:23:16 +08:00
2018-07-02 10:50:22 +08:00
![](screenshots/options_04.png)
2018-07-02 11:15:17 +08:00
2. Waiting query finished
![](screenshots/use_01.png)
### 'Add' Window
2018-07-02 10:23:16 +08:00
2018-07-02 11:15:17 +08:00
1. Click Add button in Browser window, open Add window
![](screenshots/use_02.png)
2018-07-02 11:18:27 +08:00
2. Edit key field and click Query button
2018-07-02 11:43:06 +08:00
2018-07-02 11:42:22 +08:00
![](screenshots/use_03.png)
2018-07-02 10:23:16 +08:00
2018-07-01 10:13:48 +08:00
## Other Projects Used
- [mdict-query](https://github.com/mmjang/mdict-query)
- [pystardict](https://github.com/lig/pystardict)
- [WordQuery](https://github.com/finalion/WordQuery)
2018-07-02 18:33:03 +08:00
- [AnkiHub](https://github.com/dayjaby/AnkiHub)