Provide ready-to-use (practical) example map files

[ericcornelissen]

Feature Request

• wordrow version: n/a

Description

Provide example dictionaries that can be used in practice, for example:

• British to American English
• Fix common mistakes in the English language
• More...?

Not sure if they should be provided a) inside the repository, b) in the wiki, c) as gists, or d) some other way.

Example

For example, the British to American English dictionary could look something like:

# British to American

This file defines a mapping from British to American English for [wordrow]. You
can use it to convert British to American English:

  $ wordrow --map-file british-american.md input.txt

or to convert American to British English:

  $ wordrow --invert --map-file british-american.md input.txt

## Suffixes

British: `-ise(d)/-yse/-isation`, American: `-ize(d)/-yze/-ization`

| British  | American |
| -------- | -------- |
| -ise     | -ize     |
| -ised    | -ized    |
| -yse     | -yze     |
| -isation | -ization |

## Spelling

British: `our`, American: `or`

| British    | American  |
| ---------- | --------- |
| Behaviour- | Behavior- |
| Colour-    | Color-    |
| Favour-    | Favor-    |
| Favourite- | Favorite- |
| Flavour-   | Flavor-   |
| Honour-    | Honor-    |

British: `-re`, American: `-er`

| British | American |
| ------- | -------- |
| Centre  | Center   |

British: `-lling`, American: `-ling`

| British    | American  |
| ---------- | --------- |
| Modelling  | Modeling  |
| Travelling | Traveling |

British: `-lled`, American: `-led`

| British   | American |
| --------- | -------- |
| Travelled | Traveled |

British: `-ller`, American: `-ler`

| British   | American |
| --------- | -------- |
| Traveller | Traveler |

### Miscellaneous

| British  | American |
| -------- | -------- |
| Dialogue | Dialog   |
| Cypher   | Cipher   |
| Grey     | Gray     |

## British Nouns

| British  | American |
| -------- | -------- |
| Defence  | Defense  |
| Offence  | Offense  |
| practice | practise |
| pretence | pretense |

[wordrow]: https://github.com/ericcornelissen/wordrow

[ericcornelissen]

A second proposal for a ready-to-use practical example map file is one to "improve" English writing. This may include the following:

# Improve English Writing

This file defines mappings to improve English writing using [wordrow].

## Words to use instead of "very X"

| Very X         | Improvement |
| -------------- | ----------- |
| very afraid    | fearful     |
| very angry     | furious     |
| very beautiful | gorgeous    |
| very big       | massive     |
| very boring    | dull        |
| very careful   | cautious    |

... incomplete list.

[wordrow]: https://github.com/ericcornelissen/wordrow

[ericcornelissen]

I have decided for now that they can be hosted as individual gists, I see a few benefits to this approach:

• Makes it easier for outsiders to create and share their own mapping files
• Makes it easier for outsiders to update their own mapping files
• Makes it easier to collaborate on a specific mapping file (without cluttering the issues of the main project)

To make sure people can actually find those gists I will be creating a new file in the docs/ folder dedicated for this purpose.