Problem/Motivation

The Extend page (admin/modules) has two buttons with "Install" in the name that do two different things:

  • Install new module near the top takes you to a page that lets you upload files for a module from outside the site into the /modules directory on the web server
  • Install at the bottom turns on the modules that were selected on the form
    before_134.png

The Appearance page has a similar problem.

Then after you click the "Install new module" button, you come across another page with an "Install" button:

And after doing the upload successfully, you'll see a message that also says "installed":

Proposed resolution

The UI for the action of uploading files for a module/theme should consistently use the verb "Add" instead of "Install".

If there is any mention of removing files from the disk, that should use the verb "Remove".

Any other changes to UI text and URLs, or changes to the API functions, are out of scope for this issue. See #2888657-23: [meta] Less confusing and more consistent wording needed in module/theme add/install/update for a discussion of other planned changes on other issues.

Remaining tasks

  1. [Patch is on #186] Make a patch that changes the verb for uploading files for a module/theme to the web server to consistently use the verb "Add" and not "Upload" or "Install".
  2. Novice task: Make screenshots for this change. Screenshots needed/made:
    - Extend -- admin/modules (part at top with Add new button): https://www.drupal.org/files/issues/2020-11-14/after-extend.png
    - Appearance -- admin/appearance (similar): https://www.drupal.org/files/issues/2020-11-14/after-appearance.png
    - update status report (similar): https://www.drupal.org/files/issues/2020-11-14/after-updates.png
    - Page you get to after clicking one of these three buttons: https://www.drupal.org/files/issues/2020-11-14/after-add-page.png
    - Error message if there is a problem adding a module/theme: https://www.drupal.org/files/issues/2020-11-14/new-error-uploading.png
    - Successful result after adding a module: https://www.drupal.org/files/issues/2020-11-15/added-module-succesfully.png
    - Successful result after adding a theme: https://www.drupal.org/files/issues/2020-11-15/added-theme-succesfully.png
  3. Review the patch.

User interface changes

Less confusing UI text around the action of uploading files for a module/theme to the web server.

API changes

None.

Data model changes

None.

People to credit

There are numerous people who worked on other issues that are now marked as duplicates of this one, who should be credited here:

CommentFileSizeAuthor
#198 2577407-198-added-updated.png30.86 KBressa
#195 2577407-195.patch23.66 KBjhodgdon
#195 interdiff-186-195.patch7.09 KBjhodgdon
#195 2577407-186reroll-patch.txt23.7 KBjhodgdon
#189 added-theme-succesfully.png27.3 KBressa
#189 added-module-succesfully.png27.83 KBressa
#186 interdiff-184-186.txt3.38 KBjhodgdon
#186 2577407-186.patch23.83 KBjhodgdon
#186 new-error-uploading.png14.59 KBjhodgdon
#185 erroruploading.png19.36 KBjhodgdon
#185 after-add-page.png45.99 KBjhodgdon
#185 after-updates.png24.99 KBjhodgdon
#185 after-appearance.png26.35 KBjhodgdon
#185 after-extend.png28.08 KBjhodgdon
#184 interdiff-181-184.txt6.91 KBjhodgdon
#184 2577407-184.patch24.5 KBjhodgdon
#181 2577407-181.patch19.87 KBjhodgdon
#174 2020 07 16 Drupal's Installation User Interface Change Suggestions.txt6.63 KBsajosh
#160 extend.png22.59 KBifrik
#137 module_install_form_has-2577407-137.patch1 KBvulcanr
#125 2577407-124.txt1 KBvulcanr
#122 module_install_form_has-2577407-122.patch1 KBvulcanr
#118 screenshot.png68.64 KBbrahmjeet789
#118 interdiff.txt2.23 KBbrahmjeet789
#118 module_install_form_has-2577407-116.patch0 bytesbrahmjeet789
#114 module_install_form_has-2577407-114.patch2.12 KBvulcanr
#112 Update_manager___Site-Install.png22.74 KBxjm
#111 install_page.png43.32 KBxjm
#107 screenshot_after.jpg53.58 KBTony-Mac
#107 screenshot_before.jpg71.39 KBTony-Mac
#104 screenshot_before.jpg71.39 KBTony-Mac
#104 screenshot_after.jpg70.84 KBTony-Mac
#59 after.png46.25 KBsnehi
#103 module_install_form_has-2577407-103.patch1 KBvulcanr
#102 module_install_form_has-2577407-102.patch1 KBmanjit.singh
#59 before.png42.31 KBsnehi
#54 Screenshot2.png46.71 KBsnehi
#97 module_install_form_has-2577407-97.patch449 bytesvulcanr
#50 Screenshot.png36.55 KBsnehi
#91 module_install_form_has-2577407-91.patch449 bytesvulcanr
#75 Screenshot.png50.08 KBsnehi
#41 drupal-rename_install_button_to_save_configuration-2577407-41-D8.patch21.65 KBsagar ramgade
#23 save_configuratio-23.patch605 bytesAnonymous (not verified)
#34 drupal-rename_install_button_to_save_configuration-2577407-20-D8.patch12.41 KBsagar ramgade
#74 2577407-74.patch1.75 KBsnehi
button_issue.png31.1 KBsnehi
#62 Screen Shot 2015-10-18 at 9.44.04 AM.png177.2 KBcilefen
#30 drupal-rename_install_button_to_save_configuration-2577407-D8.patch16.67 KBsagar ramgade
#16 save_configuration-15.patch605 bytesAnonymous (not verified)

Comments

snehi created an issue. See original summary.

cilefen’s picture

Status: Active » Closed (works as designed)
Issue tags: -save button

This is the form for installing modules. That is all it does, and that is different from D7. There is a different form for uninstalling them, so "Install" is appropriate here.

snehi’s picture

Status: Closed (works as designed) » Active

This is the extend page where we can enable module that are already installed. I don't think install button should be there.
There is already a button named as install new module which link to another page for installing module and there is also a install button, which is OK.
I hope you got my point.

cilefen’s picture

Issue tags: +Usability

Maybe "Enable"?

snehi’s picture

I think save configuration because it also includes disabling too.

nickdickinsonwilde’s picture

Issue summary: View changes
nickdickinsonwilde’s picture

No disabling is not on that page - that page only lets you enable modules - uninstall and install are on different pages. So I would say enable would make the only logical/userfriendly sense.

Bojhan’s picture

Status: Active » Closed (works as designed)

This works as designed. We changed the functions, you now "install" not enable.

snehi’s picture

Status: Closed (works as designed) » Active

Hi all i m talking about EXTEND page in D8.
Install button at the bottom of this page means you are installing all the selected modules. But in actual these modules are already installed we have to just enable on this page.
Let me know if further clarification required. Please don't close the issue directly, first discuss and then close it.

cilefen’s picture

@Bojhan I think the issue and the head-scratcher on this form is that there is an "Install new module" button and and "Install" button. They do two different things: the former installs the files for a module, and the latter installs the module in the database.

Anonymous’s picture

Assigned: Unassigned »
Anonymous’s picture

@snehi
should install button be save configuration or save configurations

cilefen’s picture

The button enables modules and nothing else, so i vote for "Enable Modules".

longwave’s picture

How about "Install selected modules", as opposed to "Install new module"?

cilefen’s picture

@longwave There is an "Install new module" button at the top of the page, which is the form that actually downloads modules. The idea is to differentiate this button, which enables modules, from that one.

Anonymous’s picture

StatusFileSize
new605 bytes
Anonymous’s picture

Status: Active » Needs review
cilefen’s picture

Issue tags: +Needs usability review

I think the standard is "Save configuration". The second word is not capitalized. "Save configuration" is an improvement over "Install", but I prefer "Enable modules", but we may be moving away from the notion of "enabling" to simply "install" and "uninstall".

Anonymous’s picture

@cliefen "Enable modules" is good. so can i change "Save Configuration" as "Enable modules" or just kept it as "Save configuration"

longwave’s picture

@cliefen Yes, so I am suggesting "Install selected modules" for the bottom button, and keep "Install new module" at the top.

Status: Needs review » Needs work

The last submitted patch, 16: save_configuration-15.patch, failed testing.

Anonymous’s picture

Status: Needs work » Active
Anonymous’s picture

StatusFileSize
new605 bytes
cilefen’s picture

Re #19 and #20: The top button downloads, then installs a module. The bottom button installs (formerly "enables") the modules. The trouble is the wording of install. Of anything, I like @longwave's suggestion in #20 more than my own.

Anonymous’s picture

Status: Active » Needs review

Status: Needs review » Needs work

The last submitted patch, 23: save_configuratio-23.patch, failed testing.

The last submitted patch, 16: save_configuration-15.patch, failed testing.

cilefen’s picture

@pavan.maddula The tests are failing because each test line referencing the "Install" button must be updated too. Can we try it with the suggestion in #20?

The last submitted patch, 23: save_configuratio-23.patch, failed testing.

sagar ramgade’s picture

I think its better to rename the Install button to "Save configuration" as same form is used to install/enable/disable modules. I had attached the patch which covers the test too.

sagar ramgade’s picture

Status: Needs work » Needs review
longwave’s picture

No, this form is only used to install modules. There is no concept of enabled or disabled modules any more, and to uninstall them you have to use the separate tab provided for this.

Anonymous’s picture

Status: Needs review » Active
sagar ramgade’s picture

Status: Active » Needs review
StatusFileSize
new12.41 KB

Sorry about that I was unaware, suggestion in #20 makes sense and patch is attached.

Anonymous’s picture

Status: Needs review » Active

Status: Active » Needs work

davidhernandez’s picture

#20 is the only suggestion that seems reasonable. This page is installing modules, not simply enabling them, so I think that needs to be referenced in the button/text.

sagar ramgade’s picture

Attached the patch which covers the test missed in earlier one.

marvin_b8’s picture

Status: Needs work » Needs review

Status: Needs review » Needs work

Status: Needs work » Needs review
Anonymous’s picture

Assigned: » Unassigned
cilefen’s picture

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

Now that we are in RC and this issue changes translatable strings, it is postponed to 8.1.x.

dawehner’s picture

The issue summary is seriously confusing at the moment.

cilefen’s picture

Title: Install button instead of save configuration » Module install form has two "install" buttons that do different things
Issue summary: View changes

better?

sagar ramgade’s picture

yes that makes sense than earlier.

snehi’s picture

Status: Needs review » Needs work
StatusFileSize
new36.55 KB

@Sagar Thanks for the patch
Screenshot but i think it should be 'Save configuration'

cilefen’s picture

Status: Needs work » Needs review

@snehi I am not sure that is agreed.

snehi’s picture

Status: Needs review » Reviewed & tested by the community

This is RTBC now.

yesct’s picture

Issue summary: View changes
Status: Reviewed & tested by the community » Needs review
Issue tags: +Needs screenshots

@snehi thanks for looking at this issue.

especially a rtbc review should have some explaination of what was reviewed and why the changes are ok.

this issue had a couple "needs" tags on it, which indicate that it is not rtbc until those things are done.

additionally, I think in this issue, we need screenshots in the issue summary. I added a link with instructions for how to make nice screenshots.
specifically, in this case, we should have a screenshot which shows both buttons, the one at the top, and the one at the bottom. (both before and after screenshots)

snehi’s picture

Issue summary: View changes
StatusFileSize
new46.71 KB
snehi’s picture

@YesCT Hows Now ?

cilefen’s picture

@snehi Based on YesCT's comment...

specifically, in this case, we should have a screenshot which shows both buttons, the one at the top, and the one at the bottom. (both before and after screenshots)

... no, we need more.

Also please read the patch review article to find out what is expected. It is not necessary to do every little thing, however, you should review the patch on all relevant points.

Finally, the screenshot you just posted contradicts the issue summary and the newest patch.

snehi’s picture

Status: Needs review » Needs work

@cilefen, Sorry for doing this. Actually i applied the patch in drupal 8.0.x but i checked it in 8.1.x in wrong Drupal Installation.
It is my fault, i am changing issue status.
In 8.1.x this issue is resolved and install button is now as save configuration but i lost my 8.0.x it is showing

The website encountered an unexpected error. Please try again later.

Again my Apologies for the same.

cilefen’s picture

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

Let's put this back on 8.0.x for the sake of testing. I don't even know the status of the 8.1.x branch. It has no commits merged since 2014. I wish we still had the 8.x branch.

I think the button used to read "Save configuration" but a more recent change converted it to "Install" so this issue is necessary. What we want is "Install selected modules".

snehi’s picture

StatusFileSize
new42.31 KB
new46.25 KB

It is well working in 8.0.x.

Before

before_134.png

After

after_139.png

cilefen’s picture

@snehi Could you put the screenshots in the issue summary please?

snehi’s picture

Issue summary: View changes
cilefen’s picture

cilefen’s picture

Status: Needs work » Needs review
Bojhan’s picture

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

I dont think this resolves anything? Aslong as they both state "Install" its likely people will confuse the two.

cilefen’s picture

@Bojhan I do not understand you reasoning. The patch makes them say "Install new module" and "Install selected modules", which is an improvement over "Install new module" and "Install", which are confusing.

Bojhan’s picture

@cilefen You are right that the output is different and more specific. But do you think people won't just keep confusing the two? I think the bottom should be install, and the top should be Add module? Since you are not installing it anyway?

cilefen’s picture

But do you think people won't just keep confusing the two?

That could happen.

I would prefer removing "Install new module" and making a new tab layout. Instead of List, Update, Uninstall: Install, Uninstall, Add, Update.

Bojhan’s picture

Nope, that is against UI guidelines see #1090012: Tabs

I don't want this to turn into a opinions game. We have established patterns for buttons, and they ought to be as short and simple as possible. This is diverting from that. We start actions at the top with the Add "result" and in this case that is adding a new module, it is not installing. We can spend more time discussing this, but I am not sure how effective that is over queues.

cilefen’s picture

Status: Needs review » Closed (won't fix)

Then why push it to 8.1.x? There is nothing to discuss.

Bojhan’s picture

Status: Closed (won't fix) » Needs work
Issue tags: -Needs usability review

I hope you are not getting frustrated. We can fix this in 8.1, I feel like we can resolve this - but perhaps not the solution your proposing.

cilefen’s picture

Sorry, I thought that what you wrote in #68 meant "no".

Bojhan’s picture

What about: "Add new module" at the top and "Install" at the bottom?

cilefen’s picture

Yes, that would be an improvement.

snehi’s picture

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

Adding Patch.

snehi’s picture

Assigned: Unassigned » snehi
StatusFileSize
new50.08 KB

Adding screenshot.
Screenshot_122.png

cilefen’s picture

@snehi Could you put the new screenshot in the issue summary as the new "after" screenshot and update the issue summary with the new plan?

snehi’s picture

Issue summary: View changes
snehi’s picture

Issue summary: View changes
snehi’s picture

@cilefen Done.

jhodgdon’s picture

I just reported #2667812: UI text around "install" and "enable" when you download/install/enable a module from d.o is confusing, which is mostly a duplicate of this issue.

However, in that report, I also suggested we need to change the form on admin/modules/install so that it doesn't say "install" all over it, and also the form you get to after you do an upload, which says you need to go "enable" the new modules (we don't say "enable" any more, and there is no "enable" on the admin/modules page that this links to, it's "install").

I don't think this issue covers those two problems. Should we:
a) Expand this issue to cover those two problems
b) Keep the other issue open to cover those two problems.

Also... what about themes? I bet the wording problem is the same there?

My recommendation would be, since this is such a small patch anyway and it's all UI, we fix all of the related problems on this one issue rather than fragmenting.

Thoughts?

cilefen’s picture

I agree with your recommendation.

jhodgdon’s picture

If no one disagrees with that recommendation, we should copy the "Problem" section from the other issue's summary to here, because it's more complete, and close the other one as a duplicate. And probably change the title here to include the new problems.

David_Rothstein’s picture

Is this a duplicate of #2543066: "Install new module" and "Install new theme" links are confusing?

In that issue I had thought about "Add new module" but felt like it just introduced even more unclear terminology (do most people really perceive a difference between "add" and "install")? So in short, if you come to that page intending to turn on something like the Forum module (which ships with core) you might still be very tempted to click "Add new module" at the top (i.e. to add the Forum module to your site) and then wind up stuck.

My suggestion to resolve that was to rename the top link to "Install a module not listed below" (or if we can find a less wordy way to say the same thing) and leave the bottom button alone, and then also do #992190: Link to enable a new module after adding it via the Update Manager is confusing - allow users to enable it directly from that screen instead so that the top link can be used to do what people expect it to.

jhodgdon’s picture

We have at least 3 issues around this same problem. Let's consolidate and make 1 issue and fix all the problems there.

snehi’s picture

I closed the following issues. We can start work over here.

https://www.drupal.org/node/2543066
https://www.drupal.org/node/992190

David_Rothstein’s picture

Issue tags: +Needs backport to D7

Also transferring the backport tag over from the first issue.

jhodgdon’s picture

Status: Needs review » Needs work
Issue tags: +Needs issue summary update

Also we desperately need an updated issue summary here that explains exactly what this issue is and isn't covering. And probably, since the issue scope here has been expanded, a new patch that fixes the full scope.

But please, first an issue summary update so we know what we are trying to solve.

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

Drupal 8.1.0-beta1 was released on March 2, 2016, which means new developments and disruptive changes should now be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.0-beta1 was released on August 3, 2016, which means new developments and disruptive changes should now be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

vulcanr’s picture

StatusFileSize
new449 bytes

Only updated the label created at

update.links.action.yml

WIth the new label for that button.

vulcanr’s picture

Status: Needs work » Needs review

Status: Needs review » Needs work

The last submitted patch, 91: module_install_form_has-2577407-91.patch, failed testing.

The last submitted patch, 74: 2577407-74.patch, failed testing.

vulcanr’s picture

Status: Needs work » Needs review

patch 91

vulcanr’s picture

Issue tags: +Dublin2016
vulcanr’s picture

StatusFileSize
new449 bytes

Added new patch.

Status: Needs review » Needs work

The last submitted patch, 97: module_install_form_has-2577407-97.patch, failed testing.

pixelmord’s picture

Issue tags: +String change in 8.3.0

I reviewed the patch and it does exactly what this issue goal requires.

Patch applies cleanly to 8.3.x

manjit.singh’s picture

But i dont know why the testing is going to fail again and again in 8.2.x. finger crossed for 8.3 ;)

