[5.2] [Guided tours] Add a What's New tour when updating to Joomla 5.2

administrator/components/com_admin/sql/updates/mysql/5.2.0-2024-08-22.sql

@@ -0,0 +1,3 @@
+INSERT INTO `#__guidedtour_steps` (`title`, `description`, `position`, `target`, `type`, `interactive_type`, `url`, `published`, `language`, `note`, `params`, `tour_id`, `created`, `created_by`, `modified`, `modified_by`) VALUES ('COM_GUIDEDTOURS_TOUR_WHATSNEW_5_2_STEP_0_TITLE', 'COM_GUIDEDTOURS_TOUR_WHATSNEW_5_2_STEP_0_DESCRIPTION', 'right', '#sidebarmenu nav > ul:first-of-type > li:last-child', 0, 1, '', 1, '*', '', '"{\"required\":1,\"requiredvalue\":\"\"}"', 0, CURRENT_TIMESTAMP(), 0, CURRENT_TIMESTAMP(), 0);
+INSERT INTO `#__guidedtours` (`title`, `description`, `extensions`, `url`, `published`, `language`, `note`, `access`, `uid`, `autostart`, `created`, `created_by`, `modified`, `modified_by`) VALUES ('COM_GUIDEDTOURS_TOUR_WHATSNEW_5_2_TITLE', 'COM_GUIDEDTOURS_TOUR_WHATSNEW_5_2_DESCRIPTION', '["com_cpanel"]', 'administrator/index.php', 1, '*', '', 1, 'joomla-whatsnew-5-2', 1, CURRENT_TIMESTAMP(), 0, CURRENT_TIMESTAMP(), 0);
+UPDATE `#__guidedtour_steps` SET `tour_id` = LAST_INSERT_ID() WHERE `tour_id`=0;

administrator/components/com_admin/sql/updates/postgresql/5.2.0-2024-08-22.sql

@@ -0,0 +1,3 @@
+INSERT INTO "#__guidedtour_steps" ("title", "description", "position", "target", "type", "interactive_type", "url", "published", "language", "note", "params", "tour_id", "created", "created_by", "modified", "modified_by") VALUES ('COM_GUIDEDTOURS_TOUR_WHATSNEW_5_2_STEP_0_TITLE', 'COM_GUIDEDTOURS_TOUR_WHATSNEW_5_2_STEP_0_DESCRIPTION', 'right', '#sidebarmenu nav > ul:first-of-type > li:last-child', 0, 1, '', 1, '*', '', '"{\"required\":1,\"requiredvalue\":\"\"}"', 0, CURRENT_TIMESTAMP, 0, CURRENT_TIMESTAMP, 0);
+INSERT INTO "#__guidedtours" ("title", "description", "extensions", "url", "published", "language", "note", "access", "uid", "autostart", "created", "created_by", "modified", "modified_by") VALUES ('COM_GUIDEDTOURS_TOUR_WHATSNEW_5_2_TITLE', 'COM_GUIDEDTOURS_TOUR_WHATSNEW_5_2_DESCRIPTION', '["com_cpanel"]', 'administrator/index.php', 1, '*', '', 1, 'joomla-whatsnew-5-2', 1, CURRENT_TIMESTAMP, 0, CURRENT_TIMESTAMP, 0);
+UPDATE "#__guidedtour_steps" SET "tour_id" = currval(pg_get_serial_sequence('#__guidedtours','id')) WHERE "tour_id"=0;

administrator/language/en-GB/guidedtours.joomla_whatsnew_5_2.ini

@@ -0,0 +1,2 @@
+COM_GUIDEDTOURS_TOUR_WHATSNEW_5_2_DESCRIPTION = "<h1 class=\"fw-medium\">Welcome to Joomla 5.2!</h1><div class=\"row align-items-center mb-4 pt-4 border-top border-1\"><div class=\"col-md-6 col-lg-5 text-center text-md-start mb-3 mb-md-0\"><img class=\"img-fluid\" src=\"media/com_guidedtours/images/5_2/enhancedtourheader.png\" alt=\"The first step of the welcome tour, showing the new header look\" width=\"640\" height=\"384\"></div><div class=\"col-md-6 col-lg-7\"><h2 class=\"mb-3\">Guided Tours Updates</h2><h3>Auto-start Tours</h3><p>This feature will allow you to create your own auto-start Guided Tour. The contextual tour can be opted out for one or all users. Tours can be restarted from the Guided Tours menu.</p><h3>Enhancements</h3><ul class=\"mb-3\"><li>For clarity, the <em>Step Counter</em> was positioned first in the tour header.</li><li>The modal window resizes automatically to accommodate larger content and images.</li></ul></div></div><div class=\"row align-items-center border-top border-1 pt-4\"><div class=\"col-md-6 col-lg-7 mb-3\"><h2 class=\"mb-3\">Core Updates</h2><h3>Mail Template Layout</h3><p>Take it a step further by creating an entirely unique layout (including logo) which can be applied to one or all mail templates.</p><p>From <span class=\"fw-medium\">Global Configuration -&gt; Mail Templates</span>, layouts can be defined in HTML.</p><h3>Other Enhancements and Fixes</h3><ul class=\"mb-3\"><li>Nested Subforms - Allows the nesting of Subform inside a Subform Custom Field</li><li>Total Count - The count and total number of list items</li></ul></div><div class=\"col-md-6 col-lg-5\"><img class=\"img-fluid\" src=\"media/com_guidedtours/images/5_2/mailtemplate.png\" alt=\"Mail template example, including a header logo and a footer\" width=\"640\" height=\"370\" loading=\"lazy\"></div></div>"
+COM_GUIDEDTOURS_TOUR_WHATSNEW_5_2_TITLE = "What’s New in Joomla 5.2!"

