Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sammdot/plover-maajik

孖翼粵語速記法Plover插件 / MaaJik Cantonese steno plugin for Plover
https://github.com/sammdot/plover-maajik

Last synced: about 12 hours ago
JSON representation

孖翼粵語速記法Plover插件 / MaaJik Cantonese steno plugin for Plover

Host: GitHub
URL: https://github.com/sammdot/plover-maajik
Owner: sammdot
License: mit
Created: 2022-06-09T05:22:49.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-09-29T16:34:08.000Z (almost 2 years ago)
Last Synced: 2024-09-18T17:46:41.907Z (9 days ago)
Language: Python
Size: 9.45 MB
Stars: 7
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # MaaJik / 孖翼

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/sammdot/plover-maajik)](https://github.com/sammdot/plover-maajik/releases/latest)

[![PyPI](https://img.shields.io/pypi/v/plover-maajik)](https://pypi.org/project/plover-maajik)

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/sammdot/plover-maajik/build)

![GitHub](https://img.shields.io/github/license/sammdot/plover-maajik)

MaaJik /ma˥ jɪk̚˨/ (孖翼, "a pair of wings") is a work-in-progress Cantonese

machine shorthand theory. This repository contains an implementation of it for

Plover, including a system plugin and dictionaries.

![MaaJik keyboard layout](https://raw.githubusercontent.com/sammdot/plover-maajik/main/assets/layout.png)

![MaaJik writing demo](https://raw.githubusercontent.com/sammdot/plover-maajik/main/assets/demo.png)

## Installation

1. Install the `plover-maajik` package through Plover's Plugins Manager.

2. Restart Plover.

3. Go to Configure > System, and change your system to `MaaJik`.

## Usage

See the [documentation](https://github.com/sammdot/plover-maajik/blob/main/docs/README.md) included in this repository for a detailed explanation of how the MaaJik theory works.

The base dictionaries are in the `maajik/dictionaries` directory. Below is the recommended dictionary order:

- [`user.json`](https://github.com/sammdot/plover-maajik/blob/main/maajik/dictionaries/user.json) – Empty, add your own entries here

- [`commands.json`](https://github.com/sammdot/plover-maajik/blob/main/maajik/dictionaries/commands.json) – Formatting and control commands

- [`punctuation.json`](https://github.com/sammdot/plover-maajik/blob/main/maajik/dictionaries/punctuation.json) - Punctuation outlines

- [`briefs.json`](https://github.com/sammdot/plover-maajik/blob/main/maajik/dictionaries/briefs.json) – Briefs for common words and phrases

- [`cangjie.json`](https://github.com/sammdot/plover-maajik/blob/main/maajik/dictionaries/cangjie.json) – Cangjie fingerspelling entries

- _[`cangjie.py`](https://github.com/sammdot/plover-maajik/blob/main/maajik/dictionaries/cangjie.py)_ (_optional_, requires `plover-python-dictionary` plugin) – Visual indication of Cangjie code input

- [`base.json`](https://github.com/sammdot/plover-maajik/blob/main/maajik/dictionaries/base.json) – Phonetic entries

A Steno Explainers infographic of the basic phonetic chords is also available:

![MaaJik Steno Explainers](https://steno.sammdot.ca/maajik.png)