The last submitted patch, 97: module_install_form_has-2577407-97.patch, failed testing.

manjit.singh’s picture

Status: Needs work » Needs review
StatusFileSize
new1 KB

updating the test file also.

vulcanr’s picture

New patch changing the strings in both files.

Tony-Mac’s picture

StatusFileSize
new71.39 KB
new70.84 KB

Before and after screenshots

Tony-Mac’s picture

Tony-Mac’s picture

Tony-Mac’s picture

StatusFileSize
new71.39 KB
new53.58 KB

Ooops uploaded same jpgs twice. Corrected.

manjit.singh’s picture

Status: Needs review » Reviewed & tested by the community

Changes looks good as per the expectation in the description.
Removing the duplicate patch - #102.

xjm credited shell_cm.

xjm’s picture

Issue summary: View changes
Status: Reviewed & tested by the community » Needs work
StatusFileSize
new43.32 KB

So this issue has gone a lot of different places over the past year, but the current patch looks great to me for two reasons:

  1. It uses the "+Add thing" button pattern found elsewhere in core.
  2. It finally clears up the difference between installing a module that is already on your site, and the thing that allows you to download a module and not install it.

Great work everyone!

However, the "+Add new module" button still takes you to a page entitled "Install new module" at /admin/modules/install. I think in order for this change to be complete, we also should change the word "Install" to "Add" on that page as well. Otherwise, we are making the UI text on the other form more confusing.

