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

Better terminology for the editor 'canvas' #59407

Open
afercia opened this issue Feb 27, 2024 · 4 comments
Open

Better terminology for the editor 'canvas' #59407

afercia opened this issue Feb 27, 2024 · 4 comments
Labels
[Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). Needs Copy Review Needs review of user-facing copy (language, phrasing) [Package] Edit Site /packages/edit-site [Type] Bug An existing feature does not function as intended

Comments

@afercia
Copy link
Contributor

afercia commented Feb 27, 2024

Description

Splitting this out from #59317

While reviewing #59317 together with @carolinan and @SergeyBiryukov, we wondered whether the term 'canvas' for the editor is any friendly or useful for users.

Currently, there's 4 occurrences of the term 'canvas' within translatable strings:

lib/experiments-page.php:
  112  		array(
  113: 			'label' => __( 'Test enhancements to the Grid block that let you move and resize items in the editor canvas.', 'gutenberg' ),
  114  			'id'    => 'gutenberg-grid-interactivity',

packages/block-editor/src/components/iframe/index.js:
  315  				src={ src }
  316: 				title={ __( 'Editor canvas' ) }
  317  				onKeyDown={ ( event ) => {

packages/edit-site/src/components/block-editor/editor-canvas.js:
  55  	const viewModeProps = {
  56: 		'aria-label': __( 'Editor Canvas' ),
  57  		role: 'button',

packages/edit-site/src/components/block-editor/resize-handle.js:
  42  			>
  43: 				{ __( 'Use left and right arrow keys to resize the canvas.' ) }
  44  			</VisuallyHidden>

More occurrences used internally, in comments, tests, etc.

The only place where the term 'canvas' is visible to users is in the 'Experiments' admin page of the Gutenberg plugin.
The ohter 3 cases are strings only available fo assistive technology users, used for:

  • the 'title' attribute of the editor iframe.
  • the aria-label of the editor iframe, obly in view mode when the iframe has a role=button.
  • the visually hidden description of the editor resize handler in view mode.

Anyways, the term 'canvas' seems too technical for most users. Also, in 'view' mode, the editor iframe isn't really the editor 'canvas'. Rather, for users it's a preview that can be clicked to switch the editor to 'edit' mode.
Moreover, in the Post editor and in the Site editor, the iframe content is pretty different bust it is still named 'editor canvas' regardless.

Step-by-step reproduction instructions

  • N/A this is more a naming issue.
  • Hint: search through the codebase for the term 'canvas' within translatable strings, suggested regex: __\( '.*canvas

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 [Type] Bug An existing feature does not function as intended [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Package] Edit Site /packages/edit-site labels Feb 27, 2024
@karthick-murugan
Copy link
Contributor

@afercia - So what is your opinion for the 4 occurrence's of canvas in the above 4 files that you have mentioned? To be renamed to something else?

@afercia afercia added the Needs Copy Review Needs review of user-facing copy (language, phrasing) label Dec 12, 2024
@afercia
Copy link
Contributor Author

afercia commented Dec 12, 2024

@karthick-murugan in my opinion they should be renamed. 'Canvas' may be okay as a technical term used by developers working on the codebase but it's not that helpful for users. In common language, a canvas is something related to paintings.

Not to mention it creates confusion for translators. For example, in Italian it's translated in three different ways:

  • 'area di lavoro' (work area)
  • 'area editor'
  • 'canvas'

Image

It would be interesting checking how it is translated in other languages, to confirm it just creates confusion.

@karthick-murugan
Copy link
Contributor

@karthick-murugan in my opinion they should be renamed. 'Canvas' may be okay as a technical term used by developers working on the codebase but it's not that helpful for users. In common language, a canvas is something related to paintings.

It will be helpful if you suggest some names instead of canvas so that it will useful to move this forward.

@karthick-murugan
Copy link
Contributor

It will be helpful if you suggest some names instead of canvas so that it will useful to move this forward.

@afercia - Please give some feedback for the above when you get some time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). Needs Copy Review Needs review of user-facing copy (language, phrasing) [Package] Edit Site /packages/edit-site [Type] Bug An existing feature does not function as intended
Projects
None yet
Development

No branches or pull requests

2 participants