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.Problem/Motivation
While going through this issue #2017477: Multilingual tour for content translation settings we wanted to provide a tour for admin/config/regional/content-language that is a page with some functionality when you install language module (so a language module tour should be provided) and extended when you install content translation module.
I discovered that if I configure two sets tips for the same route (two yaml files) only one of them is shown.
Proposed resolution
To discuss:
1- Have tour button for every tour available in that page. This also allows multilingual for example to provide a tour on the Extend page explaining the purpose of the different modules. This means display many buttons on the toolbar instead of one to take each of the tours available using their label.
2- Have a way to merge tour tips, if two tours are available for a page merge their tips by weight so you take all the tours available.
3- config yamls extend the configuration of other installed configuration. I think is not possible to merge the yamls so one tour can be extended with more tips.
Remaining tasks
Decide a solution.
Comments
Comment #1
rodrigoaguileraComment #2
rodrigoaguileraComment #3
larowlanThey were supposed to work this way...
Comment #4
larowlanComment #5
larowlanSo the javascript supports this if you're linking from another page.
foo/bar?tour=1&tips=some-classis supposed to auto start a tour with it filtered to tips with the class some-classComment #6
rodrigoaguileraOh that is great.
I'm thinking that tours that need to be "extended" by other modules add a hook_tour_tips_alter that can add links to the last step of the tour to take the additional tours that live on that same page.
I'll try that later and will update the docs if this is the preferred way to deal with this kind of situation.
For the moment I'm wondering how we can be sure that the "main" tour is the one that is going to appear when you click on the tour button. I understand this main tour as the one we are going to add links to take other tours in the same page.
I'm not sure how to order tours
If this a solution we can close this issue.
Comment #7
larowlanThere is a hook_tour_tips_alter, see tour.api.php
Comment #8
rodrigoaguileraYeah I meant implementing the hook.
For example for this tour #2017477: Multilingual tour for content translation settings
Write a tour for the language module explaining the translation settings in that page and write another tour on the same page for the content_translation module that you can take at the end of the "main" language tour using hook_tour_tips_alter on the last tour tip
My concern is that I want the language tour to be the "main" tour that you take when you access that page but ther will be two tours defined for that route.
I guess that clicking on that link will reload the page with the second tour and then you lose all you did on the first tour (checking chechboxes).
I want my plan to be understood and reviewed so maybe it can be a pattern to follow. Tell me any doubts you have about it.
Comment #9
jhodgdonI don't understand why you can't use the alter hook for this? I mean, in this case the page works one way by default, and if a module adds some stuff to the page via some kind of page altering hook/class/plugin, then it should also be able to do an alter hook to add stuff to the tips. That seems like the right thing to do, and this hook already exists.
So my feeling is that this is not a bug at all?
If there's another use case for why we need to have two sets of tips, please explain in the issue summary, but I think the use case covered in the current summary is best done via the existing alter hook.
Comment #10
jhodgdonhttps://api.drupal.org/api/drupal/core!modules!tour!tour.api.php/functio...
Comment #18
pameeela CreditAttribution: pameeela commentedThanks everyone who contributed to this issue.
As part of the Bug smash initiative, we are triaging issues that are marked 'Postponed (maintainer needs more info)'. Based on the lack of additional information provided since jhodgdon's reply, I am marking this 'Closed (cannot reproduce)'.
If anyone believes this issue should not be closed, please provide specific information around the use case for why we need to have two sets of tips.