Background

This issue is part of the task to review the UI texts of the modules for Drupal 8:
#2499495: [meta] Review UI text for D8 core modules

Tasks

  • Review the module description on the Extend page
  • Review the description on the Structure page
  • Review the UI text on the admin pages, such as /admin/structure/contact

Comments

ifrik’s picture

Issue summary: View changes
manjit.singh’s picture

I dont know what we have to do in this issue queue.. I know this is a very stupid question i asked. But i have checked

  • Review the module description on the Extend page
  • Review the description on the Structure page
  • Review the UI text on the admin pages, such as /admin/structure/contact

They all have different descriptions in a contact module. What we have to do now ?

pguillard’s picture

Status: Active » Needs work
StatusFileSize
new2.41 KB

I guess the sentence in the extend page :

Enables the use of both personal and site-wide contact forms

is more accurate than the one in the structure page :

Create and manage contact forms.

and I would also add this at the beginning the admin page :

This page provides a list of both personal and site-wide contact forms.

Just my suggestion...

manjit.singh’s picture

Status: Needs work » Needs review

triggering test bot

ifrik’s picture

Issue tags: +Barcelona2015
luismagr’s picture

I have reviewed this patch and it applies. Also texts seems to be fine.

shwetaneelsharma’s picture

Status: Needs review » Reviewed & tested by the community
StatusFileSize
new167.72 KB
new152.69 KB
new153.37 KB

update_texts_for_contact-2501909-3.patch passes testing. The description seem to be uniform and appropriate now.
Attaching screenshots from all three pages.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 3: update_texts_for_contact-2501909-3.patch, failed testing.

pjbaert’s picture

Status: Needs work » Needs review
StatusFileSize
new2.41 KB

Quickly rerolled this patch.

ifrik’s picture

Status: Needs review » Needs work

Thanks for the patch, but I think the administration page of the contact module needs more work by removing unnecessary text.
There is lots of duplication with the help text on that page.
We can probably reduce it two questions here: what means "select" and why can you not edit/delete the Personal contact form.

pguillard’s picture

Status: Needs work » Needs review
StatusFileSize
new2.44 KB
new1.57 KB

As of #10, I have at least removed the last two sentences that were redundant.

jhodgdon’s picture

Issue tags: +rc deadline

https://groups.drupal.org/node/484788 Apparently this needs to be "rc deadline" because it changes translatable UI text strings

+++ b/core/modules/contact/contact.links.menu.yml
@@ -1,7 +1,7 @@
-  description: 'Create and manage contact forms.'
+  description: 'Enable the use of both personal and site-wide contact forms.'

This change or something similar is being done on another issue that is unifying and updating the text shown on the Configure admin page. Probably we can take it out of this patch and in this patch, we can make sure that the rest of hook_help() agrees with the wording chosen in the other issue? See
#2570997: [Meta] Update the module descriptions on the Configuration page and child issues.

jhodgdon’s picture

Status: Needs review » Needs work

Thanks for the patch!

+++ b/core/modules/contact/contact.module
@@ -39,9 +39,8 @@ function contact_help($route_name, RouteMatchInterface $route_match) {
+      $output .= '<p>' . t('This page provides a list of both personal and site-wide contact forms.') . '</p>';

I don't think we need this line. We should NOT have things in the page help that just say what is on the page, if it is self-evident.

So I think probably this patch (the part in contact.module) should just be removing text. And the part in contact.links.menu.yml I think is covered by a different issue.

pguillard’s picture

Status: Needs work » Needs review
StatusFileSize
new1.67 KB

Applying #12 and #13 suggestions

jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community
Issue tags: -rc deadline

OK, good... So let's see what was in those two lines... sorry I am doing about 10 things at once today and maybe didn't look at this carefully enough.

So... Here (without the patch) is what the Contact forms structure page says at the top:

The Personal contact form is the form for site visitors to contact registered users; the name and recipients of this form cannot be edited. Other forms listed here are your configured site-wide contact forms, which site visitors can use to send mail to a centralized email address or addresses. You can edit the name and recipients of site-wide forms by choosing the Edit operation. You can also configure the fields and display of both personal and site-wide forms.

If you have configured a default site-wide contact form, a Contact menu link in the Footer menu will link to it. You can modify this link from the Menus page if you have the Menu UI module installed. You can also create links to other contact forms; the URL has format contact/machine_name_of_form.

If you would like additional text to appear on a site-wide contact page, beyond field labels, use a block. You can create and edit blocks on the Block layout page, if you have the Block module installed.

These paragraphs were all put there for reasons, to avoid confusion:
- Tell what the 2 types of contact forms are
- Explain why the personal form has no Edit
- Tell what the URL is for the site-wide forms. This is no longer necessary though, since the page shows these URLs directly.
- Suggest making footer menu links and tell about the existing links. We don't really need to do that.
- Suggest using blocks to add text to the page. We don't need to do that.

So... Agreed on the current patch: getting rid of those last two paragraphs is a Good Thing.

We could also probably remove some of the text in that first paragraph. I don't think we need to tell the users that they can manage the fields, since there is a Manage Fields link down there. I also don't really think we need to explain here about the edit.

Really... Maybe we don't need page-level help here at all. Do we? Is the UI clear enough without this explanation? I mean it says right in the table "Personal contact form" ... but maybe that explanation of what the personal contact form is, is helpful.

Ok.

Let's just get this patch in. And it doesn't need to be RC deadline now because it is only removing 2 strings of UI text, not adding or modifying any strings.

Bojhan’s picture

Yup, agree with jhodgdon here - we dont even need that first sentence. We only refer to "other places" when they are highly related but not in the tab navigation.

jhodgdon’s picture

Status: Reviewed & tested by the community » Needs work

Well then. Let's get rid of the entire page help in a new patch please?

pguillard’s picture

Status: Needs work » Needs review
StatusFileSize
new1.88 KB

Here we go.
@jhodgdon : This new patch just removes help on that page as suggested at #17.

jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Perfect, thanks!

xjm’s picture

Version: 8.0.x-dev » 8.1.x-dev

Nice, +1 for removing unhelpful UI text. Thanks!

As a UI change (though a small one), this should be targeted against 8.1.x now per https://www.drupal.org/core/d8-allowed-changes#minor.

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Committed 396acc1 and pushed to 8.1.x. Thanks!

  • alexpott committed 396acc1 on 8.1.x
    Issue #2501909 by pguillard, pjbaert, shwetaneelsharma, jhodgdon, ifrik...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.