Skip to content

Inconsistent terminology referring to viewlet in commands #62218

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

Closed
Tyriar opened this issue Oct 30, 2018 · 6 comments
Closed

Inconsistent terminology referring to viewlet in commands #62218

Tyriar opened this issue Oct 30, 2018 · 6 comments
Assignees
Labels
polish Cleanup and polish issue
Milestone

Comments

@Tyriar
Copy link
Member

Tyriar commented Oct 30, 2018

#62097

Looking at the commands list we refer to the viewlet as "viewlet", "sidebar" and "sideBar".

@Tyriar Tyriar added the polish Cleanup and polish issue label Oct 30, 2018
@octref
Copy link
Contributor

octref commented Oct 31, 2018

This is also a feedback from extension authors:

#58226 (comment)
microsoft/vscode-docs#1842 (comment)

I think we lack a clear UI component terminology in the Workbench. Some problems:

  • What is a "View"?
  • What is a "Viewlet"?
  • What's the relationship between "View" and "Viewlet"?
  • Does Sidebar contain 5 Views or 5 Viewlets?
  • Does Panel contain 5 Views? 5 Viewlets? 5 Panel Views?
  • Is terminal a "View"? "Viewlet"?
  • Is a tab in terminal a "View"?
  • Is everything listed under the view command a "View"?

image

I hope we can work on some updated illustration for https://code.visualstudio.com/docs/getstarted/userinterface that breaks down the Workbench UI for user understanding.

@isidorn isidorn added this to the November 2018 milestone Oct 31, 2018
@octref octref closed this as completed in fe5db1a Oct 31, 2018
@octref octref reopened this Oct 31, 2018
@isidorn
Copy link
Contributor

isidorn commented Nov 6, 2018

Here's our general principles:

  1. Never expose term viewlet in the UI
  2. Everything under the "view" command is actually a view. We just use the term view in general everywhere, which I think is fine

Now taking this into account please let me know where you think we are incosistent and what exact wording would you expect us to change?

Thanks!

@isidorn isidorn added the info-needed Issue requires more information from poster label Nov 6, 2018
@octref
Copy link
Contributor

octref commented Nov 6, 2018

View lost meaning if it's the same as "box".

Never expose term viewlet in the UI

You can find a bunch of them as context keys and command names. Should we start deprecate / remove them? For example, explorerViewletVisible and searchViewletVisible.

@isidorn
Copy link
Contributor

isidorn commented Nov 7, 2018

Context keys and command ids are fine, they are UI visible but are not in the front row visible - let's put it like that. Only advanced users will see them.
Depricating context keys and command ids requires transition of data, backwards compatibility and is a pain. I would vote against that.

Leaving this issue up to you if you are very passionate about changing some names, though I would first bring it up in the UX call.

@isidorn isidorn assigned octref and unassigned isidorn Nov 7, 2018
@isidorn isidorn removed the info-needed Issue requires more information from poster label Nov 7, 2018
@octref octref assigned Tyriar and unassigned octref Nov 7, 2018
@octref
Copy link
Contributor

octref commented Nov 7, 2018

What I want is tracked in microsoft/vscode-docs#1842, so maybe @Tyriar can clarify what changes he wants.

@Tyriar
Copy link
Member Author

Tyriar commented Nov 30, 2018

I was just bringing attention to the inconsistencies

@Tyriar Tyriar closed this as completed Nov 30, 2018
@vscodebot vscodebot bot locked and limited conversation to collaborators Jan 14, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
polish Cleanup and polish issue
Projects
None yet
Development

No branches or pull requests

3 participants