From 89753ae88015281d57708d904ab0735df3dd94cb Mon Sep 17 00:00:00 2001 From: LucasC Date: Fri, 27 Dec 2024 15:53:13 +0100 Subject: [PATCH 1/2] XWIKI-21633: Adding a step tour on a class field doesn't work * Added a hint for the element field of the step creation/edition forms. * Added a javascript log when the retrieval of the tour's JSON fails * Removed XWiki interpretation from the JSON construction velocity template in TourJson * Added the english value for the `element` field hint. --- .../src/main/resources/TourCode/StepSheet.xml | 7 ++++++- .../src/main/resources/TourCode/TourJS.xml | 3 +++ .../src/main/resources/TourCode/TourJson.xml | 2 +- .../src/main/resources/TourCode/TourTranslations.xml | 2 ++ 4 files changed, 12 insertions(+), 2 deletions(-) diff --git a/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/StepSheet.xml b/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/StepSheet.xml index f1c4ff217da2..6f40add137fe 100644 --- a/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/StepSheet.xml +++ b/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/StepSheet.xml @@ -89,7 +89,12 @@ </dl> #else <dl> - <dt><label #if($isEditing)for="TourCode.StepClass_0_${prop.name}"#end>$services.localization.render("${class.name}_${prop.name}")</label></dt> + <dt><label #if($isEditing)for="TourCode.StepClass_0_${prop.name}"#end>$services.localization.render("${class.name}_${prop.name}")</label> + ## Add a hint for the field if there's one defined in the translations. + #if($!services.localization.render("${class.name}_${prop.name}.hint") != "${class.name}_${prop.name}.hint")## + <span class='xHint'>$!services.localization.render("${class.name}_${prop.name}.hint")</span>## + #end## + </dt> <dd>$vobj.get($prop.getName())</dd> </dl> #end diff --git a/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourJS.xml b/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourJS.xml index c4b4c9961d8f..6a58bf1c51e5 100644 --- a/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourJS.xml +++ b/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourJS.xml @@ -428,7 +428,10 @@ require(['jquery', 'xwiki-meta'], function ($, xm) { createTour(tour); } } + }).fail(function (data) { + console.log("Querying the JSON for the Tour failed. %o", data); }); + ; }); }); diff --git a/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourJson.xml b/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourJson.xml index 80b0fdeb6199..6f1c3f09559a 100644 --- a/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourJson.xml +++ b/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourJson.xml @@ -38,7 +38,7 @@ true {{include reference="TourCode.Macros"/}} -{{velocity}} + {{velocity wiki="false"}} #if ($xcontext.action == 'get') ##-------------------------------------------------------- ## Get the tour steps corresponding to the target page diff --git a/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourTranslations.xml b/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourTranslations.xml index 714656a87192..1441f9989319 100644 --- a/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourTranslations.xml +++ b/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourTranslations.xml @@ -69,6 +69,8 @@ tour.popover.show.hint=You can restart the tour by clicking this button at anyti # Steps TourCode.StepClass_order=Order TourCode.StepClass_element=Element (CSS selector that identify an element) + TourCode.StepClass_element.hint=CSS selector that identifies an element. Escape special CSS characters with a + backslash. TourCode.StepClass_title=Title TourCode.StepClass_content=Content TourCode.StepClass_backdrop=Backdrop From d8aade54b54367f620a8a0a13116664acc9162f8 Mon Sep 17 00:00:00 2001 From: LucasC Date: Fri, 24 Jan 2025 09:08:58 +0100 Subject: [PATCH 2/2] XWIKI-21633: Adding a step tour on a class field doesn't work * Fixed code style. * Updated the JS log type. --- .../src/main/resources/TourCode/TourJS.xml | 2 +- .../src/main/resources/TourCode/TourTranslations.xml | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourJS.xml b/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourJS.xml index 6a58bf1c51e5..246e198ab5fd 100644 --- a/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourJS.xml +++ b/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourJS.xml @@ -429,7 +429,7 @@ require(['jquery', 'xwiki-meta'], function ($, xm) { } } }).fail(function (data) { - console.log("Querying the JSON for the Tour failed. %o", data); + console.error("Querying the JSON for the Tour failed. %o", data); }); ; }); diff --git a/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourTranslations.xml b/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourTranslations.xml index 1441f9989319..815716049be0 100644 --- a/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourTranslations.xml +++ b/xwiki-platform-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourTranslations.xml @@ -69,8 +69,7 @@ tour.popover.show.hint=You can restart the tour by clicking this button at anyti # Steps TourCode.StepClass_order=Order TourCode.StepClass_element=Element (CSS selector that identify an element) - TourCode.StepClass_element.hint=CSS selector that identifies an element. Escape special CSS characters with a - backslash. +TourCode.StepClass_element.hint=CSS selector that identifies an element. Escape special CSS characters with a backslash. TourCode.StepClass_title=Title TourCode.StepClass_content=Content TourCode.StepClass_backdrop=Backdrop