Since I don't think the changes can be made separately, I've closed #2667812: UI text around "install" and "enable" when you download/install/enable a module from d.o is confusing as a duplicate of this issue.

xjm’s picture

Issue summary: View changes
StatusFileSize
new22.74 KB

Then there's the strings after you submit the form on authorize.php:

That also needs "Install*" fixed to "Add*" as well as "Enable newly added modules" changed to "Install newly added modules" (not as directly in scope, but also confusing because it uses the old terminology).

xem8vfdh’s picture

I'm wondering why the options aren't:

"Install new module" -- actually downloads/unpacks/"installs" the module package (currently: "Install a new module")
"Enable Module" -- enables the module (currently: "Install module")
"Disable Module" -- disabled the module (currently: "Uninstall module")

In the grand scheme, isn't Drupal only capable of installing, enabling, and disabling modules? There is no actual "uninstall" functionality, just disabling functionality. To actually uninstall, one must "Uninstall" (read: disable) the module from the UI, then remove (read: uninstall) the files from the file system via command line/(s)ftp.

I think the word "install" is misused and, as a result, confusing.

While we are at it, it would be nice if there was legitimate "uninstall" functionality that could be run after disabling a module, to completely remove it from the file system.

vulcanr’s picture

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

Ok adding a new patch, changing the wording on the "INSTALL" button at: /admin/modules/install

