alfred-ldoce/readme.md

Quick look from Longman dictionary and create flash cards to Anki

# alfred-ldoce-express [![Build Status](https://travis-ci.org/bikenik/alfred-ldoce.svg?branch=master)](https://travis-ci.org/bikenik/alfred-ldoce)

> [Alfred 3](https://www.alfredapp.com) workflow to quick look of Longman dictionary and creating [Anki](https://apps.ankiweb.net) cards.

#### Search by headword or across all entries
![Search by headword or across all entries](./media-readme/main-window.png)

## Preview

<details>
 
<!-- toc -->

#### Create, choose and delete your decks in Anki
![Create, choose and delete your decks in Anki](./media-readme/mods.png)

#### Use <kbd>⌘L</kbd> for more info by large text and copy it
>![Use [⌘L] for more info by large text and copy it](./media-readme/largeText.png)

#### Warnings, Notifications
>  ![search wichout Anki](./media-readme/edit_mode.png)

>  ![Notification](./media-readme/Notification-alfred-readme.png)

<!-- tocstop -->

</details>

#### Try [this](https://github.com/bikenik/alfred-ldoce/blob/master/Ldoce-Express.apkg) Anki theme (Scramble-sentences) to learning by created cards
![anki-scramble-theme](./media-readme/scramble-them-preview.gif)

## Description

The search, `ldoce <query>`, uses [Pearson's API](http://developer.pearson.com/apis/dictionaries) to hunt for headwords and senses that match `headeword/<query>`. 25 results are retrieved by default for headword search.
This workflow searches from Longman Dictionary of Contemporary English (5th edition)[ldoce5 - API]. And creates Anki cards by your choices (if an article of the current word in this API not existing audio examples the Alfred will create audio examples from [Oddcast](http://www.oddcast.com/demos/tts/tts_example.php?clients). [uses random voices: Julie, Kate, James]

## Install

```
$ npm install --global alfred-ldoce
```
or as [ldoce-Express.alfredworkflow](https://github.com/bikenik/alfred-ldoce/releases)

* Download and import the [deck example](https://github.com/bikenik/alfred-ldoce/blob/master/Ldoce-Express.apkg) for Anki to install template for this grabbing from ldoce Api.

_Requires: [Node.js](https://nodejs.org) 7.6+, Alfred [Powerpack](https://www.alfredapp.com/powerpack/), [Anki](https://apps.ankiweb.net) intelligent flash cards, [AnkiConnect](https://ankiweb.net/shared/info/2055492159) plugin for Anki._

## Usage
<details>
 
<!-- toc -->
[video presentation](https://youtu.be/MD6wpJJIzHc)
![query](./media-readme/ldoce-query-schema.png)
##### In Alfred, type <kbd>ldoce</kbd>, <kbd>Enter</kbd>, and your query.

* <kbd>ldoce < query ></kbd>
  — Search for entries with the given headword 
* <kbd>ldoces <query></kbd>
  — Generic text search across all entries (searchs all entry fields)
  - <kbd>⇥</kbd>, <kbd>↩</kbd> or <kbd>⌘ + NUM</kbd>
  — Show senses of selected headword 
  - <kbd>⇧</kbd> or <kbd>⌘ + L</kbd>
  — Show Quick Look preview from [ldoceonline.com/dictionary/query](https://www.ldoceonline.com)

* <kbd>< query ></kbd> — Search for previous matching        <kbd>ldoce < query ></kbd>

  * <kbd>⇥</kbd>, <kbd>↩</kbd> or <kbd>⌘ + NUM</kbd> or click — select to choose sense for creating card
  * <kbd>⌘ + L</kbd> — Show one of vocabulary entries in Alfred's "Large Type" window
  * <kbd>⌘ + ↩</kbd> — create card from selected senses of word
  * <kbd>⌥ + ↩</kbd> — create card from all matching of current query
  * hit <kbd>fn + ↩</kbd> — export current vocabulary entries to other workfows "Call External"
  * hit <kbd>⌃ + ↩</kbd> to turn back from some additional boxes to current session of query
* <kbd>< ldl ></kbd> (last query or last query for phrasal verb) go to the definition of the word of the last query
* If you notice this sign 🔦 it means the current deffinition exist additional words for search. Hit <kbd>⌃ + ↵</kbd> (SEE ALSO) to show and search by this words.
* <kbd><ldoce !></kbd> — Choose, create or delete deck for Anki
  - <kbd><!set></kbd> - choose another deck for new cards
  - <kbd><!del></kbd> - delete any deck (with cards)
  - <kbd><!refresh></kbd> - Refreshing info by AnkiConnect. It will be done automaticaly after each query set, but can be used forcibly by this command.

<!-- tocstop -->

</details>
 

**Note:** OS X's "delete word" shortcut ( <kbd>⌥ + ⌫</kbd> ) is very handy for backing out of a current search result.

## notation conventions

![regular headword](./media-readme/flag@01.png)
: Regular

![gramatical example](./media-readme/gramatical@01.png)
: Gramatical

![phrasal verb](./media-readme/phrasal_verbs@01.png)
: Phrasal verbs

![collocation](./media-readme/collocation@01.png)
: Collocation

![runon](./media-readme/runon@01.png)
: Run-on sentences

## Configuration

* There is three options: 
	- `language`: [Choose your language](https://cloud.google.com/translate/docs/languages) (it use google-translate-api).
	- `path_to_anki-media`: /Library/Application Support/Anki2/< Profile name of Anki >/collection.media.
  - `note_type`: "Ldoce-Express" - by default don't need to change.

### ToDo

- [x] Update Readme
- [x] Add Frequency by "Ldoce 9000"
- [x] Add more info (like "due", "new", "suspend" and count of cards) through the AnkiConnect
- [ ] Tests

### By me a coffee

<a href="https://www.buymeacoffee.com/cLMme6h" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>

## License

MIT © [bikeNik](https://github.com/bikenik)