Metadata-Version: 2.1
Name: plover-fancytext
Version: 1.1.0
Summary: Silly output formatting plugin for Plover
Home-page: https://github.com/psethwick/plover_fancytext
Author: Seth Rider
Author-email: seth.rider@gmail.com
License: GNU General Public License v3 or later (GPLv3+)
Keywords: plover plover_plugin
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Plugins
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Dist: plover (>=4.0.0.dev7)

****************************
Fancy Text Plugin for Plover
****************************

This is a plugin for the open source stenography program `Plover <https://www.openstenoproject.org/plover/>`_

Requires Plover version 4.0.0 or later

What it does
############


Allows you to use Plover to output text in various (mostly joke, mostly unicode) text formats

Examples:

* bubble:  ⓑⓤⓑⓑⓛⓔ
* crytyping:   I' finne,,, h ddon'nt w,,,orry about me, re,,el yy
* fullwidth:  ｖａｐｏｒｗａｖｅ
* medieval:  𝕸𝖊𝖉𝖎𝖊𝖛𝖆𝖑
* sarcasm:  wELl ThIs IS cONvEnIeNt
* upsidedown:  ndsᴉpǝ poʍu
* zalgo:  z̓ä́l̘g̩̚o͡t́èx͓͠ẗ̬

Installing
##########


1. Open Plover
2. Navigate to the Plugin Manager tool
3. Select 'plover_fancytext' in the list
4. Click install
5. Restart Plover
6. In the Configure menu, navigate to the plugins section
7. Enable 'plover_fancytext' and apply

Usage
#####

You'll need to add Plover dictionary entries to toggle on/off the modes

The format is ``{:fancytext_set:<mode>}`` to turn on the mode and simply ``{:fancytext_set:off}`` to turn off any mode.

Here's what I use (``23*9`` is more easily read as ``#TP*T``):
::

    {
    "23*9": "{:fancytext_set:off}",
    "23*9/PW-UB": "{:fancytext_set:bubble}",
    "23*9/KRAO-EU": "{:fancytext_set:crytyping}",
    "23*9/SRA-EUP": "{:fancytext_set:fullwidth}",
    "23*9/PH-ED": "{:fancytext_set:medieval}",
    "23*9/SA-RBG": "{:fancytext_set:sarcasm}",
    "23*9/-UP": "{:fancytext_set:upsidedown}",
    "23*9/STKPWA-L": "{:fancytext_set:zalgo}"
    }

Mode Notes
##########

It's worth noting that these modes will not always work with Plover's
orthography rules. Some modes will be more wrong than others.

The  z̶͉a̕l̬ḡ͙o̕ m͏̎o̬̪d̜e̝̹ can also take two arguments for the minimum and maximum number
of combining marks. Example ``{:fancytext_set:zalgo:10:15}`` for quite a lot of
z͙͕̹̩̀͑ͮ̇̉ͣ̄͋̕ȃ̵̝͎̘̬͙̖̼͆ͤ̕͝ͅ l̵̤̟̜͎͍̠̭̽̿͂ͬͩ͜ģ̲͈͍̔ͩ̀ͣͬ̉ͨ̕̚͝o̴̢̓̓ͦ̈́̂̆͛ͭͣ. For reference the default is min=1, max=3.

You may want the 　ｆｕｌｌ　ｗｉｄｔｈ　mode to use a full-width space. This can be done by
setting space in the same entry: ``{:fancytext_set:fullwidth}{MODE:SET_SPACE:　}``.
If you do this you'll probably also want to add ``{MODE:RESET}`` to your entry which turns
off the mode.

This trick can also be applied to the upside down mode.
Include unicode 202e (right to left mark) as well as a space character for um, a
good time. You'll definitely want ``{MODE:RESET}`` on this one, and you might want
to add unicode 202d (left to right mark) to it as well. You don't want to use
these marks anywhere where text needs to be precisely correct, but should be
fine in many places.
I've not included it as part of the mode because it is definitely an acquired
taste and can end up with you having text backwards after you turn the mode off

Contributing
############

Want a new mode? Having problems?

Head to the `open source repository <https://github.com/psethwick/plover_fancytext>`_

Feel free to:

* Raise an issue
* Open a pull request, new modes accepted!