Also changed the sentence: Install another module (when a module has been installed/added) to Add another module

Pending for review.

Thanks for the feedback btw.

Status: Needs review » Needs work

The last submitted patch, 114: module_install_form_has-2577407-114.patch, failed testing.

greta_drupal’s picture

First of all, it doesn't matter what Drupal is actually doing in the backend (like installing to database after 'installing' in UI), it only matters about the user's comprehension about what is occurring. "Install a module" at the top works, but "Install" at the bottom doesn't, nor does "Enable" because the submit button also saves the disabled states.

There are 3 operations on this page/tab: 1.) Installing a module; 2.) Enabling an installed module - by checking the box; 3.) Disabling an installed module - by unchecking the box.

IMO, the bottom button should read "Save settings" or such to match other pages where this same behavior (checking/unchecking settings) is used -- permissions, configurations, etc. And, the checkbox column could simply be labeled Enable/Disable.

Alternatively: Activate and Inactivate* (over Enable and Disable).

In practice, the newer UI way to represent these states is with a slider on/off button (e.g., YouTube videos autoplay), rather than checkbox.

If you use "Add new module" here, then also use "Add new theme" on Appearance page -- and likewise enable/disable (or activate/inactivate). Stop intermixing the terms "add", "install", "enable" (and their counterparts) throughout the Drupal platform. All these issues of nomenclature need to be discussed as a package, not simply patched per individual issue in a long queue of related UI issues, without coordination. [And, how has Drupal come this far without that having been mapped out from the beginning?]

Has this UI language been reconciled with the themes page language too?

* While native English speakers will be more familiar with "deactivate", it doesn't have a parallel adjective ("deactive" not a valid word)

vulcanr’s picture

I agree with greta_drupal @ #117. I think what we need to close this issue is:

- Agree in which wording to use (including after installing the module).
- Change the wording on code.

We won't be able to close this issue, if we don't do that.

Br.

brahmjeet789’s picture

StatusFileSize
new0 bytes
new2.23 KB
new68.64 KB

I agree with @vulcanr and @greta_drupal becuase in drupal-7 also we have "install new module" so we can change intall text to enable or more i also changed some chunks is it fine? please heck.

brahmjeet789’s picture

Status: Needs work » Needs review

Status: Needs review » Needs work

The last submitted patch, 118: module_install_form_has-2577407-116.patch, failed testing.

gábor hojtsy’s picture

@brahmjeet789: seems like the patch you uploaded is empty and the screenshot you attached is not related to this issue? It is not even a core UI screenshot.

vulcanr’s picture

Added a new Patch. Changing the strings. Please review.

Just changed the 2 strings mentioned on #117.

gábor hojtsy’s picture

Issue tags: +sprint

@vulcanr: can you post an interdiff? https://www.drupal.org/documentation/git/interdiff

vulcanr’s picture

Status: Needs work » Needs review
vulcanr’s picture

StatusFileSize
new1 KB
gábor hojtsy’s picture

@greta_drupal: how can you disable an installed module on the module install page? Disabling a module in general is not a feature that exists in Drupal 8 that I know of. (Uninstalling is).

tkoleary’s picture

Status: Needs review » Reviewed & tested by the community

Some of @greta_drupal's comments are valid points but really relate to other issues already open such as #2035079: [PP-1] Figure out what to do with the install/uninstall modules page

As far as this patch it works perfectly and does what is intended, disambiguates 'Add' ie. 'go find a module to add to this list' from 'install' ie 'submit the form to activate the checked modules'.

Bojhan’s picture

Thanks for all the work, this sounds like a good choice - hope we can convert the others soon.

xjm’s picture

Status: Reviewed & tested by the community » Needs work

My previous reviews in #111 and #112 have not been fully addressed.

vulcanr’s picture

xjm I honestly think that then we are scoping much more than what we have in the task. We would then need to scope the entire admin part to see where else are showing those tables. To be honest I think we could do a follow-up task after fixing this one.

tkoleary’s picture

@xjm I tend to agree with @vulcanr on this one.

The contexts are different and require different solutions. When I am on the extend page the "Add module" button is not installing a module, it is bringing me to a place where I can install a module by importing or uploading.

Once I'm on this page I still cannot 'install' a module which can only be done on the extend page, but I also want more specificity than just "add". Something along the lines of:

[title] Get modules

[field label] Import from Drupal.org
[description] Paste the URL of the version you want to import here.

[field label] Upload an archive from your computer.
[description] If you have downloaded a module archive zip or tag.gz to your computer, upload it here.

The important thing here is that we are being explicit about the fact that you are "getting" the modules from elsewhere and that there are two ways to "get" them; import and upload. At least that's my take on it, whatever the solution, the specific needs of the import/upload screen and to the messages it returns are not adequately addressed by simply extending "add" and need to be handled individually.

tkoleary’s picture

Status: Needs work » Reviewed & tested by the community

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 122: module_install_form_has-2577407-122.patch, failed testing.

gábor hojtsy’s picture

Status: Needs work » Reviewed & tested by the community

Unrelated fails with upgrades and missing config schemas.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 122: module_install_form_has-2577407-122.patch, failed testing.

vulcanr’s picture

I'll upload a new patch

vulcanr’s picture

vulcanr’s picture

Status: Needs work » Needs review
gábor hojtsy’s picture

Status: Needs review » Reviewed & tested by the community
David_Rothstein’s picture

Status: Reviewed & tested by the community » Needs work

What about #83 and the older issue/patch linked there? No one has responded to any of that yet. I do not agree that the wording change in the current patch improves usability - it effectively just replaces one confusing word ("install") with another ("add").

Comparing to the patch in the other issue also points out two required changes that are needed here:

  1. The Update Manager help text in update_help() refers to this button directly by name, so the text needs to be changed there too.
  2. I think tkoleary is right that this issue doesn't need to change the terminology everywhere, but at the very least it should change other buttons that are exactly equivalent (such as the "Install new theme" button on the Appearance page, and possibly the "Install new module or theme" button on the Available updates page). Modules and themes should not use different terminology for the same action. #80 and #116 mentioned this also.
David_Rothstein’s picture

Trying to combine the ideas from this issue and #2543066: "Install new module" and "Install new theme" links are confusing, the button text could be:

"Add modules not listed below"

Or perhaps (since the goal was to shorten that) just:

"Add other modules"

