# plover-comment
Plover plugin to add comment/meta-information to the outline definition.
## Usage
In order to use this plugin in [Plover](https://github.com/openstenoproject/plover) you need to
create a dictionary entry of the form:
``` json
{
"example_stroke": "{:COMMENT:some comment text here}"
}
```
`COMMENT` can be replaced with `CMT` for short.
They're still subject to the rules of JSON and Plover atom, so any `{` and `}` inside the comment
must be escaped.
Alternatively the command form `{PLOVER:COMMENT:some comment text here}` can also be used.
In some new Plover version `{:comment:some comment text here}` would also work.
Raw data
{
"_id": null,
"home_page": "https://github.com/user202729/plover-comment",
"name": "plover-comment",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "plover plover_plugin",
"author": "user202729",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/e6/7b/a82b781ed475cdd848ce506a9a36a56815271d8bbbbdc22099f7abbc4f2b/plover_comment-0.0.2.tar.gz",
"platform": null,
"description": "# plover-comment\n\nPlover plugin to add comment/meta-information to the outline definition.\n\n## Usage\n\nIn order to use this plugin in [Plover](https://github.com/openstenoproject/plover) you need to\ncreate a dictionary entry of the form:\n\n``` json\n{\n \"example_stroke\": \"{:COMMENT:some comment text here}\"\n}\n```\n\n`COMMENT` can be replaced with `CMT` for short.\n\nThey're still subject to the rules of JSON and Plover atom, so any `{` and `}` inside the comment\nmust be escaped.\n\nAlternatively the command form `{PLOVER:COMMENT:some comment text here}` can also be used.\n\nIn some new Plover version `{:comment:some comment text here}` would also work.\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 or later (GPLv3+)",
"summary": "Plover plugin to add comment/meta-information to the outline definition.",
"version": "0.0.2",
"split_keywords": [
"plover",
"plover_plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d688bcd518ad910b529d84711062a81db0eb9294367f9aeb01e41d306389b745",
"md5": "0eb36bd75ecb7670732b9073921275df",
"sha256": "d3aa9a625bf92dc659453a1920d904dff1425b30e189a2a138f88189ef70223b"
},
"downloads": -1,
"filename": "plover_comment-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0eb36bd75ecb7670732b9073921275df",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 14758,
"upload_time": "2023-03-22T08:13:02",
"upload_time_iso_8601": "2023-03-22T08:13:02.270169Z",
"url": "https://files.pythonhosted.org/packages/d6/88/bcd518ad910b529d84711062a81db0eb9294367f9aeb01e41d306389b745/plover_comment-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e67ba82b781ed475cdd848ce506a9a36a56815271d8bbbbdc22099f7abbc4f2b",
"md5": "9321551a41d04efeb5c454ad3bfa0d8f",
"sha256": "f615f9af999f35810cc5c59089cf264f1cce94085e077e443c9a8fb3b8634246"
},
"downloads": -1,
"filename": "plover_comment-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "9321551a41d04efeb5c454ad3bfa0d8f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15320,
"upload_time": "2023-03-22T08:13:03",
"upload_time_iso_8601": "2023-03-22T08:13:03.811826Z",
"url": "https://files.pythonhosted.org/packages/e6/7b/a82b781ed475cdd848ce506a9a36a56815271d8bbbbdc22099f7abbc4f2b/plover_comment-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-22 08:13:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "user202729",
"github_project": "plover-comment",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "plover-comment"
}
JSON
