https://github.com/user202729/plover-comment

Plover plugin to add comment/meta-information to the outline definition.
https://github.com/user202729/plover-comment

plover plover-plugins

Last synced: about 2 months ago
JSON representation

Plover plugin to add comment/meta-information to the outline definition.

• Host: GitHub
• URL: https://github.com/user202729/plover-comment
• Owner: user202729
• License: gpl-3.0
• Created: 2021-11-02T06:28:11.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-03-22T08:12:50.000Z (almost 3 years ago)
• Last Synced: 2025-03-20T17:42:19.119Z (12 months ago)
• Topics: plover, plover-plugins
• Language: Python
• Homepage:
• Size: 14.6 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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.