The key point is that the word "new" is currently very confusing. Everyone going to this page is there because they want to add a new module to their site. What the text needs to communicate to them is that this is the link to use if you want to add a module that isn't already listed on the page.

vulcanr’s picture

@David_Rothstein I totally agree with you, and that's why a while ago I was asking if there is any native english speaker that could give us the right wording (which could make things more clear)

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.0-alpha1 will be released the week of January 30, 2017, which means new developments and disruptive changes should now be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

charles belov’s picture

Issue summary: View changes

Native English speaker here. I dispute the wording in the issue description.

  • Install new module downloads and installs a module
  • Install installs the modules that were selected on the form

This implies the end state is the same. However, if I do the first button action, I have to follow it up with the second button action. Therefore "Install" has two different meanings. Better wording for the issue, which I have applied:

  • Install new module downloads a module and makes it available for installing via the Install button
  • Install installs the modules that were selected on the form

However, the instructional text in the UI reads

"Download additional contributed modules to extend your site's functionality."

Therefore, I suggest the first button be reworded to agree with that wording:

Download contributed module

so that admins can see the direct relationship between what the UI is telling them they can do and actually doing it.

However, it's not clear to me if this button can be used both to download a contributed module and to update an existing module. If that's the case, then:

Download contributed or updated module

would be clearest.

charles belov’s picture

Issue summary: View changes

Clarified my rewording of what the first button accomplishes.

charles belov’s picture

charles belov’s picture

Issue summary: View changes

Added "Additionally, whatever wording change is made would need to be carried through to /admin/modules/install." to UI change description and possibly the URL.

charles belov’s picture

Issue summary: View changes

Added /core/authorize.php, the page that appears when you submit /admin/modules/install, as a page affected by the resolution of this issue.

charles belov’s picture

Issue summary: View changes

Short answer:

I suggest that the button which goes to /admin/modules/install be changed as follows:

On /admin/modules, change to "+Load contributed module"
On /admin/reports/updates, change to "+Load contributed module or theme"
On /admin/appearance, change to "+Load contributed theme"
On /core/authorize.php, change links upon loading a module to be consistent with the above buttons.

I suggest that the button on /admin/modules/install be changed to "Load" and the page title changed to Load Contributed Module or Theme.

I suggest that, for consistency, the button on /admin/theme/install be changed to "Load" and the page title changed to Load Contributed Theme.

I've made minimal changes to the issue description to call out the pages that need to be maintained.

Long answer:

Okay, after some testing, I'm not sure whether to change this issue's title to something like "Hamonize Extend module/theme-add/update terminology" or create a new issue. The point is, it's not just that first button, it's all of the terminology around "installing" a module into the file system vs. "installing" a module that is already in the file system into the database, as well as the sequence in which the instructions occur.

/admin/modules

Download additional contributed modules to extend your site's functionality.

Regularly review and install available updates to maintain a secure and current site. Always run the update script each time a module is updated.

+Install new module button (button)

Would better be:

Download or upload additional contributed modules to extend your site's functionality.

+Load contributed module (button)

Regularly review and install available updates to maintain a secure and current site. Always run the update script each time a module is updated.

This is because:

1) The +Download a module button only works to add a non-present module to the file system. I just tested and it cannot be used to update a module that is already in the file system. Therefore, it needs to be moved to immediately after the relevant instruction it can be used to respond to.

2) /admin/reports/updates/update uses the term Download these updates (button) for the act of obtaining a file from someplace else and placing it into the file system.

That said, /admin/modules/install both lets you "Download" from Drupal.org or whatever website and "Upload" from your local computer network, so I can see why "Download" might be confusing. We could go simply with "Load" on the button, that is "Load contributed module or theme".

/admin/modules/install

You can find modules and themes on drupal.org. The following file extensions are supported: zip tar tgz gz bz2.

Install from a URL
For example: http://ftp.drupal.org/files/projects/name.tar.gz
Or
Upload a module or theme archive to install
For example: name.tar.gz from your local computer

Install button

would better be:

You can find modules and themes on drupal.org. The following file extensions are supported: zip tar tgz gz bz2.

Download from a URL
For example: http://ftp.drupal.org/files/projects/name.tar.gz
Or
Upload a module or theme archive to install
For example: name.tar.gz from your local computer

Load button

/admin/reports/updates

Here you can find information about available updates for your installed modules and themes. Note that each module or theme is part of a "project", which may or may not have the same name, and might include multiple modules or themes within it.

+Install new module or theme button (goes to /admin/modules/install)

In this case, whatever the button is changed to on /admin/modules, this button would be changed to have the same wording, plus the words "or theme." I supposed it's okay that there would be a difference of "or theme" because /admin/reports/updates concerns both themes and modules, while /admin/modules just concerns modules.

/admin/modules/update

Has button Download these updates

If we were to adopt "Download..." or "Load..." as the word to appear on the various buttons under debate, this would bring the terminology into consistency with the exsiting wording on /admin/modules/update.

charles belov’s picture

charles belov’s picture

Issue summary: View changes

Added reference to /admin/reports/updates/install in the description.

David_Rothstein’s picture

On /admin/modules, change to "+Load contributed module"
On /admin/reports/updates, change to "+Load contributed module or theme"
On /admin/appearance, change to "+Load contributed theme"

I think "Load" might be too vague to explain what the button does.

Mentioning "contributed" here is interesting though. It feels a bit jargon-y to me, and it's also potentially confusing since it's likely that there are some contrib modules/themes available on the page already. But on the other hand, as you point out it's already used in the nearby help text.

Combining that with some refinements of what I wrote in #141 here are a few new possible suggestions:

Add contributed module
Get contributed module
Add more modules
Get more modules

I'm particularly interested in the last two.

charles belov’s picture

You have a good point that "contributed" module is jargony. There's also the issue that the page isn't restricted to bringing in contributed modules; it can also be used by custom modules. The actual key is that it is for modules that are not part of core.

I love "Get" because the whole upload/download question becomes meaningless when both the source and the site can be anywhere. I prefer "Get" to "Add" because "Add" could be misconstrued as enabling the module as well, while "Get" is clearly about movement only.

Most accurate would be "Get a non-core module" but I'd be okay with "Get a module". It does need to be singular, since the page the button takes you to will only let you get one module, after which it redirects you to a different page.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

markusd1984’s picture

Issue tags: -

Does "enable newly added module" link directly to that module / enable it or does it just open the module list?

For me, in D7 it links to admin/modules which means I always need to search for it first.

https://www.drupal.org/project/drupal/issues/2950433#comment-12512340

xem8vfdh’s picture

@markusd1984, it simply links the user back to the admin modules list page. And yes, the user has to first find it on the page, then check the box, then scroll down and click enable. Unless I am misremembering, this is how it has always worked in D6, D7, and D8. I had no experience with previous Drupal versions.

vulcanr’s picture

@xeM8VfDh same thing :)

markusd1984’s picture

thanks for clarifying. I understand modules have dependencies which probably adds to the complexity.

