Problem/Motivation
The module description is quite short and it's unclear what the difference between the Field Layout and the Layout Builder module is.
The Field Layout module description is updated in #2999610: Update the Field Layout module description to Allows users to configure the display and form display by arranging fields in several columns.
There currently is no documentation for the module, so
Proposed resolution
Assuming that my understanding of the module functionality is correct: change the module description to a wording such as
Allows users to customize the display modes of rendered entities by placing fields and blocks in regions.
.
Remaining tasks
Change the description in the info file of the Layout Builder module.
User interface changes
This is a UI text change.
API changes
None.
Data model changes
None.
Comment | File | Size | Author |
---|---|---|---|
#18 | 2999719-description-18.patch | 533 bytes | tim.plunkett |
#15 | Screen Shot 2019-01-27 at 10.43.58 PM.png | 266.11 KB | Kristen Pol |
#13 | interdiff_2-13.txt | 559 bytes | mandclu |
#13 | drupal-layout-builder-description-2999719-13.patch | 534 bytes | mandclu |
#2 | 2999719-layout-builder-module-description-2.patch | 548 bytes | ifrik |
Comments
Comment #2
ifrikThis needs a review by one of the maintainers of the Layout Builder module, to ensure that the functionality is described correctly.
Comment #3
AaronMcHaleNice idea, building on your suggestion: "Allows users to customize the display of entities by placing fields and blocks in sections which can have rows and columns of differing sizes."
(I might come back and tweak the wording a little more but that's the best single sentence summary I can come up with right now)
Comment #4
ifrikMy impression so far is that the most important feature of this module is the possibility to add to the display of an entity blocks fields that are not part of that entity.
The display in sections/rows/columns is already available in the Field Layout module.
How about, leaving the concept of rows and columns covered by the word "Layout" in the module name and highlight the ability to add other items:
Of course, in the hook_help text we can then describe this in more detail.
Comment #5
xjmGrammatically, this should be "Allows users to lay out..." (two words when it's a verb).
In "Add blocks into the display of rendered entities", the word "into" is redundant, and "display" and "rendered" are also redundant. Plus, we usually try to avoid the word "entity" in the UI.
How about something like:
Comment #6
xjmI think we should also adjust Field Layout's description to differentiate the unique purpose of Field Layout.
NW for this and #5.
Also this is almost docs gate for LB because the current description doesn't actually give any information beyond what the module name already tells you.
Comment #7
tim.plunkett#2999610: Update the Field Layout module description
Comment #8
xjmThanks @tim.plunkett. #2999610: Update the Field Layout module description is in, so just #5 then.
Comment #9
xjmMaybe:
Comment #10
volkswagenchicktagging for badcamp 2018
Comment #11
tim.plunkettComment #12
mandclu CreditAttribution: mandclu at Northern Commerce commentedComment #13
mandclu CreditAttribution: mandclu at Northern Commerce commentedUpdated to use xjm's suggestion from #9. Please review.
Comment #14
Kristen PolThe description is exactly what @xjm recommended in #9. I'll test this shortly.
Comment #15
Kristen PolThe text matches in the UI. Marking RTBC. Thanks!
Comment #16
xjmLooks great, thanks!
This could use some usability review/+1 of the text I proposed since it hasn't explicitly had that yet. Tagging for that.
Comment #17
DyanneNovaI feel like the text may imply that there is a difference in what you can do with blocks vs fields on the content. I'm also not sure if frontend is clear in this description. How about "Allows users to add and arrange blocks and content fields directly on the content."?
Comment #18
tim.plunkettI agree with @DyanneNova
Comment #19
phenaproximaAw yeah, that's a lot better. In you go!
Comment #21
xjmLooks good to me too. Great teamwork! Committed and pushed to 8.7.x.
Comment #23
tim.plunkettRetroactively tagging