Metadata-Version: 2.1
Name: plover_retro_untranslator
Version: 0.4.1
Summary: Converts the last X translations to a specified format consisting of raw steno and/or a translation
Home-page: https://github.com/Josiah-tan/plover-retro-untranslator
Author: Josiah-tan
License: GNU General Public License v3 (GPLv3)
Keywords: plover plover_plugin plover_retro_untranslator
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Plugins
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: plover >=4.0.0.dev8
Requires-Dist: PyQt5 >=5.5

# plover-retro-untranslator

- Converts the last X translations to a specified format consisting of any of the following: 
    - raw steno 
    - translation 
    - definition 
    - american translation
    - british translation

([video](https://www.youtube.com/watch?v=pLYZl5_l0qg))


# Examples

put these into your dictionary:

```json
{
"RA*UD": "=retro_untranslator:`%r`",
"STRO*EBGD": "=retro_untranslator:`%r` → `%T`",
"TKAO*EFPBD": "=retro_untranslator:`%r` → `%D`",
"-P": "=retro_untranslator:%G",
"SPH-P": "=retro_untranslator:%A",
"PWR-P: "=retro_untranslator:%B",
}
```

example stroke ⇒ output:

```
KWRURPB/RA*UD ⇒ `KWRURPB`
KWRURPB/STRO*EBGD ⇒ `KWRURPB` → `yes, your Honor`
KWRURPB/TKAO*EFPBD ⇒ `KWRURPB` → `yes{,}your Honor`
```

# Configuration

(literally the same thing as tapey-tape)

| Code | Item                 | Example             |
|:-----|:---------------------|:--------------------|
| `%r` | raw steno            | `KWRURPB`           |
| `%D` | definition           | yes{,}your Honor    |
| `%T` | translation          | `Yes, your Honor`   |
| `%A` | american translation | customize           |
| `%B` | british translation  | customise           |
| `%G` | toggle translation   | customise/customize |
| `%%` | an actual `%`        | `%`                 |



# Prerequisites

- Download plover and find the executable
	- see this [website](https://plover.readthedocs.io/en/latest/cli_reference.html) for finding the location of plover depending on which platform you are using (Linux, Windows, etc.)

# Installation

- Now run this command to install the library
``` bash
<plover_executable> -s plover_plugins install plover-retro-untranslator
```

# Developers

- This section shows how you can have an editable version of this project
- Firstly, fork this repository (in GitHub), then clone it:

``` bash
git clone https://github.com/your_user_name/plover-retro-untranslator
```

- cd into this repo
- Then install for use!
	- Note that "plover" is the executable that you downloaded to make Plover work in the first place
	- See this [[https://plover.readthedocs.io/en/latest/cli_reference.html][website]] for the different locations depending on which platform you are using (Linux, Windows, etc)

``` bash
cd plover-retro-translator
plover -s plover_plugins install -e .
```

# Acknowledgments

- Sachac's [plover-retro-stroke](https://github.com/sachac/plover_retro_stroke) for motivating the creation of this plugin
- rabbitgrowth's [tapey-tape](https://github.com/rabbitgrowth/plover-tapey-tape) for motivating the format of this plugin