It would be nice when they are met, that the link could actually trigger the enabling of that module,

that would make installing + enabling a lot quicker ;)
Suprised I couldn't find much about it so far, would have thought people would want this to avoid the search step

ifrik’s picture

Assigned: snehi » Unassigned
Status: Needs work » Closed (outdated)
Issue tags: +DevDaysLisbon
StatusFileSize
new22.59 KB

The "install module" button at the top of the page has been removed already, so this issue doesn't apply anymore. Closing the issue as outdated.

cilefen’s picture

Status: Closed (outdated) » Needs work

I'm not sure what you mean. "Install new module" is still there in 8.6.x although it is not there in the screenshot you posted.

ifrik’s picture

Thanks,
I don't quite know why I didn't have that button there.

However this issue re-opens a whole can of worms about the use of "Install" and "Uninstall" where for Drupal 8 - in contrast to Drupal 7 - it should say enable/disable.
In any case this button cannot be changed without then also changing the page it links, as well as the equivalent link on the Appereance page and the page to Install a new theme.

So - unless we want to go for a consistent language use of "Install" is putting it on the server (either through the GUI/FTP, wget, drush download, composer require) and "enable" for the step that makes functionality of the module or submodule available (either by clicking Install in the GUI or running drush enable) - I would leave this one alone for now, or make a proposal that can get a UX review before making the patch.

cilefen’s picture

@ifrik That was touched upon around comment #68.

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

xjm’s picture

Component: user interface text » update.module

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

jhodgdon’s picture

This is really a duplicate of #1207354: Install new module v/s Add new module and probably #976232: "Install" button at admin/*/install should be labeled "Continue" too? Not sure which one(s) we should keep open but probably not all 3. I will comment on the other 2 issues too.

sajosh’s picture

I suggest these changes on this page,
/admin/modules

The first just rearranges to start with the word Extend since that's the menu title of this page. Also add links to the install and update.php processes so the new user can review and understand before starting anything.

The second is not to use the words install and update together since we're using them for different purposes.

Third, why have /admin/modules/update and /admin/reports/updates? I vote for getting rid of reports/updates and putting that info in modules/update.

Extend your site's functionality by adding contributed modules.

Update changed modules (/admin/reports/updates) regularly to maintain a secure and current site. Always run the update script (/update.php) each time a module is updated.

I suggest these changes on this page,
/admin/modules/install

Add module or theme from a URL

Or

Add module or theme by uploading the archive

Button should be "Add it" because there's another step, to enable it.

Even the /core/authorize.php page uses the word "add" as per this issue.

Hi jhodgdon, I vote to keep
https://www.drupal.org/node/2577407
since it has 170 comments versus 20 and 14 for
https://www.drupal.org/project/drupal/issues/1207354
https://www.drupal.org/project/drupal/issues/976232

The word 'Add' is correctly suggested by arshadcn
https://www.drupal.org/project/drupal/issues/1207354
and Pancho has an excellent summary
https://www.drupal.org/project/drupal/issues/1207354#comment-7393362

There are a number of issues about this install workflow's wording. My suggestion is to start with the word "Add" module which then goes to the word "Enable" module then "Update" module then "Disable" module then "Uninstall" module then finally "Remove" module. All links, buttons and documents should use these words.

jhodgdon’s picture

(removing making this issue "related" to itself)

I decided #1207354: Install new module v/s Add new module was a duplicate and, as you said, even though it was older it had less discussion, so it is now closed.

#976232: "Install" button at admin/*/install should be labeled "Continue" is closely related, but is about the "Install" button that is on the next screen after you click the button that is currently labeled "Install new module" from this issue. I think we should fix them together, but we would need to expand the scope here slightly.

We have a usability team and it would be good if they could decide what to do, so that we could implement it. The patch itself is pretty easy; the hard part is figuring out a better UI.

sajosh’s picture

Hi Jhodgdon,

You're right, this is pretty easy (just wording changes), just needs some dedicated attention. I'm happy to help.

Four years ago Vulcanr kindly patched to be "+Add new module" but then the next comment got him to change it back, then he changed it back to Add then changed back, argh.

Can I suggest we go to "Add" because let's think of all the installations the general public does today ... install smartphone apps, install operating system programs. That installation process is not install then enable. It's finite. Install and use. Where as, for safety, Drupal install is Add (regardless of the steps download/unpack/install) then Enable and then set Permissions. There are three steps to the installation process. So in today's world Install would imply a complete operation, which this is not.

As I'm looking through drupal I'm seeing the "Add" words in lots of buttons. So the precedence is there so we should be consistent. "Add field", "Add content", "Add vocabulary" ... with the button "Save" or "Save and continue".

These good thoughts are years old, not days, weeks or months. So what can we do to get this whole entire thing to completion (all wording on all pages and in links)? It's under six pages I think, and mostly text changes.

jhodgdon’s picture

We have a Usability team now in the Drupal project. The next step would be to bring this issue to a meeting of the Usability Team, and let that team decide on the text that should be put in, rather than continuing to debate it here. The people who commit patches to Drupal Core will accept a patch if it is endorsed by the Usability Team, and they probably will not accept a patch that isn't.

This team meets in Zoom, with a link posted in the #ux Drupal Slack channel, on Tuesdays at 1400 UTC, but they will probably not meet this coming week due to DrupalCon. So, the next meeting would be July 21. I will bring this issue there; you are also welcome to join.

sajosh’s picture

Hi Jhodgdon and UI team,

Your suggestions sound good. I also hope we can close all these issues after that meeting, whether text will be changed or not. For that meeting, I've consolidated all suggestions on all the relevant issue pages for everyone to review here before hand.

There's no commentary in the file, just UI text including link names. Any new commentary is here ...

A) The first thing for the UI team to decide on is the Drupal Installation Life-cycle wording ... Add then Enable then Update then Disable then Uninstall then Delete. This will make it easy to change the remaining sentences, links and buttons.

I skipped the word Install because it has three steps, for security, ... Add then Enable then Permission (and really Configure). Only after all four are done is it really installed. So I suggest not using Install as a single word or step but rather as an Installation Process or Drupal Module Life-cycle.

B) The second most important thing to do is create an Installation Process wizard or steps page or document because new users have to hunt around on how to upgrade. Take for example upgrading Drupal, the update page (/admin/modules/update) doesn't offer how to download core, how to manually overwrite and that update.php must be run afterward. (I can't even find a document for new users.)

C) Suggest removing or modifying the semi duplicate web page /admin/reports/updates
1) This has no function yet it looks the same as /admin/modules/update. It's misleading that one can't actually update from that page and there are no instructions on where to go to update, especially for the brand new Drupaler.

2) It duplicates URLs because the Update tab goes to the update page with another URL (/admin/reports/updates/update) not that page's real URL (/admin/modules/update).

3) It's breadcrumbs are different making new users think they do different things.

4) The setting and uninstall tabs are missing from one and the other.

