Adjust the block terminology in Layout Builder to align with block and block_content changes

Created on 1 November 2022, about 2 years ago
Updated 26 February 2024, 9 months ago

Postponed on 📌 Rename Custom Block terminology in the admin UI Fixed .

This issue is part of the wider reorganisation of the block UI 🌱 [meta] Reorganize Block items in the administration menu Active .

Problem/Motivation

In the linked meta issue the Block items are getting reorganized and renamed in the administration menu. While working through the issues it was apparent that those changes would require a few changes to titles and labels for layout builder as well to keep consistency and at the same time improve the clarity to the user.

In a standard Drupal 9.5.x-dev install with Layout Builder installed (without any Layout Builder related extra modules), with the changes suggested in the meta issue, the + Create custom block button label would become + Create content block. This is perfectly fine and clear to the user.

The overall title Choose a block is “ok” but imprecise. The first category title the user reads is called Content fields even though blocks are the elements the user would expect based on the sidebar title. Then there is also User fields at the end of the list. None of the fields listed in Content fields and User fields could be added under Block layout (/admin/structure/block), so technically they aren’t blocks the user might ask? This could be considered a potential source of confusion.
In this context it is also uncertain if shortening the category term titles to just System, Content, Menus and so on is such a good idea. In particular the User fields category has a block category counterpart (User <-> User Fields). Then Custom Blocks are getting renamed into Content blocks in the meta issue, so with the same current naming conventions applied the counterpart situation would be also the case here with Content <-> Content fields.

And there is also the fuzziness in regards of the naming of the sidebar title Choose a block which also applies to the + Add block-button label in the main layout builder window.

For the reference the issue was discussed and agreed on in the linked issue on Slack by @aaronmchale, @benjifisher, @rkoller, and @smustgrave

Steps to reproduce

Proposed resolution

- Rephrase the overall title Choose a block to something else. Because strictly speaking the user is able to choose between blocks and fields. The sidebar title should reflect that. The + Add block button should be changed accordingly since you are able to add blocks and fields there as well. (*There is no idea and no consensus about a suggestion yet)
- Append block to every block category. Then you have Content fields , Content blocks, User fields, User blocks, Devel blocks, Help blocks and so on. It would be clearer to the user without any ambiguity.
- Since there are cases with only a single item in a category it might be considered to add a singular and plural form to the category titles so based on the count it would be User block with one item and User blocks for several items (for the english singular/plural example)
- One nitpick, the category title core is written in lowercase but all other terms are upper case at the beginning of each category title.

Remaining tasks

User interface changes

API changes

Data model changes

Release notes snippet

📌 Task
Status

Active

Version

11.0 🔥

Component
Layout builder 

Last updated about 9 hours ago

Created by

🇩🇪Germany rkoller Nürnberg, Germany

