Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

console: emoji/symbols glossary #225

Closed
hawkw opened this issue Dec 17, 2021 · 4 comments
Closed

console: emoji/symbols glossary #225

hawkw opened this issue Dec 17, 2021 · 4 comments
Labels
C-console Crate: console. E-easy Effort: easy. Good for newcomers S-feature Severity: feature. This is adding a new feature.

Comments

@hawkw
Copy link
Member

hawkw commented Dec 17, 2021

When the terminal supports Unicode, the console CLI will use a number of emojis and other symbols as icons etc. This is good, because it's easier to visually scan the UI this way, and in many cases, it uses fewer characters, allowing more screen real estate for things like paths that are potentially long. However, in some cases, the precise meaning of a particular emoji may not be quite as obvious as text. We might want to add some kind of glossary explaining the meanings of some of the emoji/symbols we use.

This could be in the documentation, or somewhere in the UI itself (a floating help window you toggle by pressing a key?)

@hawkw hawkw added S-feature Severity: feature. This is adding a new feature. E-easy Effort: easy. Good for newcomers C-console Crate: console. labels Dec 17, 2021
@bIgBV
Copy link

bIgBV commented Dec 24, 2021

A floating help window in general would be a good idea. It could be part of building the glossary I think.

@bIgBV
Copy link

bIgBV commented Dec 24, 2021

Looking at the code and thinking a spending some more time thinking about the implementation:

Different views would have different help information to display (including the glossary of emojis if they are being used), which pertains specifically to the view. If every view had a way to display help information (probably in the bottom row in one or two lines) then we could hook the event handler to display the right help information based on the current view state.

@bIgBV
Copy link

bIgBV commented Dec 24, 2021

I looked into whether or not it was possible to do floating windows using corssterm, but it doesn't look like there's an easy way to do that.

@javihernant
Copy link
Contributor

I think this can be closed as PR #432 was already merged

@hds hds closed this as completed Feb 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-console Crate: console. E-easy Effort: easy. Good for newcomers S-feature Severity: feature. This is adding a new feature.
Projects
None yet
Development

No branches or pull requests

4 participants