Attached file has all the pages in the entire Drupal module life-cycle.

jhodgdon’s picture

FYI -- on the parent issue #2888657: [meta] Less confusing and more consistent wording needed in module/theme add/install/update the Usability team is discussing the UI text for this and about 10 other issues. Until decisions are made, making another patch here would probably be premature.

sajosh’s picture

The UX team decided to create a new idea page for the overall module life-cycle in #174 above.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

jhodgdon’s picture

Title: Module install form has two "install" buttons that do different things » Action of uploading module/theme files should consistently be called "Add", not "Install"
Issue summary: View changes

We discussed this issue today at a Usability meeting -- see #2888657-23: [meta] Less confusing and more consistent wording needed in module/theme add/install/update for the result of that discussion.

I'm adopting this issue to take care of item 1 there:

There is a UI that lets you upload the files either from a URL or a tarball. The UI for this should consistently use the verb "Add" (currently uses "Install", see item 1 in the issue summary here), and if there is any mention of removing files from the disk, that should use the verb "Remove". This can be done in a minor release, as it is only UI text changing.

Updating title/summary to reflect this.

jhodgdon’s picture

Issue summary: View changes

Adding slightly to the scope from #976232: "Install" button at admin/*/install should be labeled "Continue" and marking it as a duplicate of this issue.

jhodgdon’s picture

Issue summary: View changes

Asking for more people to get credit from another duplicate issue #2839586: Make the wording on the "Install new modules" page more clear

jhodgdon’s picture

Issue summary: View changes
Status: Needs work » Needs review
Issue tags: -Needs issue summary update, -sprint +Needs screenshots
StatusFileSize
new19.87 KB

Adding one more thing to the summary...

And here's a patch. The previous patch didn't apply, and it only changed two lines of code, so I didn't make an interdiff file. Hope that's OK. The scope of the issue has changed a lot anyway. I fixed up several tests; let's see what the bot has to say.

Status: Needs review » Needs work

The last submitted patch, 181: 2577407-181.patch, failed testing. View results

jhodgdon’s picture

Of course, the one Functional test I didn't try locally failed. :) Needs a fix for the changed UI text. I'll do that tomorrow.

Issue also needs screenshots.

jhodgdon’s picture

Here's a new patch, which should fix the tests. In that I found a couple more places with "Install" being used, and also tweaked one other change where I'd used the word "Addition" in the previous patch and switched it to "Files added".

jhodgdon’s picture

StatusFileSize
new28.08 KB
new26.35 KB
new24.99 KB
new45.99 KB
new19.36 KB

Here are some screenshots:

  • after-extend, after-appearance, after-updates: The Extend (admin/modules), Appearance (admin/appearance), and Available Updates Report pages, showing that the buttons now say "Add new module/theme" Here's one:
    Extend page top
  • after-add-page: The page you get to when you click any of the three buttons. The page is identical for all three except the page title, which is either "Add new module", "Add new theme", or "Add new module or theme". The breadcrumb and URL is different too -- for instance, admin/modules/install has breadcrumbs of Home > Administration > Extend. Here's one of the pages:
    Add module/theme page
  • erroruploading: I actually have never gotten the add new module functionality working on my localhost. So I get this error message. It seems wrong -- it still has the word "Update" in it. Here's the code:
     $is_an_update = TRUE;
      try {
        if ($updater->isInstalled()) {
          // This is an update.
          $tasks = $updater->update($filetransfer);
          $is_an_update = TRUE;
        }
        else {
          $tasks = $updater->install($filetransfer);
          $is_an_update = FALSE;
        }
    ...
     if ($is_an_update) {
          _update_batch_create_message($context['results']['log'][$project], t('Error updating'), FALSE);
        }
        else {
          _update_batch_create_message($context['results']['log'][$project], t('Error adding files'), FALSE);
        }
    

    So for some reason it decided this was an update rather than adding files, which is not correct. I did modify that code a bit (made the local variable $is_an_update and made two different error messages), but the logic was there before and it is wrong. I'm not sure what to do about it... The red error message does say "File add failed!" so maybe that is OK, but the message below is confusing.
    error message

Since I can't get past that screen (I tried messing with permissions etc.) I can't make the screenshots showing the end result after you upload a module/theme. Anyone else? Any ideas about the error message?

jhodgdon’s picture

StatusFileSize
new14.59 KB
new23.83 KB
new3.38 KB

Given that the logic there is wrong, I took out that local variable and just changed the message to be less specifically about updating vs. adding. Here's a new patch. Still needs screenshots of the successful result for adding a theme and adding a module.

And here is a new error screenshot:
error message

jhodgdon’s picture

Issue summary: View changes
Status: Needs review » Needs work
Issue tags: +Novice

Updating issue summary with a Novice task for adding the 2 remaining needed screenshots.

jhodgdon’s picture

Status: Needs work » Needs review

mistaken status change

ressa’s picture

Issue summary: View changes
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new27.83 KB
new27.3 KB

Thanks @jhodgdon, great work! The patch applies against 9.2.x correctly, and the wording makes more sense now. The code looks good, from what I can tell.

Successful result after adding a module

Added module

Successful result after adding a theme

Added theme

jhodgdon’s picture

Issue tags: -Needs screenshots, -Novice

Thanks for the review and for making those screenshots! Removing tags.

ressa’s picture

Great! I now notice that the project field from info.yml is used in stead of the more human-readable name field. Wouldn't this be a friendlier, less machine-like message?

Now

Updated/added ctools successfully

Better?

Updated/added Chaos Tools (ctools) successfully

Is it best handled in a fresh issue, or if it isn't too complicated, change status here to "Needs work"?

jhodgdon’s picture

I agree with #191, but it should definitely be a separate issue. This one is very targeted towards one verb. :)

ressa’s picture

I thought as much, but wanted to check first :) I have created #3182663: Use name in upload confirmation message, instead of project.

catch’s picture

Status: Reviewed & tested by the community » Needs work

