# Plover\_clippy\_2
## Installation
### simple
- To install this plugin, right click the plover icon. go to tools -\>
plugins manager, find \`plover-clippy-2\`, and click
"install/update".
- When it finishes installing, restart Plover, go to configure -\>
plugins, and check the box next to \`plover\_clippy\_2\` to activate
the plugin
## File viewing
- Now that you have installed this plugin it's time to use it\!
- By default the output is written into clippy\_2.org in your config
files
- The same place as where your user.json and main.json is located
### Terminal
- here are some live commands for different platforms
<!-- end list -->
1. Windows
- press start, type 'powershell' enter, then copy and paste the
following:
<!-- end list -->
``` bash
Get-Content -path "$($env:LOCALAPPDATA)\plover\plover\clippy_2.org" -Wait -Tail 30
```
2. Linux
``` bash
tail -f clippy_2.org
```
3. WSL
Note that on WSL, the flag \`—disable-inotify\` may be required to
make \`tail\` work
``` bash
tail -f ---disable-inotify clippy_2.org
```
4. Plover-live-view-nvim (neovim only)
- This
[plugin](https://github.com/Josiah-tan/plover-live-view-nvim) is
a live viewer which supports:
- Splits - You can split both horizontally and vertically and
customize the sizes of the splits
- Terminal viewing (requires
[harpoon](https://github.com/ThePrimeagen/harpoon))
5. vim-autoread (vim only \[no nvim\])
- This [plugin](https://github.com/chrisbra/vim-autoread) is a
live viewer for buffer viewing
6. Extra
- see [file viewing](docs.org::*file%20viewing) for more cool
recipes
## Advanced
### Customization
- In your config directory create a python file:
- clippy\_2\_cfg.py
- feel free to write all your customization code here\!
<!-- end list -->
1. Initialization
- Below are some states that can be set by the user
- Note that these are the basic defaults (see [extended
docs](docs.org::*Defaults) for more)
<!-- end list -->
``` python
def initPost(obj, clippy):
clippy.state.output_file_name = "clippy_2.org"
clippy.state.efficiency_symbol = "*"
clippy.state.max_pad_efficiency = 5
clippy.state.max_pad_english = 15
clippy.state.justify = "left"
clippy.state.last_num_translations = 10
```
- output\_file\_name: name of the output file, directory location
will default to config directory
- efficiency\_symbol: any one character symbol used to denote how
many strokes can be saved
- max\_pad\_efficiency: the maximum number of efficiency symbols
that are allowed to be displayed
- max\_pad\_english: the maximum amount of space padding for
English translations
- justify: add white space either "left" or "right" to the output
- last\_num\_translations: these number of translations are used
to give suggestions
- note: initPost executes after this plugin initializes itself
2. Formatting Sources
- The different formats come from different "sources", choose
whenever you want\!\!\!
- below is the default, but feel free to comment out whichever
you want
<!-- end list -->
``` python
def startPost(obj, clippy):
clippy.formatting.sources.set(
["Org", {"mode": "defaultSuggest"}]
# ["Org", {"mode": "debugSuggest"}]
# ["Org", {"mode": "minimalSuggest"}]
# ["Retro", {"mode": "defaultSuggest"}]
# ["Retro", {"mode": "minimalSuggest"}]
)
```
- For more information on customizing formatting sources, see the
extended docs
3. Suggestion sources
- The suggestions come from different sources, and you can choose
which sources to include\!\!\!
- Listed below are the
defaults
<!-- end list -->
``` python
clippy.translations.sources.set("Undo", "FingerSpelling", "Retro", "Tkfps")
```
- see [Suggestion Sources](docs.org::*Suggestion%20Sources) for a
more information on what each source does
- see [Sources](docs.org::*Sources) for other methods like
"append" and "prepend"
4. distillation sources
- TODO
5. Extremity Sources
- TODO
## Multiple configurations
- In this plugin it is possible to use multiple configurations to do
crazy things like:
- multifile output, each with different configurations
- for example one file could have syntax highlighting and the
other doesn't
- become a framework for other text output programs like
tapey-tape (maybe in the future)
- see [extended docs](docs.org::*Multiple%20Configurations) for more
information
Raw data
{
"_id": null,
"home_page": "https://github.com/Josiah-tan/plover_clippy_2",
"name": "plover-clippy-2",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "plover plover_plugin plover_clippy",
"author": "Josiah Tan",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b3/81/a260267bf64da6301eb47021db39583f0ed75ad4a6398642da3a1c22d71a/plover_clippy_2-0.0.8.tar.gz",
"platform": null,
"description": "# Plover\\_clippy\\_2\n\n## Installation\n\n### simple\n\n - To install this plugin, right click the plover icon. go to tools -\\>\n plugins manager, find \\`plover-clippy-2\\`, and click\n \"install/update\".\n - When it finishes installing, restart Plover, go to configure -\\>\n plugins, and check the box next to \\`plover\\_clippy\\_2\\` to activate\n the plugin\n\n## File viewing\n\n - Now that you have installed this plugin it's time to use it\\!\n - By default the output is written into clippy\\_2.org in your config\n files\n - The same place as where your user.json and main.json is located\n\n### Terminal\n\n - here are some live commands for different platforms\n\n<!-- end list -->\n\n1. Windows\n \n - press start, type 'powershell' enter, then copy and paste the\n following:\n \n <!-- end list -->\n \n ``` bash\n Get-Content -path \"$($env:LOCALAPPDATA)\\plover\\plover\\clippy_2.org\" -Wait -Tail 30\n ```\n\n2. Linux\n \n ``` bash\n tail -f clippy_2.org\n ```\n\n3. WSL\n \n Note that on WSL, the flag \\`\u2014disable-inotify\\` may be required to\n make \\`tail\\` work\n \n ``` bash\n tail -f ---disable-inotify clippy_2.org\n ```\n\n4. Plover-live-view-nvim (neovim only)\n \n - This\n [plugin](https://github.com/Josiah-tan/plover-live-view-nvim) is\n a live viewer which supports:\n - Splits - You can split both horizontally and vertically and\n customize the sizes of the splits\n - Terminal viewing (requires\n [harpoon](https://github.com/ThePrimeagen/harpoon))\n\n5. vim-autoread (vim only \\[no nvim\\])\n \n - This [plugin](https://github.com/chrisbra/vim-autoread) is a\n live viewer for buffer viewing\n\n6. Extra\n \n - see [file viewing](docs.org::*file%20viewing) for more cool\n recipes\n\n## Advanced\n\n### Customization\n\n - In your config directory create a python file:\n - clippy\\_2\\_cfg.py\n - feel free to write all your customization code here\\!\n\n<!-- end list -->\n\n1. Initialization\n \n - Below are some states that can be set by the user\n - Note that these are the basic defaults (see [extended\n docs](docs.org::*Defaults) for more)\n \n <!-- end list -->\n \n ``` python\n def initPost(obj, clippy):\n clippy.state.output_file_name = \"clippy_2.org\"\n clippy.state.efficiency_symbol = \"*\"\n clippy.state.max_pad_efficiency = 5\n clippy.state.max_pad_english = 15\n clippy.state.justify = \"left\"\n clippy.state.last_num_translations = 10\n ```\n \n - output\\_file\\_name: name of the output file, directory location\n will default to config directory\n - efficiency\\_symbol: any one character symbol used to denote how\n many strokes can be saved\n - max\\_pad\\_efficiency: the maximum number of efficiency symbols\n that are allowed to be displayed\n - max\\_pad\\_english: the maximum amount of space padding for\n English translations\n - justify: add white space either \"left\" or \"right\" to the output\n - last\\_num\\_translations: these number of translations are used\n to give suggestions\n - note: initPost executes after this plugin initializes itself\n\n2. Formatting Sources\n \n - The different formats come from different \"sources\", choose\n whenever you want\\!\\!\\!\n - below is the default, but feel free to comment out whichever\n you want\n \n <!-- end list -->\n \n ``` python\n def startPost(obj, clippy):\n clippy.formatting.sources.set(\n [\"Org\", {\"mode\": \"defaultSuggest\"}]\n # [\"Org\", {\"mode\": \"debugSuggest\"}]\n # [\"Org\", {\"mode\": \"minimalSuggest\"}]\n \n # [\"Retro\", {\"mode\": \"defaultSuggest\"}]\n # [\"Retro\", {\"mode\": \"minimalSuggest\"}]\n )\n ```\n \n - For more information on customizing formatting sources, see the\n extended docs\n\n3. Suggestion sources\n \n - The suggestions come from different sources, and you can choose\n which sources to include\\!\\!\\!\n - Listed below are the\n defaults\n \n <!-- end list -->\n \n ``` python\n clippy.translations.sources.set(\"Undo\", \"FingerSpelling\", \"Retro\", \"Tkfps\")\n ```\n \n - see [Suggestion Sources](docs.org::*Suggestion%20Sources) for a\n more information on what each source does\n - see [Sources](docs.org::*Sources) for other methods like\n \"append\" and \"prepend\"\n\n4. distillation sources\n \n - TODO\n\n5. Extremity Sources\n \n - TODO\n\n## Multiple configurations\n\n - In this plugin it is possible to use multiple configurations to do\n crazy things like:\n - multifile output, each with different configurations\n - for example one file could have syntax highlighting and the\n other doesn't\n - become a framework for other text output programs like\n tapey-tape (maybe in the future)\n - see [extended docs](docs.org::*Multiple%20Configurations) for more\n information\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 (GPLv3)",
"summary": "plover_clippy fork focused on extensibility and useability",
"version": "0.0.8",
"project_urls": {
"Homepage": "https://github.com/Josiah-tan/plover_clippy_2"
},
"split_keywords": [
"plover",
"plover_plugin",
"plover_clippy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "69bdf8600680bd01d586f31d0ff15bae53a2b09ead0d6c146f2b9340864f7509",
"md5": "e3c00b1ad5d32d22d021df6130934ddd",
"sha256": "a18978acd0b05d3be6499aa8dcacbf177a78de3d1cf23e3e0f30652f152012e5"
},
"downloads": -1,
"filename": "plover_clippy_2-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e3c00b1ad5d32d22d021df6130934ddd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 37125,
"upload_time": "2024-09-18T11:05:20",
"upload_time_iso_8601": "2024-09-18T11:05:20.744051Z",
"url": "https://files.pythonhosted.org/packages/69/bd/f8600680bd01d586f31d0ff15bae53a2b09ead0d6c146f2b9340864f7509/plover_clippy_2-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b381a260267bf64da6301eb47021db39583f0ed75ad4a6398642da3a1c22d71a",
"md5": "4c754a653adca1880f39fba5b9d6c860",
"sha256": "bc89fda362f66bf972ddda35d78f5b775ace15e2a0f87cdc8405fda1bfc9ebfe"
},
"downloads": -1,
"filename": "plover_clippy_2-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "4c754a653adca1880f39fba5b9d6c860",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27623,
"upload_time": "2024-09-18T11:05:23",
"upload_time_iso_8601": "2024-09-18T11:05:23.739812Z",
"url": "https://files.pythonhosted.org/packages/b3/81/a260267bf64da6301eb47021db39583f0ed75ad4a6398642da3a1c22d71a/plover_clippy_2-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-18 11:05:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Josiah-tan",
"github_project": "plover_clippy_2",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "plover-clippy-2"
}
JSON
