[#43966] - [5.2] [Guided tours] Add a What's New tour when updating to Joomla 5.2
- Fixed in Code Base
- 12 Sep 2024
- Medium
- Build: 5.2-dev
- # 43966
- Diff
- obuisard:guided-tours-whatsnewtour
User tests: Successful: Unsuccessful:
Summary of Changes
This PR adds a tour that highlights new features introduced in Joomla 5.2.
Testing Instructions
Download the update package, not the full install as the tour is only available on updates!
It is possible to find the tour in the list of tours at the top of the Joomla dashboard and run it manually.
Make sure you see images when running the tour (on the first step only) and when editing the tour (System -> Manage -> Guided tours).
Actual result BEFORE applying this Pull Request
No tour highlighting new features for Joomla 5.2.
Expected result AFTER applying this Pull Request
What’s New in Joomla 5.2! tour is available.
Link to documentations
Please select:
-
Documentation link for docs.joomla.org:
-
No documentation changes for docs.joomla.org needed
-
Pull Request link for manual.joomla.org:
-
No documentation changes for manual.joomla.org needed
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | SQL Administration com_admin Postgresql Language & Strings Repository NPM Change Front End Plugins |
| Labels |
Added:
Language Change
NPM Resource Changed
PR-5.2-dev
|
||
| Title |
|
||||||
Is the intention for this to replace Post-Installation messages?
Regarding "untranslatable" pictures - good point. I would prefer that all possible pictures for translation were like that.
Something like the title enhancedtourheader_en-GB.png. If the system does not find a picture with the title enhancedtourheader_YOUR_LANGUAGE_CODE.png, the standard en-GB is loaded.
Neither the sql for tours or steps adds a value for ordering.
Why does this matter? The module displays tours ordered by ordering. So the whats new is always at the top of the list where it probably should be at the bottom next to the welcome to joomla tour so that it doesnt always display in the dropdown
Regarding "untranslatable" pictures - good point. I would prefer that all possible pictures for translation were like that.
Something like the title
enhancedtourheader_en-GB.png. If the system does not find a picture with the titleenhancedtourheader_YOUR_LANGUAGE_CODE.png, the standard en-GB is loaded.
not that simple as we dont have a method for you to add an image file into the language pack
Is the intention for this to replace Post-Installation messages?
The idea is for the What's new tours to highlight new features of a release (major or minor) on an update, of interest to the user, which is not quite the same as the post-installation messages, which targets admin, pointing that there are changes in htaccess... At least, that is how I see it.
Using images in this way means that they are not translatable. Is that a good idea?
No, but we could not find anything to hint us on how to do this (other than how the documentation screens are handled).
Neither the sql for tours or steps adds a value for ordering.
Why does this matter? The module displays tours ordered by ordering. So the whats new is always at the top of the list where it probably should be at the bottom next to the welcome to joomla tour so that it doesnt always display in the dropdown
All tours and steps get an ordering value of 0 on installation. Then values change once the user starts ordering tours.
Do you mean we should check all ordering values of the tables, get the highest number, then use that number + 1 in our SQL scripts?
Regarding "untranslatable" pictures - good point. I would prefer that all possible pictures for translation were like that.
Something like the titleenhancedtourheader_en-GB.png. If the system does not find a picture with the titleenhancedtourheader_YOUR_LANGUAGE_CODE.png, the standard en-GB is loaded.not that simple as we dont have a method for you to add an image file into the language pack
I think adding the language suffix is a good idea, but then we need to add the logic into this PR to find images according to languages. Images ultimately should still remain in the /media folder
All tours and steps get an ordering value of 0 on installation. Then values change once the user starts ordering tours.
No that is not correct. You can see that the ordering is set on installation here
joomla-cms/installation/sql/mysql/extensions.sql
Lines 987 to 999 in 76a2903
Using images in this way means that they are not translatable. Is that a good idea?
No, but we could not find anything to hint us on how to do this (other than how the documentation screens are handled).
I dont have any suggestion to make this work but having english screenshots in an arabic installation is not useful
All tours and steps get an ordering value of 0 on installation. Then values change once the user starts ordering tours.
No that is not correct. You can see that the ordering is set on installation here
OMG I should have checked, I forgot about it... I should know, I fixed those SQL lines back in Joomla 4.3 :-)
Anyway, this tour is not installed on a new installation, which means, all ordering will/may be different once we add this tour (and many more can have been added in between). So I don't see what ordering should be set here.
Using images in this way means that they are not translatable. Is that a good idea?
No, but we could not find anything to hint us on how to do this (other than how the documentation screens are handled).
I dont have any suggestion to make this work but having english screenshots in an arabic installation is not useful
I agree completely.
I put this PR in draft so we can stir some ideas about that problematic...
It could be argued that the two screenshots do not add anything to the guided tour and can simply be removed.
I have tested this item ✅ successfully on 97b4ef3
I have tested this successfully.. everything worked great.
NOTE: on the 2nd image, the envelope icon is hard to see for someone that sees perfectly well so definitely not good enough for those with visual impairments.
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/43966.
Using prebuilt package no "Whats new in Joomla 5.2" available:
"Show all tours":
index.php?option=com_guidedtours&view=tours shows 12 published and no unpublished tours.
Using prebuilt package no "Whats new in Joomla 5.2" available:
Hello @fgsw, you have to install the update package, you cannot use the full install package.
When on new installs, you get the Welcome tour.
On updated site, you get the What's new tour.
I have updated the test section to add that information (sorry, it was missing).
Thanks for trying the PR out!
I have tested this item ✅ successfully on 97b4ef3
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/43966.
I have tested this item ✅ successfully on 97b4ef3
I have re-tested this successfully with the latest PR Update.zip from ~17:26 UTC of today.
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/43966.
| Status | Pending | ⇒ | Ready to Commit |
RTC
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/43966.
pe7er
- | Labels |
Added:
RTC
|
||
| Status | Ready to Commit | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2024-09-12 03:43:49 |
| Closed_By | ⇒ | pe7er |
Using images in this way means that they are not translatable. Is that a good idea?