Big +1 to the wording change. I found a few minor issues in the patch, and it also needs a re-roll.

  1. +++ b/core/modules/update/tests/src/Functional/UpdateUploadTest.php
    @@ -69,8 +69,8 @@ public function testUploadModule() {
           'files[project_upload]' => $validArchiveFile,
         ];
    -    $this->drupalPostForm('admin/modules/install', $edit, t('Install'));
    -    $this->assertText('AAA Update test is already installed.', 'Existing module was extracted and not reinstalled.');
    +    $this->drupalPostForm('admin/modules/install', $edit, t('Continue'));
    +    $this->assertText('AAA Update test is already present.', 'Existing module was extracted and not reinstalled.');
         $this->assertSession()->addressEquals('admin/modules/install');
    

    We could remove the custom assertion message from this, which would also remove the word 'reinstalled'.

  2. +++ b/core/modules/update/tests/src/Functional/UpdateUploadTest.php
    @@ -82,24 +82,24 @@ public function testUploadModule() {
         // module now exists in the expected place in the filesystem.
    -    $this->assertRaw(t('Installed %project_name successfully', ['%project_name' => 'update_test_new_module']));
    +    $this->assertRaw(t('Updated/added %project_name successfully', ['%project_name' => 'update_test_new_module']));
         $this->assertFileExists($installedInfoFilePath);
         // Ensure the links are relative to the site root and not
    

    Why does this change to 'Updated/added' instead of just 'Added'?

  3. +++ b/core/modules/update/update.module
    @@ -31,7 +31,7 @@ function update_help($route_name, RouteMatchInterface $route_match) {
           if (_update_manager_access()) {
    -        $output .= '<p>' . t('The Update Manager also allows administrators to update and install modules and themes through the administration interface.') . '</p>';
    +        $output .= '<p>' . t('The Update Manager also allows administrators to update and add modules and themes through the administration interface.') . '</p>';
           }
           $output .= '<h3>' . t('Uses') . '</h3>';
    

    While we're here, should this be 'add and update'?

  4. +++ b/core/modules/update/update.module
    @@ -41,8 +41,8 @@ function update_help($route_name, RouteMatchInterface $route_match) {
    -        $output .= '<dd>' . t('You can also install new modules and themes in the same fashion, through the <a href=":install">Install page</a>, or by clicking the <em>Install new module/theme</em> links at the top of the <a href=":modules_page">Extend page</a> and the <a href=":themes_page">Appearance page</a>. In this case, you are prompted to provide either the URL to the download, or to upload a packaged release file from your local computer.', [':modules_page' => Url::fromRoute('system.modules_list')->toString(), ':themes_page' => Url::fromRoute('system.themes_page')->toString(), ':install' => Url::fromRoute('update.report_install')->toString()]) . '</dd>';
    +        $output .= '<dt>' . t('Adding new modules and themes through the Install page') . '</dt>';
    +        $output .= '<dd>' . t('You can also add new modules and themes in the same fashion, through the <a href=":install">Add modules and themes page</a>, or by clicking the <em>Add new module/theme</em> links at the top of the <a href=":modules_page">Extend page</a> and the <a href=":themes_page">Appearance page</a>. In this case, you are prompted to provide either the URL to the download, or to upload a packaged release file from your local computer.', [':modules_page' => Url::fromRoute('system.modules_list')->toString(), ':themes_page' => Url::fromRoute('system.themes_page')->toString(), ':install' => Url::fromRoute('update.report_install')->toString()]) . '</dd>';
    

    Is it still called the 'Install' page? Shouldn't it be the 'Add' page?

jhodgdon’s picture

Status: Needs work » Needs review
StatusFileSize
new23.7 KB
new7.09 KB
new23.66 KB

Thanks for the review! I first rerolled the patch (file called "reroll" here), and then addressed the items from #194. First the easy ones:

1. Good idea. I always like to remove assert messages, but had been trying to keep the changes in this patch limited to fixing the issue at hand, but since it's in the same line, I did this.

3. Agreed that this wording seems better.

4. Good catch! The pages are now called "Add new ..." not "Install" (see the part of the patch that is in the routing.yml file). Updated the help accordingly.

Item 2 is more complicated. The UI text change is in update.authorize.inc:

-  _update_batch_create_message($context['results']['log'][$project], t('Installed %project_name successfully', ['%project_name' => $project]));
+  _update_batch_create_message($context['results']['log'][$project], t('Updated/added %project_name successfully', ['%project_name' => $project]));

The reason that this was changed from "installed" to "updated/added" is that this code piece is used both when grabbing updated code for modules/themes and when installing completely new ones, as you can see from the two test hunks. This one is testing adding a new module:

-    $this->drupalPostForm('admin/modules/install', $edit, t('Install'));
+    $this->drupalPostForm('admin/modules/install', $edit, t('Continue'));
     // Check that submitting the form takes the user to authorize.php.
     $this->assertSession()->addressEquals('core/authorize.php');
     $this->assertSession()->titleEquals('Update manager | Drupal');
     // Check for a success message on the page, and check that the installed
     // module now exists in the expected place in the filesystem.
-    $this->assertRaw(t('Installed %project_name successfully', ['%project_name' => 'update_test_new_module']));
+    $this->assertRaw(t('Updated/added %project_name successfully', ['%project_name' => 'update_test_new_module']));

And this one is testing updating an existing module:

     $this->drupalPostForm('admin/reports/updates/update', ['projects[update_test_new_module]' => TRUE], t('Download these updates'));
     $this->drupalPostForm(NULL, ['maintenance_mode' => FALSE], t('Continue'));
     $this->assertText('Update was completed successfully.');
-    $this->assertRaw(t('Installed %project_name successfully', ['%project_name' => 'update_test_new_module']));
+    $this->assertRaw(t('Updated/added %project_name successfully', ['%project_name' => 'update_test_new_module']));

You'll note that in the second case, you were doing a code update from the Available Updates report, and the old message said "Installed", which wasn't good wording. The new wording from the previous patch says "Updated/added", which at least makes it consistent with the rest of the UI.

However, the previous patch also updated a message a few lines up in the authorize.inc file:

-    _update_batch_create_message($context['results']['log'][$project], t('Error installing / updating'), FALSE);
+    _update_batch_create_message($context['results']['log'][$project], t('Error adding / updating'), FALSE);

I changed the other message so it now says "Added / updated" instead of "Updated/added", so that it is more consistent with this earlier message.

It would in theory be possible to change the code so that the same code was not being used for the two different cases (updating existing module/theme vs. adding new one). However, that would be a big code change that I felt that would be out of scope for this issue, which was otherwise only minor UI text changes for a big win in consistency.

Anyway, here's a new patch, and interdiff. I am on my non-dev machine so I haven't run the tests, but hopefully they will still pass since these are only a few minor tweaks to the UI text and help.

jhodgdon’s picture

whoops, named the interdiff with a .patch suffix, so that test will fail. :(

jhodgdon’s picture

If someone decides this is RTBC, could you please hide the interdiff file from the Files list after you are done reviewing, so that it doesn't get picked as the one to retest every few days? Thanks!

ressa’s picture

Status: Needs review » Reviewed & tested by the community
StatusFileSize
new30.86 KB

Thanks @catch and @jhodgdon, it looks good.

Added / updated in message.

ressa’s picture

  • catch committed cfcf40d on 9.2.x
    Issue #2577407 by vulcanr, jhodgdon, Sagar Ramgade, snehi, brahmjeet789...
catch’s picture

Status: Reviewed & tested by the community » Fixed

Agreed with #195.4, we shouldn't change the actual logic here, worth doing in a follow-up though perhaps. Rest of the changes look good.

Committed cfcf40d and pushed to 9.2.x. Thanks!

jhodgdon’s picture

Thanks for the quick action!!

jhodgdon’s picture

Also I created a follow-up issue for #194 item 2, which was further discussed in #195: #3186852: update.authorize.inc log messages should be improved

Status: Fixed » Closed (fixed)

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