keymanapp / keymanapp/keyman

feat(developer): Add a "Notes" field property for Touch Layout Keys

Open
#8,869 1 comment 0 reactions 1 assignee Claimed by @mcdurdin View on GitHub
developer/ feat
Dominant language
Pascal
Stars
534
Forks
143
Avg merge
2d 10h
Merged PRs (30d)
113

Description

### Is your feature request related to a problem? Please describe.

This feature request is made to benefit easy and local-ized documentation and serves the universal goals of developer documentation. This may also be analogous to commenting code at the line of code being documented.

### Describe the solution you'd like

The KMD touch layout editor loads a panel of properties and their data on the right side of the application when a key is being edited. The implementation that I would like to see is for this panel to offer a "Notes" field that plain text can be entered into. The text would then be saved as a string in the json body as a "notes" attribute of the key object.

The developer could then record notes on why they defined the key the way that they did, etc. Useful for future reference when updates are made and for someone else trying to understand the work.

A feature like this is available in font editors, like FontLab where notes can be added to any symbol created in the font. This is highly useful for maintaining the font over the long term. Saving notes on a key is a natural analog.

### Describe alternatives you've considered

Documentation recorded externally, which is a pain to locate later.

### Related issues

_No response_

### Keyman apps

- [ ] Keyman for Android
- [ ] Keyman for iPhone and iPad
- [ ] Keyman for Linux
- [ ] Keyman for macOS
- [ ] Keyman for Windows
- [X] Keyman Developer
- [ ] KeymanWeb
- [ ] Other - give details at bottom of form

### Keyman version

_No response_

### Operating system

_No response_

### Device

_No response_

### Target application

_No response_

### Browser

_No response_

### Keyboard name

_No response_

### Keyboard version

_No response_

### Language name

_No response_

### Additional context

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.