Live updates comments and jobs are added and updated live.
  • Usability

    Makes Drupal easier to use. Preferred over UX, D7UX, etc.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • 🇬🇧United Kingdom AaronMcHale Edinburgh, Scotland

    This issue is only really postponed on 1 issue: 📌 Rename Custom Block terminology in the admin UI Fixed .

    That is the issue where we will be changing the block terminology, so once that's done we'll have a clear view on what this issue needs to change.

  • 🇬🇧United Kingdom AaronMcHale Edinburgh, Scotland

    Updating the title to better clarify what this issue is doing.

  • Status changed to Active 10 months ago
  • 🇩🇪Germany rkoller Nürnberg, Germany

    Usability review

    We discussed this issue at 📌 Drupal Usability Meeting 2024-01-19 Needs work . That issue will have a link to a recording of the meeting.

    For the record, the attendees at the usability meeting were @benjifisher, @rkoller, @simohell, @shaal, and @worldlinemine.

    If you want more feedback from the usability team, a good way to reach out is in the #ux channel in Slack.

    We’ve discussed the four open points listed in #6 - this comment will refer to those points. It has to be noted that none of the following is considered a strong recommendation.

    #6.1
    There was sort of a consensus that the mental model for the Layout Builder page shouldn’t be changed at this point and the terms Section and Block should be kept. In consequence + Add block should be kept as well.
    It has to be noted that the suggestion to go with the suggestion of something like + Add component raised in #6 was based on the observation that the user has to pick from a list of content blocks and fields in the offscreen tray and fields are actually no blocks. But I’ve learned that technically, under the hood, fields are wrapped in blocks in the context of Layout Builder. Therefore changing + Add block to something more generic like Component would be sort of counter productive and potentially confusing to the user. The same applies to the title of the offscreen tray and Choose a block could be kept.

    But on the other hand the label + Create content block in the offscreen tray is semantically wrong. Content block implies that you have a “reusable” block but the user actually creates a none-reusable inline block here. Problem is this button is the only touch point of a user with the concept of a none reusable inline block. We went through the help topics and neither on the help pages for blocks /admin/help/topic/block.overview, /admin/help/block_content nor on the help pages for layout builder admin/help/layout_builder was any word or explanation about the concept of re-usuable content blocks vs none reusable inline blocks, only content blocks are mentioned.
    One option might be to make additions to those help pages. Aside making additions to the help pages another option might be to add more touch points with those concepts in the admin ui, as proposed in #3325029: Improve the overview of the list of available blocks :

    • Show re-usuable AND none re-usable blocks on /admin/content/block
    • Add a reports page similar to Backdrop providing an overview of all created blocks

    About the actual label for the + Create content block button, the group came up with the following suggestions:

    Create block for this pageor New block for this page
    On the plus side that label makes it clear that the block is only created for this page but on the other hand the label is lengthy and what type of block is actually being created is not communicated with this label.

    Add inline block
    On the plus side inline block is the most accurate and one of the shortest labels but as mentioned before due to the fact that this offscreen tray is currently the only touchpoint with this concept inline block would also be one of the most confusing choices at this point.

    Create block
    On the plus side, in contrast to the other too specific and potential confusing suggestions, Add block is very simple and brief and through experience users will learn what this means. But on the downside going with just “block” might be too generic and again the underlaying concept of reusable and none reusable blocks isn’t touched with that variant.

    Add exclusive block
    The last suggestion that was brought up during ideation was Add exclusive block. But the consensus was that there are too many potential meanings of the word "exclusive" and it is unclear what it acutally means and refers to .

    It was also noted to keep in mind that an option to convert an inline block to a reusable content block is on the horizon as well which will complicate things even further: Add reusable option to inline block creation Needs review

    #6.2
    Appending the term Block would add a redundancy, but it would be an acceptable downside since the details of interest are front loaded. But that way it would help to clarify the point of confusion why fields are listed under the overall headline Choose a block

    #6.3
    There was sort of an agreement that based on the number of blocks it might make sense to distinguish between singular and plural form for the appended term block in the category title.

  • 🇬🇧United Kingdom AaronMcHale Edinburgh, Scotland

    But on the other hand the label + Create content block in the offscreen tray is semantically wrong. Content block implies that you have a “reusable” block but the user actually creates a none-reusable inline block here.

    "Create content block" is technically correct, as the user is creating a content block, and the user may have the option to make the block reusable. Using "content block" also avoids confusion with the list of types, after the user clicks "Create content block" if there is more than one content block type, the user will be shown a list of block types and asked to choose one to create from. In the exact same way that if they use the Add Block button on the Content Block list. So keeping the reference to "content block" ensures the user is aware that the types they are choosing from are the content block types configured under Structure.

  • 🇩🇪Germany rkoller Nürnberg, Germany

    Yes "Create content block" is "technically" correct but imprecise.

    At the moment if you click the "Create content block" button and create a block, that block shows up in the chosen section in the main content area, but at the same time you have the "Content block" section in the sidebar, the second section underneath the "Create content block" button. But the content block you've just created isn't showing up there as well. Identical labels but completely different behavior. With the current micro copy a certain knowledge about the technical backgrounds is taken for granted. And as I've noted before this sidebar is the sole direct touch point for the user with the concept of none reusable blocks in the ui.

  • 🇺🇸United States bradallenfisher

    I'm not sure if the following is being tracked, but it seems related.

    When editing a block with layout builder enabled, you no longer edit the layout builder in the front end theme. You now use the admin theme.

    Ex. /admin/content/block/1/layout - now uses admin theme whereas in the past it was frontend theme.

    on the contrary, managing the layout display for all blocks of a type:
    /admin/structure/block-content/manage/{block_name}/display/full/layout still uses the frontend theme.

    I think the preferred method is to always use the frontend theme, unless you are using a module like: https://www.drupal.org/project/layout_builder_admin_theme

    is this an issue anywhere? i can't find it. thanks!

Production build 0.71.5 2024