Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Looking at /admin/structure/types/add I think we can remove some words from descriptions to clean up the overall form a bit without losing too much information. I changed two descriptions and reduced the height of the description textarea from 5 to 2.
Description description before:
Describe this content type. The text will be displayed on the <em>Add new content</em> page.
Description description after:
This text will be displayed on the <em>Add new content</em> page.
- The first bit repeats the label and explains what a description is. No need.
- Here I left in the bit about where this will be shown. Not sure it has to, but it might be useful to help tell this apart from the Explanation or submission guidelines further down the page.
| Comment | File | Size | Author |
|---|---|---|---|
| #9 | core-shorter-description-when-adding-content-types-1957182-8.patch | 688 bytes | luismagr |
| add-content-type-ui-text.patch | 1.29 KB | yoroy | |
| Add content type texts before and after.png | 385.1 KB | yoroy | |
Comments
Comment #1
oresh CreditAttribution: oresh commentedWorks ok, no grammatical mistakes.
Changes make sens.
I think you can add 'Usability' tag, because of field height change. Maybe they would like to improve more field descriptions / height.Comment #2
webchickWhile not strictly documentation, this looks like it could benefit from jhodgdon's watchful eye.
For example, as a native speaker, "It is recommended to begin the name" is awkward to me.
Comment #3
jhodgdonI disagree on removing the "human-readable" part of the Name field's description. To me, since I do a lot of programming as well as site building, knowing whether something is meant to be a machine name or a human-readable name is important information, as is knowing where it might be displayed (or at least what types of users might see it). In this case, actually the content type name is displayed in search results, to admins adding new content and managing content, and a lot of other places, so I think it is important to mention something about that in the description text.
Also, I think the new text is innacurate. Before it suggested only using letters numbers and spaces, but now it implies that you must. I am not even sure this is a good idea to suggest -- why can't the human-readable name use whatever characters someone wants to use?
And I agree with webchick that the new text for Name is very awkward.
The change on the "Description" field is fine though. I agree we don't have to explain what the word "description" means by saying "describe the content type". :)
Comment #4
jhodgdonComment #5
darol100 CreditAttribution: darol100 commentedShould we close this issue ? If someone provide a better text and its been approve I would be happy to write a patch for it.
Comment #6
ifrikI agree with jhodgdon that for site builders the difference between machine and human readable name is quite relevant.
And that changing the help text for the Description fields makes sense.
Tagging this for the DrupalCon Barcelona so we can do this before RC1
Comment #7
luismagr CreditAttribution: luismagr as a volunteer commentedI will work on this
Comment #8
yoroy CreditAttribution: yoroy at Wunder commentedGreat! I will review when there's a patch :)
Comment #9
luismagr CreditAttribution: luismagr as a volunteer commentedThe patch doesn't apply anymore because it was implemented over a file that is not present anymore. The file was "core/modules/node/content_types.inc".
I have created the patch in the core/modules/node/src/NodeTypeForm.php where it's now the definition of this form. So that, I upload a new patch with the text for the description field.
Comment #10
yoroy CreditAttribution: yoroy at Wunder commentedFewer words = good. And I'm fine with leaving the other bits about the machine name intact. Thank you!
Comment #11
erdjordje CreditAttribution: erdjordje commentedComment #13
webchickCommitted LIVE at DrupalCon Borkalonda! ;)