administrator/language/en-GB/guidedtours.joomla_whatsnew_5_2_steps.ini

@@ -0,0 +1,2 @@
+COM_GUIDEDTOURS_TOUR_WHATSNEW_5_2_STEP_0_DESCRIPTION = "<h3>Joomla 5.2 Full Release Notes</h3><p><a title=\"Click to view full release notes\" href=\"https://www.joomla.org/announcements.html\" target=\"_blank\" rel=\"noopener\">View the full release notes on joomla.org</a></p><hr><h3>Help and Information</h3><p>Many resources to help you can be found here together with additional links to more resources, documentation, support and how to become involved in Joomla.</p>"
+COM_GUIDEDTOURS_TOUR_WHATSNEW_5_2_STEP_0_TITLE = "More Information and Help"

administrator/language/en-GB/plg_system_guidedtours.ini

@@ -9,6 +9,7 @@ PLG_SYSTEM_GUIDEDTOURS_COMPLETE="Complete"
 PLG_SYSTEM_GUIDEDTOURS_COULD_NOT_LOAD_THE_TOUR="Could not start the tour. No valid ID given."
 PLG_SYSTEM_GUIDEDTOURS_DESCRIPTION="System Guided Tour Plugin"
 PLG_SYSTEM_GUIDEDTOURS_HIDE_FOREVER="Hide Forever"
+PLG_SYSTEM_GUIDEDTOURS_LEARN_MORE="Learn More"
 PLG_SYSTEM_GUIDEDTOURS_NEXT="Next"
 PLG_SYSTEM_GUIDEDTOURS_START="Start"
 PLG_SYSTEM_GUIDEDTOURS_STEP_NUMBER_OF="Step {number} of {total}" ; Do not translate the text between the {}

plugins/system/guidedtours/src/Extension/GuidedTours.php

@@ -326,13 +326,15 @@ private function processTour($item)
         $temp->id          = 0;
         $temp->title       = $this->getApplication()->getLanguage()->_($item->title);
         $temp->description = $this->getApplication()->getLanguage()->_($item->description);
+        $temp->description = $this->fixImagePaths($temp->description);
         $temp->url         = $item->url;
 
-        // Replace 'images/' to '../images/' when using an image from /images in backend.
-        $temp->description = preg_replace('*src\=\"(?!administrator\/)images/*', 'src="../images/', $temp->description);
-
         // Set the start label for the tour.
         $temp->start_label = Text::_('PLG_SYSTEM_GUIDEDTOURS_START');
+        // What's new tours have a different label.
+        if (str_contains($item->uid, 'joomla-whatsnew')) {
+            $temp->start_label = Text::_('PLG_SYSTEM_GUIDEDTOURS_LEARN_MORE');
+        }
 
         $tour->steps[] = $temp;
 
@@ -342,6 +344,7 @@ private function processTour($item)
             $temp->id               = $i + 1;
             $temp->title            = $this->getApplication()->getLanguage()->_($step->title);
             $temp->description      = $this->getApplication()->getLanguage()->_($step->description);
+            $temp->description      = $this->fixImagePaths($temp->description);
             $temp->position         = $step->position;
             $temp->target           = $step->target;
             $temp->type             = $this->stepType[$step->type];
@@ -351,12 +354,33 @@ private function processTour($item)
             $temp->tour_id          = $step->tour_id;
             $temp->step_id          = $step->id;
 
-            // Replace 'images/' to '../images/' when using an image from /images in backend.
-            $temp->description = preg_replace('*src\=\"(?!administrator\/)images/*', 'src="../images/', $temp->description);
-
             $tour->steps[] = $temp;
         }
 
         return $tour;
     }
+
+    /**
+     * Return a modified version of a given string with usable image paths for tours
+     *
+     * @param   string  $description  The string to fix
+     *
+     * @return  string
+     *
+     * @since  __DEPLOY_VERSION__
+     */
+    private function fixImagePaths($description)
+    {
+        return preg_replace(
+            [
+                '*src=\"(?!administrator\/)images/*',
+                '*src=\"media/*',
+            ],
+            [
+                'src="../images/',
+                'src="../media/',
+            ],
+            $description
+        );
+    }
 }