Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nsmarkop/plover_korean
Korean plugin for Plover
https://github.com/nsmarkop/plover_korean
korean plover plugin stenography
Last synced: about 10 hours ago
JSON representation
Korean plugin for Plover
- Host: GitHub
- URL: https://github.com/nsmarkop/plover_korean
- Owner: nsmarkop
- License: gpl-3.0
- Created: 2017-11-30T02:48:40.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-12-18T07:22:12.000Z (almost 3 years ago)
- Last Synced: 2024-09-18T17:46:18.102Z (9 days ago)
- Topics: korean, plover, plugin, stenography
- Language: Python
- Homepage:
- Size: 379 KB
- Stars: 12
- Watchers: 2
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Plover Korean
Korean stenography for [Plover](https://github.com/openstenoproject/plover).
- [Korean Modern C - CAS-based System](#korean-modern-c)
- [Korean Modern S - Sorizava-based System](#korean-modern-s)
- [Meta Plugins](#meta-plugins)
## Installation
*This plugin has not been released on PyPI yet, so locally installing from source is currently the only option*
If you have issues with character misalignment in places like the Paper Tape in the Plover GUI try installing [Nanum Gothic Coding](https://fonts.google.com/earlyaccess#Nanum+Gothic+Coding), a monospaced sans-serif Korean font, and setting Plover's font to that where possible. The majority of monospaced fonts do not have CJK language support which is why this issue comes up for things relying on monospaced plain text display.
## Korean Modern C
Korean Modern C is a Korean stenography system based on the system used by Korean CAS machines. See the reference guide for this system [here](/plover_korean/system/cas/docs/README.md).
## Korean Modern S
Korean Modern S is a Korean stenography system based on the system used by Sorizava machines. See the reference guide for this system [here](/plover_korean/system/sorizava/docs/README.md).
## Meta Plugins
In order to use these meta plugins you need to add them with a dictionary entry like the example below:
``` json
{
"ㄴㅣㄱ": "{:meta_plugin_name:meta_plugin_argument1,meta_plugin_argument2,...}"
}
```
If there are no arguments for the meta plugin, just `{:meta_plugin_name}` is sufficient.
### Particles
Regex support for Korean syllable blocks does not work well so various meta plugins have been created for contextually determining what particle to attach to a word.
While many particles are always the same when attached to words, some change their form depending on if the word they are attached to ends with a vowel or consonant. The following table lists the current plugins with that support that can be used:
Meta Plugin Name | Concept
---------------- | ----------
ko_particle_neun | ~는/은
ko_particle_ga | ~가/이
ko_particle_reul | ~를/을
ko_particle_da | ~다/이다
ko_particle_ra | ~라/이라
ko_particle_ya | ~야/아
ko_particle_wa | ~와/과
ko_particle_rang | ~랑/이랑
ko_particle_na | ~나/이나
ko_particle_ro | ~로/으로
ko_particle_myeo | ~며/이며
If support for a particular variable particle is not currently implemented, [**please open an issue on GitHub for support to be added**](https://github.com/nsmarkop/plover_korean/issues). However, there is one additional meta plugin that can be used for when this occurs: "ko_particle_generic". It has three plugin arguments:
1. The particle to be used for words ending in vowels.
2. The particle to be used for words ending in consonants.
3. (optional) The final consonant of words where the consonant case should be treated as the vowel case.
For example, an entry that replicates the "ko_particle_neun" functionality would be:
``` json
{
"ㄴㅣㄱ": "{:ko_particle_generic:는,은}"
}
```
An entry that replicates the "ko_particle_ro" functionality would be:
``` json
{
"ㄴㅣㄱ": "{:ko_particle_generic:로,으로,ㄹ}"
}
```
If you attempt to use these plugins to attach particles to non-Korean words they cannot accurately determine how to display and will fall back to a default case.
## License
GPLv3+.