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

Avoid the term 'sidebar' in the Handbook #57546

Open
afercia opened this issue Jan 4, 2024 · 0 comments
Open

Avoid the term 'sidebar' in the Handbook #57546

afercia opened this issue Jan 4, 2024 · 0 comments
Labels
[Type] Developer Documentation Documentation for developers

Comments

@afercia
Copy link
Contributor

afercia commented Jan 4, 2024

Description

In #49613 and #49614 the term 'sidebar' was removed from most of the user-facing text / labels / names. In the same way, it should be removed from the Handbook and replaces with 'panel'.

The main points for this proposed change are:

  • The whole concept of 'sidebar' is extraneous to blind screen reader users. The term 'sidebar' is a positional reference, as it refers to something that is placed on a 'side'. As a blind user, it doesn't help me to know whether a section of the user interface is visually placed on the side, top, bottom or in any other spot of the screen.
  • Ideally, UI sections should be named based on their functionality rather than on their visual aspect. Same applies for components.
  • On small screens, most of these UI sections aren't 'sidebars' any longer. They're more full-width overlay panels so that the term 'sidebar' isn't accurate in this case.
  • When translated, the term 'sidebar' is generally way longer than in English and that doesn't help readability.

A more appropriate, generic, term that refers to functionality rather than appearance would be 'panel'. The term 'panel' is widely used in software.

It is worth pointing out that right now the term 'panel' is used a little inconsistently in the Handbook. See for example the following two examples where the Settings 'sidebar' is also called 'panel' and the single group of settings within it are called 'panels' as well.

From https://developer.wordpress.org/block-editor/

The elements highlighted in the figure are:
...
Settings Sidebar: A sidebar panel for configuring a block’s settings (among other things)

From https://developer.wordpress.org/block-editor/getting-started/tutorial/

Save the file and select the block in the Editor. You will now see both Color and Typography panels in the Settings Sidebar.

Step-by-step reproduction instructions

N/A

Screenshots, screen recording, code snippet

No response

Environment info

No response

Please confirm that you have searched existing issues in the repo.

Yes

Please confirm that you have tested with all plugins deactivated except Gutenberg.

Yes

@afercia afercia added the [Type] Developer Documentation Documentation for developers label Jan 4, 2024
Strangehill added a commit to Strangehill/gutenberg that referenced this issue Mar 7, 2024
mirka pushed a commit that referenced this issue Mar 7, 2024
Begins to address issue #57546

Co-authored-by: Strangehill <strangehill@git.wordpress.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

No branches or pull requests

1 participant